lekoala / silverstripe-blocks

src/BlockFieldList.php

<?php

namespace LeKoala\Blocks;

use SilverStripe\Forms\FormField;
use LeKoala\Blocks\Fields\BlockButtonField;
use SilverStripe\AssetAdmin\Forms\UploadField;
use LeKoala\Blocks\Fields\BlockHTMLEditorField;

/**
 * Easily add fields to your blocks
 *
 * TODO: extract BuildableFieldList from module to separate form module
 */
class BlockFieldList extends BuildableFieldList
{
    /**
     * @var string
     */
    protected $defaultTab = 'Main';

    /**
     * The key to store data to. Typically BlockData or Settings
     *
     * @var string
     */
    protected $defaultKey = 'BlockData';

    /**
     * Automatically expand the given name to match the default key
     * and items if necessary
     *
     * @param string|array $name The key or a composite key like [2, "FieldName"].
     * @param string $baseKey Will use defaultKey if not provided. Use '' for no key.
     * @return string
     */
    protected function normalizeName($name, $baseKey = null)
    {
        if ($baseKey === null) {
            $baseKey = $this->defaultKey;
        }
        if (is_array($name)) {
            $itemsKey = Block::ITEMS_KEY;
            $idx = $name[0];
            $key = $name[1];
            $name = $baseKey . '[' . $itemsKey . '][' . $idx . '][' . $key . ']';
        } else {
            if ($baseKey) {
                $name = $baseKey . '[' . $name . ']';
            }
        }
        return $name;
    }

    protected function normalizeTitle($name, $title = "")
    {
        $name = str_replace([$this->defaultKey . '[', ']'], '', $name);
        return parent::normalizeTitle($name, $title);
    }

    /**
     * Get our default uploader
     *
     * @return string
     */
    public static function getUploaderClass()
    {
        if (class_exists(\LeKoala\Base\Forms\SmartSortableUploadField::class)) {

The type LeKoala\Base\Forms\SmartSortableUploadField was not found. Maybe you did not declare it correctly or list all dependencies?

            return \LeKoala\Base\Forms\SmartSortableUploadField::class;
        } elseif (class_exists(\Bummzack\SortableFile\Forms\SortableUploadField::class)) {
            return \Bummzack\SortableFile\Forms\SortableUploadField::class;
        }
        return UploadField::class;
    }

    /**
     * Add a sortable Files uploader
     *
     * @param array $attributes
     * @param string $title
     * @return UploadField
     */
    public function addFiles($attributes = [], $title = null)
    {
        $class = self::getUploaderClass();
        $name = "Files";
        return parent::addField($class, $name, $title, $attributes);
    }

    /**
     * Add a sortable Images uploader
     *
     * @param array $attributes
     * @param string $title
     * @return UploadField
     */
    public function addImages($attributes = [], $title = null)
    {
        $class = self::getUploaderClass();
        $name = "Images";
        return parent::addField($class, $name, $title, $attributes);
    }

    /**
     * Convenience methods to add settings
     *
     * @param callable $cb
     * @return void
     */
    public function addSettings($cb)
    {
        $tab = $this->getDefaultTab();
        $key = $this->getDefaultKey();
        $this->setCurrentTab('Settings');
        $this->setDefaultKey('Settings');

        $cb($this);

        $this->setCurrentTab($tab);
        $this->setDefaultKey($key);
    }

    /**
     * Add a field to the list
     *
     * Supports adding items from lists which will be available
     * under the "Items" list
     *
     * see : $data[self::ITEMS_KEY] = self::normalizeIndexedList($data[self::ITEMS_KEY]);
     *
     * @param string $class
     * @param string|array $name Pass an array as [$idx, $name] to specify an item from a list
     * @param string $title
     * @param array $attributes
     * @return FormField
     */
    public function addField($class, $name, $title = "", $attributes = [])
    {
        $name = $this->normalizeName($name);
        return parent::addField($class, $name, $title, $attributes);
    }

    /**
     * @param string $name
     * @param string $title
     * @return BlockButtonField
     */
    public function addButton($name = "Button", $title = null)
    {
        return $this->addField(BlockButtonField::class, $name, $title);
    }

    /**
     * @param string $name
     * @param string $title
     * @param array $attributes
     * @return BlockHTMLEditorField
     */
    public function addEditor($name = "Description", $title = null, $attributes = [])
    {
        return $this->addField(BlockHTMLEditorField::class, $name, $title, $attributes);
    }


    /**
     * Get the value of defaultKey
     */
    public function getDefaultKey()
    {
        return $this->defaultKey;
    }

    /**
     * Set the value of defaultKey
     *
     * @return $this
     */
    public function setDefaultKey($defaultKey)
    {
        $this->defaultKey = $defaultKey;
        return $this;
    }

    /**
     * @param string $key
     * @param callable $callable
     * @return $this
     */
    public function withKey($key, $callable)
    {
        $defaultKey = $this->getDefaultKey();
        $this->setDefaultKey($key);
        $callable($this);
        $this->setDefaultKey($defaultKey);
        return $this;
    }
}