Class SQLDAO

Summary

abstract
File
Package hierarchy MVC\Model
Class hierarchy \SQLDAO
Implements \DAO

package
MVC
subpackage
Model
copyright
© 2005-2020 PHPBoost
license
https://www.gnu.org/licenses/gpl-3.0.html GNU/GPL-3.0
author
Loic ROUCHON horn@phpboost.com
version
PHPBoost 6.0 - last update: 2019 12 04
since
PHPBoost 3.0 - 2009 10 02
contributor
Julien BRISWALTER j1.seth@phpboost.com

Implements common access to a sql based datastore for CRUD operations on objects attached to the given <code>MappingModel</code>.

Methods

__construct()

__construct(\MappingModel $model, \DBQuerier $querier = null)

initialize the dao

Parameters

\MappingModel	$model	the model on which rely to provides services
\DBQuerier	$querier	the querier that will be used to interact with the database

Inherited from \SQLDAO

Tags

None found

save()

save(\PropertiesMapInterface $object,  $on_duplicate_update_column = '')

Saves <code>$object</code> in the table.

If the object does not exist, it is created, else, just updated

Parameters

\PropertiesMapInterface	$object	the object to save
	$on_duplicate_update_column

Inherited from \SQLDAO

Tags

None found

update()

update(array $fields, string $where = \DAO::WHERE_ALL, array $parameters = array())

Update all fields in the table to the given value if row match the where clause.

Parameters

array	$fields	keys are the fields names to update, values, their new value
string	$where	the part of the query that came just after the from
array	$parameters	the query vars to inject into the `$where`

Inherited from \SQLDAO

Tags

None found

delete()

delete(\PropertiesMapInterface $object)

Deletes <code>$object</code> from the table.

If the object does not exist, nothing is done

Parameters

\PropertiesMapInterface

$object

the object to delete

Inherited from \SQLDAO

Tags

None found

delete_all()

delete_all(string $where = \DAO::WHERE_ALL, array $parameters = array())

Deletes all object matching the where clause from the table.

Parameters

string	$where	the part of the query that came just after the from
array	$parameters	the query vars to inject into the `$where`

Inherited from \SQLDAO

Tags

None found

count()

count(string $where = \DAO::WHERE_ALL, array $parameters = array())

Count the number of object in the table matching the <code>$where</code> clause

Parameters

string	$where	the part of the query that came just after the from
array	$parameters	the query vars to inject into the `$where`

Inherited from \SQLDAO

Tags

None found

find_by_id()

find_by_id(mixed $id) : \PropertiesMapInterface

retrieves the object with the <code>$id</code> primary identifier

Parameters

mixed

$id

the object primary identifier (shoudl always be an integer)

Returns

\PropertiesMapInterface —

the objet retrieved from the table

Inherited from \SQLDAO

Tags

None found

find_all()

find_all(integer $limit = \DAO::FIND_ALL, integer $offset, array<mixed,\string[mixed]> $order_by = array()) : \QueryResultMapper

retrieves the <code>$limit</code> first objects from the <code>$offset</code> one.

If $order_by is specified, objects will be sorted in the $way way

Parameters

integer	$limit	the maximum number of objets to retrieve
integer	$offset	the offset from which retrieves objects
array<mixed,\string[mixed]>	$order_by	the column(s) on which sort will be done. This parameter is an array with nested associative subarrays for each column: `array(array('column' => $column1, 'way' => $way1), ...)` `$column1` must be a column name or an alias and `$way` could be ascending (`SQLQuerier::ORDER_BY_ASC`) or descending (`SQLQuerier::ORDER_BY_DESC`)

Returns

\QueryResultMapper —

the objects list

Inherited from \SQLDAO

Tags

None found

find_by_criteria()

find_by_criteria(string $criteria, \string[string] $parameters = array()) : \QueryResultMapper

retrieves all the objects in the table matching the <code>$criteria</code>

Parameters

string	$criteria	the part of the query that came just after the from
\string[string]	$parameters	the query vars to inject into the `$criteria`

Returns

\QueryResultMapper —

the objects list

Inherited from \SQLDAO

Tags

None found

cache_model()

cache_model()

Inherited from \SQLDAO

Tags

None found

raw_insert()

raw_insert(\PropertiesMapInterface $object,  $on_duplicate_update_column = '') : \InjectQueryResult

Parameters

\PropertiesMapInterface	$object
	$on_duplicate_update_column

Returns

\InjectQueryResult

Inherited from \SQLDAO

Tags

None found

raw_update()

raw_update(\PropertiesMapInterface $object,  $pk_value) : \InjectQueryResult

Parameters

\PropertiesMapInterface	$object
	$pk_value

Returns

\InjectQueryResult

Inherited from \SQLDAO

Tags

None found

compute_find_by_id_query()

compute_find_by_id_query()

Inherited from \SQLDAO

Tags

None found

compute_find_by_criteria_query()

compute_find_by_criteria_query()

Inherited from \SQLDAO

Tags

None found

compute_insert_query()

compute_insert_query( $on_duplicate_update_column = '')

Parameters

$on_duplicate_update_column

Inherited from \SQLDAO

Tags

None found

compute_update_query()

compute_update_query()

Inherited from \SQLDAO

Tags

None found

add_select_columns()

add_select_columns( $fields_mapping)

Parameters

$fields_mapping

Inherited from \SQLDAO

Tags

None found

compute_joins()

compute_joins()

Inherited from \SQLDAO

Tags

None found

Properties

$querier

$querier : \DBQuerier

\DBQuerier — the sql querier that will interact with the database

Tags

None found

$model

$model : \MappingModel

\MappingModel — the model on which services are based

Tags

None found

$table

$table : string

string — the name of the table in which objects will be stored

Tags

None found

$pk_db_field

$pk_db_field : string

string — the primary key database field name (prefixed by the table name)

Tags

None found

$pk_property

$pk_property : string

string — the primary key property

Tags

None found

$pk_getter

$pk_getter : string

string — the primary key getter method name

Tags

None found

$pk_setter

$pk_setter : string

string — the primary key setter method name

Tags

None found

$fields_mapping

$fields_mapping : \string[string]

\string[string] — => $db_field_name

Tags

None found

$delete_query

$delete_query : string

string — the delete prepared query

Tags

None found

$insert_query

$insert_query : string

string — the insert prepared query

Tags

None found

$update_query

$update_query : string

string — the update prepared query

Tags

None found

$find_by_id_query

$find_by_id_query : string

string — the find by id prepared query

Tags

None found

$find_by_criteria_query

$find_by_criteria_query : string

string — the find by criteria prepared query

Tags

None found