Trait Yiisoft\ActiveRecord\Trait\RepositoryTrait

Returns an instance of {@see ActiveQueryInterface} instantiated by {@see ActiveRecordInterface::query()} method.

If the $condition parameter is not null, it calls {@see \Yiisoft\ActiveRecord\ActiveQueryInterface::andWhere()} method. Do not to pass user input to this method, use {@see \Yiisoft\ActiveRecord\Trait\findByPk()} instead.

Shortcut for {@see find()} method with calling {@see ActiveQueryInterface::all()} method to get all records.

Do not to pass user input to this method, use {@see \Yiisoft\ActiveRecord\Trait\findByPk()} instead.

// find the customers whose primary key value is 10, 11 or 12.
$customers = Customer::findAll(['id' => [10, 11, 12]]);
// the above code line is equal to:
$customers = Customer::find(['id' => [10, 11, 12]])->all();

// find customers whose age is 30 and whose status is 1.
$customers = Customer::findAll(['age' => 30, 'status' => 1]);
// the above code line is equal to.
$customers = Customer::find(['age' => 30, 'status' => 1])->all();

[!WARNING] Do NOT use the following code! It is possible to inject any condition to filter by arbitrary column values!

$id = $request->getAttribute('id');
$posts = Post::findAll($id); // Do NOT use this!

Explicitly specifying the column to search:

$posts = Post::findAll(['id' => $id]);
// or use {@see \Yiisoft\ActiveRecord\Trait\findByPk()} method
$post = Post::findByPk($id);

Shortcut for {@see findAll()} method with throwing {@see NotFoundException} if no records found.

$customers = Customer::findAllOrFail(['is_active' => true]);

Finds an ActiveRecord instance by the given primary key value.

In the examples below, the id column is the primary key of the table.

$customer = Customer::findByPk(1); // WHERE id = 1

$customer = Customer::findByPk([1]); // WHERE id = 1

In the examples below, the id and id2 columns are the composite primary key of the table.

$orderItem = OrderItem::findByPk([1, 2]); // WHERE id = 1 AND id2 = 2

If you need to pass user input to this method, make sure the input value is scalar or in case of array, make sure the array values are scalar:

public function actionView(ServerRequestInterface $request)
{
    $id = (string) $request->getAttribute('id');

    $customer = Customer::findByPk($id);
}

Shortcut for {@see findByPk()} method with throwing {@see NotFoundException} if no records found.

$customer = Customer::findByPkOrFail(1);

Creates an {@see ActiveQueryInterface} instance with a given SQL statement.

Note: That because the SQL statement is already specified, calling more query modification methods (such as {@see \Yiisoft\ActiveRecord\Trait\where()}, {@see order()) on the created {@see ActiveQueryInterface} instance will have no effect.

However, calling {@see with()}, {@see asArray()}, {@see indexBy()} or {@see resultCallback()} is still fine.

Below is an example:

$customers = Customer::findBySql('SELECT * FROM customer')->all();

Shortcut for {@see find()} method with calling {@see ActiveQueryInterface::one()} method to get one record.

Do not to pass user input to this method, use {@see \Yiisoft\ActiveRecord\Trait\findByPk()} instead.

// find a single customer whose primary key value is 10
$customer = Customer::findOne(['id' => 10]);
// the above code line is equal to:
$customer = Customer::find(['id' => 10])->one();

// find the first customer whose age is 30 and whose status is 1
$customer = Customer::findOne(['age' => 30, 'status' => 1]);
// the above code line is equal to:
$customer = Customer::find(['age' => 30, 'status' => 1])->one();

[!WARNING] Do NOT use the following code! It is possible to inject any condition to filter by arbitrary column values!

$id = $request->getAttribute('id');
$post = Post::findOne($id); // Do NOT use this!

Explicitly specifying the column to search:

$post = Post::findOne(['id' => $id]);
// or use {@see \Yiisoft\ActiveRecord\Trait\findByPk()} method
$post = Post::findByPk($id);

Shortcut for {@see findOne()} method with throwing {@see NotFoundException} if no records found.

$customer = Customer::findOneOrFail(['id' => 1]);