Backpack\CRUD\app\Library\CrudPanel\CrudButton

Complexity

Total Complexity

43

Size/Duplication

Total Lines	496
Duplicated Lines	0 %

Importance

Changes	4
Bugs	0	Features	1

31 Methods

Rating	Name	Duplication	Size	Complexity
A	type()	0	5	1
A	__construct()	0	20	3
A	add()	0	3	1
A	name()	0	3	1
A	stack()	0	5	1
A	content()	0	5	1
A	view()	0	6	1
A	make()	0	6	1
A	meta()	0	5	1
A	save()	0	26	4
A	crud()	0	3	1
A	before()	0	5	1
A	after()	0	5	1
A	makeFirst()	0	3	1
A	toArray()	0	3	1
A	forget()	0	5	1
A	getKey()	0	3	1
A	remove()	0	3	1
A	section()	0	3	1
A	group()	0	3	1
A	getFinalViewPath()	0	9	3
A	makeLast()	0	3	1
A	position()	0	17	3
A	getHtml()	0	18	4
A	model_function()	0	3	1
A	to()	0	3	1
A	dd()	0	5	1
A	collection()	0	3	1
A	getViewPathsWithFallbacks()	0	8	1
A	modelFunction()	0	7	1
A	dump()	0	5	1

<?php

namespace Backpack\CRUD\app\Library\CrudPanel;

use Backpack\CRUD\ViewNamespaces;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Support\Traits\Conditionable;

/**
 * Adds fluent syntax to Backpack CRUD Buttons.
 *
 * In addition to the existing:
 * - CRUD::addButton('top', 'create', 'view', 'crud::buttons.create');
 *
 * Developers can also do:
 * - CRUD::button('create')->stack('top')->view('crud::buttons.create');
 *
 * And if the developer uses CrudButton as Button in their CrudController:
 * - Button::name('create')->stack('top')->view('crud::butons.create');
 */
class CrudButton implements Arrayable
{
    use Conditionable;

    public $stack;

    public $name;

    public $type;

    public $content;

    public $position;

    public $meta = [];

    public function __construct($nameOrAttributes, $stack = null, $type = null, $content = null, $position = null, $meta = [])
    {
        // in case an array was passed as name
        // assume it's an array that includes [$name, $stack, $type, $content]
        if (is_array($nameOrAttributes)) {
            extract($nameOrAttributes);
        }

        $this->name = $nameOrAttributes ?? 'button_'.rand(1, 999999999);
        $this->stack = $stack ?? 'top';
        $this->type = $type ?? 'view';
        $this->content = $content;
        $this->meta = $meta;

        // if no position was passed, the defaults are:
        // - 'beginning' for the 'line' stack
        // - 'end' for all other stacks
        $this->position = $position ?? ($this->stack == 'line' ? 'beginning' : 'end');

        return $this->save();
    }

    // ------
    // MAKERS
    // ------

    /**
     * Add a new button to the default stack.
     *
     * @param  string|array  $nameOrAttributes  Button name or array that contains name, stack, type and content.
     */
    public static function name($nameOrAttributes)
    {
        return new static($nameOrAttributes);
    }

    /**
     * Add a new button to the default stack.
     *
     * @param  string|array  $nameOrAttributes  Button name or array that contains name, stack, type and content.
     */
    public static function add($nameOrAttributes)
    {
        return new static($nameOrAttributes);
    }

    /**
     * This method allows one to create a button without attaching it to any 'real'
     * button stack, by moving it to a 'hidden' stack.
     *
     * It exists for one reason: so that developers can add buttons to a custom array, without
     * adding them to one of the button stacks.
     *
     * Ex: when developers need to pass multiple buttons as contents of the
     * div button. But they don't want them added to the before_content of after_content
     * stacks. So what they do is basically add them to a 'hidden' stack, that nobody will ever see.
     *
     * @param  string|array  $nameOrAttributes  Button name or array that contains name, stack, type and content.
     * @return CrudButton
     */
    public static function make($nameOrAttributes)
    {
        $button = static::add($nameOrAttributes);
        $button->stack('hidden');

        return $button;
    }

    // -------
    // SETTERS
    // -------

    /**
     * Set the button stack (where the button will be shown).
     *
     * @param  string  $stack  The name of the stack where the button should be moved.
     * @return CrudButton
     */
    public function stack($stack)
    {
        $this->stack = $stack;

        return $this->save();
    }

    /**
     * Sets the button type (view or model_function).
     *
     * @param  string  $type  The type of button - view or model_function.
     * @return CrudButton
     */
    public function type($type)
    {
        $this->type = $type;

        return $this->save();
    }

    /**
     * Sets the content of the button.
     * For the view button type, set it to the view path, including namespace.
     * For the model_function button type, set it to the name of the method on the model.
     *
     * @param  string  $content  Path to view or name of method on Model.
     * @return CrudButton
     */
    public function content($content)
    {
        $this->content = $content;

        return $this->save();
    }

    /**
     * Sets the namespace and path of the view for this button.
     * Sets the button type as 'view'.
     *
     * @param  string  $value  Path to view file.
     * @return CrudButton
     */
    public function view($value)
    {
        $this->content = $value;
        $this->type = 'view';

        return $this->save();
    }

    /**
     * Set the button position. Defines where the button will be shown
     * in regard to other buttons in the same stack.
     *
     * @param  string  $stack  'beginning' or 'end'
     * @return CrudButton
     */
    public function position($position)
    {
        switch ($position) {
            case 'beginning':
                $this->makeFirst();
                break;

            case 'end':
                $this->makeLast();
                break;

            default:
                abort(500, "Unknown button position - please use 'beginning' or 'end'.");
                break;
        }

        return $this->save();
    }

    /**
     * Sets the meta that will be available in the view.
     *
     * @param  array  $value  Array of metadata that will be available in the view.
     * @return CrudButton
     */
    public function meta($value)
    {
        $this->meta = $value;

        return $this->save();
    }

    /**
     * Sets the name of the method on the model that contains the HTML for this button.
     * Sets the button type as 'model_function'.
     *
     * @param  string  $value  Name of the method on the model.
     * @return CrudButton
     */
    public function modelFunction($value)
    {
        $this->content = $value;
        $this->type = 'model_function';
        $this->stack = 'line';

        return $this->save();
    }

    /**
     * Sets the name of the method on the model that contains the HTML for this button.
     * Sets the button type as 'model_function'.
     * Alias of the modelFunction() method.
     *
     * @param  string  $value  Name of the method on the model.
     * @return CrudButton
     */
    public function model_function($value)
    {
        return $this->modelFunction($value);
    }

    /**
     * Unserts an property that is set on the current button.
     * Possible properties: name, stack, type, content.
     *
     * @param  string  $property  Name of the property that should be cleared.
     * @return CrudButton
     */
    public function forget($property)
    {
        $this->{$property} = null;

        return $this->save();
    }

    // --------------
    // SETTER ALIASES
    // --------------

    /**
     * Moves the button to a certain button stack.
     * Alias of stack().
     *
     * @param  string  $stack  The name of the stack where the button should be moved.
     * @return self
     */
    public function to($stack)
    {
        return $this->stack($stack);
    }

    /**
     * Moves the button to a certain button stack.
     * Alias of stack().
     *
     * @param  string  $stack  The name of the stack where the button should be moved.
     * @return self
     */
    public function group($stack)
    {
        return $this->stack($stack);
    }

    /**
     * Moves the button to a certain button stack.
     * Alias of stack().
     *
     * @param  string  $stack  The name of the stack where the button should be moved.
     * @return self
     */
    public function section($stack)
    {
        return $this->stack($stack);
    }

    // -------
    // GETTERS
    // -------

    /**
     * Get the end result that should be displayed to the user.
     * The HTML itself of the button.
     *
     * @param  object|null  $entry  The eloquent Model for the current entry or null if no current entry.
     * @return \Illuminate\Contracts\View\View
     */
    public function getHtml($entry = null)
    {
        $button = $this;
        $crud = $this->crud();

        if ($this->type == 'model_function') {
            if (is_null($entry)) {
                return $crud->model->{$button->content}($crud);
            }

            return $entry->{$button->content}($crud);
        }

        if ($this->type == 'view') {
            return view($button->getFinalViewPath(), compact('button', 'crud', 'entry'));
        }

        abort(500, 'Unknown button type');
    }

    /**
     * Get an array of full paths to the filter view, consisting of:
     * - the path given in the button definition
     * - fallback view paths as configured in backpack/config/crud.php.
     *
     * @return array
     */
    private function getViewPathsWithFallbacks()
    {
        $type = $this->name;
        $paths = array_map(function ($item) use ($type) {
            return $item.'.'.$type;
        }, ViewNamespaces::getFor('buttons'));

        return array_merge([$this->content], $paths);
    }

    private function getFinalViewPath()
    {
        foreach ($this->getViewPathsWithFallbacks() as $path) {
            if (view()->exists($path)) {
                return $path;
            }
        }

        abort(500, 'Button view and fallbacks do not exist for '.$this->name.' button.');
    }

    /**
     * Get the key for this button in the global buttons collection.
     *
     * @return int
     */
    public function getKey()
    {
        return $this->crud()->getButtonKey($this->name);

The expression return $this->crud()->getButtonKey($this->name) returns the type string which is incompatible with the documented return type integer.

    }

    // -----
    // ORDER
    // -----
    // Manipulate the button collection (inside the global CrudPanel object).

    /**
     * Move this button to be the first in the buttons list.
     *
     * @return CrudButton
     */
    public function makeFirst()
    {
        return $this->before($this->collection()->first()->name);

The expression return $this->before($this->collection()->first()->name) returns the type Backpack\CRUD\app\Library\CrudPanel\CrudFilter which is incompatible with the documented return type Backpack\CRUD\app\Library\CrudPanel\CrudButton.

    }

    /**
     * Move this button to be the last one in the buttons list.
     *
     * @return CrudButton
     */
    public function makeLast()
    {
        return $this->after($this->collection()->last()->name);

The expression return $this->after($this->collection()->last()->name) returns the type Backpack\CRUD\app\Library\CrudPanel\CrudFilter which is incompatible with the documented return type Backpack\CRUD\app\Library\CrudPanel\CrudButton.

    }

    /**
     * Move the current filter after another filter.
     *
     * @param  string  $destination  Name of the destination filter.
     * @return CrudFilter
     */
    public function after($destination)
    {
        $this->crud()->moveButton($this->name, 'after', $destination);

        return $this;

The expression return $this returns the type Backpack\CRUD\app\Library\CrudPanel\CrudButton which is incompatible with the documented return type Backpack\CRUD\app\Library\CrudPanel\CrudFilter.

    }

    /**
     * Move the current field before another field.
     *
     * @param  string  $destination  Name of the destination field.
     * @return CrudFilter
     */
    public function before($destination)
    {
        $this->crud()->moveButton($this->name, 'before', $destination);

        return $this;

The expression return $this returns the type Backpack\CRUD\app\Library\CrudPanel\CrudButton which is incompatible with the documented return type Backpack\CRUD\app\Library\CrudPanel\CrudFilter.

    }

    /**
     * Remove the button from the global button collection.
     *
     * @return void
     */
    public function remove()
    {
        $this->crud()->removeButton($this->getKey());
    }

    // --------------
    // GLOBAL OBJECTS
    // --------------
    // Access to the objects stored in Laravel's service container.

    /**
     * Access the global collection when all buttons are stored.
     *
     * @return \Illuminate\Support\Collection
     */
    public function collection()
    {
        return $this->crud()->buttons();
    }

    /**
     * Access the global CrudPanel object.
     *
     * @return \Backpack\CRUD\app\Library\CrudPanel\CrudPanel
     */
    public function crud()
    {
        return app('crud');
    }

    // -----------------
    // DEBUGGING METHODS
    // -----------------

    /**
     * Dump the current object to the screen,
     * so that the developer can see its contents.
     *
     * @codeCoverageIgnore
     *
     * @return CrudButton
     */
    public function dump()
    {
        dump($this);

        return $this;
    }

    /**
     * Dump and die. Duumps the current object to the screen,
     * so that the developer can see its contents, then stops
     * the execution.
     *
     * @codeCoverageIgnore
     *
     * @return CrudButton
     */
    public function dd()
    {
        dd($this);

        return $this;
    }

    // ---------------
    // PRIVATE METHODS
    // ---------------

    /**
     * Update the global CrudPanel object with the current button.
     *
     * @return CrudButton
     */
    private function save()
    {
        if ($this->collection()->isEmpty()) {
            $this->crud()->addCrudButton($this);

            return $this;
        }

        $itemExists = $this->collection()->contains('name', $this->name);

        if (! $itemExists) {
            $this->crud()->addCrudButton($this);
            if ($this->position == 'beginning') {
                $this->before($this->collection()->first()->name);
            } else {
                $this->after($this->collection()->last()->name);
            }

            // clear the custom position, so that the next daisy chained method
            // doesn't move it yet again
            $this->position = null;
        } else {
            $this->crud()->modifyButton($this->name, $this->toArray());
        }

        return $this;
    }

    public function toArray()
    {
        return (array) $this;
    }
}