eZPublishCommunityProject  2013.5
eZ\Publish\Core\Persistence\Legacy\Content\UrlWildcard\Handler Class Reference

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

+ Inheritance diagram for eZ\Publish\Core\Persistence\Legacy\Content\UrlWildcard\Handler:
+ Collaboration diagram for eZ\Publish\Core\Persistence\Legacy\Content\UrlWildcard\Handler:

Public Member Functions

 __construct (Gateway $gateway, Mapper $mapper)
 Creates a new UrlWildcard Handler. More...
 
 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...
 

Protected Attributes

 $gateway
 
 $mapper
 

Detailed Description

The UrlWildcard Handler provides nice urls with wildcards management.

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

Constructor & Destructor Documentation

eZ\Publish\Core\Persistence\Legacy\Content\UrlWildcard\Handler::__construct ( Gateway  $gateway,
Mapper  $mapper 
)

Creates a new UrlWildcard Handler.

Parameters
\eZ\Publish\Core\Persistence\Legacy\Content\UrlWildcard\Gateway$gateway
\eZ\Publish\Core\Persistence\Legacy\Content\UrlWildcard\Mapper$mapper

Member Function Documentation

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

Creates a new url wildcard.

Parameters
string$sourceUrl
string$destinationUrl
boolean$forward
Returns

Implements eZ\Publish\SPI\Persistence\Content\UrlWildcard\Handler.

eZ\Publish\Core\Persistence\Legacy\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

Implements eZ\Publish\SPI\Persistence\Content\UrlWildcard\Handler.

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

Loads all url wild card (paged)

Parameters
mixed$offset
mixed$limit
Returns
[]

Implements eZ\Publish\SPI\Persistence\Content\UrlWildcard\Handler.

eZ\Publish\Core\Persistence\Legacy\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

Implements eZ\Publish\SPI\Persistence\Content\UrlWildcard\Handler.

Member Data Documentation

eZ\Publish\Core\Persistence\Legacy\Content\UrlWildcard\Handler::$gateway
protected
eZ\Publish\Core\Persistence\Legacy\Content\UrlWildcard\Handler::$mapper
protected

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