GroupedQuery Class Reference

Inheritance diagram for GroupedQuery:

Collaboration diagram for GroupedQuery:

Public Member Functions
	__construct ($class, $constraints="", $groupBy="")
	groupBy ($groupBy)
	execute ()
	executeValue ($func)
	Query the database to calculate aggregate values by grouping. More...
Public Member Functions inherited from AbstractQuery
	__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...

Static Public Member Functions
static	create ($class, $constraints="", $groupBy="")

Public Attributes
	$groupBy
Public Attributes inherited from AbstractQuery
	$class
	$constraints
	$filter
	$params

Detailed Description

Definition at line 39 of file grouped_query.inc.

Constructor & Destructor Documentation

__construct()

GroupedQuery::__construct	(		$class,
			$constraints = "",
			$groupBy = ""
	)

Definition at line 43 of file grouped_query.inc.

     {
          parent::__construct($class, $constraints);
          $this->groupBy = $groupBy;
     }

Member Function Documentation

create()

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

static

Definition at line 159 of file grouped_query.inc.

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

execute()

GroupedQuery::execute

(

)

Reimplemented from AbstractQuery.

Definition at line 55 of file grouped_query.inc.

     {
          $prototype = new $this->class;
          
          if (!$this->groupBy) $this->groupBy = $prototype->getPrimaryKey();
          
          if ($this->filter)
          {
               $prototype->filter = $this->filter;
          }
          
          $order_by_idx = strpos(strtoupper($this->constraints), "ORDER BY");   
          if ($order_by_idx !== false)
          {
               $orderBy = substr($this->constraints, $order_by_idx);
               
               $this->constraints = substr($this->constraints, 0, $order_by_idx);
          } 
               
          $fields = $prototype->getFieldList();
     
          if ($this->constraints == "") $this->constraints = "WHERE 1=1"; //TODO - tidy this up some day
     
          $query = "SELECT $fields FROM {$prototype->table} {$this->constraints} ".$prototype->getIdentityConstraint()." $orderBy";;
          trace($query, 3);
          
          $items = array();
          
          $field = $this->groupBy;
          
          $useFormat = preg_match("/^[A-Za-z0-9_]*$/", $field) ? false : true;
          
          try
          {
               $db = ConnectionManager::getConnection();
               
               $result = $db->prepare($query);
               $result->execute($this->params);
     
               while($line = $result->fetch())
               {
                    $item = new $this->class;     //Hack to work around PHP's stupid implementation of get_class()
                    $item->populate($line);
                    $val = ($useFormat) ? $item->format($field) : $item->get($field);
                    
                    $items[$val][] = $item;
               }
          
               unset($result);
          }
          catch(PDOException $e)
          {
               $err = "groupedQuery() failed - " . $e->getMessage();
               trace($err, 2);
               throw new DataItemException($err);
          }
          
          return $items;
     }

executeValue()

GroupedQuery::executeValue

(

$func

)

Query the database to calculate aggregate values by grouping.

The database table associated with the specified class is used as the source for the data.

Parameters

string

$func

the value or function to retrieve

Returns

array an associative array of group values to calculated aggregate values

Definition at line 122 of file grouped_query.inc.

     {
          $prototype = new $this->class;
          
          if ($this->constraints == "") $this->constraints = "WHERE 1=1"; //TODO - tidy this up some day
          $this->constraints .= " ".$prototype->getIdentityConstraint();
          
          $query = "SELECT {$this->groupBy}, $func as result FROM {$prototype->table} {$this->tableAlias} {$this->constraints} GROUP BY {$this->groupBy}";
          
          trace($query, 3);
          
          $values = array();
          
          try
          {
               $db = ConnectionManager::getConnection();
               
               $result = $db->prepare($query);
               $result->execute($this->params);
               
               while ($row = $result->fetch())
               {
                    $values[$row[$this->groupBy]] = $row['result'];
               }
               
               unset($result);
          }
          catch(PDOException $e)
          {
               $err = "Query::executeValue() failed - " . $e->getMessage();
               trace($err, 2);
               throw new DataItemException($err);
          }
          
          return $values;
     }

groupBy()

GroupedQuery::groupBy

(

$groupBy

)

Definition at line 49 of file grouped_query.inc.

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

Member Data Documentation

$groupBy

GroupedQuery::$groupBy

Definition at line 41 of file grouped_query.inc.

---

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

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