FormHelper::transformToDotSyntax() - Code Metrics - Inspection of "Properly namespace error messages in child forms." - kristijanhusak/laravel-form-builder - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c02fab...ffc04d )

by Kristijan

created 2016-06-03 17:29 UTC

FormHelper::transformToDotSyntax() A

↳ Parent: FormHelper

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	1
b	1
f	0
cc	1
eloc	2
nc	1
nop	1
crap	1

<?php  namespace Kris\LaravelFormBuilder;

use Illuminate\Support\Collection;
use Illuminate\Translation\Translator;
use Illuminate\Database\Eloquent\Model;
use Kris\LaravelFormBuilder\Fields\FormField;
use Illuminate\Contracts\View\Factory as View;

class FormHelper
{

    /**
     * @var View
     */
    protected $view;

    /**
     * @var Translator
     */
    protected $translator;

    /**
     * @var array
     */
    protected $config;

    /**
     * @var FormBuilder
     */
    protected $formBuilder;

    /**
     * All available field types
     *
     * @var array
     */
    protected static $availableFieldTypes = [
        'text'           => 'InputType',
        'email'          => 'InputType',
        'url'            => 'InputType',
        'tel'            => 'InputType',
        'search'         => 'InputType',
        'password'       => 'InputType',
        'hidden'         => 'InputType',
        'number'         => 'InputType',
        'date'           => 'InputType',
        'file'           => 'InputType',
        'image'          => 'InputType',
        'color'          => 'InputType',
        'datetime-local' => 'InputType',
        'month'          => 'InputType',
        'range'          => 'InputType',
        'time'           => 'InputType',
        'week'           => 'InputType',
        'select'         => 'SelectType',
        'textarea'       => 'TextareaType',
        'button'         => 'ButtonType',
        'submit'         => 'ButtonType',
        'reset'          => 'ButtonType',
        'radio'          => 'CheckableType',
        'checkbox'       => 'CheckableType',
        'choice'         => 'ChoiceType',
        'form'           => 'ChildFormType',
        'entity'         => 'EntityType',
        'collection'     => 'CollectionType',
        'repeated'       => 'RepeatedType',
        'static'         => 'StaticType'
    ];

    /**
     * Custom types
     *
     * @var array
     */
    private $customTypes = [];

    /**
     * @param View    $view
     * @param Translator $translator
     * @param array   $config
     */
    public function __construct(View $view, Translator $translator, array $config = [])
    {
        $this->view = $view;
        $this->translator = $translator;
        $this->config = $config;
        $this->loadCustomTypes();
    }

    /**
     * @param string $key
     * @param string $default
     * @return mixed
     */
    public function getConfig($key, $default = null)
    {
        return array_get($this->config, $key, $default);
    }

    /**
     * @return View
     */
    public function getView()
    {
        return $this->view;
    }

    /**
     * Merge options array
     *
     * @param array $first
     * @param array $second
     * @return array
     */
    public function mergeOptions(array $first, array $second)
    {
        return array_replace_recursive($first, $second);
    }

    /**
     * Get proper class for field type
     *
     * @param $type
     * @return string
     */
    public function getFieldType($type)
    {
        $types = array_keys(static::$availableFieldTypes);

        if (!$type || trim($type) == '') {
            throw new \InvalidArgumentException('Field type must be provided.');
        }

        if (array_key_exists($type, $this->customTypes)) {
            return $this->customTypes[$type];
        }

        if (!in_array($type, $types)) {
            throw new \InvalidArgumentException(
                sprintf(
                    'Unsupported field type [%s]. Available types are: %s',
                    $type,
                    join(', ', array_merge($types, array_keys($this->customTypes)))
                )
            );
        }

        $namespace = __NAMESPACE__.'\\Fields\\';

        return $namespace . static::$availableFieldTypes[$type];
    }

    /**
     * Convert array of attributes to html attributes
     *
     * @param $options
     * @return string
     */
    public function prepareAttributes($options)
    {
        if (!$options) {
            return null;
        }

        $attributes = [];

        foreach ($options as $name => $option) {
            if ($option !== null) {
                $name = is_numeric($name) ? $option : $name;
                $attributes[] = $name.'="'.$option.'" ';
            }
        }

        return join('', $attributes);
    }

    /**
     * Add custom field
     *
     * @param $name
     * @param $class
     */
    public function addCustomField($name, $class)
    {
        if (!array_key_exists($name, $this->customTypes)) {
            return $this->customTypes[$name] = $class;
        }

        throw new \InvalidArgumentException('Custom field ['.$name.'] already exists on this form object.');
    }

    /**
     * Load custom field types from config file
     */
    private function loadCustomTypes()
    {
        $customFields = (array) $this->getConfig('custom_fields');

        if (!empty($customFields)) {
            foreach ($customFields as $fieldName => $fieldClass) {
                $this->addCustomField($fieldName, $fieldClass);
            }
        }
    }

    public function convertModelToArray($model)
    {
        if (!$model) {
            return null;
        }

        if ($model instanceof Model) {
            return $model->toArray();
        }

        if ($model instanceof Collection) {
            return $model->all();
        }

        return $model;
    }

    /**
     * Format the label to the proper format
     *
     * @param $name
     * @return string
     */
    public function formatLabel($name)
    {
        if (!$name) {
            return null;
        }

        if ($this->translator->has($name)) {
            $translatedName = $this->translator->get($name);

            if (is_string($translatedName)) {
                return $translatedName;
            }
        }

        return ucfirst(str_replace('_', ' ', $name));
    }

    /**
     * @param FormField[] $fields
     * @return array
     */
    public function mergeFieldsRules($fields)
    {
        $rules = [];
        $attributes = [];
        $messages = [];

        foreach ($fields as $field) {
            if ($fieldRules = $field->getValidationRules()) {
                $rules = array_merge($rules, $fieldRules['rules']);
                $attributes = array_merge($attributes, $fieldRules['attributes']);
                $messages = array_merge($messages, $fieldRules['error_messages']);
            }
        }

        return [
            'rules' => $rules,
            'attributes' => $attributes,
            'error_messages' => $messages
        ];
    }

    /**
     * @param string $string
     * @return string
     */
    public function transformToDotSyntax($string)
    {
        return str_replace(['.', '[]', '[', ']'], ['_', '', '.', ''], $string);
    }

    /**
     * @return Translator
     */
    public function getTranslator()
    {
        return $this->translator;
    }
}


1		<?php namespace Kris\LaravelFormBuilder;
2
3		use Illuminate\Support\Collection;
4		use Illuminate\Translation\Translator;
5		use Illuminate\Database\Eloquent\Model;
6		use Kris\LaravelFormBuilder\Fields\FormField;
7		use Illuminate\Contracts\View\Factory as View;
8
9		class FormHelper
10		{
11
12		/**
13		* @var View
14		*/
15		protected $view;
16
17		/**
18		* @var Translator
19		*/
20		protected $translator;
21
22		/**
23		* @var array
24		*/
25		protected $config;
26
27		/**
28		* @var FormBuilder
29		*/
30		protected $formBuilder;
31
32		/**
33		* All available field types
34		*
35		* @var array
36		*/
37		protected static $availableFieldTypes = [
38		'text' => 'InputType',
39		'email' => 'InputType',
40		'url' => 'InputType',
41		'tel' => 'InputType',
42		'search' => 'InputType',
43		'password' => 'InputType',
44		'hidden' => 'InputType',
45		'number' => 'InputType',
46		'date' => 'InputType',
47		'file' => 'InputType',
48		'image' => 'InputType',
49		'color' => 'InputType',
50		'datetime-local' => 'InputType',
51		'month' => 'InputType',
52		'range' => 'InputType',
53		'time' => 'InputType',
54		'week' => 'InputType',
55		'select' => 'SelectType',
56		'textarea' => 'TextareaType',
57		'button' => 'ButtonType',
58		'submit' => 'ButtonType',
59		'reset' => 'ButtonType',
60		'radio' => 'CheckableType',
61		'checkbox' => 'CheckableType',
62		'choice' => 'ChoiceType',
63		'form' => 'ChildFormType',
64		'entity' => 'EntityType',
65		'collection' => 'CollectionType',
66		'repeated' => 'RepeatedType',
67		'static' => 'StaticType'
68		];
69
70		/**
71		* Custom types
72		*
73		* @var array
74		*/
75		private $customTypes = [];
76
77		/**
78		* @param View $view
79		* @param Translator $translator
80		* @param array $config
81		*/
82	90	public function __construct(View $view, Translator $translator, array $config = [])
83		{
84	90	$this->view = $view;
85	90	$this->translator = $translator;
86	90	$this->config = $config;
87	90	$this->loadCustomTypes();
88	90	}
89
90		/**
91		* @param string $key
92		* @param string $default
93		* @return mixed
94		*/
95	90	public function getConfig($key, $default = null)
96		{
97	90	return array_get($this->config, $key, $default);
98		}
99
100		/**
101		* @return View
102		*/
103	30	public function getView()
104		{
105	30	return $this->view;
106		}
107
108		/**
109		* Merge options array
110		*
111		* @param array $first
112		* @param array $second
113		* @return array
114		*/
115	90	public function mergeOptions(array $first, array $second)
116		{
117	90	return array_replace_recursive($first, $second);
118		}
119
120		/**
121		* Get proper class for field type
122		*
123		* @param $type
124		* @return string
125		*/
126	60	public function getFieldType($type)
127		{
128	60	$types = array_keys(static::$availableFieldTypes);
129
130	60	if (!$type \|\| trim($type) == '') {
131	1	throw new \InvalidArgumentException('Field type must be provided.');
132		}
133
134	59	if (array_key_exists($type, $this->customTypes)) {
135	2	return $this->customTypes[$type];
136		}
137
138	57	if (!in_array($type, $types)) {
139	2	throw new \InvalidArgumentException(
140		sprintf(
141	2	'Unsupported field type [%s]. Available types are: %s',
142		$type,
143	2	join(', ', array_merge($types, array_keys($this->customTypes)))
144		)
145		);
146		}
147
148	55	$namespace = __NAMESPACE__.'\\Fields\\';
149
150	55	return $namespace . static::$availableFieldTypes[$type];
151		}
152
153		/**
154		* Convert array of attributes to html attributes
155		*
156		* @param $options
157		* @return string
158		*/
159	72	public function prepareAttributes($options)
160		{
161	72	if (!$options) {
162	4	return null;
163		}
164
165	72	$attributes = [];
166
167	72	foreach ($options as $name => $option) {
168	72	if ($option !== null) {
169	72	$name = is_numeric($name) ? $option : $name;
170	72	$attributes[] = $name.'="'.$option.'" ';
171		}
172		}
173
174	72	return join('', $attributes);
175		}
176
177		/**
178		* Add custom field
179		*
180		* @param $name
181		* @param $class
182		*/
183	3	public function addCustomField($name, $class)
184		{
185	3	if (!array_key_exists($name, $this->customTypes)) {
186	3	return $this->customTypes[$name] = $class;
187		}
188
189	1	throw new \InvalidArgumentException('Custom field ['.$name.'] already exists on this form object.');
190		}
191
192		/**
193		* Load custom field types from config file
194		*/
195	90	private function loadCustomTypes()
196		{
197	90	$customFields = (array) $this->getConfig('custom_fields');
198
199	90	if (!empty($customFields)) {
200	1	foreach ($customFields as $fieldName => $fieldClass) {
201	1	$this->addCustomField($fieldName, $fieldClass);
202		}
203		}
204	90	}
205
206	5	public function convertModelToArray($model)
207		{
208	5	if (!$model) {
209	1	return null;
210		}
211
212	5	if ($model instanceof Model) {
213	1	return $model->toArray();
214		}
215
216	5	if ($model instanceof Collection) {
217	2	return $model->all();
218		}
219
220	5	return $model;
221		}
222
223		/**
224		* Format the label to the proper format
225		*
226		* @param $name
227		* @return string
228		*/
229	70	public function formatLabel($name)
230		{
231	70	if (!$name) {
232	1	return null;
233		}
234
235	70	if ($this->translator->has($name)) {
236	1	$translatedName = $this->translator->get($name);
237
238	1	if (is_string($translatedName)) {
239	1	return $translatedName;
240		}
241		}
242
243	69	return ucfirst(str_replace('_', ' ', $name));
244		}
245
246		/**
247		* @param FormField[] $fields
248		* @return array
249		*/
250	4	public function mergeFieldsRules($fields)
251		{
252	4	$rules = [];
253	4	$attributes = [];
254	4	$messages = [];
255
256	4	foreach ($fields as $field) {
257	4	if ($fieldRules = $field->getValidationRules()) {
258	4	$rules = array_merge($rules, $fieldRules['rules']);
259	4	$attributes = array_merge($attributes, $fieldRules['attributes']);
260	4	$messages = array_merge($messages, $fieldRules['error_messages']);
261		}
262		}
263
264		return [
265	4	'rules' => $rules,
266	4	'attributes' => $attributes,
267	4	'error_messages' => $messages
268		];
269		}
270
271		/**
272		* @param string $string
273		* @return string
274		*/
275	71	public function transformToDotSyntax($string)
276		{
277	71	return str_replace(['.', '[]', '[', ']'], ['_', '', '.', ''], $string);
278		}
279
280		/**
281		* @return Translator
282		*/
283	3	public function getTranslator()
284		{
285	3	return $this->translator;
286		}
287		}
288

kristijanhusak / laravel-form-builder

Push — master ( c02fab...ffc04d )

FormHelper::transformToDotSyntax() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like