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

TargetInterface

interface TargetInterface (View source)

Methods

string
getName()

Returns the name of this target instance

void
publishCollection(CollectionInterface $collection)

Publishes the whole collection to this target

void
publishResource(PersistentResource $resource, CollectionInterface $collection)

Publishes the given persistent resource from the given storage

void
unpublishResource(PersistentResource $resource)

Unpublishes the given persistent resource

string
getPublicStaticResourceUri(string $relativePathAndFilename)

Returns the web accessible URI pointing to the given static resource

string
getPublicPersistentResourceUri(PersistentResource $resource)

Returns the web accessible URI pointing to the specified persistent resource

void
onPublish(Closure $callback)

Registers a callback, which must be invoked by the implementation after each resource publishing

Details

at line 27
string getName()

Returns the name of this target instance

Return Value

string

at line 35
void publishCollection(CollectionInterface $collection)

Publishes the whole collection to this target

Parameters

CollectionInterface $collection

The collection to publish

Return Value

void

at line 45
void publishResource(PersistentResource $resource, CollectionInterface $collection)

Publishes the given persistent resource from the given storage

Parameters

PersistentResource $resource

The resource to publish
CollectionInterface $collection

The collection the given resource belongs to

Return Value

void

Exceptions

Exception

at line 53
void unpublishResource(PersistentResource $resource)

Unpublishes the given persistent resource

Parameters

PersistentResource $resource

The resource to unpublish

Return Value

void

at line 61
string getPublicStaticResourceUri(string $relativePathAndFilename)

Returns the web accessible URI pointing to the given static resource

Parameters

string $relativePathAndFilename

Relative path and filename of the static resource

Return Value

string

The URI

at line 70
string getPublicPersistentResourceUri(PersistentResource $resource)

Returns the web accessible URI pointing to the specified persistent resource

Parameters

PersistentResource $resource

PersistentResource object

Return Value

string

The URI

Exceptions

Exception

at line 77
void onPublish(Closure $callback)

Registers a callback, which must be invoked by the implementation after each resource publishing

Parameters

Closure $callback

Return Value

void