PHP Class Neos\Flow\ResourceManagement\Collection

Inheritance: implements Neos\Flow\ResourceManagement\CollectionInterface
Show file Open project: neos/flow-development-collection

Protected Properties

Property Type Description
$name string
$pathPatterns array
$resourceRepository ResourceRepository
$storage Neos\Flow\ResourceManagement\Storage\StorageInterface
$target Neos\Flow\ResourceManagement\Target\TargetInterface

Public Methods

Method Description
__construct ( string $name, Neos\Flow\ResourceManagement\Storage\StorageInterface $storage, Neos\Flow\ResourceManagement\Target\TargetInterface $target, array $pathPatterns ) Constructor
getName ( ) : string Returns the name of this collection
getObjects ( callable $callback = null ) : 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

__construct() public method

Constructor
public __construct ( string $name, Neos\Flow\ResourceManagement\Storage\StorageInterface $storage, Neos\Flow\ResourceManagement\Target\TargetInterface $target, array $pathPatterns )
$name string User-space name of this collection, as specified in the settings
$storage Neos\Flow\ResourceManagement\Storage\StorageInterface The storage for data used in this collection
$target Neos\Flow\ResourceManagement\Target\TargetInterface The publication target for this collection
$pathPatterns array Glob patterns for paths to consider – only supported by specific storages

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 ( callable $callback = null ) : Generator
$callback callable Function called after each object
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. The specified filename will be used when presenting the resource to a user. Its file extension is important because the resource management will derive the IANA Media Type from it.
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

Property Details

$name protected property

protected string $name
return string

$pathPatterns protected property

protected array $pathPatterns
return array

$resourceRepository protected property

protected ResourceRepository,Neos\Flow\ResourceManagement $resourceRepository
return ResourceRepository

$storage protected property

protected StorageInterface,Neos\Flow\ResourceManagement\Storage $storage
return Neos\Flow\ResourceManagement\Storage\StorageInterface

$target protected property

protected TargetInterface,Neos\Flow\ResourceManagement\Target $target
return Neos\Flow\ResourceManagement\Target\TargetInterface