Interface

eZ\Publish\API\Repository\URLService

interface URLService

URL Service.

Methods

URLUpdateStruct createUpdateStruct()

Instantiates a new URL update struct.

SearchResult findUrls(URLQuery $query)

Find URLs.

UsageSearchResult findUsages(URL $url, int $offset, int $limit = -1)

Find content objects using URL.

URL loadById(int $id)

Load single URL (by ID).

URL loadByUrl(string $url)

Load single URL (by URL).

URL updateUrl(URL $url, URLUpdateStruct $struct)

Updates URL.

Details

at line 23
public URLUpdateStruct createUpdateStruct()

Instantiates a new URL update struct.

Return Value

URLUpdateStruct

at line 33
public SearchResult findUrls(URLQuery $query)

Find URLs.

Parameters

URLQuery $query

Return Value

SearchResult

Exceptions

UnauthorizedException

at line 45
public UsageSearchResult findUsages(URL $url, int $offset, int $limit = -1)

Find content objects using URL.

Content is filter by user permissions.

Parameters

URL $url
int $offset
int $limit

Return Value

UsageSearchResult

at line 56
public URL loadById(int $id)

Load single URL (by ID).

Parameters

int $id ID of URL

Return Value

URL

Exceptions

NotFoundException
UnauthorizedException

at line 67
public URL loadByUrl(string $url)

Load single URL (by URL).

Parameters

string $url url

Return Value

URL

Exceptions

NotFoundException
UnauthorizedException

at line 80
public URL updateUrl(URL $url, URLUpdateStruct $struct)

Updates URL.

Parameters

URL $url
URLUpdateStruct $struct

Return Value

URL

Exceptions

NotFoundException
UnauthorizedException
InvalidArgumentException if the url already exists