IndexedQuery Class Reference

Inheritance diagram for IndexedQuery:

Collaboration diagram for IndexedQuery:

Public Member Functions
	__construct ($class, $constraints="", $indexBy="")
	indexBy ($indexBy)
	execute ()
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="", $indexBy="")

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

Detailed Description

Definition at line 39 of file indexed_query.inc.

Constructor & Destructor Documentation

__construct()

IndexedQuery::__construct	(		$class,
			$constraints = "",
			$indexBy = ""
	)

Definition at line 43 of file indexed_query.inc.

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

Member Function Documentation

create()

static IndexedQuery::create (   $class,   $constraints = "",   $indexBy = ""  )

static

Definition at line 127 of file indexed_query.inc.

     {
          return new IndexedQuery($class, $constraints, $indexBy);
     }

execute()

IndexedQuery::execute

(

)

Reimplemented from AbstractQuery.

Definition at line 55 of file indexed_query.inc.

     {
          $prototype = new $this->class;
     
          if (!$this->indexBy) $this->indexBy = $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"; 
          $query = "SELECT $fields FROM {$prototype->table} {$this->constraints} ".$prototype->getIdentityConstraint()." $orderBy";
          trace("DataItem indexedQuery(): $query", 3);
          
          $items = array();
          
          $field = $this->indexBy;
          
          $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;
                    $item->populate($line);
          
                    $val = ($useFormat) ? $item->format($field) : $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 = "indexedQuery() failed - " . $e->getMessage();
               trace($err, 2);
               throw new DataItemException($err);
          }
          
          return $items; 
     }

indexBy()

IndexedQuery::indexBy

(

$indexBy

)

Definition at line 49 of file indexed_query.inc.

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

Member Data Documentation

$indexBy

IndexedQuery::$indexBy

Definition at line 41 of file indexed_query.inc.

---

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

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