CHasManyRelation - system.db.ar - [ Yii中文参考手册 ]

CHasManyRelation

包	system.db.ar
继承	class CHasManyRelation » CActiveRelation » CBaseActiveRelation » CComponent
子类	CManyManyRelation
源自	1.0
版本	$Id: CActiveRecord.php 3533 2012-01-08 22:07:55Z mdomba $
源码

CHasManyRelation表示此参数指定一个HAS_MANY 关系。

公共属性

属性	类型	描述	定义在
alias	string	这个关系所指的表的别名。默认为null，意味着此别名将和此关系名一样。	CActiveRelation
className	string	相关的活动记录类的名字	CBaseActiveRelation
condition	string	WHERE 子句。如CActiveRelation这个继承类, 关联到条件里面的字段名字应该以前缀 'relationName' 来防止歧义。	CBaseActiveRelation
foreignKey	mixed	关系中的外键	CBaseActiveRelation
group	string	GROUP BY 子句。如CActiveRelation这个继承类, 关联到条件里面的字段名字应该以前缀 'relationName' 来防止歧义.	CBaseActiveRelation
having	string	HAVING 子句。为CActiveRelation子类，在此属性中引用的列名称应该以前缀 'relationName' 来防止歧义。	CBaseActiveRelation
index	string	列的名称被用作存储关联对象的键。默认为null，这意味着使用从零开始的整数ID。	CHasManyRelation
join	string	怎样跟其它数据表关联。这个跟在 SQL 语句中 JOIN 条款相同。比如，`'LEFT JOIN users ON users.`	CBaseActiveRelation
joinType	string	连接类型。默认值为‘LEFT OUTER JOIN’。	CActiveRelation
limit	integer	要选定的行的限制。它仅对懒加载这个相关对象有效。默认为 -1，意味着没有限制limit.	CHasManyRelation
name	string	相关对象的名字	CBaseActiveRelation
offset	integer	要选定的行的偏移量。它仅对懒加载这个相关对象是有效的。默认是 -1，意味着没有偏移量。	CHasManyRelation
on	string	ON 子句.	CActiveRelation
order	string	ORDER BY 子句。为CActiveRelation子类，在此属性中引用的列名称应该以前缀 'relationName' 来防止歧义。	CBaseActiveRelation
params	array	条件中的约束数据。键名是参数的占位符名字，值是参数值。	CBaseActiveRelation
scopes	mixed	要应用的范围可以设置为下列值之一: Single scope: 'scopes'=>'scopeName'.	CActiveRelation
select	mixed	要查询的字段名字。（数组或者是名字以逗号分隔的字符串）。不要转义或者是添加前缀到这个字段名字，除非它们需要在表达式里面用到。这种情况下，你应该以‘relationName’作为字段前缀。	CBaseActiveRelation
through	string	关系的名称被用作此关系的桥梁。默认为null，意味着不使用任何桥梁。	CHasManyRelation
together	boolean	是否应将此表与主表联接。当这个属性设置为false时，和这个关系关联的表将出现在一个单独的JOIN语句中。如果这个属性被设置为true，相应的表总是主表连接在一起，不管是主表被限制或没有。如果这个属性没有设置，相应的表仅和主表连接仅当主表不被限制时。	CActiveRelation
with	string\|array	指定相关的对象应该被急切的加载当这个关联对象被懒加载时。更多关于这个属性的信息，参见CActiveRecord::with()。	CActiveRelation

公共方法

方法	描述	定义在
__call()	如果类中没有调的方法名，则调用这个方法。	CComponent
__construct()	构造函数。	CBaseActiveRelation
__get()	返回一个属性值、一个事件处理程序列表或一个行为名称。	CComponent
__isset()	检查一个属性是否为null。	CComponent
__set()	设置一个组件的属性值。	CComponent
__unset()	设置一个组件的属性为null。	CComponent
asa()	返回这个名字的行为对象。	CComponent
attachBehavior()	附加一个行为到组件。	CComponent
attachBehaviors()	附加一个行为列表到组件。	CComponent
attachEventHandler()	为事件附加一个事件处理程序。	CComponent
canGetProperty()	确定属性是否可读。	CComponent
canSetProperty()	确定属性是否可写。	CComponent
detachBehavior()	从组件中分离一个行为。	CComponent
detachBehaviors()	从组件中分离所有行为。	CComponent
detachEventHandler()	分离一个存在的事件处理程序。	CComponent
disableBehavior()	禁用一个附加行为。	CComponent
disableBehaviors()	禁用组件附加的所有行为。	CComponent
enableBehavior()	启用一个附加行为。	CComponent
enableBehaviors()	启用组件附加的所有行为。	CComponent
evaluateExpression()	计算一个PHP表达式，或根据组件上下文执行回调。	CComponent
getEventHandlers()	返回一个事件的附加处理程序列表。	CComponent
hasEvent()	确定一个事件是否定义。	CComponent
hasEventHandler()	检查事件是否有附加的处理程序。	CComponent
hasProperty()	确定属性是否被定义。	CComponent
mergeWith()	合并一个带有动态指定的条件到这个关系。	CHasManyRelation
raiseEvent()	发起一个事件。	CComponent

属性详细

index 属性

public string $index;

列的名称被用作存储关联对象的键。默认为null，这意味着使用从零开始的整数ID。

limit 属性

public integer $limit;

要选定的行的限制。它仅对懒加载这个相关对象有效。默认为 -1，意味着没有限制limit.

offset 属性

public integer $offset;

要选定的行的偏移量。它仅对懒加载这个相关对象是有效的。默认是 -1，意味着没有偏移量。

through 属性（可用自 v1.1.7）

public string $through;

关系的名称被用作此关系的桥梁。默认为null，意味着不使用任何桥梁。

方法详细

mergeWith() 方法

public void mergeWith(array $criteria, boolean $fromScope=false)
$criteria	array	动态指定的条件
$fromScope	boolean	是否此条件从范围合并


public function mergeWith($criteria,$fromScope=false)
{
    if($criteria instanceof CDbCriteria)
        $criteria=$criteria->toArray();
    parent::mergeWith($criteria,$fromScope);
    if(isset($criteria['limit']) && $criteria['limit']>0)
        $this->limit=$criteria['limit'];

    if(isset($criteria['offset']) && $criteria['offset']>=0)
        $this->offset=$criteria['offset'];

    if(isset($criteria['index']))
        $this->index=$criteria['index'];
}

合并一个带有动态指定的条件到这个关系。