\Pop\Db\RecordEncoded

__construct()

__construct() 

Constructor

Instantiate the database record object

Optional parameters are an array of column values, db adapter, or a table name

Throws

\Pop\Db\Exception

hasDb()

hasDb() : boolean

Check for a DB adapter

Returns

setDb()

setDb(\Pop\Db\Adapter\AbstractAdapter  $db, string  $prefix = null, boolean  $isDefault = false) : void

Set DB adapter

Parameters

setDefaultDb()

setDefaultDb(\Pop\Db\Adapter\AbstractAdapter  $db) : void

Set DB adapter

Parameters

getDb()

getDb() : \Pop\Db\Adapter\AbstractAdapter

Get DB adapter

Returns

db()

db() : \Pop\Db\Adapter\AbstractAdapter

Get DB adapter (alias)

Returns

getSql()

getSql() : \Pop\Db\Sql

Get SQL builder

Returns

sql()

sql() : \Pop\Db\Sql

Get SQL builder (alias)

Returns

table()

table() : string

Get table name

Returns

findById()

findById(mixed  $id) : static|\Pop\Db\Record\Collection

Find by ID static method

Parameters

Returns

findOne()

findOne(array  $columns = null, array  $options = null) : static

Find one static method

Parameters

Returns

findOneOrCreate()

findOneOrCreate(array  $columns = null, array  $options = null) : static

Find one or create static method

Parameters

Returns

findLatest()

findLatest(string  $by = null, array  $columns = null, array  $options = null) : static

Find latest static method

Parameters

Returns

findBy()

findBy(array  $columns = null, array  $options = null, string  $resultAs = \Pop\Db\Record::AS_RECORD) : \Pop\Db\Record\Collection

Find by static method

Parameters

Returns

findByOrCreate()

findByOrCreate(array  $columns = null, array  $options = null, string  $resultAs = \Pop\Db\Record::AS_RECORD) : \Pop\Db\Record\Collection|\Pop\Db\Record

Find by or create static method

Parameters

Returns

findAll()

findAll(array  $options = null, string  $resultAs = \Pop\Db\Record::AS_RECORD) : \Pop\Db\Record\Collection

Find all static method

Parameters

Returns

execute()

execute(mixed  $sql, array  $params, string  $resultAs = \Pop\Db\Record::AS_RECORD) : \Pop\Db\Record\Collection

Static method to execute a custom prepared SQL statement.

Parameters

Returns

query()

query(mixed  $sql, string  $resultAs = \Pop\Db\Record::AS_RECORD) : \Pop\Db\Record\Collection

Static method to execute a custom SQL query.

Parameters

Returns

with()

with(mixed  $name, array  $options = null) : static

With a 1:many relationship (eager-loading)

Parameters

Returns

getTotal()

getTotal(array  $columns = null) : integer

Static method to get the total count of a set from the DB table

Parameters

Returns

getTableInfo()

getTableInfo() : array

Static method to get the total count of a set from the DB table

Returns

getById()

getById(mixed  $id) : static|\Pop\Db\Record\Collection

Get by ID method

Parameters

Returns

getOneBy()

getOneBy(array  $columns = null, array  $options = null) : static

Get one method

Parameters

Returns

getBy()

getBy(array  $columns = null, array  $options = null, string  $resultAs = \Pop\Db\Record::AS_RECORD) : \Pop\Db\Record\Collection

Get by method

Parameters

Returns

getAll()

getAll(array  $options = null, string  $resultAs = \Pop\Db\Record::AS_RECORD) : \Pop\Db\Record\Collection

Get all method

Parameters

Returns

hasOne()

hasOne(string  $foreignTable, string  $foreignKey, array  $options = null, boolean  $eager = false) : \Pop\Db\Record|\Pop\Db\Record\Relationships\HasOne

Has one relationship

Parameters

Returns

hasOneOf()

hasOneOf(string  $foreignTable, string  $foreignKey, array  $options = null, boolean  $eager = false) : \Pop\Db\Record|\Pop\Db\Record\Relationships\HasOne

Has one of relationship

Parameters

Returns

hasMany()

hasMany(string  $foreignTable, string  $foreignKey, array  $options = null, boolean  $eager = false) : \Pop\Db\Record\Collection|\Pop\Db\Record\Relationships\HasMany

Has many relationship

Parameters

Returns

belongsTo()

belongsTo(string  $foreignTable, string  $foreignKey, array  $options = null, boolean  $eager = false) : \Pop\Db\Record|\Pop\Db\Record\Relationships\BelongsTo

Belongs to relationship

Parameters

Returns

increment()

increment(string  $column, integer  $amount = 1) : void

Increment the record column and save

Parameters

decrement()

decrement(string  $column, integer  $amount = 1) : void

Decrement the record column and save

Parameters

replicate()

replicate(array  $replace = array()) : static

Replicate the record

Parameters

Returns

isDirty()

isDirty() : boolean

Check if row is dirty

Returns

getDirty()

getDirty() : array

Get row's dirty columns

Returns

save()

save(array  $columns = null) : void

Save the record

Parameters

delete()

delete(array  $columns = null) : void

Delete the record

Parameters

__callStatic()

__callStatic(string  $name, array  $arguments) : mixed

Call static method

Parameters

Returns

setTable()

setTable(string  $table) : \Pop\Db\Record\AbstractRecord

Set the table

Parameters

Returns

setTableFromClassName()

setTableFromClassName(string  $class) : mixed

Set the table from a class name

Parameters

Returns

setPrefix()

setPrefix(string  $prefix) : \Pop\Db\Record\AbstractRecord

Set the table prefix

Parameters

Returns

setPrimaryKeys()

setPrimaryKeys(array  $keys) : \Pop\Db\Record\AbstractRecord

Set the primary keys

Parameters

Returns

addWith()

addWith(string  $name, array  $options = null) : \Pop\Db\Record\AbstractRecord

Set with relationships

Parameters

Returns

hasWith()

hasWith(string  $name) : boolean

Determine if there is specific with relationship

Parameters

Returns

hasWiths()

hasWiths() : boolean

Determine if there are with relationships

Returns

getWiths()

getWiths() : array

Get with relationships

Returns

getWithRelationships()

getWithRelationships(boolean  $eager = true) : \Pop\Db\Record\AbstractRecord

Get with relationships

Parameters

Returns

setRelationship()

setRelationship(string  $name, mixed  $relationship) : \Pop\Db\Record\AbstractRecord

Set relationship

Parameters

Returns

getRelationship()

getRelationship(string  $name) : mixed

Get relationship

Parameters

Returns

hasRelationship()

hasRelationship(string  $name) : boolean

Has relationship

Parameters

Returns

getRelationships()

getRelationships() : array

Get relationships

Returns

getTable()

getTable() : string

Get the table

Returns

getFullTable()

getFullTable() : string

Get the full table name (prefix + table)

Returns

getPrefix()

getPrefix() : string

Get the table prefix

Returns

getPrimaryKeys()

getPrimaryKeys() : array

Get the primary keys

Returns

getPrimaryValues()

getPrimaryValues() : array

Get the primary values

Returns

getRowGateway()

getRowGateway() : \Pop\Db\Gateway\Row

Get the row gateway

Returns

getTableGateway()

getTableGateway() : \Pop\Db\Gateway\Table

Get the table gateway

Returns

toArray()

toArray() : array

Get column values as array

Returns

toArrayObject()

toArrayObject() : \ArrayObject

Get column values as array object

Returns

count()

count() : integer

Method to get count of fields in row gateway

Returns

getIterator()

getIterator() : \ArrayIterator

Method to iterate over the columns

Returns

getRows()

getRows() : \Pop\Db\Record\Collection

Get the rows

Returns

rows()

rows() : \Pop\Db\Record\Collection

Get the rows (alias method)

Returns

countRows()

countRows() : integer

Get the count of rows returned in the result

Returns

hasRows()

hasRows() : boolean

Determine if the result has rows

Returns

setColumns()

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

Set all the table column values at once

Parameters

Throws

\Pop\Db\Record\Exception

Returns

setRows()

setRows(array  $rows = null, string  $resultAs = \Pop\Db\Record\AbstractRecord::AS_RECORD) : \Pop\Db\Record\AbstractRecord

Set all the table rows at once

Parameters

Returns

processRows()

processRows(array  $rows, string  $resultAs = \Pop\Db\Record\AbstractRecord::AS_RECORD) : array

Process table rows

Parameters

Returns

processRow()

processRow(array  $row, string  $resultAs = \Pop\Db\Record\AbstractRecord::AS_RECORD) : mixed

Process a table row

Parameters

Returns

__set()

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

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

Parameters

__get()

__get(string  $name) : mixed

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

Parameters

Returns

__isset()

__isset(string  $name) : boolean

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

Parameters

Returns

__unset()

__unset(string  $name) : void

Magic method to unset $this->rowGateway[$name]

Parameters

offsetExists()

offsetExists(mixed  $offset) : boolean

ArrayAccess offsetExists

Parameters

Returns

offsetGet()

offsetGet(mixed  $offset) : mixed

ArrayAccess offsetGet

Parameters

Returns

offsetSet()

offsetSet(mixed  $offset, mixed  $value) : void

ArrayAccess offsetSet

Parameters

offsetUnset()

offsetUnset(mixed  $offset) : void

ArrayAccess offsetUnset

Parameters

encodeValue()

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

Encode value

Parameters

Throws

\Pop\Db\Record\Exception

Returns

decodeValue()

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

Decode value

Parameters

Throws

\Pop\Db\Record\Exception

Returns

verify()

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

Verify value against hash

Parameters

Returns

encode()

encode(array  $columns) : array

Scrub the column values and encode them

Parameters

Returns

decode()

decode(array  $columns) : array

Scrub the column values and decode them

Parameters

Returns

isEncodedColumn()

isEncodedColumn(string  $key) : boolean

Determine if column is an encoded column

Parameters

Returns