Giftd\Editor\Customization

Complexity

Total Complexity

21

Size/Duplication

Total Lines	249
Duplicated Lines	0 %

Coupling/Cohesion

Components	4
Dependencies	2

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
	editables()	0	1	?
	build()	0	1	?
A	settingsMap()	0	6	1
A	beforeSaving()	0	4	1
A	save()	0	8	1
A	get()	0	4	1
A	all()	0	4	1
A	setPreviewData()	0	16	3
A	setSettings()	0	6	1
A	disableEditables()	0	12	3
A	getDisabledEditables()	0	4	1
A	renamePreviewDataKeys()	0	15	4
A	setting()	0	4	1
A	settingWithPlaceholders()	0	6	1
A	group()	0	8	1
A	editable()	0	8	1

<?php

namespace Giftd\Editor;

abstract class Customization
{
    /**
     * Actual customization data.
     *
     * @var array
     */
    protected $data = [];

    /**
     * Customization-related settings.
     *
     * @var SettingsManager
     */
    protected $settings;

    /**
     * List of disabled common editables names.
     *
     * @var array
     */
    protected $disabledEditables = [];

    /**
     * Creates groupped editables list.
     *
     * @return array
     */
    abstract public function editables();

    /**
     * Builds template data.
     *
     * @return mixed
     */
    abstract public function build();

    /**
     * Returns ['customization_name' => 'setting_key'] map.
     *
     * @return array
     */
    public function settingsMap()
    {
        return [
            //
        ];
    }

    /**
     * Triggers before the save settings operation.
     */
    public function beforeSaving()
    {
        //
    }

    /**
     * Saves customization settings.
     *
     * @return $this
     */
    public function save()
    {
        $this->beforeSaving();

        $this->settings->saveReplaced();

        return $this;
    }

    /**
     * Returns value for given customization data key or default value.
     *
     * @param string $key
     * @param mixed  $defaultValue = null
     *
     * @return mixed
     */
    public function get(string $key, $defaultValue = null)
    {
        return $this->data[$key] ?? $defaultValue;
    }

    /**
     * Returns customization data.
     *
     * @return array
     */
    public function all()
    {
        return $this->data;
    }

    /**
     * Sets preview data.
     *
     * @param array $previewData
     *
     * @return $this
     */
    public function setPreviewData(array $previewData = [])
    {
        if (!count($previewData)) {
            return $this;
        }

        $settingsMap = $this->settingsMap();

        if (count($settingsMap) > 0) {
            $previewData = $this->renamePreviewDataKeys($previewData, $settingsMap);
        }

        $this->settings->replace($previewData);

        return $this;
    }

    /**
     * Sets settings manager.
     *
     * @param SettingsManager $settings
     *
     * @return $this
     */
    public function setSettings(SettingsManager $settings)
    {
        $this->settings = $settings;

        return $this;
    }

    /**
     * @param array|string $editables
     *
     * @return $this
     */
    public function disableEditables($editables)
    {
        if (is_string($editables)) {
            $editables = [$editables];
        } elseif (!is_array($editables)) {
            throw new \InvalidArgumentException('Editables must be an array or string, '.gettype($editables).' given');
        }

        $this->disabledEditables = array_merge($this->disabledEditables, $editables);

        return $this;
    }

    /**
     * @return array
     */
    public function getDisabledEditables()
    {
        return $this->disabledEditables;
    }

    /**
     * Renames customization keys to settings keys.
     *
     * @param array $previewData
     * @param array $map
     *
     * @return array
     */
    protected function renamePreviewDataKeys(array $previewData, array $map)
    {
        foreach ($map as $customizationName => $settingsKey) {
            if (!array_key_exists($customizationName, $previewData)) {
                continue;
            } elseif ($customizationName === $settingsKey) {
                continue;
            }

            $previewData[$settingsKey] = $previewData[$customizationName];
            unset($previewData[$customizationName]);
        }

        return $previewData;
    }

    /**
     * Returns value from preview data or default value.
     *
     * @param string $key
     * @param null   $defaultValue
     *
     * @return mixed|null
     */
    protected function setting(string $key, $defaultValue = null)
    {
        return $this->settings->get($key, $defaultValue);
    }

    /**
     * Returns value from preview data or default value with replaced placeholders.
     *
     * @param string $key
     * @param array  $placeholders
     * @param null   $defaultValue
     *
     * @return string
     */
    protected function settingWithPlaceholders(string $key, array $placeholders = [], $defaultValue = null)
    {
        $text = $this->setting($key, $defaultValue);

        return $this->settings->replacePlaceholders($text, $placeholders);
    }

    /**
     * Creates new editables group.
     *
     * @param string   $id
     * @param string   $title
     * @param \Closure $settingsFactory
     *
     * @return array
     */
    protected function group(string $id, string $title, \Closure $settingsFactory)
    {
        return [
            'id' => $id,
            'title' => $title,
            'settings' => $settingsFactory(),
        ];
    }

    /**
     * Creates new Editable.
     *
     * @param string      $name
     * @param string      $type
     * @param string|null $title
     * @param null        $value
     * @param array       $attributes
     *
     * @return Editable
     */
    protected function editable(string $name, string $type, string $title = null, $value = null, array $attributes = [])
    {
        return (new Editable($name))
            ->titledAs($title)
            ->usingType($type)
            ->withValue($value)
            ->withAttributes($attributes);
    }
}