Copied!

URLService

URLService.php : 20
Interface

URL Service.

Methods

publiccreateUpdateStruct()

URLService.php : 27

Instantiates a new URL update struct.

 
public createUpdateStruct() : URLUpdateStruct

Return values

URLUpdateStruct

publicfindUrls()

URLService.php : 38

Find URLs.

 
public findUrls(URLQuery $query) : SearchResult

Parameters

Name Type Default value Description
$query URLQuery - -

Return values

SearchResult

Tags
Throws
UnauthorizedException

publicfindUsages()

URLService.php : 51

Find content objects using URL.

 
public findUsages(URL $url[, int $offset = 0 ][, int $limit = -1 ]) : UsageSearchResult

Content is filter by user permissions.

Parameters

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

Return values

UsageSearchResult

publicloadById()

URLService.php : 63

Load single URL (by ID).

 
public loadById(int $id) : URL

Parameters

Name Type Default value Description
$id int -

ID of URL

Return values

URL

Tags
Throws
NotFoundException
Throws
UnauthorizedException

publicloadByUrl()

URLService.php : 75

Load single URL (by URL).

 
public loadByUrl(string $url) : URL

Parameters

Name Type Default value Description
$url string -

URL

Return values

URL

Tags
Throws
NotFoundException
Throws
UnauthorizedException

publicupdateUrl()

URLService.php : 89

Updates URL.

 
public updateUrl(URL $url, URLUpdateStruct $struct) : URL

Parameters

Name Type Default value Description
$url URL - -
$struct URLUpdateStruct - -

Return values

URL

Tags
Throws
NotFoundException
Throws
UnauthorizedException
Throws
InvalidArgumentException

if the url already exists