PHP Class Pimcore\Model\Object\KeyValue\KeyConfig

Inheritance: extends Pimcore\Model\AbstractModel
Datei anzeigen Open project: pimcore/pimcore Class Usage Examples

Public Properties

Property Type Description
$cache array
$cacheEnabled boolean
$creationDate integer
$description The key description.
$group The group id.
$id integer
$mandatory
$modificationDate integer
$name string The key
$possiblevalues Array of possible vales ("select" datatype)
$translator
$type ..)
$unit Unit information (just for information)

Public Methods

Method Description
create ( ) : KeyConfig
delete ( ) Deletes the key value key configuration
getById ( integer $id ) : KeyConfig
getByName ( $name, null $groupId = null ) : KeyConfig
getCacheEnabled ( ) : boolean
getCreationDate ( ) : integer
getDescription ( ) : mixed Returns the key description.
getGroup ( ) : mixed
getId ( ) : integer
getMandatory ( ) : mixed
getModificationDate ( ) : integer
getName ( ) : string
getPossibleValues ( ) : mixed
getTranslator ( ) : mixed Returns the translator id.
getType ( ) : mixed
getUnit ( ) : mixed
save ( ) Saves the key config
setCacheEnabled ( boolean $cacheEnabled )
setCreationDate ( $creationDate )
setDescription ( $description ) : KeyConfig Sets the key description
setGroup ( $group )
setId ( integer $id )
setMandatory ( mixed $mandatory )
setModificationDate ( $modificationDate )
setName ( string $name )
setPossibleValues ( $values )
setTranslator ( $translator ) Sets the translator id.
setType ( $type )
setUnit ( $unit )

Method Details

create() public static method

public static create ( ) : KeyConfig
return KeyConfig

delete() public method

Deletes the key value key configuration
public delete ( )

getById() public static method

public static getById ( integer $id ) : KeyConfig
$id integer
return KeyConfig

getByName() public static method

public static getByName ( $name, null $groupId = null ) : KeyConfig
$name
$groupId null
return KeyConfig

getCacheEnabled() public static method

public static getCacheEnabled ( ) : boolean
return boolean

getCreationDate() public method

public getCreationDate ( ) : integer
return integer

getDescription() public method

Returns the key description.
public getDescription ( ) : mixed
return mixed

getGroup() public method

public getGroup ( ) : mixed
return mixed

getId() public method

public getId ( ) : integer
return integer

getMandatory() public method

public getMandatory ( ) : mixed
return mixed

getModificationDate() public method

public getModificationDate ( ) : integer
return integer

getName() public method

public getName ( ) : string
return string

getPossibleValues() public method

public getPossibleValues ( ) : mixed
return mixed

getTranslator() public method

Returns the translator id.
public getTranslator ( ) : mixed
return mixed

getType() public method

public getType ( ) : mixed
return mixed

getUnit() public method

public getUnit ( ) : mixed
return mixed

save() public method

Saves the key config
public save ( )

setCacheEnabled() public static method

public static setCacheEnabled ( boolean $cacheEnabled )
$cacheEnabled boolean

setCreationDate() public method

public setCreationDate ( $creationDate )
$creationDate

setDescription() public method

Sets the key description
public setDescription ( $description ) : KeyConfig
$description
return KeyConfig

setGroup() public method

public setGroup ( $group )
$group

setId() public method

public setId ( integer $id )
$id integer

setMandatory() public method

public setMandatory ( mixed $mandatory )
$mandatory mixed

setModificationDate() public method

public setModificationDate ( $modificationDate )
$modificationDate

setName() public method

public setName ( string $name )
$name string

setPossibleValues() public method

public setPossibleValues ( $values )
$values

setTranslator() public method

Sets the translator id.
public setTranslator ( $translator )
$translator

setType() public method

public setType ( $type )
$type

setUnit() public method

public setUnit ( $unit )
$unit

Property Details

$cache public_oe static_oe property

public static array $cache
return array

$cacheEnabled public_oe static_oe property

public static bool $cacheEnabled
return boolean

$creationDate public_oe property

public int $creationDate
return integer

$description public_oe property

The key description.
public $description

$group public_oe property

The group id.
public $group

$id public_oe property

public int $id
return integer

$mandatory public_oe property

public $mandatory

$modificationDate public_oe property

public int $modificationDate
return integer

$name public_oe property

The key
public string $name
return string

$possiblevalues public_oe property

Array of possible vales ("select" datatype)
public $possiblevalues

$translator public_oe property

public $translator

$type public_oe property

..)
public $type

$unit public_oe property

Unit information (just for information)
public $unit