Copied!

Handler

Handler.php : 9
Interface

Methods

publicassign()

Handler.php : 81

Assigns section to single content object.

 
public assign(mixed $sectionId, mixed $contentId) : mixed

Parameters

Name Type Default value Description
$sectionId mixed - -
$contentId mixed - -

publicassignmentsCount()

Handler.php : 90

Number of content assignments a Section has.

 
public assignmentsCount(mixed $sectionId) : int

Parameters

Name Type Default value Description
$sectionId mixed - -

Return values

int

publiccountRoleAssignmentsUsingSection()

Handler.php : 108

Counts the number of role assignments using section with $sectionId in their limitations.

 
public countRoleAssignmentsUsingSection(int $sectionId) : int

Parameters

Name Type Default value Description
$sectionId int - -

Return values

int

publiccreate()

Handler.php : 22

Create a new section.

 
public create(string $name, string $identifier) : Section

Parameters

Name Type Default value Description
$name string - -
$identifier string - -

Return values

Section

publicdelete()

Handler.php : 73

Delete a section.

 
public delete(mixed $id) : mixed

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

Name Type Default value Description
$id mixed - -

publicload()

Handler.php : 44

Get section data.

 
public load(mixed $id) : Section

Parameters

Name Type Default value Description
$id mixed - -

Return values

Section

Tags
Throws
NotFoundException

If section is not found

publicloadAll()

Handler.php : 51

Get all section data.

 
public loadAll() : array<string|int, Section>

Return values

array<string|int, Section>

publicloadByIdentifier()

Handler.php : 62

Get section data by identifier.

 
public loadByIdentifier(string $identifier) : Section

Parameters

Name Type Default value Description
$identifier string - -

Return values

Section

Tags
Throws
NotFoundException

If section is not found

publicpoliciesCount()

Handler.php : 99

Number of role policies using a Section in limitations.

 
public policiesCount(mixed $sectionId) : int

Parameters

Name Type Default value Description
$sectionId mixed - -

Return values

int

publicupdate()

Handler.php : 33

Update name and identifier of a section.

 
public update(mixed $id, string $name, string $identifier) : Section

Parameters

Name Type Default value Description
$id mixed - -
$name string - -
$identifier string - -

Return values

Section