PHP Interface Neos\Flow\ResourceManagement\CollectionInterface

Mostra file Open project: neos/flow-development-collection Interface Usage Examples

Public Methods

Method Description
getName ( ) : string Returns the name of this collection
getObjects ( ) : Generator Returns all internal data objects of the storage attached to this collection.
getStorage ( ) : Neos\Flow\ResourceManagement\Storage\StorageInterface Returns the storage used for this collection
getStreamByResource ( PersistentResource $resource ) : resource | boolean Returns a stream handle of the given persistent resource which allows for opening / copying the resource's data. Note that this stream handle may only be used read-only.
getTarget ( ) : Neos\Flow\ResourceManagement\Target\TargetInterface Returns the publication target defined for this collection
importResource ( string | resource $source ) : PersistentResource Imports a resource (file) from the given URI or PHP resource stream into this collection.
importResourceFromContent ( string $content ) : PersistentResource Imports a resource from the given string content into this collection.
publish ( ) : void Publishes the whole collection to the corresponding publishing target

Method Details

getName() public method

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

getObjects() public method

Returns all internal data objects of the storage attached to this collection.
public getObjects ( ) : Generator
return Generator

getStorage() public method

Returns the storage used for this collection
public getStorage ( ) : Neos\Flow\ResourceManagement\Storage\StorageInterface
return Neos\Flow\ResourceManagement\Storage\StorageInterface

getStreamByResource() public method

Returns a stream handle of the given persistent resource which allows for opening / copying the resource's data. Note that this stream handle may only be used read-only.
public getStreamByResource ( PersistentResource $resource ) : resource | boolean
$resource PersistentResource The resource to retrieve the stream for
return resource | boolean | boolean The resource stream or FALSE if the stream could not be obtained

getTarget() public method

Returns the publication target defined for this collection
public getTarget ( ) : Neos\Flow\ResourceManagement\Target\TargetInterface
return Neos\Flow\ResourceManagement\Target\TargetInterface

importResource() public method

On a successful import this method returns a PersistentResource object representing the newly imported persistent resource. Note that this collection must have a writable storage in order to import resources.
public importResource ( string | resource $source ) : PersistentResource
$source string | resource
return PersistentResource A resource object representing the imported resource

importResourceFromContent() public method

On a successful import this method returns a PersistentResource object representing the newly imported persistent resource. Note that this collection must have a writable storage in order to import resources.
public importResourceFromContent ( string $content ) : PersistentResource
$content string The actual content to import
return PersistentResource A resource object representing the imported resource

publish() public method

Publishes the whole collection to the corresponding publishing target
public publish ( ) : void
return void