Method Details

all() public method #

Executes the query and returns all results as an array.

public array all ( $db = null )

andWhere() public method #

Adds an additional WHERE condition to the existing one.

The new condition and the existing one will be joined using the AND operator.

public $this andWhere ( $condition, $params = [] )

behaviors() public method #

Returns a list of behaviors that this component should behave as.

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from \craft\db\Behavior. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using getBehavior() or be detached using detachBehavior(). Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

public array behaviors ( )

column() public method #

Executes the query and returns the first column of the result.

public array column ( $db = null )

exists() public method #

Returns a value indicating whether the query result contains any row of data.

public boolean exists ( $db = null )

getRawSql() public method #

Shortcut for createCommand()->getRawSql().

See also:

• createCommand()
• yii\db\Command::getRawSql()

public string getRawSql ( yii\db\Connection $db = null )

init() public method #

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )

isJoined() public method #

Returns whether a given table has been joined in this query.

public boolean isJoined ( \craft\db\string $table )

nth() public method #

Executes the query and returns a single row of result at a given offset.

public array, null nth ( \craft\db\int $n, yii\db\Connection $db = null )

one() public method #

Executes the query and returns a single row of result.

public array, null one ( $db = null )

orWhere() public method #

Adds an additional WHERE condition to the existing one.

The new condition and the existing one will be joined using the OR operator.

public $this orWhere ( $condition, $params = [] )

pairs() public method #

Executes the query and returns the first two columns in the results as key/value pairs.

public array pairs ( yii\db\Connection $db = null )

queryScalar() protected method #

Queries a scalar value by setting select() first.

Restores the value of select to make this query reusable.

protected boolean, string queryScalar ( $selectExpression, $db )

scalar() public method #

Returns the query result as a scalar value.

The value returned will be the first column in the first row of the query results.

public string, null, false scalar ( $db = null )

where() public method #

Sets the WHERE part of the query.

The method requires a $condition parameter, and optionally a $params parameter specifying the values to be bound to the query.

The $condition parameter should be either a string (e.g. 'id=1') or an array.

{@inheritdoc}

public $this where ( $condition, $params = [] )

Event Details

EVENT_DEFINE_BEHAVIORS event of type craft\events\DefineBehaviorsEvent #

The event that is triggered when defining the class behaviors

See also behaviors().

EVENT_INIT event of type yii\base\Event #

The event that is triggered after the query's init cycle

See also init().