PHP Class Pimcore\Model\Object\ClassDefinition

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

Méthodes publiques

Свойство 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

Méthodes publiques

Méthode 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

Méthodes protégées

Méthode Description
deletePhpClasses ( ) : void
getInfoDocBlock ( ) : string
getInfoDocBlockForFields ( $definition, $text, $level ) : string

Method Details

addFieldDefinition() public méthode

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

cleanupForExport() public static méthode

public static cleanupForExport ( &$data )
$data

create() public static méthode

public static create ( array $values = [] ) : self
$values array
Résultat self

delete() public méthode

public delete ( ) : void
Résultat void

deletePhpClasses() protected méthode

protected deletePhpClasses ( ) : void
Résultat void

extractDataDefinitions() public méthode

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

getAllowInherit() public méthode

public getAllowInherit ( ) : boolean
Résultat boolean

getAllowVariants() public méthode

public getAllowVariants ( ) : boolean
Résultat boolean

getById() public static méthode

public static getById ( $id ) : mixed | null | ClassDefinition
$id
Résultat mixed | null | ClassDefinition

getByName() public static méthode

public static getByName ( string $name ) : self
$name string
Résultat self

getCreationDate() public méthode

public getCreationDate ( ) : integer
Résultat integer

getDefinitionFile() public méthode

public getDefinitionFile ( null $name = null ) : string
$name null
Résultat string

getDescription() public méthode

public getDescription ( ) : string
Résultat string

getFieldDefinition() public méthode

public getFieldDefinition ( $key ) : Data
Résultat Pimcore\Model\Object\ClassDefinition\Data

getFieldDefinitions() public méthode

public getFieldDefinitions ( ) : Data[]
Résultat Pimcore\Model\Object\ClassDefinition\Data[]

getGroup() public méthode

public getGroup ( ) : string
Résultat string

getIcon() public méthode

public getIcon ( ) : string
Résultat string

getId() public méthode

public getId ( ) : integer
Résultat integer

getInfoDocBlock() protected méthode

protected getInfoDocBlock ( ) : string
Résultat string

getInfoDocBlockForFields() protected méthode

protected getInfoDocBlockForFields ( $definition, $text, $level ) : string
$definition
$text
$level
Résultat string

getLayoutDefinitions() public méthode

public getLayoutDefinitions ( ) : array
Résultat array

getModificationDate() public méthode

public getModificationDate ( ) : integer
Résultat integer

getName() public méthode

public getName ( ) : string
Résultat string

getParent() public méthode

public getParent ( ) : mixed
Résultat mixed

getParentClass() public méthode

public getParentClass ( ) : string
Résultat string

getPreviewUrl() public méthode

public getPreviewUrl ( ) : string
Résultat string

getPropertyVisibility() public méthode

public getPropertyVisibility ( ) : array
Résultat array

getShowVariants() public méthode

public getShowVariants ( ) : boolean
Résultat boolean

getUseTraits() public méthode

public getUseTraits ( ) : string
Résultat string

getUserModification() public méthode

public getUserModification ( ) : integer
Résultat integer

getUserOwner() public méthode

public getUserOwner ( ) : integer
Résultat integer

rename() public méthode

public rename ( string $name ) : void
$name string
Résultat void

save() public méthode

public save ( )

setAllowInherit() public méthode

public setAllowInherit ( boolean $allowInherit ) : void
$allowInherit boolean
Résultat void

setAllowVariants() public méthode

public setAllowVariants ( boolean $allowVariants ) : void
$allowVariants boolean
Résultat void

setCreationDate() public méthode

public setCreationDate ( integer $creationDate ) : void
$creationDate integer
Résultat void

setDescription() public méthode

public setDescription ( $description )
$description

setFieldDefinitions() public méthode

public setFieldDefinitions ( array $fieldDefinitions ) : void
$fieldDefinitions array
Résultat void

setGroup() public méthode

public setGroup ( string $group )
$group string

setIcon() public méthode

public setIcon ( $icon )
$icon

setId() public méthode

public setId ( integer $id )
$id integer

setLayoutDefinitions() public méthode

public setLayoutDefinitions ( array $layoutDefinitions ) : void
$layoutDefinitions array
Résultat void

setModificationDate() public méthode

public setModificationDate ( integer $modificationDate ) : void
$modificationDate integer
Résultat void

setName() public méthode

public setName ( string $name )
$name string

setParent() public méthode

public setParent ( mixed $parent ) : void
$parent mixed
Résultat void

setParentClass() public méthode

public setParentClass ( string $parentClass ) : void
$parentClass string
Résultat void

setPreviewUrl() public méthode

public setPreviewUrl ( $previewUrl )
$previewUrl

setPropertyVisibility() public méthode

public setPropertyVisibility ( $propertyVisibility )
$propertyVisibility

setShowVariants() public méthode

public setShowVariants ( boolean $showVariants )
$showVariants boolean

setUseTraits() public méthode

public setUseTraits ( string $useTraits ) : ClassDefinition
$useTraits string
Résultat ClassDefinition

setUserModification() public méthode

public setUserModification ( integer $userModification ) : void
$userModification integer
Résultat void

setUserOwner() public méthode

public setUserOwner ( integer $userOwner ) : void
$userOwner integer
Résultat void

Property Details

$allowInherit public_oe property

public bool $allowInherit
Résultat boolean

$allowVariants public_oe property

public bool $allowVariants
Résultat boolean

$creationDate public_oe property

public int $creationDate
Résultat integer

$description public_oe property

public string $description
Résultat string

$fieldDefinitions public_oe property

public array $fieldDefinitions
Résultat array

$group public_oe property

public string $group
Résultat string

$icon public_oe property

public string $icon
Résultat string

$id public_oe property

public int $id
Résultat integer

$layoutDefinitions public_oe property

public array $layoutDefinitions
Résultat array

$modificationDate public_oe property

public int $modificationDate
Résultat integer

$name public_oe property

public string $name
Résultat string

$parentClass public_oe property

Name of the parent class if set
public string $parentClass
Résultat string

$previewUrl public_oe property

public string $previewUrl
Résultat string

$propertyVisibility public_oe property

public array $propertyVisibility
Résultat array

$showVariants public_oe property

public bool $showVariants
Résultat boolean

$useTraits public_oe property

public $useTraits

$userModification public_oe property

public int $userModification
Résultat integer

$userOwner public_oe property

public int $userOwner
Résultat integer