PivotQuery Class Reference

Standard Pivot Query, with support for paging. More...

Inheritance diagram for PivotQuery:

Collaboration diagram for PivotQuery:

Public Member Functions
	__construct ($base, $baseConstraint="")
	Constructs a new AbstractPivotQuery. More...
	page ($page, $size)
	Sets the page number and size for constraining the result set by page. More...
	execute ()
Public Member Functions inherited from AbstractPivotQuery
	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="")

Public Attributes
	$page
	$size
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

Standard Pivot Query, with support for paging.

Author

andy

Definition at line 307 of file pivot.inc.

Constructor & Destructor Documentation

__construct()

PivotQuery::__construct	(		$base,
			$baseConstraint = ""
	)

Constructs a new AbstractPivotQuery.

Parameters

string	$base	Class name of the DataItem that will be the base
string	$baseConstraint	SQL constraint over which the base query will operate.

Reimplemented from AbstractPivotQuery.

Definition at line 312 of file pivot.inc.

     {
          parent::__construct($base, $baseConstraint);
     }

Member Function Documentation

create()

static PivotQuery::create (   $base,   $baseConstraint = ""  )

static

Definition at line 331 of file pivot.inc.

     {
          return new PivotQuery($base, $baseConstraint);
     }

execute()

PivotQuery::execute

(

)

See also

AbstractQuery::execute()

Reimplemented from AbstractQuery.

Definition at line 339 of file pivot.inc.

     {
          $query = $this->generateQuery();
          
          trace("$query", 3);
          trace("Page: $this->page Size: $this->size", 3);
          $items = array();
          
          $size = $this->size;
          
          try
          {
               $db = ConnectionManager::getConnection();
                    
               $result = $db->prepare($query);
               $result->execute($this->params);
                    
               if ($this->page > 0)
               {
                    $count = ($this->page - 1) * $this->size;
                    while($count--)
                    {
                         $result->fetch();
                    }
               }
                         
               while($line = $result->fetch())
               {
                    $item = $this->createPivotItem();
                    $item->populate($line);
                    $items[] = $item;
          
                    --$size;
                    if ($size == 0) break;
               }
                              
               unset($result);
          }
          catch(PDOException $e)
          {
               $err = "query() failed - " . $e->getMessage();
               trace($err, 2);
               throw new DataItemException($err);
          }
          
          trace(count($items)." items found", 3);
          return $items;      
     }

page()

PivotQuery::page	(		$page,
			$size
	)

Sets the page number and size for constraining the result set by page.

By default results are not paged.

Parameters

$page	integer the page number
$size	integer the number of items per page

Returns

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

Definition at line 324 of file pivot.inc.

     {
          $this->page = $page;
          $this->size = $size;
          return $this;
     }

Member Data Documentation

$page

PivotQuery::$page

Definition at line 309 of file pivot.inc.

$size

PivotQuery::$size

Definition at line 310 of file pivot.inc.

---

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

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