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

2025-01-10 15:47:30

Comments

Popular Articles

db\BaseActiveRecord afterRefresh() afterRefresh() public method (available since version 2.0.8) This method is called when the AR object is refreshed. The default implementation wi

db\BaseActiveRecord canGetProperty() canGetProperty() public method Returns a value indicating whether a property can be read. A property can be read if: the class has a getter metho

db\BaseActiveRecord update() update() public method Saves the changes to this active record into the associated database table. This method performs the following steps in or

db\BaseActiveRecord getAttributeLabel() getAttributeLabel() public method Returns the text label for the specified attribute. If the attribute looks like relatedModel.attribute, then th

db\BaseActiveRecord findByCondition() findByCondition() protected static method Finds ActiveRecord instance(s) by the given condition. This method is internally called by findOne() an