yii\db\ActiveQuery::onCondition PHP Method

ActiveQuery Class Documentation Show file Open project: yiisoft/yii2

onCondition() public method

The condition will be used in the ON part when [[ActiveQuery::joinWith()]] is called. Otherwise, the condition will be used in the WHERE part of a query. Use this method to specify additional conditions when declaring a relation in the ActiveRecord class: php public function getActiveUsers() { return $this->hasMany(User::className(), ['id' => 'user_id']) ->onCondition(['active' => true]); } Note that this condition is applied in case of a join as well as when fetching the related records. Thus only fields of the related table can be used in the condition. Trying to access fields of the primary record will cause an error in a non-join-query.

public onCondition ( string \| array $condition, array $params = [] )
$condition	string \| array	the ON condition. Please refer to [[Query::where()]] on how to specify this parameter.
$params	array	the parameters (name => value) to be bound to the query.

    public function onCondition($condition, $params = [])
    {
        $this->on = $condition;
        $this->addParams($params);
        return $this;
    }

ActiveQuery

__construct

alias

all

andOnCondition

buildJoinWith

createCommand

getJoinType

getQueryTableName

init

innerJoinWith

joinWith