GroupedPivotQuery Class Reference

Performs a pivot query against the database, returning an array of arrays of PivotItems, grouped by a particular field. More...

Inheritance diagram for GroupedPivotQuery:

Collaboration diagram for GroupedPivotQuery:

Public Member Functions
	__construct ($base, $baseConstraint="", $groupBy="")
	groupBy ($groupBy)
	Set the field by which results should be grouped. More...
	execute ()
Public Member Functions inherited from AbstractPivotQuery
	__construct ($base, $baseConstraint="")
	Constructs a new AbstractPivotQuery. More...
	pivot ($pivotClass, $pivotConstraint, $pivotFunction="SUM")
	Adds the pivot to the query. More...
	range ($rangeClass, $rangeConstraint)
	Adds the range to the query. More...
	field ($field, $alias="", $type=String)
	Adds a fixed field to the output object. More...
	pivotField ($format, $value, $alias=null, $expression="SUM", $type=Number)
	Adds a pivot field format to the output object. More...
	createPivotItem ()
	Creates an empty PivotItem, configured with fields and field aliases based on the pivot and range. More...
	additionalFields ()
	Register additional fields from the base to be included in the PivotItem output. More...
Public Member Functions inherited from AbstractQuery
	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...

Static Public Member Functions
static	create ($class, $constraints="", $groupBy="")
	Create a new GroupedPivotQuery. More...

Public Attributes
	$groupBy
Public Attributes inherited from AbstractPivotQuery
	$baseClass
	$baseConstraint
	$baseItem
	$rangeClass
	$rangeConstraint
	$pivotClass
	$pivotConstraint
	$pivotItem
	$fields
	$fieldAliases
	$additionalFields = array()
	$groupByFields = array()
	$orderBy
	$totalField = null
Public Attributes inherited from AbstractQuery
	$class
	$constraints
	$filter
	$params

Additional Inherited Members
Protected Member Functions inherited from AbstractPivotQuery
	generateFieldExpressions ()
	Builds the expressions for the pivot query. More...
	generateQuery ()
	Generates SQL for the full pivot query, with grouping. More...

Detailed Description

Performs a pivot query against the database, returning an array of arrays of PivotItems, grouped by a particular field.

If the indexing field has unique values, indexedQuery() might be more appropriate.

Author

andy

Definition at line 486 of file pivot.inc.

Constructor & Destructor Documentation

__construct()

GroupedPivotQuery::__construct	(		$base,
			$baseConstraint = "",
			$groupBy = ""
	)

Definition at line 490 of file pivot.inc.

     {
          parent::__construct($base, $baseConstraint);
          $this->groupBy = $groupBy;
     }

Member Function Documentation

create()

static GroupedPivotQuery::create (   $class,   $constraints = "",   $groupBy = ""  )

static

Create a new GroupedPivotQuery.

Parameters

string	$class	the base class for the query
string	$constraints	the base constraint for the query
string	$groupBy	the field by which results should be grouped

Returns

GroupedPivotQuery

Definition at line 553 of file pivot.inc.

     {
          return new GroupedPivotQuery($class, $constraints, $groupBy);
     }

execute()

GroupedPivotQuery::execute

(

)

See also

AbstractQuery::execute()

Reimplemented from AbstractQuery.

Definition at line 510 of file pivot.inc.

     {
          $query = $this->generateQuery();
          
          trace($query, 3);
 
          $items = array();
 
          $field = $this->groupBy;
 
          try
          {
               $db = ConnectionManager::getConnection();
                    
               $result = $db->prepare($query);
               $result->execute($this->params);
 
               while($line = $result->fetch())
               {
                    $item = $this->createPivotItem();
                    $item->populate($line);
                    $items[$item->$field][] = $item;
               }
 
               unset($result);
          }
          catch(PDOException $e)
          {
               $err = "GroupedPivotQuery failed - " . $e->getMessage();
               trace($err, 2);
               throw new DataItemException($err);
          }
 
          return $items;
     }

groupBy()

GroupedPivotQuery::groupBy

(

$groupBy

)

Set the field by which results should be grouped.

Parameters

string

$groupBy

the field by which results should be grouped

Returns

GroupedPivotQuery

Definition at line 501 of file pivot.inc.

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

Member Data Documentation

$groupBy

GroupedPivotQuery::$groupBy

Definition at line 488 of file pivot.inc.

---

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

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