PHP Интерфейс Neos\Flow\ResourceManagement\CollectionInterface

Показать файл Открыть проект Примеры использования интерфейса

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

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

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

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