class DirectoryResource implements SelfCheckingResourceInterface, Serializable

DirectoryResource represents a resources stored in a subdirectory tree.

Methods

__construct(string $resource, string|null $pattern = null)

Constructor.

string
__toString()

Returns a string representation of the Resource.

string
getResource()

No description

string|null
getPattern()

Returns the pattern to restrict monitored files.

bool
isFresh(int $timestamp)

Returns true if the resource has not been updated since the given timestamp.

serialize()

No description

unserialize($serialized)

No description

Details

at line line 32
__construct(string $resource, string|null $pattern = null)

Constructor.

Parameters

string $resource The file path to the resource
string|null $pattern A pattern to restrict monitored files

Exceptions

InvalidArgumentException

at line line 45
string __toString()

Returns a string representation of the Resource.

This method is necessary to allow for resource de-duplication, for example by means of array_unique(). The string returned need not have a particular meaning, but has to be identical for different ResourceInterface instances referring to the same resource; and it should be unlikely to collide with that of other, unrelated resource instances.

Return Value

string A string representation unique to the underlying Resource

at line line 53
string getResource()

Return Value

string The file path to the resource

at line line 63
string|null getPattern()

Returns the pattern to restrict monitored files.

Return Value

string|null

at line line 71
bool isFresh(int $timestamp)

Returns true if the resource has not been updated since the given timestamp.

Parameters

int $timestamp The last time the resource was loaded

Return Value

bool True if the resource has not been updated, false otherwise

at line line 96
serialize()

at line line 101
unserialize($serialized)

Parameters

$serialized