FormHelper - Code Metrics - Jitamin/jitamin - Measure and Improve Code Quality continuously with Scrutinizer

FormHelper B
last analyzed 2017-12-27 06:16 UTC

↳ Parent: Project
Complexity

Total Complexity
Size/Duplication

Total Lines	420
Duplicated Lines	4.29 %
Coupling/Cohesion

Components	1
Dependencies	1
Importance

Changes
Metric	Value
dl	18
loc	420
rs	8.3673
c	0
b	0
f	0
wmc	45
lcom	1
cbo	1
22 Methods

Rating	Name	Duplication	Size	Complexity
A	csrf()	0	4	1
A	hidden()	0	4	1
B	select()	0	22	6
A	radios()	0	10	3
A	radio()	0	4	2
A	checkboxes()	0	10	3
A	checkbox()	0	4	2
A	label()	0	4	1
A	textarea()	0	12	2
A	file()	0	7	2
A	input()	0	15	2
A	text()	0	4	1
A	password()	0	4	1
A	email()	0	4	1
A	number()	0	4	1
A	numeric()	0	4	1
A	date()	9	9	1
A	datetime()	9	9	1
A	errorClass()	0	4	2
A	errorList()	0	16	3
A	formValue()	0	8	3
B	textEditor()	0	17	5
How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class
Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.
Complex classes like FormHelper often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use FormHelper, and based on these observations, apply Extract Interface, too.
<?php

/*
 * This file is part of Jitamin.
 *
 * Copyright (C) Jitamin Team
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Jitamin\Helper;

use Jitamin\Foundation\Base;

/**
 * Form helpers.
 */
class FormHelper extends Base
{
    /**
     * Hidden CSRF token field.
     *
     * @return string
     */
    public function csrf()
    {
        return '<input type="hidden" name="csrf_token" value="'.$this->token->getCSRFToken().'"/>';
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * Display a hidden form field.
     *
     * @param string $name   Field name
     * @param array  $values Form values
     *
     * @return string
     */
    public function hidden($name, array $values = [])
    {
        return '<input type="hidden" name="'.$name.'" id="form-'.$name.'" '.$this->formValue($values, $name).'/>';
    }

    /**
     * Display a select field.
     *
     * @param string $name       Field name
     * @param array  $options    Options
     * @param array  $values     Form values
     * @param array  $errors     Form errors
     * @param array  $attributes
     * @param string $class      CSS class
     *
     * @return string
     */
    public function select($name, array $options, array $values = [], array $errors = [], array $attributes = [], $class = '')
    {
        $html = '<select name="'.$name.'" id="form-'.$name.'" class="'.$class.'" '.implode(' ', $attributes).'>';

        foreach ($options as $id => $value) {
            $html .= '<option value="'.$this->helper->text->e($id).'"';
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

            if (isset($values->$name) && $id == $values->$name) {
                $html .= ' selected="selected"';
            }
            if (isset($values[$name]) && $id == $values[$name]) {
                $html .= ' selected="selected"';
            }

            $html .= '>'.$this->helper->text->e($value).'</option>';
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }

        $html .= '</select>';
        $html .= $this->errorList($errors, $name);

        return $html;
    }

    /**
     * Display a radio field group.
     *
     * @param string $name    Field name
     * @param array  $options Options
     * @param array  $values  Form values
     *
     * @return string
     */
    public function radios($name, array $options, array $values = [])
    {
        $html = '';

        foreach ($options as $value => $label) {
            $html .= $this->radio($name, $label, $value, isset($values[$name]) && $values[$name] == $value);
        }

        return $html;
    }

    /**
     * Display a radio field.
     *
     * @param string $name     Field name
     * @param string $label    Form label
     * @param string $value    Form value
     * @param bool   $selected Field selected or not
     * @param string $class    CSS class
     *
     * @return string
     */
    public function radio($name, $label, $value, $selected = false, $class = '')
    {
        return '<label><input type="radio" name="'.$name.'" class="'.$class.'" value="'.$this->helper->text->e($value).'" '.($selected ? 'checked="checked"' : '').'> '.$this->helper->text->e($label).'</label>';
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * Display a checkboxes group.
     *
     * @param string $name    Field name
     * @param array  $options Options
     * @param array  $values  Form values
     *
     * @return string
     */
    public function checkboxes($name, array $options, array $values = [])
    {
        $html = '';

        foreach ($options as $value => $label) {
            $html .= $this->checkbox($name.'['.$value.']', $label, $value, isset($values[$name]) && in_array($value, $values[$name]));
        }

        return $html;
    }

    /**
     * Display a checkbox field.
     *
     * @param string $name    Field name
     * @param string $label   Form label
     * @param string $value   Form value
     * @param bool   $checked Field selected or not
     * @param string $class   CSS class
     *
     * @return string
     */
    public function checkbox($name, $label, $value, $checked = false, $class = '')
    {
        return '<label><input type="checkbox" name="'.$name.'" class="'.$class.'" value="'.$this->helper->text->e($value).'" '.($checked ? 'checked="checked"' : '').'>&nbsp;'.$this->helper->text->e($label).'</label>';
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * Display a form label.
     *
     * @param string $name       Field name
     * @param string $label      Form label
     * @param array  $attributes HTML attributes
     *
     * @return string
     */
    public function label($label, $name, array $attributes = [])
    {
        return '<label for="form-'.$name.'" '.implode(' ', $attributes).'>'.$this->helper->text->e($label).'</label>';
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * Display a textarea.
     *
     * @param string $name       Field name
     * @param array  $values     Form values
     * @param array  $errors     Form errors
     * @param array  $attributes HTML attributes
     * @param string $class      CSS class
     *
     * @return string
     */
    public function textarea($name, $values = [], array $errors = [], array $attributes = [], $class = '')
    {
        $class .= $this->errorClass($errors, $name);

        $html = '<textarea name="'.$name.'" id="form-'.$name.'" class="'.$class.'" ';
        $html .= implode(' ', $attributes).'>';
        $html .= isset($values[$name]) ? $this->helper->text->e($values[$name]) : '';
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $html .= '</textarea>';
        $html .= $this->errorList($errors, $name);

        return $html;
    }

    /**
     * Display a markdown editor.
     *
     * @param string $name       Field name
     * @param array  $values     Form values
     * @param array  $errors     Form errors
     * @param array  $attributes
     *
     * @return string
     */
    public function textEditor($name, $values = [], array $errors = [], array $attributes = [])
    {
        $params = [
            'name'         => $name,
            'text'         => isset($values[$name]) ? $values[$name] : '',
            'css'          => $this->errorClass($errors, $name),
            'required'     => isset($attributes['required']) && $attributes['required'],
            'tabindex'     => isset($attributes['tabindex']) ? $attributes['tabindex'] : '-1',
            'labelPreview' => t('Preview'),
            'labelWrite'   => t('Write'),
            'placeholder'  => isset($attributes['placeholder']) ? $attributes['placeholder'] : t('Write your text in Markdown'),
        ];
        $html = '<div class="js-text-editor" data-params=\''.json_encode($params, JSON_HEX_APOS).'\'></div>';
        $html .= $this->errorList($errors, $name);

        return $html;
    }

    /**
     * Display file field.
     *
     * @param string $name
     * @param array  $errors
     * @param bool   $multiple
     *
     * @return string
     */
    public function file($name, array $errors = [], $multiple = false)
    {
        $html = '<input type="file" name="'.$name.'" id="form-'.$name.'" '.($multiple ? 'multiple' : '').'>';
        $html .= $this->errorList($errors, $name);

        return $html;
    }

    /**
     * Display a input field.
     *
     * @param string $type       HMTL input tag type
     * @param string $name       Field name
     * @param array  $values     Form values
     * @param array  $errors     Form errors
     * @param array  $attributes HTML attributes
     * @param string $class      CSS class
     *
     * @return string
     */
    public function input($type, $name, $values = [], array $errors = [], array $attributes = [], $class = '')
    {
        $class .= $this->errorClass($errors, $name);

        $html = '<input type="'.$type.'" name="'.$name.'" id="form-'.$name.'" '.$this->formValue($values, $name).' class="'.$class.'" ';
        $html .= implode(' ', $attributes).'>';

        if (in_array('required', $attributes)) {
            $html .= '<span class="form-required">*</span>';
        }

        $html .= $this->errorList($errors, $name);

        return $html;
    }

    /**
     * Display a text field.
     *
     * @param string $name       Field name
     * @param array  $values     Form values
     * @param array  $errors     Form errors
     * @param array  $attributes HTML attributes
     * @param string $class      CSS class
     *
     * @return string
     */
    public function text($name, $values = [], array $errors = [], array $attributes = [], $class = '')
    {
        return $this->input('text', $name, $values, $errors, $attributes, $class);
    }

    /**
     * Display a password field.
     *
     * @param string $name       Field name
     * @param array  $values     Form values
     * @param array  $errors     Form errors
     * @param array  $attributes HTML attributes
     * @param string $class      CSS class
     *
     * @return string
     */
    public function password($name, $values = [], array $errors = [], array $attributes = [], $class = '')
    {
        return $this->input('password', $name, $values, $errors, $attributes, $class);
    }

    /**
     * Display an email field.
     *
     * @param string $name       Field name
     * @param array  $values     Form values
     * @param array  $errors     Form errors
     * @param array  $attributes HTML attributes
     * @param string $class      CSS class
     *
     * @return string
     */
    public function email($name, $values = [], array $errors = [], array $attributes = [], $class = '')
    {
        return $this->input('email', $name, $values, $errors, $attributes, $class);
    }

    /**
     * Display a number field.
     *
     * @param string $name       Field name
     * @param array  $values     Form values
     * @param array  $errors     Form errors
     * @param array  $attributes HTML attributes
     * @param string $class      CSS class
     *
     * @return string
     */
    public function number($name, $values = [], array $errors = [], array $attributes = [], $class = '')
    {
        return $this->input('number', $name, $values, $errors, $attributes, $class);
    }

    /**
     * Display a numeric field (allow decimal number).
     *
     * @param string $name       Field name
     * @param array  $values     Form values
     * @param array  $errors     Form errors
     * @param array  $attributes HTML attributes
     * @param string $class      CSS class
     *
     * @return string
     */
    public function numeric($name, $values = [], array $errors = [], array $attributes = [], $class = '')
    {
        return $this->input('text', $name, $values, $errors, $attributes, $class.' form-numeric');
    }

    /**
     * Date field.
     *
     * @param string $label
     * @param string $name
     * @param array  $values
     * @param array  $errors
     * @param array  $attributes
     *
     * @return string
     */
    public function date($label, $name, array $values, array $errors = [], array $attributes = [])

    {
        $userFormat = $this->dateParser->getUserDateFormat();
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $values = $this->dateParser->format($values, [$name], $userFormat);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $attributes = array_merge(['placeholder="'.date($userFormat).'"'], $attributes);

        return $this->helper->form->label($label, $name).
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $this->helper->form->text($name, $values, $errors, $attributes, 'form-date');
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * Datetime field.
     *
     * @param string $label
     * @param string $name
     * @param array  $values
     * @param array  $errors
     * @param array  $attributes
     *
     * @return string
     */
    public function datetime($label, $name, array $values, array $errors = [], array $attributes = [])

    {
        $userFormat = $this->dateParser->getUserDateTimeFormat();
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $values = $this->dateParser->format($values, [$name], $userFormat);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $attributes = array_merge(['placeholder="'.date($userFormat).'"'], $attributes);

        return $this->helper->form->label($label, $name).
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $this->helper->form->text($name, $values, $errors, $attributes, 'form-datetime');
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * Display the form error class.
     *
     * @param array  $errors Error list
     * @param string $name   Field name
     *
     * @return string
     */
    private function errorClass(array $errors, $name)
    {
        return !isset($errors[$name]) ? '' : ' form-error';
    }

    /**
     * Display a list of form errors.
     *
     * @param array  $errors List of errors
     * @param string $name   Field name
     *
     * @return string
     */
    private function errorList(array $errors, $name)
    {
        $html = '';

        if (isset($errors[$name])) {
            $html .= '<ul class="form-errors">';

            foreach ($errors[$name] as $error) {
                $html .= '<li>'.$this->helper->text->e($error).'</li>';
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            }

            $html .= '</ul>';
        }

        return $html;
    }

    /**
     * Get an escaped form value.
     *
     * @param mixed  $values Values
     * @param string $name   Field name
     *
     * @return string
     */
    private function formValue($values, $name)
    {
        if (isset($values->$name)) {
            return 'value="'.$this->helper->text->e($values->$name).'"';
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }

        return isset($values[$name]) ? 'value="'.$this->helper->text->e($values[$name]).'"' : '';
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }
}

Jitamin / jitamin

FormHelper B last analyzed 2017-12-27 06:16 UTC
