lekoala / silverstripe-cms-actions

src/CustomButton.php

<?php

namespace LeKoala\CmsActions;

use SilverStripe\View\HTML;

/**
 * Common button functionnality that is shared between CustomAction and CustomLink
 */
trait CustomButton
{
    /**
     * Default classes applied in constructor
     * @config
     * @var array
     */
    private static $default_classes = [
        'btn',
        'btn-info'
    ];

    /**
     * Whether to place the button in a dot-menu
     * @var bool
     */
    protected $dropUp = false;

    /**
     * An icon for this button
     * @var string|null
     */
    protected $buttonIcon;

    /**
     * An icon using l-i element
     * @var array
     */
    protected $lastIcon = [];

    /**
     * The confirmation message
     * @var string
     */
    protected $confirmation;

    /**
     * Get the title of the link
     * Called by ActionsGridFieldItemRequest to build default message
     *
     * @return string
     */
    public function getTitle()
    {
        return $this->title;
    }

    /**
     * Set the value of title
     *
     * @param string $title
     * @return $this
     */
    public function setTitle($title)
    {
        $this->title = $title;

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

        return $this;
    }

    /**
     * Get the dropUp value
     * Called by ActionsGridFieldItemRequest to determine placement
     *
     * @return bool
     */
    public function getDropUp()
    {
        return $this->dropUp;
    }

    /**
     * Set the value of dropUp
     *
     * @param bool $is
     * @return $this
     */
    public function setDropUp($is)
    {
        $this->dropUp = !!$is;

        return $this;
    }

    /**
     * @param string $type
     * @return $this
     */
    public function setButtonType($type)
    {
        if ($this->extraClasses) {
            foreach ($this->extraClasses as $k => $v) {
                if (strpos($k, 'btn-') !== false) {
                    unset($this->extraClasses[$k]);
                }
            }
        }

        $btn = sprintf('btn-%s', $type);
        $this->extraClasses[$btn] = $btn;

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

        return $this;
    }

    /**
     * Get the title with icon if set
     *
     * @return string
     */
    protected function getButtonTitle()
    {
        return $this->title;
    }

    /**
     * Get an icon for this button
     *
     * @return string
     */
    public function getButtonIcon()
    {
        return $this->buttonIcon;
    }

    /**
     * Set an icon for this button
     *
     * Feel free to use SilverStripeIcons constants
     *
     * @param string $buttonIcon An icon for this button
     * @return $this
     */
    public function setButtonIcon(string $buttonIcon)
    {
        $this->buttonIcon = $buttonIcon;

        return $this;
    }

    /**
     * Get an icon for this button
     *
     * @return array
     */
    public function getLastIcon()
    {
        return $this->lastIcon;
    }

    /**
     * Set an icon for this button
     *
     * @param string|array $lastIcon An icon for this button
     * @param string $set
     * @param string $type
     * @param string $size
     * @return $this
     */
    public function setLastIcon($lastIcon, $set = null, $type = null, $size = null)
    {
        if (is_string($lastIcon)) {
            $lastIcon = [
                'name' => $lastIcon
            ];
        }
        if ($set) {
            $lastIcon['set'] = $set;
        }
        if ($type) {
            $lastIcon['type'] = $type;
        }
        if ($size) {
            $lastIcon['size'] = $size;
        }
        $this->lastIcon = $lastIcon;

        return $this;
    }

    /**
     * @return boolean
     */
    public function hasLastIcon()
    {
        return !empty($this->lastIcon['name']);
    }

    /**
     * @return string
     */
    public function renderLastIcon()
    {
        if (!$this->hasLastIcon()) {
            return '';
        }
        return HTML::createTag('l-i', $this->lastIcon);
    }

    /**
     * Get the value of confirmation
     * @return bool|string
     */
    public function getConfirmation()
    {
        return $this->confirmation;
    }

    /**
     * Set the value of confirmation
     *
     * @param string|bool $confirmation A confirm message or true for a generic message
     * @return $this
     */
    public function setConfirmation($confirmation)
    {
        if ($confirmation === true) {
            $confirmation = _t('CustomButton.CONFIRM_MESSAGE', 'Are you sure?');
        }
        $this->confirmation = $confirmation;

        return $this;
    }
}