BannedAtScope::addWithBanned() - Code Metrics - cybercog/laravel-ban - Measure and Improve Code Quality continuously with Scrutinizer

BannedAtScope::addWithBanned() A
last analyzed 2025-02-22 11:14 UTC

↳ Parent: BannedAtScope

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php

/*
 * This file is part of Laravel Ban.
 *
 * (c) Anton Komarev <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Cog\Laravel\Ban\Scopes;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Scope;

class BannedAtScope implements Scope
{
    /**
     * All of the extensions to be added to the builder.
     *
     * @var array
     */
    protected $extensions = [
        'WithBanned',
        'WithoutBanned',
        'OnlyBanned',
    ];

    /**
     * Apply the scope to a given Eloquent query builder.
     *
     * @param \Illuminate\Database\Eloquent\Builder $builder
     * @param \Illuminate\Database\Eloquent\Model $model
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function apply(Builder $builder, Model $model)
    {
        if (method_exists($model, 'shouldApplyBannedAtScope') && $model->shouldApplyBannedAtScope()) {
            return $builder->whereNull('banned_at');

        }

        return $builder;
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
    }

    /**
     * Extend the query builder with the needed functions.
     *
     * @param \Illuminate\Database\Eloquent\Builder $builder
     * @return void
     */
    public function extend(Builder $builder): void
    {
        foreach ($this->extensions as $extension) {
            $this->{"add{$extension}"}($builder);
        }
    }

    /**
     * Add the `withBanned` extension to the builder.
     *
     * @param \Illuminate\Database\Eloquent\Builder $builder
     * @return void
     */
    protected function addWithBanned(Builder $builder): void
    {
        $builder->macro('withBanned', function (Builder $builder) {
            return $builder->withoutGlobalScope($this);
        });
    }

    /**
     * Add the `withoutBanned` extension to the builder.
     *
     * @param \Illuminate\Database\Eloquent\Builder $builder
     * @return void
     */
    protected function addWithoutBanned(Builder $builder): void
    {
        $builder->macro('withoutBanned', function (Builder $builder) {
            return $builder->withoutGlobalScope($this)->whereNull('banned_at');
        });
    }

    /**
     * Add the `onlyBanned` extension to the builder.
     *
     * @param \Illuminate\Database\Eloquent\Builder $builder
     * @return void
     */
    protected function addOnlyBanned(Builder $builder): void
    {
        $builder->macro('onlyBanned', function (Builder $builder) {
            return $builder->withoutGlobalScope($this)->whereNotNull('banned_at');
        });
    }
}


1			<?php
2
3			/*
4			* This file is part of Laravel Ban.
5			*
6			* (c) Anton Komarev <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			declare(strict_types=1);
13
14			namespace Cog\Laravel\Ban\Scopes;
15
16			use Illuminate\Database\Eloquent\Builder;
17			use Illuminate\Database\Eloquent\Model;
18			use Illuminate\Database\Eloquent\Scope;
19
20			class BannedAtScope implements Scope
21			{
22			/**
23			* All of the extensions to be added to the builder.
24			*
25			* @var array
26			*/
27			protected $extensions = [
28			'WithBanned',
29			'WithoutBanned',
30			'OnlyBanned',
31			];
32
33			/**
34			* Apply the scope to a given Eloquent query builder.
35			*
36			* @param \Illuminate\Database\Eloquent\Builder $builder
37			* @param \Illuminate\Database\Eloquent\Model $model
38			* @return \Illuminate\Database\Eloquent\Builder
39			*/
40			public function apply(Builder $builder, Model $model)
41			{
42			if (method_exists($model, 'shouldApplyBannedAtScope') && $model->shouldApplyBannedAtScope()) {
43			return $builder->whereNull('banned_at');
			0 ignored issues – show Bug Best Practice introduced 2018-03-22 12:07 UTC by Report Bug Copy Issue Report The expression `return $builder->whereNull('banned_at')` also could return the type `Illuminate\Database\Query\Builder` which is incompatible with the documented return type `Illuminate\Database\Eloquent\Builder`. Loading history...
44			}
45
46			return $builder;
			0 ignored issues – show Bug Best Practice introduced 2018-03-22 12:07 UTC by Report Bug Copy Issue Report The expression `return $builder` returns the type `Illuminate\Database\Eloquent\Builder` which is incompatible with the return type mandated by `Illuminate\Database\Eloquent\Scope::apply()` of `void`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
47			}
48
49			/**
50			* Extend the query builder with the needed functions.
51			*
52			* @param \Illuminate\Database\Eloquent\Builder $builder
53			* @return void
54			*/
55			public function extend(Builder $builder): void
56			{
57			foreach ($this->extensions as $extension) {
58			$this->{"add{$extension}"}($builder);
59			}
60			}
61
62			/**
63			* Add the `withBanned` extension to the builder.
64			*
65			* @param \Illuminate\Database\Eloquent\Builder $builder
66			* @return void
67			*/
68			protected function addWithBanned(Builder $builder): void
69			{
70			$builder->macro('withBanned', function (Builder $builder) {
71			return $builder->withoutGlobalScope($this);
72			});
73			}
74
75			/**
76			* Add the `withoutBanned` extension to the builder.
77			*
78			* @param \Illuminate\Database\Eloquent\Builder $builder
79			* @return void
80			*/
81			protected function addWithoutBanned(Builder $builder): void
82			{
83			$builder->macro('withoutBanned', function (Builder $builder) {
84			return $builder->withoutGlobalScope($this)->whereNull('banned_at');
85			});
86			}
87
88			/**
89			* Add the `onlyBanned` extension to the builder.
90			*
91			* @param \Illuminate\Database\Eloquent\Builder $builder
92			* @return void
93			*/
94			protected function addOnlyBanned(Builder $builder): void
95			{
96			$builder->macro('onlyBanned', function (Builder $builder) {
97			return $builder->withoutGlobalScope($this)->whereNotNull('banned_at');
98			});
99			}
100			}
101

cybercog / laravel-ban

BannedAtScope::addWithBanned() A last analyzed 2025-02-22 11:14 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

BannedAtScope::addWithBanned() A
last analyzed 2025-02-22 11:14 UTC