0 follower

Trait Yiisoft\ActiveRecord\Trait\CustomConnectionTrait

All Classes | Methods

Trait to implement a custom connection name for ActiveRecord.

Public Methods

Method	Description	Defined By
db()		Yiisoft\ActiveRecord\Trait\CustomConnectionTrait
withConnectionName()	Sets the connection name for the ActiveRecord.	Yiisoft\ActiveRecord\Trait\CustomConnectionTrait

Method Details

Hide inherited methods

db() public method

public db( ): \Yiisoft\Db\Connection\ConnectionInterface

Source code

                public function db(): ConnectionInterface
{
    if (!empty($this->connectionName)) {
        return ConnectionProvider::get($this->connectionName);
    }
    return parent::db();
}

withConnectionName() public method

Sets the connection name for the ActiveRecord.

public withConnectionName( string $connectionName ): Yiisoft\ActiveRecord\Trait\CustomConnectionTrait
$connectionName	string

Source code

                public function withConnectionName(string $connectionName): static
{
    $new = clone $this;
    $new->connectionName = $connectionName;
    return $new;
}