PostService::getCustomFilters() - Code Metrics - Inspection of "fix: update docs for order by" - cslant/blog-api-package - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — main (#68)

unknown

created 2025-03-26 10:03 UTC

PostService::getCustomFilters() F

↳ Parent: PostService

Complexity

Conditions	11
Paths	768

Size

Total Lines	60
Code Lines	32

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
cc	11
eloc	32
c	1
b	0
f	1
nc	768
nop	1
dl	0
loc	60
rs	3.4722

How to fix Long Method Complexity

<?php

namespace CSlant\Blog\Api\Services;

use Botble\Base\Models\BaseQueryBuilder;
filter:
    dependency_paths: ["lib/*"]
use Botble\Language\Facades\Language;
filter:
    dependency_paths: ["lib/*"]
use CSlant\Blog\Core\Http\Responses\Base\BaseHttpResponse;
use CSlant\Blog\Core\Models\Post;
use Illuminate\Contracts\Pagination\LengthAwarePaginator;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Arr;

/**
 * Class PostService
 *
 * @package CSlant\Blog\Api\Services
 *
 * @method BaseHttpResponse httpResponse()
 */
class PostService
{
    /**
     * Get posts by filters.
     *
     * @param  array<string, mixed>  $filters
     *
     * @return LengthAwarePaginator<Post>
     */
    public function getCustomFilters(array $filters): LengthAwarePaginator
    {
        $data = Post::query();

        if ($filters['tags'] !== null) {
            $tags = array_filter((array) $filters['tags']);

            $data = $data->whereHas('tags', function (Builder $query) use ($tags): void {
                $query->whereIn('tags.id', $tags);
            });
        }

        if ($filters['categories'] !== null) {
            $categories = array_filter((array) $filters['categories']);

            $data = $data->whereHas('categories', function (Builder $query) use ($categories): void {
                $query->whereIn('categories.id', $categories);
            });
        }

        if ($filters['categories_exclude'] !== null) {
            $data = $data
                ->whereHas('categories', function (Builder $query) use ($filters): void {
                    $query->whereNotIn('categories.id', array_filter((array) $filters['categories_exclude']));
                });
        }

        if ($filters['exclude'] !== null) {
            $data = $data->whereNotIn('id', array_filter((array) $filters['exclude']));
        }

        if ($filters['include'] !== null) {
            $data = $data->whereNotIn('id', array_filter((array) $filters['include']));
        }

        if ($filters['author'] !== null) {
            $data = $data->whereIn('author_id', array_filter((array) $filters['author']));
        }

        if ($filters['author_exclude'] !== null) {
            $data = $data->whereNotIn('author_id', array_filter((array) $filters['author_exclude']));
        }

        if ($filters['featured'] !== null) {
            $data = $data->where('is_featured', $filters['featured']);
        }

        if ($filters['search'] !== null) {
            $keyword = isset($filters['search']) ? (string) $filters['search'] : null;
            $data = $this->search($data, $keyword);
        }

        $orderBy = Arr::get($filters, 'order_by', 'updated_at');
        $order = Arr::get($filters, 'order', 'desc');

        $data = $data
            ->wherePublished()
            ->orderBy($orderBy, $order);

        return $data->paginate((int) $filters['per_page']);
    }

    /**
     * @param  BaseQueryBuilder|Builder<Model>  $model
     * @param  null|string  $keyword
     *
     * @return BaseQueryBuilder|Builder<Model>
     */
    protected function search(Builder|BaseQueryBuilder $model, ?string $keyword): Builder|BaseQueryBuilder
    {
        if (!$model instanceof BaseQueryBuilder || !$keyword) {
            return $model;
        }

        if (
            is_plugin_active('language') &&
            is_plugin_active('language-advanced') &&
            Language::getCurrentLocale() != Language::getDefaultLocale()
        ) {
            return $model
                ->whereHas('translations', function (BaseQueryBuilder $query) use ($keyword): void {
                    $query
                        ->addSearch('name', $keyword, false, false)
                        ->addSearch('description', $keyword, false);
                });
        }

        return $model
            ->where(function (BaseQueryBuilder $query) use ($keyword): void {
                $query
                    ->addSearch('name', $keyword, false, false)
                    ->addSearch('description', $keyword, false);
            });
    }
}


1			<?php
2
3			namespace CSlant\Blog\Api\Services;
4
5			use Botble\Base\Models\BaseQueryBuilder;
			0 ignored issues – show Bug introduced 2025-03-21 09:10 UTC by Report Bug Copy Issue Report The type `Botble\Base\Models\BaseQueryBuilder` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
6			use Botble\Language\Facades\Language;
			0 ignored issues – show Bug introduced 2025-03-26 10:07 UTC by Report Bug Copy Issue Report The type `Botble\Language\Facades\Language` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
7			use CSlant\Blog\Core\Http\Responses\Base\BaseHttpResponse;
8			use CSlant\Blog\Core\Models\Post;
9			use Illuminate\Contracts\Pagination\LengthAwarePaginator;
10			use Illuminate\Database\Eloquent\Builder;
11			use Illuminate\Database\Eloquent\Model;
12			use Illuminate\Support\Arr;
13
14			/**
15			* Class PostService
16			*
17			* @package CSlant\Blog\Api\Services
18			*
19			* @method BaseHttpResponse httpResponse()
20			*/
21			class PostService
22			{
23			/**
24			* Get posts by filters.
25			*
26			* @param array<string, mixed> $filters
27			*
28			* @return LengthAwarePaginator<Post>
29			*/
30			public function getCustomFilters(array $filters): LengthAwarePaginator
31			{
32			$data = Post::query();
33
34			if ($filters['tags'] !== null) {
35			$tags = array_filter((array) $filters['tags']);
36
37			$data = $data->whereHas('tags', function (Builder $query) use ($tags): void {
38			$query->whereIn('tags.id', $tags);
39			});
40			}
41
42			if ($filters['categories'] !== null) {
43			$categories = array_filter((array) $filters['categories']);
44
45			$data = $data->whereHas('categories', function (Builder $query) use ($categories): void {
46			$query->whereIn('categories.id', $categories);
47			});
48			}
49
50			if ($filters['categories_exclude'] !== null) {
51			$data = $data
52			->whereHas('categories', function (Builder $query) use ($filters): void {
53			$query->whereNotIn('categories.id', array_filter((array) $filters['categories_exclude']));
54			});
55			}
56
57			if ($filters['exclude'] !== null) {
58			$data = $data->whereNotIn('id', array_filter((array) $filters['exclude']));
59			}
60
61			if ($filters['include'] !== null) {
62			$data = $data->whereNotIn('id', array_filter((array) $filters['include']));
63			}
64
65			if ($filters['author'] !== null) {
66			$data = $data->whereIn('author_id', array_filter((array) $filters['author']));
67			}
68
69			if ($filters['author_exclude'] !== null) {
70			$data = $data->whereNotIn('author_id', array_filter((array) $filters['author_exclude']));
71			}
72
73			if ($filters['featured'] !== null) {
74			$data = $data->where('is_featured', $filters['featured']);
75			}
76
77			if ($filters['search'] !== null) {
78			$keyword = isset($filters['search']) ? (string) $filters['search'] : null;
79			$data = $this->search($data, $keyword);
80			}
81
82			$orderBy = Arr::get($filters, 'order_by', 'updated_at');
83			$order = Arr::get($filters, 'order', 'desc');
84
85			$data = $data
86			->wherePublished()
87			->orderBy($orderBy, $order);
88
89			return $data->paginate((int) $filters['per_page']);
90			}
91
92			/**
93			* @param BaseQueryBuilder\|Builder<Model> $model
94			* @param null\|string $keyword
95			*
96			* @return BaseQueryBuilder\|Builder<Model>
97			*/
98			protected function search(Builder\|BaseQueryBuilder $model, ?string $keyword): Builder\|BaseQueryBuilder
99			{
100			if (!$model instanceof BaseQueryBuilder \|\| !$keyword) {
101			return $model;
102			}
103
104			if (
105			is_plugin_active('language') &&
106			is_plugin_active('language-advanced') &&
107			Language::getCurrentLocale() != Language::getDefaultLocale()
108			) {
109			return $model
110			->whereHas('translations', function (BaseQueryBuilder $query) use ($keyword): void {
111			$query
112			->addSearch('name', $keyword, false, false)
113			->addSearch('description', $keyword, false);
114			});
115			}
116
117			return $model
118			->where(function (BaseQueryBuilder $query) use ($keyword): void {
119			$query
120			->addSearch('name', $keyword, false, false)
121			->addSearch('description', $keyword, false);
122			});
123			}
124			}
125

cslant / blog-api-package

Pull Request — main (#68)

PostService::getCustomFilters() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like