WithBulkActions::setSelectAll() - Code Metrics - Inspection of "WIP" - XetaIO/Xetaravel - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 5.0.0 ( 49e1c0...87aae2 )

by Fèvre

created 2025-04-14 19:49 UTC

WithBulkActions::setSelectAll() A

↳ Parent: WithBulkActions

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

declare(strict_types=1);

namespace Xetaravel\Livewire\Traits;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\DB;
use Masmerise\Toaster\Toastable;
use Throwable;

trait WithBulkActions
{
    use Toastable;

    /**
     * Whatever the current page of rows are all selected or not.
     *
     * @var bool
     */
    public bool $selectPage = false;

    /**
     * Whatever the user has selected all rows or not.
     *
     * @var bool
     */
    public bool $selectAll = false;

    /**
     * The id array of selected rows.
     *
     * @var Collection
     */
    public Collection $selected;

    /**
     * Filter the field on component mount regarding the allowed fields.
     *
     * @return void
     */
    public function mountWithBulkActions(): void
    {
        $this->selected = collect();
    }

    /**
     * If the selectAll is true, we need to select (and check the checkbox) of all rows
     * rendering in the current page.
     *
     * @return void
     */
    public function renderingWithBulkActions(): void
    {
        if ($this->selectAll) {
            $this->selectPageRows();
        }
    }

    /**
     * Whenever the user unselect a checkbox, we need to disable the selectAll option and selectPage.
     *
     * @return void
     */
    public function updatedSelected(): void
    {
        $this->selectAll = false;
        $this->selectPage = false;
    }

    /**
     * Whatever we have selected all rows in the current page.
     *
     * @param mixed $value The current page where all rows get selected.
     *
     * @return void|null
     */
    public function updatedSelectPage($value)
    {
        if ($value) {
            $this->selectPageRows();

            return;
        }

        $this->selectAll = false;
        $this->selected = collect();
    }

    /**
     * Convert the selected rows id into string type.
     *
     * @return void
     */
    public function selectPageRows(): void
    {
        $this->selected = $this->rows->pluck('id')->map(fn ($id) => (string) $id);
    }

    /**
     * Set selectAll to true.
     *
     * @return void
     */
    public function setSelectAll(): void
    {
        $this->selectAll = true;
    }

    /**
     * Get all select rows by their id, preparing for deleting them.
     *
     * @eturn Builder
     */
    public function getSelectedRowsQueryProperty(): Builder
    {

        return app($this->model)
            ->unless($this->selectAll, function ($query) {
            ->/** @scrutinizer ignore-call */ unless($this->selectAll, function ($query) {
                return $query->whereKey($this->selected->values());
            });
    }

    /**
     * Delete all selected rows and display a flash message.
     *
     * @return bool
     *
     * @throws Throwable
     */
    public function deleteSelected(): bool
    {
        $models = collect(
            $this->selectedRowsQuery

                ->get()
                ->pluck('id')
                ->toArray()
        );

        if ($models->count() <= 0) {
            return false;
        }

        // For each id, we fetch the model and check the permission related to the model.
        // If one fail, then they all won't be deleted.
        $models->each(function ($id) {
            $model = app($this->model)->where('id', $id)->first();
            $model = app($this->model)->/** @scrutinizer ignore-call */ where('id', $id)->first();

            $this->authorize('delete', $model);
                   authorize('delete', $model);
        });

        $model = $this->model;

        $result = DB::transaction(function () use ($model, $models) {
            return app($model)->destroy($models->toArray());
            return app($model)->/** @scrutinizer ignore-call */ destroy($models->toArray());
        });

        if ($result) {
            $this->selected = collect();

            return true;
        }

        return false;
    }
}


XetaIO / Xetaravel

Push — 5.0.0 ( 49e1c0...87aae2 )

WithBulkActions::setSelectAll() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like