ORMDriverYAML Class Reference

An ORM driver which is backed by YAML. More...

Inheritance diagram for ORMDriverYAML:
ORMDriverNative ORMDriverInterface

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.
 delete ($table, $structure, $filter)
 Delete objects matching a given filter from a table.
 update ($table, $structure, $filter, $values)
 Update one or more objects in a table matching a filter with a given set of values.
 insert_single ($table, $structure, $values)
 Insert an object into a specified table.

Detailed Description

An ORM driver which is backed by YAML.


Member Function Documentation

ORMDriverYAML::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

Reimplemented from ORMDriverNative.

ORMDriverYAML::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

Reimplemented from ORMDriverNative.

ORMDriverYAML::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

If the orm structure has only one key and that key is an integer in the structure, find the max of that key and increment by one.

Reimplemented from ORMDriverNative.

ORMDriverYAML::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

Reimplemented from ORMDriverNative.

ORMDriverYAML::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

Reimplemented from ORMDriverNative.


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