SimpleORMap Class Reference

Inheritance diagram for SimpleORMap:

Collaboration diagram for SimpleORMap:

Public Member Functions
	__construct ($id=null)
	__clone ()
	getRelationOptions ($relation)
	getTableMetadata ()
	hasAutoIncrementColumn ()
	setId ($id)
	getId ()
	getNewId ()
	toArray ($only_these_fields=null)
	toArrayRecursive ($only_these_fields=null)
	getValue ($field)
	getRelationValue ($relation, $field)
	setValue ($field, $value)
	__get ($field)
	__set ($field, $value)
	__isset ($field)
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	getIterator ()
	count ()
	isField ($field)
	isAdditionalField ($field)
	isAliasField ($field)
	setData ($data, $reset=false)
	haveData ()
	isNew ()
	isDeleted ()
	setNew ($is_new)
	getWhereQuery ()
	restore ()
	store ()
	triggerChdate ()
	delete ()
	isDirty ()
	isFieldDirty ($field)
	revertValue ($field)
	getPristineValue ($field)
	initRelation ($relation)
	resetRelation ($relation)

Static Public Member Functions
static	expireTableScheme ()
static	find ($id)
static	exists ($id)
static	countBySql ($sql=1, $params=array())
static	create ($data)
static	build ($data, $is_new=true)
static	buildExisting ($data)
static	import ($data)
static	findBySQL ($sql, $params=array())
static	findByObject (SimpleORMap $object)
static	findOneBySQL ($where, $params=array())
static	findThru ($foreign_key_value, $options)
static	findEachBySQL ($callable, $sql, $params=array())
static	findMany ($pks=array(), $order='', $order_params=array())
static	findEachMany ($callable, $pks=array(), $order='', $order_params=array())
static	findAndMapBySQL ($callable, $where, $params=array())
static	findAndMapMany ($callable, $pks=array(), $order='', $order_params=array())
static	deleteBySQL ($where, $params=array())
static	toObject ($id_or_object)
static	__callStatic ($name, $arguments)

Protected Member Functions
	_getId ($field)
	_setId ($field, $value)
	_getAdditionalValueFromRelation ($field)
	_setAdditionalValueFromRelation ($field, $value)
	_getAdditionalValue ($field)
	_setAdditionalValue ($field, $value)
	parseRelationOptions ($type, $name, $options)
	getTableScheme ()
	storeRelations ($only_these=null)
	deleteRelations ()
	initializeContent ()
	applyCallbacks ($type)
	registerCallback ($types, $cb)
	unregisterCallback ($types, $cb)
	cbAutoIncrementColumn ($type)
	cbAutoKeyCreation ()
	cbNotificationMapper ($cb_type)
	setSerializedValue ($field, $value)

Static Protected Member Functions
static	configure ($config=array())
static	tableScheme ($db_table)

Protected Attributes
	$content = array()
	$content_db = array()
	$is_new = true
	$db_table = ''
	$db_fields = null
	$pk = null
	$default_values = array()
	$serialized_fields = array()
	$alias_fields = array()
	$additional_fields = array()
	$relations = array()
	$has_many = array()
	$has_one = array()
	$belongs_to = array()
	$has_and_belongs_to_many = array()
	$registered_callbacks
	$known_slots = array()
	$reserved_slots = array('value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id')
	$notification_map = array()
	$additional_data = array()

Static Protected Attributes
static	$schemes = null
static	$config = array()

Constructor & Destructor Documentation

__construct()

__construct

(

$id = null

)

constructor, give primary key of record as param to fetch corresponding record from db if available, if not preset primary key with given value. Give null to create new record

Parameters

mixed

$id

primary key of table

Here is the call graph for this function:

Member Function Documentation

__callStatic()

static __callStatic (   $name,   $arguments  )

static

interceptor for static findByColumn / findEachByColumn magic

Parameters

string	$name
array	$arguments

Exceptions

BadMethodCallException

Returns

mixed

Here is the call graph for this function:

__clone()

__clone

(

)

clean up references after cloning

__get()

__get

(

$field

)

magic method for dynamic properties

Here is the call graph for this function:

__isset()

__isset

(

$field

)

magic method for dynamic properties

__set()

__set	(		$field,
			$value
	)

magic method for dynamic properties

Here is the call graph for this function:

_getAdditionalValue()

_getAdditionalValue (   $field )

protected

Parameters

string

$field

Returns

multitype:

_getAdditionalValueFromRelation()

_getAdditionalValueFromRelation (   $field )

protected

retrieves an additional field value from relation

Parameters

string

$field

Returns

multitype:

Here is the call graph for this function:

Here is the caller graph for this function:

_getId()

_getId (   $field )

protected

returns internal used id value (multiple keys concatenated with _)

Here is the call graph for this function:

_setAdditionalValue()

_setAdditionalValue (   $field,   $value  )

protected

Parameters

string	$field
mixed	$value

Returns

multitype:

Here is the caller graph for this function:

_setAdditionalValueFromRelation()

_setAdditionalValueFromRelation (   $field,   $value  )

protected

sets additional value in field imported from relation

Parameters

string	$field
mixed	$value

Returns

multitype:

Here is the call graph for this function:

_setId()

_setId (   $field,   $value  )

protected

sets internal used id value (multiple keys concatenated with _)

Here is the call graph for this function:

applyCallbacks()

applyCallbacks (   $type )

protected

invoke registered callbacks for given type if one callback returns false the following will not be invoked

Parameters

string

$type

type of callback

Returns

bool return value from last callback

Here is the caller graph for this function:

build()

static build (   $data,   $is_new = true  )

static

build object with given data

Parameters

array	assoc array of record
bool	set object to new state

Returns

SimpleORMap

Here is the caller graph for this function:

buildExisting()

static buildExisting (   $data )

static

Here is the caller graph for this function:

cbAutoIncrementColumn()

cbAutoIncrementColumn (   $type )

protected

default callback for tables with auto_increment primary key

Parameters

string

$type

callback type

Returns

boolean

Here is the call graph for this function:

cbAutoKeyCreation()

cbAutoKeyCreation ( )

protected

default callback for tables without auto_increment

Here is the call graph for this function:

cbNotificationMapper()

cbNotificationMapper (   $cb_type )

protected

default callback used to map specific callbacks to NotificationCenter

Parameters

string

$cb_type

callback type

Returns

boolean

Here is the call graph for this function:

configure()

static configure (   $config = array() )

staticprotected

set configuration data from subclass

Parameters

array

$config

configuration data

Returns

void

count()

count

(

)

Countable

Here is the caller graph for this function:

countBySql()

static countBySql (   $sql = 1,   $params = array()  )

static

returns number of records

Parameters

string	sql clause to use on the right side of WHERE
array	params for query

Returns

number

Here is the call graph for this function:

Here is the caller graph for this function:

create()

static create (   $data )

static

creates new record with given data in db returns the new object or null

Parameters

array

assoc array of record

Returns

SimpleORMap

Here is the caller graph for this function:

delete()

delete

(

)

delete entry from database the object is cleared, but is not(!) turned to new state

Returns

int number of deleted rows

Here is the call graph for this function:

deleteBySQL()

static deleteBySQL (   $where,   $params = array()  )

static

deletes objects specified by sql clause

Parameters

string	sql clause to use on the right side of WHERE
array	parameters for query

Returns

number

Here is the caller graph for this function:

deleteRelations()

deleteRelations ( )

protected

sends a delete message to all related objects if a relation has a callback for 'on_delete' configured, the callback is invoked instead

Returns

number addition of all return values, false if none was called

Here is the call graph for this function:

Here is the caller graph for this function:

exists()

static exists (   $id )

static

returns true if given key exists in db

Parameters

string

primary key

Returns

boolean

Here is the call graph for this function:

Here is the caller graph for this function:

expireTableScheme()

static expireTableScheme ( )

static

force reload of cached table metadata

Here is the call graph for this function:

Here is the caller graph for this function:

find()

static find (   $id )

static

returns new instance for given key when found in db, else null

Parameters

string

primary key

Returns

SimpleORMap|NULL

findAndMapBySQL()

static findAndMapBySQL (   $callable,   $where,   $params = array()  )

static

passes objects for given sql through given callback and returns an array of callback return values

Parameters

callable	$callable	callback which gets the current record as param
	string	where clause of sql
	array	sql statement parameters

Returns

array return values of callback

findAndMapMany()

static findAndMapMany (   $callable,   $pks = array(),   $order = '',   $order_params = array()  )

static

passes objects for by given pks through given callback and returns an array of callback return values

Parameters

callable	$callable	callback which gets the current record as param
array	$pks	array of primary keys of called class
string	$order	order by sql

Returns

array return values of callback

Here is the call graph for this function:

Here is the caller graph for this function:

findByObject()

static findByObject ( SimpleORMap  $object )

static

Here is the call graph for this function:

findBySQL()

static findBySQL (   $sql,   $params = array()  )

static

returns array of instances of given class filtered by given sql

Parameters

string	sql clause to use on the right side of WHERE
array	parameters for query

Returns

array array of "self" objects

Here is the call graph for this function:

Here is the caller graph for this function:

findEachBySQL()

static findEachBySQL (   $callable,   $sql,   $params = array()  )

static

passes objects for given sql through given callback

Parameters

callable	$callable	callback which gets the current record as param
	string	where clause of sql
	array	sql statement parameters

Returns

integer number of found records

Here is the call graph for this function:

Here is the caller graph for this function:

findEachMany()

static findEachMany (   $callable,   $pks = array(),   $order = '',   $order_params = array()  )

static

passes objects for by given pks through given callback

Parameters

callable	$callable	callback which gets the current record as param
array	$pks	array of primary keys of called class
string	$order	order by sql

Returns

integer number of found records

Here is the call graph for this function:

Here is the caller graph for this function:

findMany()

static findMany (   $pks = array(),   $order = '',   $order_params = array()  )

static

returns array of instances of given class for by given pks

Parameters

array	array og primary keys
string	order by clause

Returns

array

Here is the call graph for this function:

Here is the caller graph for this function:

findOneBySQL()

static findOneBySQL (   $where,   $params = array()  )

static

returns one instance of given class filtered by given sql only first row of query is used

Parameters

string	sql clause to use on the right side of WHERE
array	parameters for query

Returns

SimpleORMap|NULL

Here is the caller graph for this function:

findThru()

static findThru (   $foreign_key_value,   $options  )

static

find related records for a n:m relation (has_many_and_belongs_to_many) using a combination table holding the keys

Parameters

string	value of foreign key to find related records
array	relation options from other side of relation

Returns

array of "self" objects

Here is the call graph for this function:

Here is the caller graph for this function:

getId()

getId

(

)

returns primary key, multiple keys as array

Returns

string|array current primary key, null if not set

Here is the call graph for this function:

Here is the caller graph for this function:

getIterator()

getIterator

(

)

IteratorAggregate

Here is the call graph for this function:

getNewId()

getNewId

(

)

create new unique pk as md5 hash if pk consists of multiple columns, false is returned

Returns

boolean|string

Here is the call graph for this function:

Here is the caller graph for this function:

getPristineValue()

getPristineValue

(

$field

)

returns unmodified value of given field

Parameters

string

$field

Exceptions

InvalidArgumentException

Returns

mixed

getRelationOptions()

getRelationOptions

(

$relation

)

returns array with option for given relation available options: 'type': relation type, on of 'has_many', 'belongs_to', 'has_one', 'has_and_belongs_to_many' 'class_name': name of class for related records 'foreign_key': name of column with foreign key or callback to retrieve foreign key value 'assoc_foreign_key': name of foreign key column in related class 'assoc_func': name of static method to call on related class to find related records 'assoc_func_params_func': callback to retrieve params for assoc_func 'thru_table': name of relation table for n:m relation 'thru_key': name of column holding foreign key in relation table 'thru_assoc_key': name of column holding foreign key from related class in relation table 'on_delete': contains simply 'delete' to indicate that related records should be deleted or callback to invoke before record gets deleted 'on_store': contains simply 'store' to indicate that related records should be stored or callback to invoke after record gets stored

Parameters

string

$relation

name of relation

Returns

array assoc array containing options

Here is the call graph for this function:

Here is the caller graph for this function:

getRelationValue()

getRelationValue	(		$relation,
			$field
	)

gets a value from a related object only possible, if the relation has cardinality 1 e.g. 'has_one' or 'belongs_to'

Parameters

string	$relation	name of relation
string	$field	name of column

Exceptions

InvalidArgumentException

if no relation with given name is found

Returns

mixed the value from the related object

Here is the call graph for this function:

Here is the caller graph for this function:

getTableMetadata()

getTableMetadata

(

)

returns table and columns metadata

Returns

array assoc array with columns, primary keys and name of table

getTableScheme()

getTableScheme ( )

protected

restore table metadata from db or cache

Here is the caller graph for this function:

getValue()

getValue

(

$field

)

returns value of a column

Exceptions

InvalidArgumentException	if column could not be found
BadMethodCallException	if getter for additional field could not be found

Parameters

string

$field

Returns

null|string|SimpleORMapCollection

Here is the call graph for this function:

Here is the caller graph for this function:

getWhereQuery()

getWhereQuery

(

)

returns sql clause with current table and pk

Returns

boolean|string

Here is the call graph for this function:

Here is the caller graph for this function:

hasAutoIncrementColumn()

hasAutoIncrementColumn

(

)

returns true, if table has an auto_increment column

Returns

boolean

Here is the caller graph for this function:

haveData()

haveData

(

)

check if object is empty

Returns

bool true if at least one field is not null

Here is the caller graph for this function:

import()

static import (   $data )

static

generate SimpleORMap object structure from assoc array if given array contains data of related objects in sub-arrays they are also generated. Existing records are updated, new records are created (but changes are not yet stored)

Parameters

array

$data

Returns

SimpleORMap

Here is the caller graph for this function:

initializeContent()

initializeContent ( )

protected

init internal content arrays with nulls

Exceptions

UnexpectedValueException

if there is an unmatched alias

Here is the caller graph for this function:

initRelation()

initRelation

(

$relation

)

intitalize a relationship and get related record(s)

Parameters

string

$relation

name of relation

Exceptions

InvalidArgumentException

if the relation does not exists

Returns

void

Here is the call graph for this function:

Here is the caller graph for this function:

isAdditionalField()

isAdditionalField

(

$field

)

check if given column is additional

Parameters

string

$field

Returns

boolean

isAliasField()

isAliasField

(

$field

)

check if given column is an alias

Parameters

string

$field

Returns

boolean

isDeleted()

isDeleted

(

)

check if object was deleted

Returns

boolean

Here is the call graph for this function:

isDirty()

isDirty

(

)

checks if at least one field was modified since last restore

Returns

boolean

Here is the call graph for this function:

Here is the caller graph for this function:

isField()

isField

(

$field

)

check if given column exists in table

Parameters

string

$field

Returns

boolean

Here is the caller graph for this function:

isFieldDirty()

isFieldDirty

(

$field

)

checks if given field was modified since last restore

Parameters

string

$field

Returns

boolean

Here is the caller graph for this function:

isNew()

isNew

(

)

check if object exists in database

Returns

boolean

Here is the caller graph for this function:

offsetExists()

offsetExists

(

$offset

)

ArrayAccess: Check whether the given offset exists.

offsetGet()

offsetGet

(

$offset

)

ArrayAccess: Get the value at the given offset.

Here is the call graph for this function:

offsetSet()

offsetSet	(		$offset,
			$value
	)

ArrayAccess: Set the value at the given offset.

Here is the call graph for this function:

offsetUnset()

offsetUnset

(

$offset

)

ArrayAccess: unset the value at the given offset (not applicable)

parseRelationOptions()

parseRelationOptions (   $type,   $name,   $options  )

protected

try to determine all needed options for a relationship from configured options

Parameters

string	$type
string	$name
array	$options

Exceptions

Exception

if options for thru_table could not be determined

Returns

array

Here is the caller graph for this function:

registerCallback()

registerCallback (   $types,   $cb  )

protected

register given callback for one or many possible callback types callback param could be a closure or method name of current class

Parameters

string | array	$types	types to register callback for
mixed	$cb	callback

Exceptions

InvalidArgumentException

if the callback type is not known

Returns

number of registered callbacks

Here is the call graph for this function:

Here is the caller graph for this function:

resetRelation()

resetRelation

(

$relation

)

clear data for a relationship

Parameters

string

$relation

name of relation

Exceptions

InvalidArgumentException

if teh relation does not exists

Here is the caller graph for this function:

restore()

restore

(

)

restore entry from database

Returns

boolean

Here is the call graph for this function:

Here is the caller graph for this function:

revertValue()

revertValue

(

$field

)

reverts value of given field to last restored value

Parameters

string

$field

Returns

mixed the restored value

setData()

setData	(		$data,
			$reset = false
	)

set multiple column values if second param is set, existing data in object will be discarded and dirty state is cleared, else new data overrides old data

Parameters

array	$data	assoc array
boolean	$reset	existing data in object will be discarded

Returns

number of columns changed

Here is the call graph for this function:

Here is the caller graph for this function:

setId()

setId

(

$id

)

set primary key for entry, combined keys must be passed as array

Parameters

string|array

primary key

Exceptions

InvalidArgumentException

if given key is not complete

Returns

boolean

Here is the call graph for this function:

Here is the caller graph for this function:

setNew()

setNew

(

$is_new

)

set object to new state

Parameters

boolean

$is_new

Returns

boolean

Here is the caller graph for this function:

setSerializedValue()

setSerializedValue (   $field,   $value  )

protected

default setter used to proxy serialized fields with ArrayObjects

Parameters

string	$field	column name
string	$value	value

Here is the caller graph for this function:

setValue()

setValue	(		$field,
			$value
	)

sets value of a column

Exceptions

InvalidArgumentException	if column could not be found
BadMethodCallException	if setter for additional field could not be found

Parameters

string	$field
string	$value

Returns

string

Here is the call graph for this function:

Here is the caller graph for this function:

store()

store

(

)

store entry in database

Exceptions

UnexpectedValueException

if there are forbidden NULL values

Returns

number|boolean

Here is the call graph for this function:

Here is the caller graph for this function:

storeRelations()

storeRelations (   $only_these = null )

protected

sends a store message to all initialized related objects if a relation has a callback for 'on_store' configured, the callback is instead invoked

Returns

number addition of all return values, false if none was called

Here is the call graph for this function:

Here is the caller graph for this function:

tableScheme()

static tableScheme (   $db_table )

staticprotected

fetch table metadata from db or from local cache

Parameters

string

$db_table

Returns

bool true if metadata could be fetched

Here is the call graph for this function:

toArray()

toArray

(

$only_these_fields = null

)

returns data of table row as assoc array pass array of fieldnames or ws separated string to limit fields

Parameters

mixed

$only_these_fields

limit returned fields

Returns

array

Here is the call graph for this function:

Here is the caller graph for this function:

toArrayRecursive()

toArrayRecursive

(

$only_these_fields = null

)

returns data of table row as assoc array including related records with a 'has*' relationship recurses one level without param

$only_these_fields limits output for relationships in this way: $only_these_fields = array('field_1', 'field_2', 'relation1', 'relation2' => array('rel2_f1', 'rel2_f2', 'rel2_rel11' => array( rel2_rel1_f1) ) ) Here all fields of relation1 will be returned.

Parameters

mixed

$only_these_fields

limit returned fields

Returns

array

Here is the call graph for this function:

toObject()

static toObject (   $id_or_object )

static

returns object of given class for given id or null the param could be a string, an assoc array containing primary key field or an already matching object. In all these cases an object is returned

Parameters

mixed

id as string, object or assoc array

Returns

NULL|object

Here is the call graph for this function:

Here is the caller graph for this function:

triggerChdate()

triggerChdate

(

)

set chdate column to current timestamp

Returns

boolean

Here is the call graph for this function:

Here is the caller graph for this function:

unregisterCallback()

unregisterCallback (   $types,   $cb  )

protected

unregister given callback for one or many possible callback types

Parameters

string | array	$types	types to unregister callback for
mixed	$cb

Exceptions

InvalidArgumentException

if the callback type is not known

Returns

number of unregistered callbacks

Here is the call graph for this function:

Field Documentation

$additional_data

array $additional_data = array()

protected

assoc array for storing values for additional fields

$additional_fields

array $additional_fields = array()

protected

additional computed fields name => callable

$alias_fields

array $alias_fields = array()

protected

aliases for columns alias => column

$belongs_to

array $belongs_to = array()

protected

n:1 relations

$config

array $config = array()

staticprotected

configuration data for subclasses

See also

self::configure()

$content

array $content = array()

protected

table row data

$content_db

array $content_db = array()

protected

table row data

$db_fields

array $db_fields = null

protected

table columns

$db_table

string $db_table = ''

protected

name of db table

$default_values

array $default_values = array()

protected

default values for columns

$has_and_belongs_to_many

array $has_and_belongs_to_many = array()

protected

n:m relations

$has_many

array $has_many = array()

protected

1:n relation

$has_one

array $has_one = array()

protected

1:1 relation

$is_new

boolean $is_new = true

protected

new state of entry

$known_slots

array $known_slots = array()

protected

contains an array of all used identifiers for fields (db columns + aliased columns + additional columns + relations)

$notification_map

array $notification_map = array()

protected

assoc array used to map SORM callback to NotificationCenter keys are SORM callbacks, values notifications eg. 'after_create' => 'FooDidCreate'

$pk

array $pk = null

protected

primary key columns

$registered_callbacks

array $registered_callbacks

protected

Initial value:

= array('before_create' => array(),
                                              'before_update' => array(),
                                              'before_store' => array(),
                                              'before_delete' => array(),
                                              'before_initialize' => array(),
                                              'after_create' => array(),
                                              'after_update' => array(),
                                              'after_store' => array(),
                                              'after_delete' => array(),
                                              'after_initialize' => array())

callbacks

$relations

array $relations = array()

protected

stores instantiated related objects

$reserved_slots

array $reserved_slots = array('value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id')

protected

reserved indentifiers, fields with those names must not have an explicit getXXX() method

$schemes

array $schemes = null

staticprotected

db table metadata

$serialized_fields

$serialized_fields = array()

protected

---

The documentation for this class was generated from the following file:

• lib/models/SimpleORMap.class.php