eZPublishCommunityProject  2013.4
eZ\Publish\SPI\Persistence\Content\Section\Handler Interface Reference
+ Inheritance diagram for eZ\Publish\SPI\Persistence\Content\Section\Handler:

Public Member Functions

 assign ($sectionId, $contentId)
 Assigns section to single content object. More...
 
 assignmentsCount ($sectionId)
 Number of content assignments a Section has. More...
 
 create ($name, $identifier)
 Create a new section. More...
 
 delete ($id)
 Delete a section. More...
 
 load ($id)
 Get section data. More...
 
 loadAll ()
 Get all section data. More...
 
 loadByIdentifier ($identifier)
 Get section data by identifier. More...
 
 update ($id, $name, $identifier)
 Update name and identifier of a section. More...
 

Member Function Documentation

eZ\Publish\SPI\Persistence\Content\Section\Handler::assign (   $sectionId,
  $contentId 
)

Assigns section to single content object.

Parameters
mixed$sectionId
mixed$contentId

Implemented in eZ\Publish\Core\Persistence\Legacy\Content\Section\Handler, eZ\Publish\Core\Persistence\InMemory\SectionHandler, and eZ\Publish\Core\Persistence\Cache\SectionHandler.

eZ\Publish\SPI\Persistence\Content\Section\Handler::assignmentsCount (   $sectionId)
eZ\Publish\SPI\Persistence\Content\Section\Handler::create (   $name,
  $identifier 
)

Create a new section.

Parameters
string$name
string$identifier
Returns
Todo:

Should validate that $identifier is unique??

What about translatable $name?

Implemented in eZ\Publish\Core\Persistence\Legacy\Content\Section\Handler, eZ\Publish\Core\Persistence\InMemory\SectionHandler, and eZ\Publish\Core\Persistence\Cache\SectionHandler.

eZ\Publish\SPI\Persistence\Content\Section\Handler::delete (   $id)

Delete a section.

Might throw an exception if the section is still associated with some content objects. Make sure that no content objects are associated with the section any more before calling this method.

Parameters
mixed$id

Implemented in eZ\Publish\Core\Persistence\Legacy\Content\Section\Handler, eZ\Publish\Core\Persistence\InMemory\SectionHandler, and eZ\Publish\Core\Persistence\Cache\SectionHandler.

eZ\Publish\SPI\Persistence\Content\Section\Handler::load (   $id)

Get section data.

Parameters
mixed$id
Exceptions
\eZ\Publish\API\Repository\Exceptions\NotFoundExceptionIf section is not found
Returns

Implemented in eZ\Publish\Core\Persistence\Legacy\Content\Section\Handler, eZ\Publish\Core\Persistence\InMemory\SectionHandler, and eZ\Publish\Core\Persistence\Cache\SectionHandler.

eZ\Publish\SPI\Persistence\Content\Section\Handler::loadAll ( )
eZ\Publish\SPI\Persistence\Content\Section\Handler::loadByIdentifier (   $identifier)

Get section data by identifier.

Parameters
string$identifier
Exceptions
\eZ\Publish\API\Repository\Exceptions\NotFoundExceptionIf section is not found
Returns

Implemented in eZ\Publish\Core\Persistence\Legacy\Content\Section\Handler, eZ\Publish\Core\Persistence\InMemory\SectionHandler, and eZ\Publish\Core\Persistence\Cache\SectionHandler.

eZ\Publish\SPI\Persistence\Content\Section\Handler::update (   $id,
  $name,
  $identifier 
)

Update name and identifier of a section.

Parameters
mixed$id
string$name
string$identifier
Returns

Implemented in eZ\Publish\Core\Persistence\Legacy\Content\Section\Handler, eZ\Publish\Core\Persistence\InMemory\SectionHandler, and eZ\Publish\Core\Persistence\Cache\SectionHandler.


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