PHP Класс Neos\Flow\ResourceManagement\Collection

Наследование: implements Neos\Flow\ResourceManagement\CollectionInterface
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$name string
$pathPatterns array
$resourceRepository ResourceRepository
$storage Neos\Flow\ResourceManagement\Storage\StorageInterface
$target Neos\Flow\ResourceManagement\Target\TargetInterface

Открытые методы

Метод Описание
__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

Описание методов

__construct() публичный Метод

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() публичный Метод

Returns the name of this collection
public getName ( ) : string
Результат string

getObjects() публичный Метод

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
Результат Generator

getStorage() публичный Метод

Returns the storage used for this collection
public getStorage ( ) : Neos\Flow\ResourceManagement\Storage\StorageInterface
Результат Neos\Flow\ResourceManagement\Storage\StorageInterface

getStreamByResource() публичный Метод

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
Результат resource | boolean | boolean The resource stream or FALSE if the stream could not be obtained

getTarget() публичный Метод

Returns the publication target defined for this collection
public getTarget ( ) : Neos\Flow\ResourceManagement\Target\TargetInterface
Результат Neos\Flow\ResourceManagement\Target\TargetInterface

importResource() публичный Метод

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
Результат PersistentResource A resource object representing the imported resource

importResourceFromContent() публичный Метод

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
Результат PersistentResource A resource object representing the imported resource

publish() публичный Метод

Publishes the whole collection to the corresponding publishing target
public publish ( ) : void
Результат void

Описание свойств

$name защищенное свойство

protected string $name
Результат string

$pathPatterns защищенное свойство

protected array $pathPatterns
Результат array

$resourceRepository защищенное свойство

protected ResourceRepository,Neos\Flow\ResourceManagement $resourceRepository
Результат ResourceRepository

$storage защищенное свойство

protected StorageInterface,Neos\Flow\ResourceManagement\Storage $storage
Результат Neos\Flow\ResourceManagement\Storage\StorageInterface

$target защищенное свойство

protected TargetInterface,Neos\Flow\ResourceManagement\Target $target
Результат Neos\Flow\ResourceManagement\Target\TargetInterface