* @link http://www.pradosoft.com/
* @copyright Copyright © 2005-2008 PradoSoft
* @license http://www.pradosoft.com/license/
* @version $Id$
* @package System.Data.ActiveRecord.Relations
*/
/**
* Loads base active record relations class.
*/
Prado::using('System.Data.ActiveRecord.Relations.TActiveRecordRelation');
/**
* Implements TActiveRecord::HAS_MANY relationship between the source object having zero or
* more foreign objects. Consider the entity relationship between a Team and a Player.
*
* +------+ +--------+
* | Team | 1 <----- * | Player |
* +------+ +--------+
*
* Where one team may have 0 or more players and each player belongs to only
* one team. We may model Team-Player object relationship as active record as follows.
*
* class TeamRecord extends TActiveRecord
* {
* const TABLE='team';
* public $name; //primary key
* public $location;
*
* public $players=array(); //list of players
*
* public static $RELATIONS=array
* (
* 'players' => array(self::HAS_MANY, 'PlayerRecord')
* );
*
* public static function finder($className=__CLASS__)
* {
* return parent::finder($className);
* }
* }
* class PlayerRecord extends TActiveRecord
* {
* // see TActiveRecordBelongsTo for detailed definition
* }
*
* The static $RELATIONS property of TeamRecord defines that the
* property $players has many PlayerRecords.
*
* The players list may be fetched as follows.
*
* $team = TeamRecord::finder()->with_players()->findAll();
*
* The method with_xxx() (where xxx is the relationship property
* name, in this case, players) fetchs the corresponding PlayerRecords using
* a second query (not by using a join). The with_xxx() accepts the same
* arguments as other finder methods of TActiveRecord, e.g. with_players('age < ?', 35).
*
* @author Wei Zhuo
* @version $Id$
* @package System.Data.ActiveRecord.Relations
* @since 3.1
*/
class TActiveRecordHasMany extends TActiveRecordRelation
{
/**
* Get the foreign key index values from the results and make calls to the
* database to find the corresponding foreign objects.
* @param array original results.
*/
protected function collectForeignObjects(&$results)
{
$fkeys = $this->getRelationForeignKeys();
$properties = array_values($fkeys);
$fields = array_keys($fkeys);
$indexValues = $this->getIndexValues($properties, $results);
$fkObjects = $this->findForeignObjects($fields,$indexValues);
$this->populateResult($results,$properties,$fkObjects,$fields);
}
/**
* @return array foreign key field names as key and object properties as value.
* @since 3.1.2
*/
public function getRelationForeignKeys()
{
$fkObject = $this->getContext()->getForeignRecordFinder();
return $this->findForeignKeys($fkObject, $this->getSourceRecord());
}
/**
* Updates the associated foreign objects.
* @return boolean true if all update are success (including if no update was required), false otherwise .
*/
public function updateAssociatedRecords()
{
$obj = $this->getContext()->getSourceRecord();
$fkObjects = &$obj->{$this->getContext()->getProperty()};
$success=true;
if(($total = count($fkObjects))> 0)
{
$source = $this->getSourceRecord();
$fkeys = $this->findForeignKeys($fkObjects[0], $source);
for($i=0;$i<$total;$i++)
{
foreach($fkeys as $fKey => $srcKey)
$fkObjects[$i]->setColumnValue($fKey, $source->getColumnValue($srcKey));
$success = $fkObjects[$i]->save() && $success;
}
}
return $success;
}
}