PHP Класс Pimcore\Model\Object\ClassDefinition

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

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

Свойство Тип Описание
$allowInherit boolean
$allowVariants boolean
$creationDate integer
$description string
$fieldDefinitions array
$group string
$icon string
$id integer
$layoutDefinitions array
$modificationDate integer
$name string
$parentClass string Name of the parent class if set
$previewUrl string
$propertyVisibility array
$showVariants boolean
$useTraits
$userModification integer
$userOwner integer

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

Метод Описание
addFieldDefinition ( string $key, Data $data ) : void
cleanupForExport ( &$data )
create ( array $values = [] ) : self
delete ( ) : void
extractDataDefinitions ( array | Layout | Data $def ) : void
getAllowInherit ( ) : boolean
getAllowVariants ( ) : boolean
getById ( $id ) : mixed | null | ClassDefinition
getByName ( string $name ) : self
getCreationDate ( ) : integer
getDefinitionFile ( null $name = null ) : string
getDescription ( ) : string
getFieldDefinition ( $key ) : Data
getFieldDefinitions ( ) : Data[]
getGroup ( ) : string
getIcon ( ) : string
getId ( ) : integer
getLayoutDefinitions ( ) : array
getModificationDate ( ) : integer
getName ( ) : string
getParent ( ) : mixed
getParentClass ( ) : string
getPreviewUrl ( ) : string
getPropertyVisibility ( ) : array
getShowVariants ( ) : boolean
getUseTraits ( ) : string
getUserModification ( ) : integer
getUserOwner ( ) : integer
rename ( string $name ) : void
save ( )
setAllowInherit ( boolean $allowInherit ) : void
setAllowVariants ( boolean $allowVariants ) : void
setCreationDate ( integer $creationDate ) : void
setDescription ( $description )
setFieldDefinitions ( array $fieldDefinitions ) : void
setGroup ( string $group )
setIcon ( $icon )
setId ( integer $id )
setLayoutDefinitions ( array $layoutDefinitions ) : void
setModificationDate ( integer $modificationDate ) : void
setName ( string $name )
setParent ( mixed $parent ) : void
setParentClass ( string $parentClass ) : void
setPreviewUrl ( $previewUrl )
setPropertyVisibility ( $propertyVisibility )
setShowVariants ( boolean $showVariants )
setUseTraits ( string $useTraits ) : ClassDefinition
setUserModification ( integer $userModification ) : void
setUserOwner ( integer $userOwner ) : void

Защищенные методы

Метод Описание
deletePhpClasses ( ) : void
getInfoDocBlock ( ) : string
getInfoDocBlockForFields ( $definition, $text, $level ) : string

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

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

public addFieldDefinition ( string $key, Data $data ) : void
$key string
$data Pimcore\Model\Object\ClassDefinition\Data
Результат void

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

public static cleanupForExport ( &$data )
$data

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

public static create ( array $values = [] ) : self
$values array
Результат self

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

public delete ( ) : void
Результат void

deletePhpClasses() защищенный Метод

protected deletePhpClasses ( ) : void
Результат void

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

public extractDataDefinitions ( array | Layout | Data $def ) : void
$def array | Pimcore\Model\Object\ClassDefinition\Layout | Pimcore\Model\Object\ClassDefinition\Data
Результат void

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

public getAllowInherit ( ) : boolean
Результат boolean

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

public getAllowVariants ( ) : boolean
Результат boolean

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

public static getById ( $id ) : mixed | null | ClassDefinition
$id
Результат mixed | null | ClassDefinition

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

public static getByName ( string $name ) : self
$name string
Результат self

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

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

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

public getDefinitionFile ( null $name = null ) : string
$name null
Результат string

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

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

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

public getFieldDefinition ( $key ) : Data
Результат Pimcore\Model\Object\ClassDefinition\Data

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

public getFieldDefinitions ( ) : Data[]
Результат Pimcore\Model\Object\ClassDefinition\Data[]

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

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

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

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

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

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

getInfoDocBlock() защищенный Метод

protected getInfoDocBlock ( ) : string
Результат string

getInfoDocBlockForFields() защищенный Метод

protected getInfoDocBlockForFields ( $definition, $text, $level ) : string
$definition
$text
$level
Результат string

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

public getLayoutDefinitions ( ) : array
Результат array

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

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

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

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

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

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

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

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

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

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

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

public getPropertyVisibility ( ) : array
Результат array

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

public getShowVariants ( ) : boolean
Результат boolean

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

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

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

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

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

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

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

public rename ( string $name ) : void
$name string
Результат void

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

public save ( )

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

public setAllowInherit ( boolean $allowInherit ) : void
$allowInherit boolean
Результат void

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

public setAllowVariants ( boolean $allowVariants ) : void
$allowVariants boolean
Результат void

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

public setCreationDate ( integer $creationDate ) : void
$creationDate integer
Результат void

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

public setDescription ( $description )
$description

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

public setFieldDefinitions ( array $fieldDefinitions ) : void
$fieldDefinitions array
Результат void

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

public setGroup ( string $group )
$group string

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

public setIcon ( $icon )
$icon

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

public setId ( integer $id )
$id integer

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

public setLayoutDefinitions ( array $layoutDefinitions ) : void
$layoutDefinitions array
Результат void

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

public setModificationDate ( integer $modificationDate ) : void
$modificationDate integer
Результат void

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

public setName ( string $name )
$name string

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

public setParent ( mixed $parent ) : void
$parent mixed
Результат void

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

public setParentClass ( string $parentClass ) : void
$parentClass string
Результат void

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

public setPreviewUrl ( $previewUrl )
$previewUrl

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

public setPropertyVisibility ( $propertyVisibility )
$propertyVisibility

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

public setShowVariants ( boolean $showVariants )
$showVariants boolean

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

public setUseTraits ( string $useTraits ) : ClassDefinition
$useTraits string
Результат ClassDefinition

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

public setUserModification ( integer $userModification ) : void
$userModification integer
Результат void

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

public setUserOwner ( integer $userOwner ) : void
$userOwner integer
Результат void

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

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

public bool $allowInherit
Результат boolean

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

public bool $allowVariants
Результат boolean

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

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

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

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

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

public array $fieldDefinitions
Результат array

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

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

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

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

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

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

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

public array $layoutDefinitions
Результат array

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

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

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

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

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

Name of the parent class if set
public string $parentClass
Результат string

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

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

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

public array $propertyVisibility
Результат array

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

public bool $showVariants
Результат boolean

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

public $useTraits

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

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

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

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