Mounting a query with Laravel

Question

I’m studying the structure of the Laravel from this example already ready => beast.

In the project there is the repository userRepository with the following structure:

<?php

namespace App\Repositories;

use App\Models\User;

class UserRepository
{
    /**
     * Get users collection paginate.
     *
     * @param  int  $nbrPages
     * @param  array  $parameters
     * @return \Illuminate\Contracts\Pagination\LengthAwarePaginator
     */
    public function getAll($nbrPages, $parameters)
    {
        return User::with ('ingoing')
            ->orderBy ($parameters['order'], $parameters['direction'])
            ->when (($parameters['role'] !== 'all'), function ($query) use ($parameters) {
                $query->whereRole ($parameters['role']);
            })->when ($parameters['valid'], function ($query) {
                $query->whereValid (true);
            })->when ($parameters['confirmed'], function ($query) {
                $query->whereConfirmed (true);
            })->when ($parameters['new'], function ($query) {
                $query->has ('ingoing');
            })->paginate ($nbrPages);
    }
}

This structure makes use of the config file parameters:

<?php

return [

    'users' => [
        'order' => 'created_at',
        'direction' => 'desc',
        'role' => 'all',
        'valid' => false,
        'confirmed' => false,
        'new' => false,
    ],
    'posts' => [
        'order' => 'created_at',
        'direction' => 'desc',
        'new' => false,
        'active' => false,
    ],
    'contacts' => [
        'new' => false,
    ],
    'comments' => [
        'new' => false,
        'valid' => false,
    ],

];

The structure of the database is as follows:

Schema::create('users', function(Blueprint $table) {
    $table->increments('id');
    $table->timestamps();
    $table->string('name')->unique();
    $table->string('email')->unique();
    $table->string('password');
    $table->rememberToken();
    $table->enum('role', array('user', 'redac', 'admin'));
    $table->boolean('valid')->default(false);
});

I’m trying to understand these methods: whereRole, whereValid and whereConfirmed, I searched the entire project and I couldn’t find the structure of these methods, as Laravel puts together these methods?

Answer 1

That’s one of the cool (and confusing things about Laravel).

These methods do not exist, they are short versions of the method where, what comes after this keyword is the name of the column that is part of the where.

That is to say,

$query->whereRole('algumValor')

is exactly the same thing as

$query->where('role', 'algumValor')

how Laravel assembles these methods?

This has already been answered in: Is there any magic method for calling an attribute as a method in php?