crhg/eloquent-exists-relation

Add withExits method to check existence of related records with subquery.

v1.1.2 2020-01-22 02:13 UTC

Requires

• php: ^7.1
• illuminate/database: ^5.6,>=5.6.12 || ^6.0
• illuminate/support: ^5.6,>=5.6.12 || ^6.0

Requires (Dev)

• mockery/mockery: ^1.2
• orchestra/database: ^3.5 || ^4.0
• orchestra/testbench: ^3.5 || ^4.0

MIT

• Manabu Matsui

README

Add an attribute that indicates whether there is an element indicated by the relation specified when acquiring to the Eloquent Model using a subquery. It is similar to withCount, which finds the number of elements of a relation, but it differs in obtaining only whether it exists without counting.

INSTALL

composer require crhg/eloquent-exists-relation

This package is compliant with Package Discovery so no additional configuration is required.

In case of Lumen

Register EloquentExistsRelationProvider as follows in bootstrap/app.php.

$app->register(\Crhg\EloquentExistsRelation\Providers\EloquentExistsRelationProvider::class);

USAGE

If you want to know wheather results from a relationship exists without actually loading them you may use the withExists method, which will place a {relation}_exists column on your resulting models. For example:

$posts = App\Post::withExists('comments')->get();

foreach ($posts as $post) {
    echo $post->comments_exists;
}

You may add the "exists" for multiple relations as well as add constraints to the queries:

$posts = App\Post::withCount(['votes', 'comments' => function ($query) {
    $query->where('content', 'like', 'foo%');
}])->get();

echo $posts[0]->votes_exists;
echo $posts[0]->comments_exists;

You may also alias the relationship exists result, allowing multiple exists on the same relationship:

$posts = App\Post::withCount([
    'comments',
    'comments as pending_comments_exists' => function ($query) {
        $query->where('approved', false);
    }
])->get();

echo $posts[0]->comments_exists;

echo $posts[0]->pending_comments_exists;

TIPS

Since the value of EXISTS may not be a boolean value (for example, 0 or 1 in mysql), it is convenient to cast it explicitly when you want to treat it as a boolean value.

    protected $cast = [
        'commensts_exists' => 'bool',
    ];