Xetaravel\Http\Livewire\Traits\WithBulkActions

Complexity

Total Complexity

11

Size/Duplication

Total Lines	114
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	updatedSelectPage()	0	8	2
A	selectPageRows()	0	3	1
A	getSelectedRowsQueryProperty()	0	4	1
A	selectAll()	0	3	1
A	renderingWithBulkActions()	0	4	2
A	updatedSelected()	0	4	1
A	deleteSelected()	0	14	3

<?php

namespace Xetaravel\Http\Livewire\Traits;

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

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

    /**
     * The id array of selected rows.
     *
     * @var array
     */
    public $selected = [];

    /**
     * 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
     */
    public function updatedSelectPage($value)
    {
        if ($value) {
            return $this->selectPageRows();

Are you sure the usage of $this->selectPageRows() targeting Xetaravel\Http\Livewire\Traits\WithBulkActions::selectPageRows() seems to always return null.

        }

        $this->selectAll = false;
        $this->selected = [];
    }

    /**
     * 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 selectAll(): void
    {
        $this->selectAll = true;
    }

    /**
     * Get all select rows by their id, preparing for deleting them.
     *
     * @return mixed
     */
    public function getSelectedRowsQueryProperty()
    {
        return (clone $this->rowsQuery)
            ->unless($this->selectAll, fn($query) => $query->whereKey($this->selected));
    }

    /**
     * Delete all selected rows and display a flash message.
     *
     * @return void
     */
    public function deleteSelected(): void
    {
        $deleteCount = $this->selectedRowsQuery->count();

The property selectedRowsQuery does not exist on Xetaravel\Http\Livewire\Traits\WithBulkActions. Did you mean selected?

        if ($deleteCount <= 0) {
            return;
        }

        if ($this->selectedRowsQuery->delete()) {
            $this->fireFlash('delete', 'success', $deleteCount);

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

        } else {
            $this->fireFlash('delete', 'danger');
        }
        $this->showDeleteModal = false;

The property showDeleteModal does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

    }
}