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

Section controller. More...

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

Public Member Functions

 __construct (SectionService $sectionService)
 Construct controller. More...
 
 createSection ()
 Create new section. More...
 
 deleteSection ($sectionId)
 Delete a section by ID. More...
 
 listSections ()
 List sections. More...
 
 loadSection ($sectionId)
 Loads a section. More...
 
 loadSectionByIdentifier ()
 Loads section by identifier. More...
 
 updateSection ($sectionId)
 Updates a section. 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 Member Functions

 mapToUpdateStruct (SectionCreateStruct $createStruct)
 Maps a SectionCreateStruct to a SectionUpdateStruct. More...
 
- Protected Member Functions inherited from eZ\Publish\Core\REST\Server\Controller
 getMediaType ()
 Extracts the requested media type from $request. More...
 

Protected Attributes

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

Detailed Description

Section controller.

Constructor & Destructor Documentation

eZ\Publish\Core\REST\Server\Controller\Section::__construct ( SectionService  $sectionService)

Construct controller.

Parameters
\eZ\Publish\API\Repository\SectionService$sectionService

Member Function Documentation

eZ\Publish\Core\REST\Server\Controller\Section::createSection ( )

Create new section.

Exceptions
\eZ\Publish\Core\REST\Server\Exceptions\ForbiddenException
Returns
eZ\Publish\Core\REST\Server\Controller\Section::deleteSection (   $sectionId)

Delete a section by ID.

Parameters
$sectionId
Returns
eZ\Publish\Core\REST\Server\Controller\Section::listSections ( )

List sections.

Returns
eZ\Publish\Core\REST\Server\Controller\Section::loadSection (   $sectionId)

Loads a section.

Parameters
$sectionId
Returns
eZ\Publish\Core\REST\Server\Controller\Section::loadSectionByIdentifier ( )

Loads section by identifier.

Returns

Referenced by eZ\Publish\Core\REST\Server\Controller\Section\listSections().

eZ\Publish\Core\REST\Server\Controller\Section::mapToUpdateStruct ( SectionCreateStruct  $createStruct)
protected

Maps a SectionCreateStruct to a SectionUpdateStruct.

Needed since both structs are encoded into the same media type on input.

Parameters
\eZ\Publish\API\Repository\Values\Content\SectionCreateStruct$createStruct
Returns

Referenced by eZ\Publish\Core\REST\Server\Controller\Section\updateSection().

eZ\Publish\Core\REST\Server\Controller\Section::updateSection (   $sectionId)

Updates a section.

Parameters
$sectionId
Exceptions
\eZ\Publish\Core\REST\Server\Exceptions\ForbiddenException
Returns

Member Data Documentation

eZ\Publish\Core\REST\Server\Controller\Section::$sectionService
protected

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