PHP Interface Neos\Flow\ResourceManagement\Storage\StorageInterface

Datei anzeigen Open project: neos/flow-development-collection Interface Usage Examples

Public Methods

Method Description
getName ( ) : string Returns the instance name of this storage
getObjects ( ) : Generator Retrieve all Objects stored in this storage.
getObjectsByCollection ( Neos\Flow\ResourceManagement\CollectionInterface $collection ) : Generator Retrieve all Objects stored in this storage, filtered by the given collection name
getStreamByResource ( PersistentResource $resource ) : resource | boolean Returns a stream handle which can be used internally to open / copy the given resource stored in this storage.
getStreamByResourcePath ( string $relativePath ) : resource | boolean Returns a stream handle which can be used internally to open / copy the given resource stored in this storage.

Method Details

getName() public method

Returns the instance name of this storage
public getName ( ) : string
return string

getObjects() public method

Retrieve all Objects stored in this storage.
public getObjects ( ) : Generator
return Generator

getObjectsByCollection() public method

Retrieve all Objects stored in this storage, filtered by the given collection name
public getObjectsByCollection ( Neos\Flow\ResourceManagement\CollectionInterface $collection ) : Generator
$collection Neos\Flow\ResourceManagement\CollectionInterface
return Generator

getStreamByResource() public method

Returns a stream handle which can be used internally to open / copy the given resource stored in this storage.
public getStreamByResource ( PersistentResource $resource ) : resource | boolean
$resource Neos\Flow\ResourceManagement\PersistentResource The resource stored in this storage
return resource | boolean | boolean The resource stream or FALSE if the stream could not be obtained

getStreamByResourcePath() public method

Returns a stream handle which can be used internally to open / copy the given resource stored in this storage.
public getStreamByResourcePath ( string $relativePath ) : resource | boolean
$relativePath string A path relative to the storage root, for example "MyFirstDirectory/SecondDirectory/Foo.css"
return resource | boolean | boolean A URI (for example the full path and filename) leading to the resource file or FALSE if it does not exist