PHP Class Pimcore\Model\Object\ClassDefinition

Inheritance: extends Pimcore\Model\AbstractModel, use trait Pimcore\Model\Object\ClassDefinition\Helper\VarExport
Show file Open project: pimcore/pimcore Class Usage Examples

Public Properties

Property Type Description
$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

Public Methods

Method Description
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

Protected Methods

Method Description
deletePhpClasses ( ) : void
getInfoDocBlock ( ) : string
getInfoDocBlockForFields ( $definition, $text, $level ) : string

Method Details

addFieldDefinition() public method

public addFieldDefinition ( string $key, Data $data ) : void
$key string
$data Pimcore\Model\Object\ClassDefinition\Data
return void

cleanupForExport() public static method

public static cleanupForExport ( &$data )
$data

create() public static method

public static create ( array $values = [] ) : self
$values array
return self

delete() public method

public delete ( ) : void
return void

deletePhpClasses() protected method

protected deletePhpClasses ( ) : void
return void

extractDataDefinitions() public method

public extractDataDefinitions ( array | Layout | Data $def ) : void
$def array | Pimcore\Model\Object\ClassDefinition\Layout | Pimcore\Model\Object\ClassDefinition\Data
return void

getAllowInherit() public method

public getAllowInherit ( ) : boolean
return boolean

getAllowVariants() public method

public getAllowVariants ( ) : boolean
return boolean

getById() public static method

public static getById ( $id ) : mixed | null | ClassDefinition
$id
return mixed | null | ClassDefinition

getByName() public static method

public static getByName ( string $name ) : self
$name string
return self

getCreationDate() public method

public getCreationDate ( ) : integer
return integer

getDefinitionFile() public method

public getDefinitionFile ( null $name = null ) : string
$name null
return string

getDescription() public method

public getDescription ( ) : string
return string

getFieldDefinition() public method

public getFieldDefinition ( $key ) : Data
return Pimcore\Model\Object\ClassDefinition\Data

getFieldDefinitions() public method

public getFieldDefinitions ( ) : Data[]
return Pimcore\Model\Object\ClassDefinition\Data[]

getGroup() public method

public getGroup ( ) : string
return string

getIcon() public method

public getIcon ( ) : string
return string

getId() public method

public getId ( ) : integer
return integer

getInfoDocBlock() protected method

protected getInfoDocBlock ( ) : string
return string

getInfoDocBlockForFields() protected method

protected getInfoDocBlockForFields ( $definition, $text, $level ) : string
$definition
$text
$level
return string

getLayoutDefinitions() public method

public getLayoutDefinitions ( ) : array
return array

getModificationDate() public method

public getModificationDate ( ) : integer
return integer

getName() public method

public getName ( ) : string
return string

getParent() public method

public getParent ( ) : mixed
return mixed

getParentClass() public method

public getParentClass ( ) : string
return string

getPreviewUrl() public method

public getPreviewUrl ( ) : string
return string

getPropertyVisibility() public method

public getPropertyVisibility ( ) : array
return array

getShowVariants() public method

public getShowVariants ( ) : boolean
return boolean

getUseTraits() public method

public getUseTraits ( ) : string
return string

getUserModification() public method

public getUserModification ( ) : integer
return integer

getUserOwner() public method

public getUserOwner ( ) : integer
return integer

rename() public method

public rename ( string $name ) : void
$name string
return void

save() public method

public save ( )

setAllowInherit() public method

public setAllowInherit ( boolean $allowInherit ) : void
$allowInherit boolean
return void

setAllowVariants() public method

public setAllowVariants ( boolean $allowVariants ) : void
$allowVariants boolean
return void

setCreationDate() public method

public setCreationDate ( integer $creationDate ) : void
$creationDate integer
return void

setDescription() public method

public setDescription ( $description )
$description

setFieldDefinitions() public method

public setFieldDefinitions ( array $fieldDefinitions ) : void
$fieldDefinitions array
return void

setGroup() public method

public setGroup ( string $group )
$group string

setIcon() public method

public setIcon ( $icon )
$icon

setId() public method

public setId ( integer $id )
$id integer

setLayoutDefinitions() public method

public setLayoutDefinitions ( array $layoutDefinitions ) : void
$layoutDefinitions array
return void

setModificationDate() public method

public setModificationDate ( integer $modificationDate ) : void
$modificationDate integer
return void

setName() public method

public setName ( string $name )
$name string

setParent() public method

public setParent ( mixed $parent ) : void
$parent mixed
return void

setParentClass() public method

public setParentClass ( string $parentClass ) : void
$parentClass string
return void

setPreviewUrl() public method

public setPreviewUrl ( $previewUrl )
$previewUrl

setPropertyVisibility() public method

public setPropertyVisibility ( $propertyVisibility )
$propertyVisibility

setShowVariants() public method

public setShowVariants ( boolean $showVariants )
$showVariants boolean

setUseTraits() public method

public setUseTraits ( string $useTraits ) : ClassDefinition
$useTraits string
return ClassDefinition

setUserModification() public method

public setUserModification ( integer $userModification ) : void
$userModification integer
return void

setUserOwner() public method

public setUserOwner ( integer $userOwner ) : void
$userOwner integer
return void

Property Details

$allowInherit public property

public bool $allowInherit
return boolean

$allowVariants public property

public bool $allowVariants
return boolean

$creationDate public property

public int $creationDate
return integer

$description public property

public string $description
return string

$fieldDefinitions public property

public array $fieldDefinitions
return array

$group public property

public string $group
return string

$icon public property

public string $icon
return string

$id public property

public int $id
return integer

$layoutDefinitions public property

public array $layoutDefinitions
return array

$modificationDate public property

public int $modificationDate
return integer

$name public property

public string $name
return string

$parentClass public property

Name of the parent class if set
public string $parentClass
return string

$previewUrl public property

public string $previewUrl
return string

$propertyVisibility public property

public array $propertyVisibility
return array

$showVariants public property

public bool $showVariants
return boolean

$useTraits public property

public $useTraits

$userModification public property

public int $userModification
return integer

$userOwner public property

public int $userOwner
return integer