sunnysideup / silverstripe-cms-niceties

src/Forms/CheckboxSetFieldWithLinks.php

<?php

namespace Sunnysideup\CMSNiceties\Forms;

use SilverStripe\Forms\CheckboxSetField;
use SilverStripe\ORM\ArrayList;
use SilverStripe\ORM\FieldType\DBField;

class CheckboxSetFieldWithLinks extends CheckboxSetField
{
    protected $classNameForLinks = '';

    protected $isReact = '';

    protected $linksPerOption = [];

    public function getTemplate()
    {
        return self::class;
    }

    public function setClassNameForLinks(string $s): self
    {
        $this->classNameForLinks = $s;

        return $this;
    }

    public function getClassNameForLinks(): string
    {
        return $this->classNameForLinks;
    }

    public function setIsReact(bool $b): self
    {
        $this->isReact = $b;

        return $this;
    }

    public function getIsReact(): bool
    {
        return $this->isReact;

The expression return $this->isReact returns the type string which is incompatible with the type-hinted return boolean.

    }

    /**
     * Gets the list of options to render in this formfield.
     *
     * @return ArrayList
     */
    public function getOptions()
    {
        $options = parent::getOptions();
        $className = $this->getClassNameForLinks();
        if ($className !== '' && $className !== '0') {
            foreach ($options as $option) {
                $obj = $className::get_by_id($option->Value);
                if ($obj && $obj->hasMethod('CMSEditLink')) {
                    $link = $obj->CMSEditLink();
                    if ($option->isChecked) {
                        $this->linksPerOption[] = '<a href="' . $link . '">' . $option->Title . '</a>';
                    }

                    $option->setField('Link', $link);
                    $option->setField(
                        'Title',
                        DBField::create_field('HTMLText', '<a href="' . $link . '">' . $option->Title . '</a>')
                    );
                }
            }
        }

        return $options;
    }

    public function getLinksPerOption(): array
    {
        return $this->linksPerOption;
    }

    public function getLinksPerOptionAsString(): string
    {
        return implode(', ', $this->linksPerOption);
    }

    public function Type()
    {
        return 'optionset checkboxset checkboxsetwithlinks';
    }

    public function getDescription()
    {
        $this->getOptions();
        if ($this->isReact) {
            $this->description .= 'Quick Edit: <br />' . $this->getLinksPerOptionAsString();
        }

        return $this->description;
    }
}