Customization::beforeSaving() - Code Metrics - Inspection of "Save settings" - tzurbaev/giftd-editor-manager - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 914e3f...2b201f )

by Timur

created 2017-05-18 12:24 UTC

Customization::beforeSaving() A

↳ Parent: Customization

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	1
nc	1
nop	0

<?php

namespace Giftd\Editor;

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

    /**
     * Preview data.
     *
     * @var array
     */
    protected $previewData = [];

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

    /**
     * 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 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;
    }

    /**
     * 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;
            }

            $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);
    }
}


1			<?php
2
3			namespace Giftd\Editor;
4
5			abstract class Customization
6			{
7			/**
8			* Actual customization data.
9			*
10			* @var array
11			*/
12			protected $data = [];
13
14			/**
15			* Preview data.
16			*
17			* @var array
18			*/
19			protected $previewData = [];
20
21			/**
22			* Customization-related settings.
23			*
24			* @var SettingsManager
25			*/
26			protected $settings;
27
28			/**
29			* Creates groupped editables list.
30			*
31			* @return array
32			*/
33			abstract public function editables();
34
35			/**
36			* Builds template data.
37			*
38			* @return mixed
39			*/
40			abstract public function build();
41
42			/**
43			* Returns ['customization_name' => 'setting_key'] map.
44			*
45			* @return array
46			*/
47			public function settingsMap()
48			{
49			return [
50			//
51			];
52			}
53
54			/**
55			* Triggers before the save settings operation.
56			*/
57			public function beforeSaving()
58			{
59			//
60			}
61
62			/**
63			* Saves customization settings.
64			*
65			* @return $this
66			*/
67			public function save()
68			{
69			$this->beforeSaving();
70
71			$this->settings->saveReplaced();
72
73			return $this;
74			}
75
76			/**
77			* Returns customization data.
78			*
79			* @return array
80			*/
81			public function all()
82			{
83			return $this->data;
84			}
85
86			/**
87			* Sets preview data.
88			*
89			* @param array $previewData
90			*
91			* @return $this
92			*/
93			public function setPreviewData(array $previewData = [])
94			{
95			if (!count($previewData)) {
96			return $this;
97			}
98
99			$settingsMap = $this->settingsMap();
100
101			if (count($settingsMap) > 0) {
102			$previewData = $this->renamePreviewDataKeys($previewData, $settingsMap);
103			}
104
105			$this->settings->replace($previewData);
106
107			return $this;
108			}
109
110			/**
111			* Sets settings manager.
112			*
113			* @param SettingsManager $settings
114			*
115			* @return $this
116			*/
117			public function setSettings(SettingsManager $settings)
118			{
119			$this->settings = $settings;
120
121			return $this;
122			}
123
124			/**
125			* Renames customization keys to settings keys.
126			*
127			* @param array $previewData
128			* @param array $map
129			*
130			* @return array
131			*/
132			protected function renamePreviewDataKeys(array $previewData, array $map)
133			{
134			foreach ($map as $customizationName => $settingsKey) {
135			if (!array_key_exists($customizationName, $previewData)) {
136			continue;
137			}
138
139			$previewData[$settingsKey] = $previewData[$customizationName];
140			unset($previewData[$customizationName]);
141			}
142
143			return $previewData;
144			}
145
146			/**
147			* Returns value from preview data or default value.
148			*
149			* @param string $key
150			* @param null $defaultValue
151			*
152			* @return mixed\|null
153			*/
154			protected function setting(string $key, $defaultValue = null)
155			{
156			return $this->settings->get($key, $defaultValue);
157			}
158
159			/**
160			* Returns value from preview data or default value with replaced placeholders.
161			*
162			* @param string $key
163			* @param array $placeholders
164			* @param null $defaultValue
165			*
166			* @return string
167			*/
168			protected function settingWithPlaceholders(string $key, array $placeholders = [], $defaultValue = null)
169			{
170			$text = $this->setting($key, $defaultValue);
171
172			return $this->settings->replacePlaceholders($text, $placeholders);
173			}
174
175			/**
176			* Creates new editables group.
177			*
178			* @param string $id
179			* @param string $title
180			* @param \Closure $settingsFactory
181			*
182			* @return array
183			*/
184			protected function group(string $id, string $title, \Closure $settingsFactory)
185			{
186			return [
187			'id' => $id,
188			'title' => $title,
189			'settings' => $settingsFactory(),
190			];
191			}
192
193			/**
194			* Creates new Editable.
195			*
196			* @param string $name
197			* @param string $type
198			* @param string\|null $title
199			* @param null $value
200			* @param array $attributes
201			*
202			* @return Editable
203			*/
204			protected function editable(string $name, string $type, string $title = null, $value = null, array $attributes = [])
205			{
206			return (new Editable($name))
207			->titledAs($title)
208			->usingType($type)
209			->withValue($value)
210			->withAttributes($attributes);
211			}
212			}
213

tzurbaev / giftd-editor-manager

Push — master ( 914e3f...2b201f )

Customization::beforeSaving() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like