Copied!

Handler

Handler.php : 19
Interface

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.

Methods

publiccountAll()

Handler.php : 99

Counts URL Wildcards.

 
public countAll() : int

Return values

int

publiccreate()

Handler.php : 30

Creates a new url wildcard.

 
public create(string $sourceUrl, string $destinationUrl[, bool $forward = false ]) : UrlWildcard

Parameters

Name Type Default value Description
$sourceUrl string - -
$destinationUrl string - -
$forward bool false -

Return values

UrlWildcard

publicexactSourceUrlExists()

Handler.php : 94

Checks whether UrlWildcard with given source url exits.

 
public exactSourceUrlExists(string $sourceUrl) : bool

Parameters

Name Type Default value Description
$sourceUrl string - -

Return values

bool

publicfind()

Handler.php : 74

Find URLWildcards.

 
public find(URLWildcardQuery $query) : array<string|int, mixed>

Parameters

Name Type Default value Description
$query URLWildcardQuery - -

Return values

array<string|int, mixed>

Tags
Throws
UnauthorizedException

publicload()

Handler.php : 57

Loads a url wild card.

 
public load(mixed $id) : UrlWildcard

Parameters

Name Type Default value Description
$id mixed - -

Return values

UrlWildcard

Tags
Throws
NotFoundException

if the url wild card was not found

publicloadAll()

Handler.php : 67

Loads all url wild card (paged).

 
public loadAll([int $offset = 0 ][, int $limit = -1 ]) : array<string|int, UrlWildcard>

Parameters

Name Type Default value Description
$offset int 0 -
$limit int -1 -

Return values

array<string|int, UrlWildcard>

publicremove()

Handler.php : 46

removes an url wildcard.

 
public remove(mixed $id) : mixed

Parameters

Name Type Default value Description
$id mixed - -
Tags
Throws
NotFoundException

if the url wild card was not found

publictranslate()

Handler.php : 85

Performs lookup for given (source) URL.

 
public translate(string $sourceUrl) : UrlWildcard

Parameters

Name Type Default value Description
$sourceUrl string - -

Return values

UrlWildcard

Tags
Throws
NotFoundException

if the url wild card was not found

publicupdate()

Handler.php : 32 
public update(int $id, string $sourceUrl, string $destinationUrl, bool $forward) : UrlWildcard

Parameters

Name Type Default value Description
$id int - -
$sourceUrl string - -
$destinationUrl string - -
$forward bool - -

Return values

UrlWildcard