FileResource
in package
implements
SelfCheckingResourceInterface
FileResource represents a resource stored on the filesystem.
The resource can be a file or a directory.
Tags
Table of Contents
Interfaces
- SelfCheckingResourceInterface
- Interface for Resources that can check for freshness autonomously, without special support from external services.
Properties
- $resource : string
Methods
- __construct() : mixed
- __toString() : string
- Returns a string representation of the Resource.
- getResource() : string
- Returns the canonicalized, absolute path to the resource.
- isFresh() : bool
- Returns true if the resource has not been updated since the given timestamp.
Properties
$resource
private
string
$resource
Methods
__construct()
public
__construct(string $resource) : mixed
Parameters
- $resource : string
-
The file path to the resource
Tags
__toString()
Returns a string representation of the Resource.
public
__toString() : string
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 values
stringgetResource()
Returns the canonicalized, absolute path to the resource.
public
getResource() : string
Return values
stringisFresh()
Returns true if the resource has not been updated since the given timestamp.
public
isFresh(int $timestamp) : bool
Parameters
- $timestamp : int
-
The last time the resource was loaded