Packages:
default
System
System.Caching
System.Collections
System.Data
System.Data.ActiveRecord
System.Data.ActiveRecord.Relations
System.Data.ActiveRecord.Scaffold
System.Data.ActiveReecord.Scaffold.InputBuilder
System.Data.Commom.Sqlite
System.Data.Common
System.Data.Common.Mssql
System.Data.Common.Mysql
System.Data.Common.Oracle
System.Data.Common.Pgsql
System.Data.Common.Sqlite
System.Data.DataGateway
System.Data.SqlMap
System.Data.SqlMap.Configuration
System.Data.SqlMap.Statements
System.Exceptions
System.I18N
System.IO
System.Security
System.Util
System.Web
System.Web.Services
System.Web.UI
System.Web.UI.ActiveControls
System.Web.UI.WebControls
System.Web.UI.WebControls.assets
System.Xml


Classes:
Keyword

Class TActiveRecordHasMany

TActiveRecordRelation
   |
   --TActiveRecordHasMany

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.

  1. +------+ +--------+
  2. | Team | 1 <----- * | Player |
  3. +------+ +--------+
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.
  1. class TeamRecord extends TActiveRecord
  2. {
  3. const TABLE='team';
  4. public $name; //primary key
  5. public $location;
  6.  
  7. public $players=array(); //list of players
  8.  
  9. public static $RELATIONS=array
  10. (
  11. 'players' => array(self::HAS_MANY, 'PlayerRecord')
  12. );
  13.  
  14. public static function finder($className=__CLASS__)
  15. {
  16. return parent::finder($className);
  17. }
  18. }
  19. class PlayerRecord extends TActiveRecord
  20. {
  21. // see TActiveRecordBelongsTo for detailed definition
  22. }
The static <tt>$RELATIONS</tt> property of TeamRecord defines that the property <tt>$players</tt> has many <tt>PlayerRecord</tt>s.

The players list may be fetched as follows.

  1. $team = TeamRecord::finder()->with_players()->findAll();
The method <tt>with_xxx()</tt> (where <tt>xxx</tt> is the relationship property name, in this case, <tt>players</tt>) fetchs the corresponding PlayerRecords using a second query (not by using a join). The <tt>with_xxx()</tt> accepts the same arguments as other finder methods of TActiveRecord, e.g. <tt>with_players('age < ?', 35)</tt>.

Since: 3.1
Author: Wei Zhuo <weizho[at]gmail[dot]com>

Method Summary
protected  void
collectForeignObjects ( array &$results)
Get the foreign key index values from the results and make calls to the database to find the corresponding foreign objects.
array
boolean
Updates the associated foreign objects.
Methods Inherited From TActiveRecordRelation
TActiveRecordRelation::fetchResultsInto(), TActiveRecordRelation::findForeignKeys(), TActiveRecordRelation::findForeignObjects(), TActiveRecordRelation::getContext(), TActiveRecordRelation::getCriteria(), TActiveRecordRelation::getIndexValues(), TActiveRecordRelation::getObjectHash(), TActiveRecordRelation::getSourceRecord(), TActiveRecordRelation::populateResult(), TActiveRecordRelation::setObjectProperty(), TActiveRecordRelation::setResultCollection(), TActiveRecordRelation::__call()

Method Details

collectForeignObjects

protected void collectForeignObjects (array &$results )

Get the foreign key index values from the results and make calls to the database to find the corresponding foreign objects.

Input
array&$resultsoriginal results.
Output
Exception

getRelationForeignKeys

public array getRelationForeignKeys ()

Output
array foreign key field names as key and object properties as value.
Exception

updateAssociatedRecords

public boolean updateAssociatedRecords ()

Updates the associated foreign objects.

Output
boolean true if all update are success (including if no update was required), false otherwise .
Exception