TaxonomyServiceInterface

TaxonomyServiceInterface.php : 22 Copy path

Interface

Constants¶

MOVE_POSITION_NEXT ¶

TaxonomyServiceInterface.php : 24 Copy path

public mixed MOVE_POSITION_NEXT = 'next'

MOVE_POSITION_PREV ¶

TaxonomyServiceInterface.php : 25 Copy path

public mixed MOVE_POSITION_PREV = 'prev'

Methods¶

countAllEntries() ¶

TaxonomyServiceInterface.php : 142 Copy path

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

Parameters

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

Return values

int

Tags

countEntryChildren() ¶

TaxonomyServiceInterface.php : 157 Copy path

public countEntryChildren(TaxonomyEntry $parentEntry) : int

Parameters

Name	Type	Default value	Description
$parentEntry	TaxonomyEntry	-	-

Return values

int

createEntry() ¶

TaxonomyServiceInterface.php : 79 Copy path

public createEntry(TaxonomyEntryCreateStruct $createStruct) : TaxonomyEntry

Parameters

Name	Type	Default value	Description
$createStruct	TaxonomyEntryCreateStruct	-	-

Return values

TaxonomyEntry

Tags

findEntries() ¶

TaxonomyServiceInterface.php : 167 Copy path

Finds the entries matching the query which the current user can read.

public findEntries(TaxonomyEntryQuery $query) : TaxonomyEntryList

Both the returned page and the total count include only entries the current user can read, ordered by entry ID.

Parameters

Name	Type	Default value	Description
$query	TaxonomyEntryQuery	-	-

Return values

TaxonomyEntryList

Tags

getPath() ¶

TaxonomyServiceInterface.php : 174 Copy path

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

Parameters

Name	Type	Default value	Description
$entry	TaxonomyEntry	-	-

Return values

iterable<string|int, TaxonomyEntry>

Tags

loadAllEntries() ¶

TaxonomyServiceInterface.php : 133 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>

Tags

loadEntriesByIds() ¶

TaxonomyServiceInterface.php : 44 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 : 71 Copy path

public loadEntryByContentId(int $contentId) : TaxonomyEntry

Parameters

Name	Type	Default value	Description
$contentId	int	-	-

Return values

TaxonomyEntry

Tags

loadEntryById() ¶

TaxonomyServiceInterface.php : 33 Copy path

public loadEntryById(int $id) : TaxonomyEntry

Parameters

Name	Type	Default value	Description
$id	int	-	-

Return values

TaxonomyEntry

Tags

loadEntryByIdentifier() ¶

TaxonomyServiceInterface.php : 52 Copy path

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

Parameters

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

Return values

TaxonomyEntry

Tags

loadEntryChildren() ¶

TaxonomyServiceInterface.php : 151 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>

Tags

loadRootEntry() ¶

TaxonomyServiceInterface.php : 63 Copy path

public loadRootEntry(string $taxonomyName) : TaxonomyEntry

Parameters

Name	Type	Default value	Description
$taxonomyName	string	-	-

Return values

TaxonomyEntry

Tags

moveEntry() ¶

TaxonomyServiceInterface.php : 106 Copy path

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

Parameters

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

Tags

moveEntryRelativeToSibling() ¶

TaxonomyServiceInterface.php : 119 Copy path

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

Parameters

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

Tags

removeEntry() ¶

TaxonomyServiceInterface.php : 98 Copy path

public removeEntry(TaxonomyEntry $entry) : void

Parameters

Name	Type	Default value	Description
$entry	TaxonomyEntry	-	-

Tags

updateEntry() ¶

TaxonomyServiceInterface.php : 87 Copy path

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

Parameters

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

Return values

TaxonomyEntry