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)

No description

Details

string getName()

Returns the name of this target instance

Return Value

string

void publishCollection(CollectionInterface $collection)

Publishes the whole collection to this target

Parameters

CollectionInterface $collection

The collection to publish

Return Value

void

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

void unpublishResource(PersistentResource $resource)

Unpublishes the given persistent resource

Parameters

PersistentResource $resource

The resource to unpublish

Return Value

void

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

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

void onPublish(Closure $callback)

No description

Parameters

Closure $callback

Return Value

void