eZPublishCommunityProject  2013.9
eZ\Publish\SPI\Persistence\Content\UrlWildcard\Handler Interface Reference

The UrlWildcard Handler interface provides nice urls with wildcards management. More...

+ Inheritance diagram for eZ\Publish\SPI\Persistence\Content\UrlWildcard\Handler:

Public Member Functions

 create ($sourceUrl, $destinationUrl, $forward=false)
 Creates a new url wildcard. More...
 
 load ($id)
 Loads a url wild card. More...
 
 loadAll ($offset=0, $limit=-1)
 Loads all url wild card (paged) More...
 
 remove ($id)
 removes an url wildcard More...
 

Detailed Description

The UrlWildcard Handler interface provides nice urls with wildcards management.

Its methods operate on a representation of the url alias data structure held inside a storage engine.

Member Function Documentation

eZ\Publish\SPI\Persistence\Content\UrlWildcard\Handler::create (   $sourceUrl,
  $destinationUrl,
  $forward = false 
)

Creates a new url wildcard.

Parameters
string$sourceUrl
string$destinationUrl
boolean$forward
Returns

Implemented in eZ\Publish\Core\Persistence\Legacy\Content\UrlWildcard\Handler, and eZ\Publish\Core\Persistence\InMemory\UrlWildcardHandler.

eZ\Publish\SPI\Persistence\Content\UrlWildcard\Handler::load (   $id)

Loads a url wild card.

Exceptions
\eZ\Publish\API\Repository\Exceptions\NotFoundExceptionif the url wild card was not found
Parameters
mixed$id
Returns

Implemented in eZ\Publish\Core\Persistence\Legacy\Content\UrlWildcard\Handler, and eZ\Publish\Core\Persistence\InMemory\UrlWildcardHandler.

eZ\Publish\SPI\Persistence\Content\UrlWildcard\Handler::loadAll (   $offset = 0,
  $limit = -1 
)

Loads all url wild card (paged)

Parameters
int$offset
int$limit
Returns
[]

Implemented in eZ\Publish\Core\Persistence\Legacy\Content\UrlWildcard\Handler, and eZ\Publish\Core\Persistence\InMemory\UrlWildcardHandler.

eZ\Publish\SPI\Persistence\Content\UrlWildcard\Handler::remove (   $id)

removes an url wildcard

Exceptions
\eZ\Publish\API\Repository\Exceptions\NotFoundExceptionif the url wild card was not found
Parameters
mixed$id

Implemented in eZ\Publish\Core\Persistence\Legacy\Content\UrlWildcard\Handler, and eZ\Publish\Core\Persistence\InMemory\UrlWildcardHandler.


The documentation for this interface was generated from the following file: