ResourceInterface
interface ResourceInterface
ResourceInterface is the interface that must be implemented by all Resource classes.
Methods
| string | __toString() Returns a string representation of the Resource. |
|
| bool | isFresh(int $timestamp) deprecated Returns true if the resource has not been updated since the given timestamp. |
|
| mixed | getResource() deprecated Returns the tied resource. |
Details
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 |
bool isFresh(int $timestamp) deprecated
deprecated
since 2.8, to be removed in 3.0. If your resource can check itself for freshness implement the SelfCheckingResourceInterface instead.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 |
mixed getResource() deprecated
deprecated
since 2.8, to be removed in 3.0. As there are many different kinds of resource, a single getResource() method does not make sense at the interface level. You can still call getResource() on implementing classes, probably after performing a type check. If you know the concrete type of Resource at hand, the return value of this method may make sense to you.Returns the tied resource.
Return Value
| mixed | The resource |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/Config/Resource/ResourceInterface.html