eZPublishCommunityProject  2013.9
eZ\Publish\Core\REST\Server\Controller\URLAlias Class Reference

URLAlias controller. More...

+ Inheritance diagram for eZ\Publish\Core\REST\Server\Controller\URLAlias:
+ Collaboration diagram for eZ\Publish\Core\REST\Server\Controller\URLAlias:

Public Member Functions

 __construct (URLAliasService $urlAliasService, LocationService $locationService)
 Construct controller. More...
 
 createURLAlias ()
 Creates a new URL alias. More...
 
 deleteURLAlias ($urlAliasId)
 The given URL alias is deleted. More...
 
 listGlobalURLAliases ()
 Returns the list of global URL aliases. More...
 
 listLocationURLAliases ($locationPath)
 Returns the list of URL aliases for a location. More...
 
 loadURLAlias ($urlAliasId)
 Returns the URL alias with the given ID. More...
 
- Public Member Functions inherited from eZ\Publish\Core\REST\Server\Controller
 setContainer (Container $container)
 
 setInputDispatcher (InputDispatcher $inputDispatcher)
 
 setRepository (Repository $repository)
 
 setRequest (Request $request=null)
 
 setRequestParser (RequestParser $requestParser)
 
 setRouter (RouterInterface $router)
 

Protected Attributes

 $locationService
 
 $urlAliasService
 
- Protected Attributes inherited from eZ\Publish\Core\REST\Server\Controller
 $container
 
 $inputDispatcher
 
 $repository
 
 $request
 
 $requestParser
 
 $router
 

Additional Inherited Members

- Protected Member Functions inherited from eZ\Publish\Core\REST\Server\Controller
 getMediaType ()
 Extracts the requested media type from $request. More...
 

Detailed Description

URLAlias controller.

Constructor & Destructor Documentation

eZ\Publish\Core\REST\Server\Controller\URLAlias::__construct ( URLAliasService  $urlAliasService,
LocationService  $locationService 
)

Construct controller.

Parameters
\eZ\Publish\API\Repository\URLAliasService$urlAliasService
\eZ\Publish\API\Repository\LocationService$locationService

Member Function Documentation

eZ\Publish\Core\REST\Server\Controller\URLAlias::createURLAlias ( )

Creates a new URL alias.

Exceptions
\eZ\Publish\Core\REST\Server\Exceptions\ForbiddenException
Returns
eZ\Publish\Core\REST\Server\Controller\URLAlias::deleteURLAlias (   $urlAliasId)

The given URL alias is deleted.

Parameters
$urlAliasId
Returns
eZ\Publish\Core\REST\Server\Controller\URLAlias::listGlobalURLAliases ( )

Returns the list of global URL aliases.

Returns
eZ\Publish\Core\REST\Server\Controller\URLAlias::listLocationURLAliases (   $locationPath)

Returns the list of URL aliases for a location.

Parameters
$locationPath
Returns
eZ\Publish\Core\REST\Server\Controller\URLAlias::loadURLAlias (   $urlAliasId)

Returns the URL alias with the given ID.

Parameters
$urlAliasId
Returns

Member Data Documentation

eZ\Publish\Core\REST\Server\Controller\URLAlias::$locationService
protected
eZ\Publish\Core\REST\Server\Controller\URLAlias::$urlAliasService
protected

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