Jidaikobo\Kontiki\Models\Traits\IndexTrait

Complexity

Total Complexity

10

Size/Duplication

Total Lines	87
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getPagination()	0	3	1
A	getIndexData()	0	24	1
A	applyPostTypeFilter()	0	6	2
A	applyFiltersToQuery()	0	10	1
A	applySorting()	0	12	5

<?php

namespace Jidaikobo\Kontiki\Models\Traits;

use Illuminate\Database\Query\Builder;
use Jidaikobo\Kontiki\Utils\Pagination;

trait IndexTrait
{
    protected Pagination $pagination;

    public function getIndexData(
        string $context = '',
        array $queryParams = []
    ): array {
        $query = $this->applyFiltersToQuery($context, $queryParams);

        // Set up pagination
        $totalItems = $query->count();
        $paged = (int)($queryParams['paged'] ?? 1);
        $perPage = (int)($queryParams['perPage'] ?? 10);
        $this->pagination = new Pagination($paged, $perPage);
        $this->pagination->setTotalItems($totalItems);

        // Fetch and process data
        $data = $query->limit($this->pagination->getLimit())
                      ->offset($this->pagination->getOffset())
                      ->get()
                      ->map(fn($item) => (array) $item)
                      ->toArray();

        // process data (ex: UTC to JST)
        $processedData = array_map(fn($item) => $this->processDataBeforeGet($item), $data);

It seems like processDataBeforeGet() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $processedData;
    }

    /**
     * Applies all filters and conditions to the query builder.
     *
     * @param string $context context text.
     * @param array $queryParams The query parameters.
     * @return Builder The modified query.
     */
    private function applyFiltersToQuery(
        string $context = '',
        array $queryParams = []
    ): Builder {
        $query = $this->getQuery();

It seems like getQuery() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $query = $this->buildSearchConditions($query, $queryParams['s'] ?? '');

It seems like buildSearchConditions() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $query = $this->getAdditionalConditions($query, $context);

It seems like getAdditionalConditions() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $query = $this->applySorting($query, $queryParams);
        $query = $this->applyPostTypeFilter($query);
        return $query;
    }

    /**
     * Applies sorting conditions to the query.
     *
     * @param Builder $query The query builder instance.
     * @param array $queryParams The query parameters containing sorting details.
     * @return Builder The modified query.
     */
    private function applySorting(Builder $query, array $queryParams): Builder
    {
        if (!empty($queryParams['orderby']) && !empty($queryParams['order'])) {
            $validColumns = array_keys($this->getFields());

It seems like getFields() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            $column = in_array($queryParams['orderby'], $validColumns, true) ?
                $queryParams['orderby'] :
                'id';
            $direction = strtoupper($queryParams['order']) === 'DESC' ? 'DESC' : 'ASC';
            return $query->orderBy($column, $direction);

It seems like $column can also be of type string; however, parameter $column of Illuminate\Database\Query\Builder::orderBy() does only seem to accept Closure|Illuminate\Database\Eloquent\Builder|Illuminate\Database\Query\Builder, maybe add an additional type check?

        }

        return $query->orderBy('id', 'DESC');
    }

    /**
     * Applies the post_type filter to the query.
     *
     * @param Builder $query The query builder instance.
     * @return Builder The modified query.
     */
    private function applyPostTypeFilter(Builder $query): Builder
    {
        if (!empty($this->getPostType())) {

It seems like getPostType() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            return $query->where('post_type', '=', $this->getPostType());
        }
        return $query;
    }

    public function getPagination(): Pagination
    {
        return $this->pagination;
    }
}