IndexedPivotQuery Class Reference

Run a pivot query and return the results indexed by a selected field. More...

Inheritance diagram for IndexedPivotQuery:

Collaboration diagram for IndexedPivotQuery:

Public Member Functions
	__construct ($base, $baseConstraint="", $indexBy="")
	indexBy ($indexBy)
	Sets the field by which the results should be indexed. 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 ($base, $baseConstraint="", $indexBy="")
	Creates a new IndexedPivotQuery instance. More...

Public Attributes
	$indexBy
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

Run a pivot query and return the results indexed by a selected field.

Author

andy

Definition at line 394 of file pivot.inc.

Constructor & Destructor Documentation

__construct()

IndexedPivotQuery::__construct	(		$base,
			$baseConstraint = "",
			$indexBy = ""
	)

Definition at line 398 of file pivot.inc.

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

Member Function Documentation

create()

static IndexedPivotQuery::create (   $base,   $baseConstraint = "",   $indexBy = ""  )

static

Creates a new IndexedPivotQuery instance.

Parameters

string	$base	class name for the base objects
string	$baseConstraint	query constraint for the base objects
string	$indexBy	the field by which the results should be indexed.

Returns

IndexedPivotQuery

Definition at line 473 of file pivot.inc.

     {
          return new IndexedPivotQuery($base, $baseConstraint, $indexBy);
     }

execute()

IndexedPivotQuery::execute

(

)

See also

AbstractQuery::execute()

Reimplemented from AbstractQuery.

Definition at line 418 of file pivot.inc.

     {
          $query = $this->generateQuery();
          
          trace("$query", 3);
          $items = array();
          $field = $this->indexBy;
 
          try
          {
               $db = ConnectionManager::getConnection();
 
               $result = $db->prepare($query);
               $result->execute($this->params);
                    
               while($line = $result->fetch())
               {
                    $item = $this->createPivotItem();
                    $item->populate($line);
                    $val = $item->get($field);
 
                    if (array_key_exists($val, $items))
                    {
                         // Implicitly promote to array if there is a collision
                         if (!is_array($items[$val]))
                         {
                              $items[$val] = array($items[$val]);
                         }
                         $items[$val][] = $item;
                    }
                    else
                    {
                         $items[$val] = $item;
                    }
               }
                    
               unset($result);
          }
          catch(PDOException $e)
          {
               $err = "IndexedPivotQuery failed - " . $e->getMessage();
               trace($err, 2);
               throw new DataItemException($err);
          }
 
          return $items;
     }

indexBy()

IndexedPivotQuery::indexBy

(

$indexBy

)

Sets the field by which the results should be indexed.

Parameters

string

$indexBy

the field by which the results should be indexed.

Returns

IndexedPivotQuery

Definition at line 409 of file pivot.inc.

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

Member Data Documentation

$indexBy

IndexedPivotQuery::$indexBy

Definition at line 396 of file pivot.inc.

---

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

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