TaxonomyServiceInterface

TaxonomyServiceInterface.php : 16 Copy path

Constants¶

MOVE_POSITION_NEXT ¶

TaxonomyServiceInterface.php : 18 Copy path

public mixed MOVE_POSITION_NEXT = 'next'

MOVE_POSITION_PREV ¶

TaxonomyServiceInterface.php : 19 Copy path

public mixed MOVE_POSITION_PREV = 'prev'

Methods¶

countAllEntries() ¶

TaxonomyServiceInterface.php : 68 Copy path

public countAllEntries([string|null $taxonomyName = null ]) : int

Parameters

Name	Type	Default value	Description
$taxonomyName	string\|null	null	-

Return values

int

countEntryChildren() ¶

TaxonomyServiceInterface.php : 75 Copy path

public countEntryChildren(TaxonomyEntry $parentEntry) : int

Parameters

Name	Type	Default value	Description
$parentEntry	TaxonomyEntry	-	-

Return values

int

createEntry() ¶

TaxonomyServiceInterface.php : 50 Copy path

public createEntry(TaxonomyEntryCreateStruct $createStruct) : TaxonomyEntry

Parameters

Name	Type	Default value	Description
$createStruct	TaxonomyEntryCreateStruct	-	-

Return values

TaxonomyEntry

getPath() ¶

TaxonomyServiceInterface.php : 80 Copy path

public getPath(TaxonomyEntry $entry) : iterable<string|int, TaxonomyEntry>

Parameters

Name	Type	Default value	Description
$entry	TaxonomyEntry	-	-

Return values

iterable<string|int, TaxonomyEntry>

loadAllEntries() ¶

TaxonomyServiceInterface.php : 66 Copy path

public loadAllEntries([string|null $taxonomyName = null ][, int|null $limit = 30 ][, int $offset = 0 ]) : Traversable<string|int, TaxonomyEntry>

Parameters

Name	Type	Default value	Description
$taxonomyName	string\|null	null	-
$limit	int\|null	30	-
$offset	int	0	-

Return values

Traversable<string|int, TaxonomyEntry>

loadEntriesByIds() ¶

TaxonomyServiceInterface.php : 33 Copy path

public loadEntriesByIds(array<string|int, int> $ids) : Traversable<string|int, TaxonomyEntry>

Parameters

Name	Type	Default value	Description
$ids	array<string\|int, int>	-	-

Return values

Traversable<string|int, TaxonomyEntry>

Tags

loadEntryByContentId() ¶

TaxonomyServiceInterface.php : 48 Copy path

public loadEntryByContentId(int $contentId) : TaxonomyEntry

Parameters

Name	Type	Default value	Description
$contentId	int	-	-

Return values

TaxonomyEntry

Tags

loadEntryById() ¶

TaxonomyServiceInterface.php : 24 Copy path

public loadEntryById(int $id) : TaxonomyEntry

Parameters

Name	Type	Default value	Description
$id	int	-	-

Return values

TaxonomyEntry

Tags

loadEntryByIdentifier() ¶

TaxonomyServiceInterface.php : 38 Copy path

public loadEntryByIdentifier(string $identifier[, string $taxonomyName = null ]) : TaxonomyEntry

Parameters

Name	Type	Default value	Description
$identifier	string	-	-
$taxonomyName	string	null	-

Return values

TaxonomyEntry

Tags

loadEntryChildren() ¶

TaxonomyServiceInterface.php : 73 Copy path

public loadEntryChildren(TaxonomyEntry $parentEntry[, int|null $limit = 30 ][, int $offset = 0 ]) : Traversable<string|int, TaxonomyEntry>

Parameters

Name	Type	Default value	Description
$parentEntry	TaxonomyEntry	-	-
$limit	int\|null	30	-
$offset	int	0	-

Return values

Traversable<string|int, TaxonomyEntry>

loadRootEntry() ¶

TaxonomyServiceInterface.php : 43 Copy path

public loadRootEntry(string $taxonomyName) : TaxonomyEntry

Parameters

Name	Type	Default value	Description
$taxonomyName	string	-	-

Return values

TaxonomyEntry

Tags

moveEntry() ¶

TaxonomyServiceInterface.php : 56 Copy path

public moveEntry(TaxonomyEntry $entry, TaxonomyEntry $newParent) : void

Parameters

Name	Type	Default value	Description
$entry	TaxonomyEntry	-	-
$newParent	TaxonomyEntry	-	-

moveEntryRelativeToSibling() ¶

TaxonomyServiceInterface.php : 61 Copy path

public moveEntryRelativeToSibling(TaxonomyEntry $entry, TaxonomyEntry $sibling, string $position) : void

Parameters

Name	Type	Default value	Description
$entry	TaxonomyEntry	-	-
$sibling	TaxonomyEntry	-	-
$position	string	-	-

removeEntry() ¶

TaxonomyServiceInterface.php : 54 Copy path

public removeEntry(TaxonomyEntry $entry) : void

Parameters

Name	Type	Default value	Description
$entry	TaxonomyEntry	-	-

updateEntry() ¶

TaxonomyServiceInterface.php : 52 Copy path

public updateEntry(TaxonomyEntry $taxonomyEntry, TaxonomyEntryUpdateStruct $updateStruct) : TaxonomyEntry

Parameters

Name	Type	Default value	Description
$taxonomyEntry	TaxonomyEntry	-	-
$updateStruct	TaxonomyEntryUpdateStruct	-	-

Return values

TaxonomyEntry