eZPublishCommunityProject  2013.5
eZ\Publish\API\Repository\URLWildcardService Interface Reference
+ Inheritance diagram for eZ\Publish\API\Repository\URLWildcardService:

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 (URLWildcard $urlWildcard)
 Removes an url wildcard. More...
 
 translate ($url)
 Translates an url to an existing uri resource based on the source/destination patterns of the url wildcard. More...
 

Member Function Documentation

eZ\Publish\API\Repository\URLWildcardService::create (   $sourceUrl,
  $destinationUrl,
  $forward = false 
)

Creates a new url wildcard.

Exceptions
\eZ\Publish\API\Repository\Exceptions\InvalidArgumentExceptionif the $sourceUrl pattern already exists
\eZ\Publish\API\Repository\Exceptions\UnauthorizedExceptionif the user is not allowed to create url wildcards
\eZ\Publish\API\Repository\Exceptions\ContentValidationExceptionif the number of "*" patterns in $sourceUrl and the number of {} placeholders in $destinationUrl doesn't match or if the placeholders aren't a valid number sequence({1}/{2}/{3}), starting with 1.
Parameters
string$sourceUrl
string$destinationUrl
boolean$forward
Returns

Implemented in eZ\Publish\Core\Repository\URLWildcardService, and eZ\Publish\Core\SignalSlot\URLWildcardService.

eZ\Publish\API\Repository\URLWildcardService::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\Repository\URLWildcardService, and eZ\Publish\Core\SignalSlot\URLWildcardService.

eZ\Publish\API\Repository\URLWildcardService::loadAll (   $offset = 0,
  $limit = -1 
)

Loads all url wild card (paged)

Parameters
int$offset
int$limit
Returns
[]

Implemented in eZ\Publish\Core\Repository\URLWildcardService, and eZ\Publish\Core\SignalSlot\URLWildcardService.

eZ\Publish\API\Repository\URLWildcardService::remove ( URLWildcard  $urlWildcard)

Removes an url wildcard.

Exceptions
\eZ\Publish\API\Repository\Exceptions\UnauthorizedExceptionif the user is not allowed to remove url wildcards
Parameters
\eZ\Publish\API\Repository\Values\Content\UrlWildcard$urlWildcardthe url wildcard to remove

Implemented in eZ\Publish\Core\Repository\URLWildcardService, and eZ\Publish\Core\SignalSlot\URLWildcardService.

eZ\Publish\API\Repository\URLWildcardService::translate (   $url)

Translates an url to an existing uri resource based on the source/destination patterns of the url wildcard.

Exceptions
\eZ\Publish\API\Repository\Exceptions\NotFoundExceptionif the url could not be translated
Parameters
mixed$url
Returns

Implemented in eZ\Publish\Core\Repository\URLWildcardService, and eZ\Publish\Core\SignalSlot\URLWildcardService.


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