PHP Интерфейс Sulu\Component\CustomUrl\Manager\CustomUrlManagerInterface

Показать файл Открыть проект Примеры использования интерфейса

Открытые методы

Метод Описание
create ( string $webspaceKey, array $data, string | null $locale = null ) : CustomUrlDocument Create a new custom-url with given data.
delete ( string $uuid ) : CustomUrlDocument Delete custom-url identified by uuid.
deleteRoute ( string $webspaceKey, string $uuid ) : CustomUrlDocument Delete route of a custom-url.
find ( string $uuid, string | null $locale = null ) : CustomUrlDocument Returns a single custom-url object identified by uuid.
findByPage ( Sulu\Component\DocumentManager\Behavior\Mapping\UuidBehavior $page ) : CustomUrlDocument[] Returns a list of custom-url documents which targeting the given page.
findByUrl ( string $url, string $webspaceKey, string $locale = null ) : CustomUrlDocument Returns a single custom-url object identified by url.
findList ( string $webspaceKey, $locale ) : array Returns a list of custom-url data (in a assoc-array).
findRouteByUrl ( string $url, string $webspaceKey, string $locale = null ) : RouteDocument Returns route for a custom-url object.
findUrls ( string $webspaceKey ) : string[] Returns a list of custom-urls.
invalidate ( CustomUrlDocument $document ) Invalidate http-cache for given document.
invalidateRoute ( string $webspaceKey, RouteDocument $routeDocument ) Invalidate http-cache for given route-document.
save ( string $uuid, array $data, string | null $locale = null ) : CustomUrlDocument Update a single custom-url object identified by uuid with given data.

Описание методов

create() публичный Метод

Create a new custom-url with given data.
public create ( string $webspaceKey, array $data, string | null $locale = null ) : CustomUrlDocument
$webspaceKey string
$data array
$locale string | null
Результат Sulu\Component\CustomUrl\Document\CustomUrlDocument

delete() публичный Метод

Delete custom-url identified by uuid.
public delete ( string $uuid ) : CustomUrlDocument
$uuid string
Результат Sulu\Component\CustomUrl\Document\CustomUrlDocument

deleteRoute() публичный Метод

Delete route of a custom-url.
public deleteRoute ( string $webspaceKey, string $uuid ) : CustomUrlDocument
$webspaceKey string
$uuid string
Результат Sulu\Component\CustomUrl\Document\CustomUrlDocument

find() публичный Метод

Returns a single custom-url object identified by uuid.
public find ( string $uuid, string | null $locale = null ) : CustomUrlDocument
$uuid string
$locale string | null
Результат Sulu\Component\CustomUrl\Document\CustomUrlDocument

findByPage() публичный Метод

Returns a list of custom-url documents which targeting the given page.
public findByPage ( Sulu\Component\DocumentManager\Behavior\Mapping\UuidBehavior $page ) : CustomUrlDocument[]
$page Sulu\Component\DocumentManager\Behavior\Mapping\UuidBehavior
Результат Sulu\Component\CustomUrl\Document\CustomUrlDocument[]

findByUrl() публичный Метод

Returns a single custom-url object identified by url.
public findByUrl ( string $url, string $webspaceKey, string $locale = null ) : CustomUrlDocument
$url string
$webspaceKey string
$locale string
Результат Sulu\Component\CustomUrl\Document\CustomUrlDocument

findList() публичный Метод

Returns a list of custom-url data (in a assoc-array).
public findList ( string $webspaceKey, $locale ) : array
$webspaceKey string
Результат array

findRouteByUrl() публичный Метод

Returns route for a custom-url object.
public findRouteByUrl ( string $url, string $webspaceKey, string $locale = null ) : RouteDocument
$url string
$webspaceKey string
$locale string
Результат Sulu\Component\CustomUrl\Document\RouteDocument

findUrls() публичный Метод

Returns a list of custom-urls.
public findUrls ( string $webspaceKey ) : string[]
$webspaceKey string
Результат string[]

invalidate() публичный Метод

Invalidate http-cache for given document.
public invalidate ( CustomUrlDocument $document )
$document Sulu\Component\CustomUrl\Document\CustomUrlDocument

invalidateRoute() публичный Метод

Invalidate http-cache for given route-document.
public invalidateRoute ( string $webspaceKey, RouteDocument $routeDocument )
$webspaceKey string
$routeDocument Sulu\Component\CustomUrl\Document\RouteDocument

save() публичный Метод

Update a single custom-url object identified by uuid with given data.
public save ( string $uuid, array $data, string | null $locale = null ) : CustomUrlDocument
$uuid string
$data array
$locale string | null
Результат Sulu\Component\CustomUrl\Document\CustomUrlDocument