DirectoryResource

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()
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()
	unserialize($serialized)

Details

__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

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

string getResource()

Return Value

string

The file path to the resource

string|null getPattern()

Returns the pattern to restrict monitored files.

Return Value

string|null

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

serialize()

unserialize($serialized)

Parameters

$serialized

Links:

http://api.symfony.com/master/Symfony/Component/Config/Resource/DirectoryResource.html

doc_Symfony

2016-10-28 06:14:17

Comments