ORMDriverSQL Class Reference

An ORM driver which is backed by a generic (MySQL-like) SQL database. More...

Inheritance diagram for ORMDriverSQL:
ORMDriverInterface ORMDriverMySQL ORMDriverPgSQL

Public Member Functions

 count ($table, $structure, $filter)
 Get the number of objects in a table that matches a given filter.
 it ($table, $structure, $filter, $columns, $order=array(), $limit=false, $offset=false)
 Get the objects in a table that matches a given filter.
 stats ($table, $structure, $filter, $intersections)
 Returns an arbitrary (driver-specific) status summary of this table.
 update ($table, $structure, $filter, $values)
 Update one or more objects in a table matching a filter with a given set of values.
 delete ($table, $structure, $filter)
 Delete objects matching a given filter from a table.
 insert_single ($table, $structure, $values)
 Insert an object into a specified table.

Protected Attributes

 $sql_builder_visitor_class_name = 'LivestatusSQLBuilderVisitor'
 Which visitor should sql_where() use?

Detailed Description

An ORM driver which is backed by a generic (MySQL-like) SQL database.


Member Function Documentation

ORMDriverSQL::count ( table,
structure,
filter 
)

Get the number of objects in a table that matches a given filter.

Parameters:
$table string The table to perform the count on
$structure array An associative array describing this table
$filter LivestatusFilterBase The filter
Returns:
int The number of objects in $table matching $filter

Implements ORMDriverInterface.

ORMDriverSQL::delete ( table,
structure,
filter 
)

Delete objects matching a given filter from a table.

Parameters:
$table string The table to delete from
$structure array An associative array describing this table
$filter LivestatusFilterBase The filter
Returns:
void

Implements ORMDriverInterface.

ORMDriverSQL::insert_single ( table,
structure,
values 
)

Insert an object into a specified table.

Parameters:
$table string The table to insert the object into
$structure array An associative array describing this table
$values array A mapping from fields to values
Returns:
mixed An identifier for the inserted object, which should be unique to this driver/table combination

Implements ORMDriverInterface.

ORMDriverSQL::it ( table,
structure,
filter,
columns,
order = array(),
limit = false,
offset = false 
)

Get the objects in a table that matches a given filter.

Parameters:
$table string The table to perform the query on
$structure array An associative array describing this table
$filter LivestatusFilterBase The filter
$columns array An array of strings denoting the columns to expose in the iterator
$order array An array of strings denoting the columns to order by in the format "<column [asc|desc]>"
$limit int Upper bound on the number of objects in the returned iterator
$offset int Specifies the offset
Returns:
Iterator Iterator over the objects in $table matching $filter

Implements ORMDriverInterface.

ORMDriverSQL::stats ( table,
structure,
filter,
intersections 
)

Returns an arbitrary (driver-specific) status summary of this table.

Parameters:
$table string The table
$structure array An associative array describing this table
$filter LivestatusFilterBase The filter
$intersections mixed
Todo:
document $intersections if you know what it does

Implements ORMDriverInterface.

ORMDriverSQL::update ( table,
structure,
filter,
values 
)

Update one or more objects in a table matching a filter with a given set of values.

Parameters:
$table string The table to update
$structure array An associative array describing this table
$filter LivestatusFilterBase The filter
$values array A mapping from fields to values
Returns:
void

To remove the possibility of ambiguity when the table is joined, add the updated table's name before the key

Implements ORMDriverInterface.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables

Generated on 19 Dec 2018 for ninja by  doxygen 1.6.1