App\View\Helper\PropertyHelper

Complexity

Total Complexity

54

Size/Duplication

Total Lines	398
Duplicated Lines	0 %

Importance

Changes	3
Bugs	3	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	schema()	0	16	4
A	value()	0	17	3
B	translationControl()	0	21	7
A	fieldLabel()	0	10	3
B	control()	0	22	10
A	fastCreateFieldsMap()	0	25	4
A	prepareFieldOptions()	0	14	4
A	dateRange()	0	28	1
C	translationsMap()	0	84	11
B	fastCreateFields()	0	37	7

<?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\CacheTools;
use App\Utility\Translate;
use Cake\Cache\Cache;
use Cake\Core\Configure;
use Cake\Utility\Hash;
use Cake\View\Helper;
use Throwable;

/**
 * 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 array $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 object or resource type, for others schemas
     * @return string
     */
    public function control(string $name, mixed $value, array $options = [], ?string $type = null): string
    {
        $forceReadonly = !empty(Hash::get($options, 'readonly'));
        $controlOptions = $this->Schema->controlOptions($name, $value, $this->schema($name, $type));
        $controlOptions['label'] = $this->fieldLabel($name, $type);
        $readonly = Hash::get($controlOptions, 'readonly') || $forceReadonly;
        if ($readonly === true && array_key_exists('html', $controlOptions)) {
            $controlOptions['html'] = str_replace('readonly="false"', 'readonly="true"', $controlOptions['html']);
            $controlOptions['html'] = str_replace(':readonly=false', ':readonly=true', $controlOptions['html']);
        }
        if ($readonly === true && array_key_exists('v-datepicker', $controlOptions)) {
            unset($controlOptions['v-datepicker']);
        }
        if (!$readonly && Hash::get($controlOptions, 'class') === 'json' || Hash::get($controlOptions, 'type') === '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));
    }

    /**
     * Generates a form control for translation property
     *
     * @param string $name The property name
     * @param mixed|null $value The property value
     * @param array $options The form element options, if any
     * @return string
     */
    public function translationControl(string $name, mixed $value, array $options = []): string
    {
        $formControlName = sprintf('translated_fields[%s]', $name);
        $controlOptions = $this->Schema->controlOptions($name, $value, $this->schema($name, null));
        if (array_key_exists('html', $controlOptions)) {
            $controlOptions['html'] = str_replace(sprintf('name="%s"', $name), sprintf('name="%s"', $formControlName), $controlOptions['html']);
        }
        $controlOptions['label'] = $this->fieldLabel($name, null);
        $readonly = Hash::get($controlOptions, 'readonly');
        if ($readonly === true && array_key_exists('v-datepicker', $controlOptions)) {
            unset($controlOptions['v-datepicker']);
        }
        if (Hash::get($controlOptions, 'class') === 'json' || Hash::get($controlOptions, 'type') === 'json') {
            $jsonKeys = (array)Configure::read('_jsonKeys');
            Configure::write('_jsonKeys', array_merge($jsonKeys, [$formControlName]));
        }
        if (Hash::check($controlOptions, 'html')) {
            return (string)Hash::get($controlOptions, 'html', '');
        }

        return $this->Form->control($formControlName, 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 = (string)Translate::get($name);
        $t = empty($type) ? $this->getView()->get('objectType') : $type;
        if (empty($t)) {
            return $defaultLabel;
        }
        $key = sprintf('Properties.%s.options.%s.label', $t, $name);

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

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

        return $res === null ? null : (array)$res;
    }

    /**
     * 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 = Hash::get($resource, $path);
                break;
            }
        }

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

    /**
     * Return translations for object fields and more.
     *
     * @return array
     */
    public function translationsMap(): array
    {
        try {
            $key = CacheTools::cacheKey('translationsMap');
            $map = Cache::remember(
                $key,
                function () {
                    $map = [];
                    $keys = [];
                    Configure::load('properties');
                    $properties = (array)Configure::read('DefaultProperties');
                    $removeKeys = ['_element', '_hide', '_keep'];
                    foreach ($properties as $name => $prop) {
                        $keys[] = trim($name);
                        $keys = array_merge($keys, (array)Hash::get($prop, 'fastCreate.all', []));
                        $keys = array_merge($keys, (array)Hash::get($prop, 'index', []));
                        $keys = array_merge($keys, (array)Hash::get($prop, 'filter', []));
                        $groups = array_keys((array)Hash::get($prop, 'view', []));
                        $addKeys = array_reduce($groups, function ($carry, $group) use ($prop, $removeKeys) {
                            $carry[] = $group;
                            $groupKeys = (array)Hash::get($prop, sprintf('view.%s', $group), []);
                            $groupKeys = array_filter(
                                $groupKeys,
                                function ($val, $key) use ($removeKeys) {
                                    return is_string($val) && !in_array($key, $removeKeys);
                                },
                                ARRAY_FILTER_USE_BOTH,
                            );

                            return array_merge($carry, $groupKeys);
                        }, []);
                        $keys = array_merge($keys, $addKeys);
                    }
                    $keys = array_map(function ($key) {
                        return is_array($key) ? array_key_first($key) : $key;
                    }, $keys);
                    $keys = array_diff($keys, $removeKeys);
                    $keys = array_unique($keys);
                    $keys = array_map(function ($key) {
                        return strpos($key, '/') !== false ? substr($key, strrpos($key, '/') + 1) : $key;
                    }, $keys);
                    $properties = (array)Configure::read(sprintf('Properties'));
                    foreach ($properties as $name => $prop) {
                        $keys[] = trim($name);
                        $keys = array_merge($keys, (array)Hash::get($prop, 'fastCreate.all', []));
                        $keys = array_merge($keys, (array)Hash::get($prop, 'index', []));
                        $keys = array_merge($keys, (array)Hash::get($prop, 'filter', []));
                        $groups = array_keys((array)Hash::get($prop, 'view', []));
                        $addKeys = array_reduce($groups, function ($carry, $group) use ($prop, $removeKeys) {
                            $carry[] = $group;
                            $groupKeys = (array)Hash::get($prop, sprintf('view.%s', $group), []);
                            $groupKeys = array_filter(
                                $groupKeys,
                                function ($val, $key) use ($removeKeys) {
                                    return is_string($val) && !in_array($key, $removeKeys);
                                },
                                ARRAY_FILTER_USE_BOTH,
                            );

                            return array_merge($carry, $groupKeys);
                        }, []);
                        $keys = array_merge($keys, $addKeys);
                    }
                    $keys = array_map(function ($key) {
                        return is_array($key) ? array_key_first($key) : $key;
                    }, $keys);
                    $keys = array_diff($keys, $removeKeys);
                    $keys = array_unique($keys);
                    $keys = array_map(function ($key) {
                        return strpos($key, '/') !== false ? substr($key, strrpos($key, '/') + 1) : $key;
                    }, $keys);
                    sort($keys);
                    foreach ($keys as $key) {
                        $map[$key] = (string)Translate::get($key);
                    }

                    return $map;
                },
            );
        } catch (Throwable $e) {
            $map = [];
        }

        return $map;
    }

    /**
     * Return fast create fields per module map.
     *
     * @return array
     */
    public function fastCreateFieldsMap(): array
    {
        $defaultTitleType = Configure::read('UI.richeditor.title', []) ? 'textarea' : 'string';
        $map = [];
        $properties = (array)Configure::read(sprintf('Properties'));
        $uploadable = $this->getView()->get('uploadable', []);
        $defaults = [
            'objects' => [
                'all' => [['title' => $defaultTitleType], 'status', 'description'],
                'required' => ['status', 'title'],
            ],
            'media' => [
                'all' => [['title' => $defaultTitleType], 'status', 'name'],
                'required' => ['name', 'status', 'title'],
            ],
        ];
        foreach ($properties as $name => $prop) {
            $cfg = (array)Hash::get($prop, 'fastCreate', []);
            $defaultFieldMap = in_array($name, $uploadable) ? $defaults['media'] : $defaults['objects'];
            $fields = (array)Hash::get($cfg, 'all', $defaultFieldMap['all']);
            $required = (array)Hash::get($cfg, 'required', $defaultFieldMap['required']);
            $map[$name] = compact('fields', 'required');
        }

        return $map;
    }

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