PHP Класс Pimcore\Model\Element\Tag

Наследование: extends Pimcore\Model\AbstractModel
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$children Tag[]
$id integer
$idPath string
$name string
$parent Tag
$parentId integer

Открытые методы

Метод Описание
addTagToElement ( $cType, $cId, Tag $tag ) adds given tag to element
batchAssignTagsToElement ( $cType, array $cIds, array $tagIds, boolean | false $replace = false )
correctPath ( )
getById ( $id ) : Pimcore\Model\Element\Tag
getChildren ( ) : Tag[]
getElementsForTag ( Tag $tag, string $type, array $subtypes = [], array $classNames = [], boolean $considerChildTags = false ) : array Retrieves all elements that have a specific tag or one of its child tags assigned
getFullIdPath ( ) : string
getId ( ) : integer
getIdPath ( ) : string
getName ( ) : string
getNamePath ( $includeOwnName = true )
getParent ( ) : Tag
getParentId ( ) : integer
getTagsForElement ( $cType, $cId ) : Tag[] returns all assigned tags for element
hasChildren ( )
removeTagFromElement ( $cType, $cId, Tag $tag ) removes given tag from element
save ( )
setId ( integer $id ) : Tag
setName ( string $name ) : Tag
setParentId ( integer $parentId ) : Tag
setTagsForElement ( $cType, $cId, array $tags ) sets given tags to element and removes all other tags to remove all tags from element, provide empty array of tags

Описание методов

addTagToElement() публичный статический Метод

adds given tag to element
public static addTagToElement ( $cType, $cId, Tag $tag )
$cType
$cId
$tag Tag

batchAssignTagsToElement() публичный статический Метод

public static batchAssignTagsToElement ( $cType, array $cIds, array $tagIds, boolean | false $replace = false )
$cType
$cIds array
$tagIds array
$replace boolean | false

correctPath() публичный Метод

public correctPath ( )

getById() публичный статический Метод

public static getById ( $id ) : Pimcore\Model\Element\Tag
$id
Результат Pimcore\Model\Element\Tag

getChildren() публичный Метод

public getChildren ( ) : Tag[]
Результат Tag[]

getElementsForTag() публичный статический Метод

Retrieves all elements that have a specific tag or one of its child tags assigned
public static getElementsForTag ( Tag $tag, string $type, array $subtypes = [], array $classNames = [], boolean $considerChildTags = false ) : array
$tag Tag The tag to search for
$type string The type of elements to search for: 'document', 'asset' or 'object'
$subtypes array Filter by subtypes, eg. page, object, email, folder etc.
$classNames array For objects only: filter by classnames
$considerChildTags boolean Look for elements having one of $tag's children assigned
Результат array

getFullIdPath() публичный Метод

public getFullIdPath ( ) : string
Результат string

getId() публичный Метод

public getId ( ) : integer
Результат integer

getIdPath() публичный Метод

public getIdPath ( ) : string
Результат string

getName() публичный Метод

public getName ( ) : string
Результат string

getNamePath() публичный Метод

public getNamePath ( $includeOwnName = true )

getParent() публичный Метод

public getParent ( ) : Tag
Результат Tag

getParentId() публичный Метод

public getParentId ( ) : integer
Результат integer

getTagsForElement() публичный статический Метод

returns all assigned tags for element
public static getTagsForElement ( $cType, $cId ) : Tag[]
$cType
$cId
Результат Tag[]

hasChildren() публичный Метод

public hasChildren ( )

removeTagFromElement() публичный статический Метод

removes given tag from element
public static removeTagFromElement ( $cType, $cId, Tag $tag )
$cType
$cId
$tag Tag

save() публичный Метод

public save ( )

setId() публичный Метод

public setId ( integer $id ) : Tag
$id integer
Результат Tag

setName() публичный Метод

public setName ( string $name ) : Tag
$name string
Результат Tag

setParentId() публичный Метод

public setParentId ( integer $parentId ) : Tag
$parentId integer
Результат Tag

setTagsForElement() публичный статический Метод

sets given tags to element and removes all other tags to remove all tags from element, provide empty array of tags
public static setTagsForElement ( $cType, $cId, array $tags )
$cType
$cId
$tags array

Описание свойств

$children публичное свойство

public Tag[],Pimcore\Model\Element $children
Результат Tag[]

$id публичное свойство

public int $id
Результат integer

$idPath публичное свойство

public string $idPath
Результат string

$name публичное свойство

public string $name
Результат string

$parent публичное свойство

public Tag,Pimcore\Model\Element $parent
Результат Tag

$parentId публичное свойство

public int $parentId
Результат integer