Backpack\CRUD\PanelTraits\Buttons

Complexity

Total Complexity

23

Size/Duplication

Total Lines	162
Duplicated Lines	9.88 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

80%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	addButtonFromModelFunction()	0	4	1
A	addButtonFromView()	0	6	1
A	buttons()	0	4	1
A	addButton()	0	31	5
A	removeButton()	0	6	3
A	initButtons()	0	15	1
A	modifyButton()	16	19	4
A	removeAllButtons()	0	4	1
A	removeAllButtonsFromStack()	0	6	1
A	removeButtonFromStack()	0	6	2
A	removeButtons()	0	8	3

<?php

namespace Backpack\CRUD\PanelTraits;

use Illuminate\Support\Collection;

trait Buttons
{
    // ------------
    // BUTTONS
    // ------------

    // TODO: $this->crud->reorderButtons('stack_name', ['one', 'two']);

    /**
     * Add a button to the CRUD table view.
     *
     * @param string      $stack           Where should the button be visible? Options: top, line, bottom.
     * @param string      $name            The name of the button. Unique.
     * @param string      $type            Type of button: view or model_function.
     * @param string      $content         The HTML for the button.
     * @param bool|string $position        Position on the stack: beginning or end. If false, the position will be
     *                                     'beginning' for the line stack or 'end' otherwise.
     * @param bool        $replaceExisting True if a button with the same name on the given stack should be replaced.
     *
     * @return \Backpack\CRUD\PanelTraits\CrudButton The new CRUD button.
     */
    public function addButton($stack, $name, $type, $content, $position = false, $replaceExisting = true)
    {
        if ($position == false) {
            switch ($stack) {
                case 'line':
                    $position = 'beginning';
                    break;

                default:
                    $position = 'end';
                    break;
            }
        }

        if ($replaceExisting) {
            $this->removeButton($name, $stack);
        }

        $button = new CrudButton($stack, $name, $type, $content);
        switch ($position) {
            case 'beginning':
                $this->buttons->prepend($button);

The property buttons does not exist. Did you maybe forget to declare it?

                break;

            default:
                $this->buttons->push($button);
                break;
        }

        return $button;
    }

    public function addButtonFromModelFunction($stack, $name, $model_function_name, $position = false)
    {
        $this->addButton($stack, $name, 'model_function', $model_function_name, $position);
    }

    public function addButtonFromView($stack, $name, $view, $position = false)
    {
        $view = 'crud::buttons.'.$view;

        $this->addButton($stack, $name, 'view', $view, $position);
    }

    /**
     * @return Collection
     */
    public function buttons()
    {
        return $this->buttons;
    }

    public function initButtons()
    {
        $this->buttons = collect();

        // line stack
        $this->addButton('line', 'show', 'view', 'crud::buttons.show', 'end');
        $this->addButton('line', 'update', 'view', 'crud::buttons.update', 'end');
        $this->addButton('line', 'revisions', 'view', 'crud::buttons.revisions', 'end');
        $this->addButton('line', 'clone', 'view', 'crud::buttons.clone', 'end');
        $this->addButton('line', 'delete', 'view', 'crud::buttons.delete', 'end');

        // top stack
        $this->addButton('top', 'create', 'view', 'crud::buttons.create');
        $this->addButton('top', 'reorder', 'view', 'crud::buttons.reorder');
    }

    /**
     * Modify the attributes of a button.
     *
     * @param  string $name          The button name.
     * @param  array  $modifications The attributes and their new values.

Should the type for parameter $modifications not be array|null? Also, consider making the array more specific, something like array<String>, or String[].

     *
     * @return CrudButton                The button that has suffered the changes, for daisychaining methods.
     */
    public function modifyButton($name, $modifications = null)

This method seems to be duplicated in your project.

    {
        /**
         * @var CrudButton|null
         */
        $button = $this->buttons()->firstWhere('name', $name);

        if (! $button) {
            abort(500, 'CRUD Button "'.$name.'" not found. Please check the button exists before you modify it.');
        }

        if (is_array($modifications)) {
            foreach ($modifications as $key => $value) {
                $button->{$key} = $value;
            }
        }

        return $button;
    }

    /**
     * Remove a button from the CRUD panel.
     *
     * @param string $name  Button name.
     * @param string $stack Optional stack name.

Should the type for parameter $stack not be string|null?

     */
    public function removeButton($name, $stack = null)
    {
        $this->buttons = $this->buttons->reject(function ($button) use ($name, $stack) {
            return $stack == null ? $button->name == $name : ($button->stack == $stack) && ($button->name == $name);

It seems like you are loosely comparing $stack of type string|null against null; this is ambiguous if the string can be empty. Consider using a strict comparison === instead.

        });
    }

    /**
     * @param array $names Button names
     * @param string|null $stack Optional stack name.
     */
    public function removeButtons($names, $stack = null)
    {
        if (! empty($names)) {
            foreach ($names as $name) {
                $this->removeButton($name, $stack);
            }
        }
    }

    public function removeAllButtons()
    {
        $this->buttons = collect([]);
    }

    public function removeAllButtonsFromStack($stack)
    {
        $this->buttons = $this->buttons->reject(function ($button) use ($stack) {
            return $button->stack == $stack;
        });
    }

    public function removeButtonFromStack($name, $stack)
    {
        $this->buttons = $this->buttons->reject(function ($button) use ($name, $stack) {
            return $button->name == $name && $button->stack == $stack;
        });
    }
}

class CrudButton
{
    public $stack;
    public $name;
    public $type = 'view';
    public $content;

    public function __construct($stack, $name, $type, $content)
    {
        $this->stack = $stack;
        $this->name = $name;
        $this->type = $type;
        $this->content = $content;
    }
}