\Pop\Db\RecordEncoded

Encoded record class

Summary

Methods
Properties
Constants
setColumns()
toArray()
encodeValue()
decodeValue()
verify()
encode()
decode()
isEncodedColumn()
__set()
__get()
No public properties found
No constants found
No protected methods found
$jsonFields
$phpFields
$base64Fields
$hashFields
$encryptedFields
$hashAlgorithm
$hashOptions
$cipherMethod
$key
$iv
N/A
No private methods found
No private properties found
N/A

Properties

$jsonFields

$jsonFields : array

JSON-encoded fields

Type

array

$phpFields

$phpFields : array

PHP-serialized fields

Type

array

$base64Fields

$base64Fields : array

Base64-encoded fields

Type

array

$hashFields

$hashFields : array

Password-hashed fields

Type

array

$encryptedFields

$encryptedFields : array

Encrypted fields

Type

array

$hashAlgorithm

$hashAlgorithm : string

Hash algorithm

Type

string

$hashOptions

$hashOptions : array

Hash options

Type

array

$cipherMethod

$cipherMethod : string

Cipher method

Type

string

$key

$key : string

Encrypted field key

Type

string

$iv

$iv : string

Encrypted field IV (base64-encoded)

Type

string

Methods

setColumns()

setColumns(mixed  $columns = null) : \Pop\Db\Record\Encoded

Set all the table column values at once

Parameters

mixed $columns

Throws

\Pop\Db\Record\Exception

Returns

\Pop\Db\Record\Encoded

toArray()

toArray() : array

Get column values as array

Returns

array

encodeValue()

encodeValue(string  $key, mixed  $value) : string

Encode value

Parameters

string $key
mixed $value

Throws

\Pop\Db\Record\Exception

Returns

string

decodeValue()

decodeValue(string  $key, string  $value) : mixed

Decode value

Parameters

string $key
string $value

Throws

\Pop\Db\Record\Exception

Returns

mixed

verify()

verify(string  $key, string  $value) : boolean

Verify value against hash

Parameters

string $key
string $value

Returns

boolean

encode()

encode(array  $columns) : array

Scrub the column values and encode them

Parameters

array $columns

Returns

array

decode()

decode(array  $columns) : array

Scrub the column values and decode them

Parameters

array $columns

Returns

array

isEncodedColumn()

isEncodedColumn(string  $key) : boolean

Determine if column is an encoded column

Parameters

string $key

Returns

boolean

__set()

__set(string  $name, mixed  $value) : void

Magic method to set the property to the value of $this->rowGateway[$name]

Parameters

string $name
mixed $value

__get()

__get(string  $name) : mixed

Magic method to return the value of $this->rowGateway[$name]

Parameters

string $name

Returns

mixed