Class NormalizedJSONFieldsBehavior

Enables transparent serialization and storage of array objects in database fields as JSON strings.

CComponent

Extended by

CBehavior implements IBehavior

Extended by

CModelBehavior

Extended by

CActiveRecordBehavior

Extended by

TransformedFieldStorageBehavior

Extended by

JSONFieldsBehavior

Extended by

NormalizedJSONFieldsBehavior

Direct known subclasses

JSONFieldsDefaultValuesBehavior

Package: application\components
Author: Demitri Morgan <demitri@x2engine.com>, Derek Mueller <derek@x2engine.com>
Located at x2engine/protected/components/NormalizedJSONFieldsBehavior.php

Methods summary
`public type`	# `fields( mixed $name )` Returns an array defining the expected structure of the JSON-bearing attribute specified by $name. Returns an array defining the expected structure of the JSON-bearing attribute specified by $name. Child classes can override this method to specify default values for fields in the embedded JSON object other than null (in this class, all embedded fields within all attributes are null by default). Parameters `$name` `mixed` Returns `type`
`public type`	# `packAttribute( type $name )` Normalizes the attribute array to the structure defined in `NormalizedJSONFieldsBehavior::fields()` and then JSON-encodes it to prepare it for saving. Normalizes the attribute array to the structure defined in `NormalizedJSONFieldsBehavior::fields()` and then JSON-encodes it to prepare it for saving. Parameters `$name` `type` $name Returns `type` Overrides `JSONFieldsBehavior::packAttribute()`
`public type`	# `unpackAttribute( string $name )` JSON-decodes the value stored in the database column for the attribute, and then normalizes it to the structure defined in `NormalizedJSONFieldsBehavior::fields()` JSON-decodes the value stored in the database column for the attribute, and then normalizes it to the structure defined in `NormalizedJSONFieldsBehavior::fields()` Parameters `$name` `string` $name The attribute to be unpacked Returns `type` Overrides `JSONFieldsBehavior::unpackAttribute()`

Methods inherited from TransformedFieldStorageBehavior
`afterFind(), afterSave(), beforeSave(), packAll(), unpackAll()`

Methods inherited from CActiveRecordBehavior
`afterDelete(), beforeCount(), beforeDelete(), beforeFind(), events()`

Methods inherited from CModelBehavior
`afterConstruct(), afterValidate(), beforeValidate()`

Methods inherited from CBehavior
`attach(), detach(), getEnabled(), getOwner(), setEnabled()`

Methods inherited from CComponent
`__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()`

Properties summary
`protected mixed`	`$_fields`		#
`protected type`	`$hasOptions`	`true`	# If true, specifies that the array `TransformedFieldStorageBehavior::$transformAttributes` has keys that refer to the attribute names and values referring to options for each attribute. Otherwise, it is a simple array containing attribute names. If true, specifies that the array `TransformedFieldStorageBehavior::$transformAttributes` has keys that refer to the attribute names and values referring to options for each attribute. Otherwise, it is a simple array containing attribute names.
`public boolean`	`$maintainCurrentFieldsOrder`	`false`	# If true, when setting the JSON field, the order of the current field values will be maintained. If true, when setting the JSON field, the order of the current field values will be maintained. Param `boolean`

Properties inherited from TransformedFieldStorageBehavior
`$transformAttributes`

Magic properties inherited from CActiveRecordBehavior
`$owner`

Magic properties inherited from CBehavior
`$enabled`