1. interface
  2. Neos
  3. \
  4. Flow
  5. \
  6. ResourceManagement
  7. \
  8. Storage
  9. \
  10. StorageInterface

StorageInterface

interface StorageInterface (View source)

Interface for a resource storage

Methods

string
getName()

Returns the instance name of this storage

resource|bool
getStreamByResource(PersistentResource $resource)

Returns a stream handle which can be used internally to open / copy the given resource stored in this storage.

resource|bool
getStreamByResourcePath(string $relativePath)

Returns a stream handle which can be used internally to open / copy the given resource stored in this storage.

StorageObject>
getObjects()

Retrieve all Objects stored in this storage.

StorageObject>
getObjectsByCollection(CollectionInterface $collection)

Retrieve all Objects stored in this storage, filtered by the given collection name

Details

at line 30
string getName()

Returns the instance name of this storage

Return Value

string

at line 40
resource|bool getStreamByResource(PersistentResource $resource)

Returns a stream handle which can be used internally to open / copy the given resource stored in this storage.

Parameters

PersistentResource $resource

The resource stored in this storage

Return Value

resource|bool

The resource stream or false if the stream could not be obtained

at line 50
resource|bool getStreamByResourcePath(string $relativePath)

Returns a stream handle which can be used internally to open / copy the given resource stored in this storage.

Parameters

string $relativePath

A path relative to the storage root, for example "MyFirstDirectory/SecondDirectory/Foo.css"

Return Value

resource|bool

A URI (for example the full path and filename) leading to the resource file or false if it does not exist

at line 58
StorageObject> getObjects()

Retrieve all Objects stored in this storage.

Return Value

StorageObject>

at line 67
StorageObject> getObjectsByCollection(CollectionInterface $collection)

Retrieve all Objects stored in this storage, filtered by the given collection name

Parameters

CollectionInterface $collection

Return Value

StorageObject>