PHP Class Pimcore\Model\Object\Data\KeyValue

Inheritance: extends Pimcore\Model\AbstractModel

Afficher le fichier Open project: pimcore/pimcore Class Usage Examples

Méthodes publiques

Свойство	Type	Description
$arr	array
$class	Pimcore\Model\Object\ClassDefinition
$objectId	integer

Protected Properties

Свойство	Type	Description
$multivalent		Whether multivalent values are allowed.

Méthodes publiques

Méthode	Description
__call ( $name, $arguments ) : array \| mixed \| null \| void
__construct ( )
__toString ( ) : string
deleteEntryByKeyId ( $keyId )	deletes an entry with the given keyId if the entry exists
getClass ( ) : ClassDefinition
getEntryByKeyId ( $keyId ) : array \| null
getInternalProperties ( ) : array
getKeyId ( $propName, null $groupId = null ) : integer
getKeyvaluepairsByGroup ( $groupName ) : array
getMultivalent ( )
getObjectId ( ) : integer
getProperties ( boolean $forEditMode = false ) : array
getProperty ( $propName, null $groupId = null ) : array \| null
setClass ( ClassDefinition $class )
setMultivalent ( $multivalent )
setObjectId ( $objectId )
setProperties ( $arr )
setProperty ( $propName, $value )
setPropertyWithId ( $keyId, $value, boolean $fromGrid = false ) : KeyValue	Sets the value of the property with the given id
setValueWithKeyId ( $keyId, $value )

Private Methods

Méthode	Description
getTranslatedValue ( $keyId, $value ) : string

Method Details

__call() public méthode

public __call ( $name, $arguments ) : array \| mixed \| null \| void
$name
$arguments
Résultat	array \| mixed \| null \| void

__construct() public méthode

public __construct ( )

__toString() public méthode

public __toString ( ) : string
Résultat	string

deleteEntryByKeyId() public méthode

deletes an entry with the given keyId if the entry exists

public deleteEntryByKeyId ( $keyId )
$keyId

getClass() public méthode

public getClass ( ) : ClassDefinition
Résultat	Pimcore\Model\Object\ClassDefinition

getEntryByKeyId() public méthode

public getEntryByKeyId ( $keyId ) : array \| null
$keyId
Résultat	array \| null

getInternalProperties() public méthode

public getInternalProperties ( ) : array
Résultat	array

getKeyId() public méthode

public getKeyId ( $propName, null $groupId = null ) : integer
$propName
$groupId	null
Résultat	integer

getKeyvaluepairsByGroup() public méthode

public getKeyvaluepairsByGroup ( $groupName ) : array
$groupName
Résultat	array

getMultivalent() public méthode

public getMultivalent ( )

getObjectId() public méthode

public getObjectId ( ) : integer
Résultat	integer

getProperties() public méthode

public getProperties ( boolean $forEditMode = false ) : array
$forEditMode	boolean
Résultat	array

getProperty() public méthode

public getProperty ( $propName, null $groupId = null ) : array \| null
$propName
$groupId	null
Résultat	array \| null

setClass() public méthode

public setClass ( ClassDefinition $class )
$class	Pimcore\Model\Object\ClassDefinition

setMultivalent() public méthode

public setMultivalent ( $multivalent )
$multivalent

setObjectId() public méthode

public setObjectId ( $objectId )
$objectId

setProperties() public méthode

public setProperties ( $arr )
$arr

setProperty() public méthode

public setProperty ( $propName, $value )
$propName
$value

setPropertyWithId() public méthode

Sets the value of the property with the given id

public setPropertyWithId ( $keyId, $value, boolean $fromGrid = false ) : KeyValue
$keyId		the id of the key
$value		the value
$fromGrid	boolean	if true then the data is coming from the grid, we have to check if the value needs to be translated
Résultat	KeyValue	the resulting object

setValueWithKeyId() public méthode

public setValueWithKeyId ( $keyId, $value )
$keyId
$value

Property Details

$arr public_oe property

public array $arr
Résultat	array

$class public_oe property

public ClassDefinition,Pimcore\Model\Object $class
Résultat	Pimcore\Model\Object\ClassDefinition

$multivalent protected_oe property

Whether multivalent values are allowed.

protected $multivalent

$objectId public_oe property

public int $objectId
Résultat	integer