PropertyHelper::prepareFieldOptions() - Code Metrics - Inspection of "Fast create form: fields types (#852)" - bedita/manager - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( ad93c0...af2985 )

by Stefano

created 2022-10-07 07:56 UTC

PropertyHelper::prepareFieldOptions() A

↳ Parent: PropertyHelper

Complexity

Conditions	4
Paths	4

Size

Total Lines	14
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	11
nc	4
nop	3
dl	0
loc	14
rs	9.9
c	0
b	0
f	0

<?php
/**
 * BEdita, API-first content management framework
 * Copyright 2020 ChannelWeb Srl, Chialab Srl
 *
 * This file is part of BEdita: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * See LICENSE.LGPL or <http://gnu.org/licenses/lgpl-3.0.html> for more details.
 */
namespace App\View\Helper;

use App\Form\Control;
use App\Form\Form;
use App\Utility\Translate;
use Cake\Core\Configure;
use Cake\Utility\Hash;
use Cake\View\Helper;

/**
 * Helper class to generate properties html
 *
 * @property \App\View\Helper\SchemaHelper $Schema The schema helper
 * @property \Cake\View\Helper\FormHelper $Form The form helper
 */
class PropertyHelper extends Helper
{
    /**
     * List of helpers used by this helper
     *
     * @var array
     */
    public $helpers = ['Form', 'Schema'];

    /**
     * Special paths to retrieve properties from related resources
     *
     * @var array
     */
    public const RELATED_PATHS = [
        'file_name' => 'relationships.streams.data.0.attributes.file_name',
        'mime_type' => 'relationships.streams.data.0.attributes.mime_type',
        'file_size' => 'relationships.streams.data.0.meta.file_size',
    ];

    /**
     * Special properties having their own custom schema type
     *
     * @var array
     */
    public const SPECIAL_PROPS_TYPE = [
        'categories' => 'categories',
        'relations' => 'relations',
        'file_size' => 'byte',
    ];

    /**
     * Generates a form control element for an object property by name, value and options.
     * Use SchemaHelper (@see \App\View\Helper\SchemaHelper) to get control options by schema model.
     * Use FormHelper (@see \Cake\View\Helper\FormHelper::control) to render control.
     *
     * @param string $name The property name
     * @param mixed|null $value The property value
     * @param array $options The form element options, if any
     * @param string|null $type The type, for others schemas
     * @return string
     */
    public function control(string $name, $value, array $options = [], ?string $type = null): string
    {
        $controlOptions = $this->Schema->controlOptions($name, $value, $this->schema($name, $type));
        $controlOptions['label'] = $this->fieldLabel($name, $type);
        if (Hash::get($controlOptions, 'class') === 'json') {
            $jsonKeys = (array)Configure::read('_jsonKeys');
            Configure::write('_jsonKeys', array_merge($jsonKeys, [$name]));
        }
        if (Hash::check($controlOptions, 'html')) {
            return (string)Hash::get($controlOptions, 'html', '');
        }

        return $this->Form->control($name, array_merge($controlOptions, $options));
    }

    /**
     * Return label for field by name and type.
     * If there's a config for the field and type, return it.
     * Return translation of name, otherwise.
     *
     * @param string $name The field name
     * @param string|null $type The object type
     * @return string
     */
    public function fieldLabel(string $name, ?string $type = null): string
    {
        $defaultLabel = Translate::get($name);
        $t = empty($type) ? $this->getView()->get('objectType') : $type;
        if (empty($t)) {
            return $defaultLabel;
        }
        $key = sprintf('Properties.%s.labels.fields.%s', $t, $name);

        return Configure::read($key, $defaultLabel);
    }

    /**
     * JSON Schema array of property name
     *
     * @param string $name The property name
     * @param string|null $type The type, for others schemas
     * @return array
     */
    public function schema(string $name, ?string $type = null): array
    {
        $schema = (array)$this->_View->get('schema');
        if (!empty($type)) {
            $schemas = (array)$this->_View->get('schemasByType');
            $schema = (array)Hash::get($schemas, $type);
        }
        $res = (array)Hash::get($schema, sprintf('properties.%s', $name));
        $default = array_filter([
            'type' => Hash::get(self::SPECIAL_PROPS_TYPE, $name),
            $name => Hash::get($schema, sprintf('%s', $name)),
        ]);
        if (in_array($name, self::SPECIAL_PROPS_TYPE)) {
            return $default;
        }

        return !empty($res) ? $res : $default;
    }

    /**
     * Get formatted property value of a resource or object.
     *
     * @param array $resource Resource or object data
     * @param string $property Property name
     * @return string
     */
    public function value(array $resource, string $property): string
    {
        $paths = array_filter([
            $property,
            sprintf('attributes.%s', $property),
            sprintf('meta.%s', $property),
            (string)Hash::get(self::RELATED_PATHS, $property),
        ]);
        $value = '';
        foreach ($paths as $path) {
            if (Hash::check($resource, $path)) {
                $value = (string)Hash::get($resource, $path);
                break;
            }
        }

        return $this->Schema->format($value, $this->schema($property));
    }

    /**
     * Return html for fast create form fields.
     *
     * @param string $type The object type
     * @param string $prefix The prefix
     * @return string The html for form fields
     */
    public function fastCreateFields(string $type, string $prefix): string
    {
        $cfg = (array)Configure::read(sprintf('Properties.%s.fastCreate', $type));
        $fields = (array)Hash::get($cfg, 'all', ['status', 'title', 'description']);
        $required = (array)Hash::get($cfg, 'required', ['status', 'title']);
        $html = '';
        $jsonKeys = [];
        $ff = [];
        foreach ($fields as $field => $fieldType) {
            $field = is_numeric($field) ? $fieldType : $field;
            $fieldClass = !in_array($field, $required) ? 'fastCreateField' : 'fastCreateField required';
            $fieldOptions = [
                'id' => sprintf('%s%s', $prefix, $field),
                'class' => $fieldClass,
                'data-name' => $field,
                'key' => sprintf('%s-%s', $type, $field),
            ];
            if ($field === 'date_ranges') {
                $html .= $this->dateRange($type, $fieldOptions);
                continue;
            }
            if ($fieldType === 'json') {
                $jsonKeys[] = $field;
            }
            $this->prepareFieldOptions($field, $fieldType, $fieldOptions);

            $html .= $this->control($field, '', $fieldOptions, $type);
            $ff[] = $field;
        }
        $jsonKeys = array_unique(array_merge($jsonKeys, (array)Configure::read('_jsonKeys')));
        $jsonKeys = array_intersect($jsonKeys, $ff);

        if (!empty($jsonKeys)) {
            $html .= $this->Form->control('_jsonKeys', ['type' => 'hidden', 'value' => implode(',', $jsonKeys)]);
        }

        return $html;
    }

    /**
     * Prepare field options for field.
     *
     * @param string $field The field name
     * @param string|null $fieldType The field type, if any
     * @param array $fieldOptions The field options
     * @return void
     */
    public function prepareFieldOptions(string $field, ?string $fieldType, array &$fieldOptions): void
    {
        $method = '';
        if (!empty($fieldType) && in_array($fieldType, Control::CONTROL_TYPES)) {
            $methodInfo = (array)Form::getMethod(Control::class, $fieldType);
            $className = (string)Hash::get($methodInfo, 0);
            $method = (string)Hash::get($methodInfo, 1);
            $preserveClass = Hash::get($fieldOptions, 'class', '');
            $fieldOptions = array_merge($fieldOptions, $className::$method([]));
            $fieldOptions['class'] .= ' ' . $preserveClass;
            $fieldOptions['class'] = trim($fieldOptions['class']);
        }
        if ($field === 'status') {
            $fieldOptions['v-model'] = 'object.attributes.status';
        }
    }

    /**
     * Return html for date range fields.
     *
     * @param string $type The object type
     * @param array $options The options
     * @return string The html for date range fields
     */
    public function dateRange(string $type, array $options): string
    {
        $optionsFrom = array_merge($options, [
            'id' => 'start_date_0',
            'name' => 'date_ranges[0][start_date]',
            'v-datepicker' => 'true',
            'date' => 'true',
            'time' => 'true',
            'daterange' => 'true',
        ]);
        $optionsTo = array_merge($options, [
            'id' => 'end_date_0',
            'name' => 'date_ranges[0][end_date]',
            'v-datepicker' => 'true',
            'date' => 'true',
            'time' => 'true',
            'daterange' => 'true',
        ]);
        $optionsAllDay = array_merge($options, [
            'id' => 'all_day_0',
            'name' => 'date_ranges[0][params][all_day]',
            'type' => 'checkbox',
        ]);
        $from = $this->control(__('From'), '', $optionsFrom, $type);
        $to = $this->control(__('To'), '', $optionsTo, $type);
        $allDay = $this->control(__('All day'), '', $optionsAllDay, $type);

        return sprintf('<div class="date-ranges-item mb-1"><div>%s%s%s</div></div>', $from, $to, $allDay);
    }
}


1			<?php
2			/**
3			* BEdita, API-first content management framework
4			* Copyright 2020 ChannelWeb Srl, Chialab Srl
5			*
6			* This file is part of BEdita: you can redistribute it and/or modify
7			* it under the terms of the GNU Lesser General Public License as published
8			* by the Free Software Foundation, either version 3 of the License, or
9			* (at your option) any later version.
10			*
11			* See LICENSE.LGPL or <http://gnu.org/licenses/lgpl-3.0.html> for more details.
12			*/
13			namespace App\View\Helper;
14
15			use App\Form\Control;
16			use App\Form\Form;
17			use App\Utility\Translate;
18			use Cake\Core\Configure;
19			use Cake\Utility\Hash;
20			use Cake\View\Helper;
21
22			/**
23			* Helper class to generate properties html
24			*
25			* @property \App\View\Helper\SchemaHelper $Schema The schema helper
26			* @property \Cake\View\Helper\FormHelper $Form The form helper
27			*/
28			class PropertyHelper extends Helper
29			{
30			/**
31			* List of helpers used by this helper
32			*
33			* @var array
34			*/
35			public $helpers = ['Form', 'Schema'];
36
37			/**
38			* Special paths to retrieve properties from related resources
39			*
40			* @var array
41			*/
42			public const RELATED_PATHS = [
43			'file_name' => 'relationships.streams.data.0.attributes.file_name',
44			'mime_type' => 'relationships.streams.data.0.attributes.mime_type',
45			'file_size' => 'relationships.streams.data.0.meta.file_size',
46			];
47
48			/**
49			* Special properties having their own custom schema type
50			*
51			* @var array
52			*/
53			public const SPECIAL_PROPS_TYPE = [
54			'categories' => 'categories',
55			'relations' => 'relations',
56			'file_size' => 'byte',
57			];
58
59			/**
60			* Generates a form control element for an object property by name, value and options.
61			* Use SchemaHelper (@see \App\View\Helper\SchemaHelper) to get control options by schema model.
62			* Use FormHelper (@see \Cake\View\Helper\FormHelper::control) to render control.
63			*
64			* @param string $name The property name
65			* @param mixed\|null $value The property value
66			* @param array $options The form element options, if any
67			* @param string\|null $type The type, for others schemas
68			* @return string
69			*/
70			public function control(string $name, $value, array $options = [], ?string $type = null): string
71			{
72			$controlOptions = $this->Schema->controlOptions($name, $value, $this->schema($name, $type));
73			$controlOptions['label'] = $this->fieldLabel($name, $type);
74			if (Hash::get($controlOptions, 'class') === 'json') {
75			$jsonKeys = (array)Configure::read('_jsonKeys');
76			Configure::write('_jsonKeys', array_merge($jsonKeys, [$name]));
77			}
78			if (Hash::check($controlOptions, 'html')) {
79			return (string)Hash::get($controlOptions, 'html', '');
80			}
81
82			return $this->Form->control($name, array_merge($controlOptions, $options));
83			}
84
85			/**
86			* Return label for field by name and type.
87			* If there's a config for the field and type, return it.
88			* Return translation of name, otherwise.
89			*
90			* @param string $name The field name
91			* @param string\|null $type The object type
92			* @return string
93			*/
94			public function fieldLabel(string $name, ?string $type = null): string
95			{
96			$defaultLabel = Translate::get($name);
97			$t = empty($type) ? $this->getView()->get('objectType') : $type;
98			if (empty($t)) {
99			return $defaultLabel;
100			}
101			$key = sprintf('Properties.%s.labels.fields.%s', $t, $name);
102
103			return Configure::read($key, $defaultLabel);
104			}
105
106			/**
107			* JSON Schema array of property name
108			*
109			* @param string $name The property name
110			* @param string\|null $type The type, for others schemas
111			* @return array
112			*/
113			public function schema(string $name, ?string $type = null): array
114			{
115			$schema = (array)$this->_View->get('schema');
116			if (!empty($type)) {
117			$schemas = (array)$this->_View->get('schemasByType');
118			$schema = (array)Hash::get($schemas, $type);
119			}
120			$res = (array)Hash::get($schema, sprintf('properties.%s', $name));
121			$default = array_filter([
122			'type' => Hash::get(self::SPECIAL_PROPS_TYPE, $name),
123			$name => Hash::get($schema, sprintf('%s', $name)),
124			]);
125			if (in_array($name, self::SPECIAL_PROPS_TYPE)) {
126			return $default;
127			}
128
129			return !empty($res) ? $res : $default;
130			}
131
132			/**
133			* Get formatted property value of a resource or object.
134			*
135			* @param array $resource Resource or object data
136			* @param string $property Property name
137			* @return string
138			*/
139			public function value(array $resource, string $property): string
140			{
141			$paths = array_filter([
142			$property,
143			sprintf('attributes.%s', $property),
144			sprintf('meta.%s', $property),
145			(string)Hash::get(self::RELATED_PATHS, $property),
146			]);
147			$value = '';
148			foreach ($paths as $path) {
149			if (Hash::check($resource, $path)) {
150			$value = (string)Hash::get($resource, $path);
151			break;
152			}
153			}
154
155			return $this->Schema->format($value, $this->schema($property));
156			}
157
158			/**
159			* Return html for fast create form fields.
160			*
161			* @param string $type The object type
162			* @param string $prefix The prefix
163			* @return string The html for form fields
164			*/
165			public function fastCreateFields(string $type, string $prefix): string
166			{
167			$cfg = (array)Configure::read(sprintf('Properties.%s.fastCreate', $type));
168			$fields = (array)Hash::get($cfg, 'all', ['status', 'title', 'description']);
169			$required = (array)Hash::get($cfg, 'required', ['status', 'title']);
170			$html = '';
171			$jsonKeys = [];
172			$ff = [];
173			foreach ($fields as $field => $fieldType) {
174			$field = is_numeric($field) ? $fieldType : $field;
175			$fieldClass = !in_array($field, $required) ? 'fastCreateField' : 'fastCreateField required';
176			$fieldOptions = [
177			'id' => sprintf('%s%s', $prefix, $field),
178			'class' => $fieldClass,
179			'data-name' => $field,
180			'key' => sprintf('%s-%s', $type, $field),
181			];
182			if ($field === 'date_ranges') {
183			$html .= $this->dateRange($type, $fieldOptions);
184			continue;
185			}
186			if ($fieldType === 'json') {
187			$jsonKeys[] = $field;
188			}
189			$this->prepareFieldOptions($field, $fieldType, $fieldOptions);
190
191			$html .= $this->control($field, '', $fieldOptions, $type);
192			$ff[] = $field;
193			}
194			$jsonKeys = array_unique(array_merge($jsonKeys, (array)Configure::read('_jsonKeys')));
195			$jsonKeys = array_intersect($jsonKeys, $ff);
196
197			if (!empty($jsonKeys)) {
198			$html .= $this->Form->control('_jsonKeys', ['type' => 'hidden', 'value' => implode(',', $jsonKeys)]);
199			}
200
201			return $html;
202			}
203
204			/**
205			* Prepare field options for field.
206			*
207			* @param string $field The field name
208			* @param string\|null $fieldType The field type, if any
209			* @param array $fieldOptions The field options
210			* @return void
211			*/
212			public function prepareFieldOptions(string $field, ?string $fieldType, array &$fieldOptions): void
213			{
214			$method = '';
215			if (!empty($fieldType) && in_array($fieldType, Control::CONTROL_TYPES)) {
216			$methodInfo = (array)Form::getMethod(Control::class, $fieldType);
217			$className = (string)Hash::get($methodInfo, 0);
218			$method = (string)Hash::get($methodInfo, 1);
219			$preserveClass = Hash::get($fieldOptions, 'class', '');
220			$fieldOptions = array_merge($fieldOptions, $className::$method([]));
221			$fieldOptions['class'] .= ' ' . $preserveClass;
222			$fieldOptions['class'] = trim($fieldOptions['class']);
223			}
224			if ($field === 'status') {
225			$fieldOptions['v-model'] = 'object.attributes.status';
226			}
227			}
228
229			/**
230			* Return html for date range fields.
231			*
232			* @param string $type The object type
233			* @param array $options The options
234			* @return string The html for date range fields
235			*/
236			public function dateRange(string $type, array $options): string
237			{
238			$optionsFrom = array_merge($options, [
239			'id' => 'start_date_0',
240			'name' => 'date_ranges[0][start_date]',
241			'v-datepicker' => 'true',
242			'date' => 'true',
243			'time' => 'true',
244			'daterange' => 'true',
245			]);
246			$optionsTo = array_merge($options, [
247			'id' => 'end_date_0',
248			'name' => 'date_ranges[0][end_date]',
249			'v-datepicker' => 'true',
250			'date' => 'true',
251			'time' => 'true',
252			'daterange' => 'true',
253			]);
254			$optionsAllDay = array_merge($options, [
255			'id' => 'all_day_0',
256			'name' => 'date_ranges[0][params][all_day]',
257			'type' => 'checkbox',
258			]);
259			$from = $this->control(__('From'), '', $optionsFrom, $type);
260			$to = $this->control(__('To'), '', $optionsTo, $type);
261			$allDay = $this->control(__('All day'), '', $optionsAllDay, $type);
262
263			return sprintf('<div class="date-ranges-item mb-1"><div>%s%s%s</div></div>', $from, $to, $allDay);
264			}
265			}
266

bedita / manager

Push — master ( ad93c0...af2985 )

PropertyHelper::prepareFieldOptions() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like