db\BaseActiveRecord getRelation()

getRelation() public method

Returns the relation object with the specified name.

A relation is defined by a getter method which returns an yii\db\ActiveQueryInterface object. It can be declared in either the Active Record class itself or one of its behaviors.

public yii\db\ActiveQueryInterface\|yii\db\ActiveQuery getRelation ( $name, $throwException = true )
$name	string	The relation name, e.g. `orders` for a relation defined via `getOrders()` method (case-sensitive).
$throwException	boolean	Whether to throw exception if the relation does not exist.
return	yii\db\ActiveQueryInterface\|yii\db\ActiveQuery	The relational query object. If the relation does not exist and `$throwException` is `false`, `null` will be returned.
throws	yii\base\InvalidParamException	if the named relation does not exist.

Links:

http://www.yiiframework.com/doc-2.0/yii-db-baseactiverecord.html#getRelation()-detail

doc_Yii

2016-10-30 16:56:48

Comments

Popular Articles

db\BaseActiveRecord findAll() findAll() public static method Returns a list of active record models that match the specified primary key value(s) or a set of column values. Th

db\BaseActiveRecord markAttributeDirty() markAttributeDirty() public method Marks an attribute dirty. This method may be called to force updating a record when calling update(), even if

db\BaseActiveRecord getAttribute() getAttribute() public method Returns the named attribute value. If this record is the result of a query and the attribute is not loaded, null wil

db\BaseActiveRecord getPrimaryKey() getPrimaryKey() public method Returns the primary key value(s). public mixed getPrimaryKey ( $asArray = false )$asArray boolean Whether to ret

db\BaseActiveRecord delete() delete() public method Deletes the table row corresponding to this active record. This method performs the following steps in order: call beforeD