CBaseActiveRelation
优质
小牛编辑
129浏览
2023-12-01
所有包 | 属性 | 方法
CBaseActiveRelation是所有活动关系类的基类。
源码: framework/db/ar/CActiveRecord.php#1926 (显示)
源码: framework/db/ar/CActiveRecord.php#1940 (显示)
包 | system.db.ar |
---|---|
继承 | class CBaseActiveRelation » CComponent |
子类 | CActiveRelation, CStatRelation |
版本 | $Id: CActiveRecord.php 3533 2012-01-08 22:07:55Z mdomba $ |
源码 | framework/db/ar/CActiveRecord.php |
公共属性
隐藏继承属性
属性 | 类型 | 描述 | 定义在 |
---|---|---|---|
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 |
join | string | 怎样跟其它数据表关联。这个跟在 SQL 语句中 JOIN 条款相同。 比如,'LEFT JOIN users ON users. | CBaseActiveRelation |
name | string | 相关对象的名字 | CBaseActiveRelation |
order | string | ORDER BY 子句。为CActiveRelation子类, 在此属性中引用的列名称应该以前缀 'relationName' 来防止歧义。 | CBaseActiveRelation |
params | array | 条件中的约束数据。 键名是参数的占位符名字,值是参数值。 | CBaseActiveRelation |
select | mixed | 要查询的字段名字。(数组或者是名字以逗号分隔的字符串)。 不要转义或者是添加前缀到这个字段名字,除非它们需要在表达式里面用到。 这种情况下,你应该以‘relationName’作为字段前缀。 | CBaseActiveRelation |
公共方法
隐藏继承方法
方法 | 描述 | 定义在 |
---|---|---|
__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() | 将一个动态指定的条件合并到这个关系。 | CBaseActiveRelation |
raiseEvent() | 发起一个事件。 | CComponent |
属性详细
className 属性 public string $className;相关的活动记录类的名字
condition 属性 public string $condition;WHERE 子句。如CActiveRelation这个继承类, 关联到条件里面的字段名字应该以前缀 'relationName' 来防止歧义。
foreignKey 属性 public mixed $foreignKey;关系中的外键
group 属性 public string $group;GROUP BY 子句。如CActiveRelation这个继承类, 关联到条件里面的字段名字应该以前缀 'relationName' 来防止歧义.
having 属性 public string $having;HAVING 子句。为CActiveRelation子类, 在此属性中引用的列名称应该以前缀 'relationName' 来防止歧义。
join 属性 (可用自 v1.1.3) public string $join;怎样跟其它数据表关联。这个跟在 SQL 语句中 JOIN 条款相同。 比如,'LEFT JOIN users ON users.id=authorID'
。
相关对象的名字
order 属性 public string $order;ORDER BY 子句。为CActiveRelation子类, 在此属性中引用的列名称应该以前缀 'relationName' 来防止歧义。
params 属性 public array $params;条件中的约束数据。 键名是参数的占位符名字,值是参数值。
select 属性 public mixed $select;要查询的字段名字。(数组或者是名字以逗号分隔的字符串)。 不要转义或者是添加前缀到这个字段名字,除非它们需要在表达式里面用到。 这种情况下,你应该以‘relationName’作为字段前缀。
方法详细
__construct() 方法public void __construct(string $name, string $className, string $foreignKey, array $options=array ( )) | ||
$name | string | 关系的名称 |
$className | string | 相关活动记录类的名称 |
$foreignKey | string | 这种关系的外键 |
$options | array | 附加选项(name=>value),键必须是这个类的属性名。 |
publicfunction__construct($name,$className,$foreignKey,$options=array())
{
$this->name=$name;
$this->className=$className;
$this->foreignKey=$foreignKey;
foreach($optionsas$name=>$value)
$this->$name=$value;
}
构造函数。
mergeWith() 方法public void mergeWith(array $criteria, boolean $fromScope=false) | ||
$criteria | array | 动态指定的条件 |
$fromScope | boolean | 是否此条件被从范围合并 |
publicfunctionmergeWith($criteria,$fromScope=false)
{
if($criteriainstanceofCDbCriteria)
$criteria=$criteria->toArray();
if(isset($criteria['select'])&&$this->select!==$criteria['select'])
{
if($this->select==='*')
$this->select=$criteria['select'];
elseif($criteria['select']!=='*')
{
$select1=is_string($this->select)?preg_split('/s*,s*/',trim($this->select),-1,PREG_SPLIT_NO_EMPTY):$this->select;
$select2=is_string($criteria['select'])?preg_split('/s*,s*/',trim($criteria['select']),-1,PREG_SPLIT_NO_EMPTY):$criteria['select'];
$this->select=array_merge($select1,array_diff($select2,$select1));
}
}
if(isset($criteria['condition'])&&$this->condition!==$criteria['condition'])
{
if($this->condition==='')
$this->condition=$criteria['condition'];
elseif($criteria['condition']!=='')
$this->condition="({$this->condition})AND({$criteria['condition']})";
}
if(isset($criteria['params'])&&$this->params!==$criteria['params'])
$this->params=array_merge($this->params,$criteria['params']);
if(isset($criteria['order'])&&$this->order!==$criteria['order'])
{
if($this->order==='')
$this->order=$criteria['order'];
elseif($criteria['order']!=='')
$this->order=$criteria['order'].','.$this->order;
}
if(isset($criteria['group'])&&$this->group!==$criteria['group'])
{
if($this->group==='')
$this->group=$criteria['group'];
elseif($criteria['group']!=='')
$this->group.=','.$criteria['group'];
}
if(isset($criteria['join'])&&$this->join!==$criteria['join'])
{
if($this->join==='')
$this->join=$criteria['join'];
elseif($criteria['join']!=='')
$this->join.=''.$criteria['join'];
}
if(isset($criteria['having'])&&$this->having!==$criteria['having'])
{
if($this->having==='')
$this->having=$criteria['having'];
elseif($criteria['having']!=='')
$this->having="({$this->having})AND({$criteria['having']})";
}
}
将一个动态指定的条件合并到这个关系。