Class EncryptedFieldsBehavior

Behavior class for storing encrypted values in database fields.

CComponent

Extended by

CBehavior implements IBehavior

Extended by

CModelBehavior

Extended by

CActiveRecordBehavior

Extended by

TransformedFieldStorageBehavior

Extended by

EncryptedFieldsBehavior

Direct known subclasses

JSONEmbeddedModelFieldsBehavior

Package: application\components
Author: Demitri Morgan <demitri@x2engine.com>
Located at x2engine/protected/components/EncryptedFieldsBehavior.php

Methods summary
`public static`	# `setup( type $keyFile, type $IVFile )` Creates a new encryption utility object for use with this behavior. Creates a new encryption utility object for use with this behavior. Parameters `$keyFile` `type` $keyFile `$IVFile` `type` $IVFile
`public static`	# `setupUnsafe( )`
`public`	# `attach( CComponent $owner )` Checks for whether a working encryption object is available before attaching. Checks for whether a working encryption object is available before attaching. Parameters `$owner` `CComponent` $owner the component that this behavior is to be attached to. Throws `Exception` Overrides `CBehavior::attach()`
`public string`	# `packAttribute( string $name )` Encrypts the attribute for database storage. Encrypts the attribute for database storage. Parameters `$name` `string` $name Attribute to be transformed Returns `string`
`public string`	# `unpackAttribute( string $name )` Decrypts the attribute for setting/use in the interface. Decrypts the attribute for setting/use in the interface. Parameters `$name` `string` $name Attribute to be transformed Returns `string`

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
`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 static boolean`	`$encrypt`	`true`	# If true, the stored value will be encrypted. If true, the stored value will be encrypted.
`public static EncryptUtil`	`$encryption`		# Encryption utility object Encryption utility object
`public boolean`	`$checkObject`	`true`	# If true, throws an exception if no object has been instantiated. If true, throws an exception if no object has been instantiated. This is to prevent generating a new key for every new usage (which would render useless any and all encrypted data; it could not be decrypted if that were the case).

Properties inherited from TransformedFieldStorageBehavior
`$hasOptions, $transformAttributes`

Magic properties inherited from CActiveRecordBehavior
`$owner`

Magic properties inherited from CBehavior
`$enabled`