AbstractQuery Class Reference

Inheritance diagram for AbstractQuery:

Public Member Functions
	__construct ($class, $constraints="")
	constraints ($constraints)
	Sets the constraint clause for the Query. More...
	filter ($filter)
	Sets a filter to constrain the fields retrieved when the query is executed. More...
	params ($params)
	Sets the bound parameters array. More...
	bind ()
	Binds placeholders to parameter values. More...
	execute ()

Public Attributes
	$class
	$constraints
	$filter
	$params

Detailed Description

Definition at line 37 of file query.inc.

Constructor & Destructor Documentation

__construct()

AbstractQuery::__construct	(		$class,
			$constraints = ""
	)

Reimplemented in Query, JSONQuery, IteratedQuery, PivotQuery, and AbstractPivotQuery.

Definition at line 44 of file query.inc.

     {
          $this->class = $class;
          $this->constraints = $this->massageSQL($constraints);
          
          $this->filter = null;
          $this->params = array();
     }

Member Function Documentation

bind()

AbstractQuery::bind

(

)

Binds placeholders to parameter values.

Returns

Query reference to the Query object, to allow for call chaining.

Definition at line 101 of file query.inc.

     {
          $num = func_num_args();
          for($i = 0; $i < $num; $i += 2)
          {
               $this->params[func_get_arg($i)] = $this->massageSQL(func_get_arg($i + 1));
          }
          
          return $this;
     }

constraints()

AbstractQuery::constraints

(

$constraints

)

Sets the constraint clause for the Query.

Parameters

string

$constraints

the constraint clause;

Returns

Query reference to the Query object, to allow for call chaining.

Definition at line 68 of file query.inc.

     {
          $this->constraints = $this->massageSQL($constraints);
          return $this;
     }

execute()

AbstractQuery::execute ( )

abstract

Reimplemented in Query, GroupedPivotQuery, IndexedPivotQuery, PivotQuery, JSONQuery, IteratedQuery, IndexedQuery, and GroupedQuery.

filter()

AbstractQuery::filter

(

$filter

)

Sets a filter to constrain the fields retrieved when the query is executed.

Parameters

$filter

Object the InclusionFilter or ExclusionFilter to use

Returns

Query reference to the Query object, to allow for call chaining.

Definition at line 79 of file query.inc.

     {
          $this->filter = $filter;
          return $this;
     }

params()

AbstractQuery::params

(

$params

)

Sets the bound parameters array.

Generally it is more convenient to call bind() but this method can be useful if the query is being constructed programmatically.

Parameters

$params

the array of placeholders and parameters to bind

Returns

Query reference to the Query object, to allow for call chaining.

Definition at line 91 of file query.inc.

     {
          $this->params = $params;
          return $this;
     }

Member Data Documentation

$class

AbstractQuery::$class

Definition at line 39 of file query.inc.

$constraints

AbstractQuery::$constraints

Definition at line 40 of file query.inc.

$filter

AbstractQuery::$filter

Definition at line 41 of file query.inc.

$params

AbstractQuery::$params

Definition at line 42 of file query.inc.

---

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

• C:/code/cms.sonjara.com/framework/query.inc