Field::image() - Code Metrics - Inspection of "Add Time input field" - yiisoft/form - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed
Pull Request — master (#238)

unknown
created 2023-01-16 18:44 UTC
Field::image() A

↳ Parent: Field
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	1
CRAP Score	1
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	1
dl	0
loc	3
ccs	1
cts	1
cp	1
crap	1
rs	10
<?php

declare(strict_types=1);

namespace Yiisoft\Form;

use RuntimeException;
use Yiisoft\Form\Field\Button;
use Yiisoft\Form\Field\ButtonGroup;
use Yiisoft\Form\Field\Checkbox;
use Yiisoft\Form\Field\CheckboxList;
use Yiisoft\Form\Field\Date;
use Yiisoft\Form\Field\DateTime;
use Yiisoft\Form\Field\DateTimeLocal;
use Yiisoft\Form\Field\Email;
use Yiisoft\Form\Field\ErrorSummary;
use Yiisoft\Form\Field\Fieldset;
use Yiisoft\Form\Field\File;
use Yiisoft\Form\Field\Hidden;
use Yiisoft\Form\Field\Image;
use Yiisoft\Form\Field\Number;
use Yiisoft\Form\Field\Part\Error;
use Yiisoft\Form\Field\Part\Hint;
use Yiisoft\Form\Field\Part\Label;
use Yiisoft\Form\Field\Password;
use Yiisoft\Form\Field\RadioList;
use Yiisoft\Form\Field\Range;
use Yiisoft\Form\Field\ResetButton;
use Yiisoft\Form\Field\Select;
use Yiisoft\Form\Field\SubmitButton;
use Yiisoft\Form\Field\Telephone;
use Yiisoft\Form\Field\Text;
use Yiisoft\Form\Field\Textarea;
use Yiisoft\Form\Field\Time;
use Yiisoft\Form\Field\Url;

use function array_key_exists;

final class Field
{
    /**
     * @psalm-var array<string,array>
     */
    private static array $configs = [
        'default' => [],
    ];

    private static string $defaultConfigName = 'default';

    /**
     * @psalm-var array<string,FieldFactory>
     */
    private static array $factories = [];

    /**
     * @param array<string,array> $configs Array of configurations with {@see FieldFactory::__construct()}
     * arguments indexed by name. For example:
     * ```php
     * [
     *     'default' => [
     *         'containerClass' => 'formField',
     *     ],
     *     'bulma' => [
     *         'containerClass' => 'field',
     *         'inputClass' => 'input',
     *         'invalidClass' => 'has-background-danger',
     *         'validClass' => 'has-background-success',
     *         'template' => "{label}<div class=\"control\">\n{input}</div>\n{hint}\n{error}",
     *         'labelClass' => 'label',
     *         'errorClass' => 'has-text-danger is-italic',
     *         'hintClass' => 'help',
     *     ],
     *     'bootstrap5' => [
     *         'containerClass' => 'mb-3',
     *         'invalidClass' => 'is-invalid',
     *         'errorClass' => 'text-danger fst-italic',
     *         'hintClass' => 'form-text',
     *         'inputClass' => 'form-control',
     *         'labelClass' => 'form-label',
     *         'validClass' => 'is-valid',
     *     ],
     * ]
     * ```
     * @param string $defaultConfigName Configuration name that will be used for create fields by default. If value is
     * not "default", then `$configs` must contain configuration with this name.
     */
    public static function initialize(array $configs = [], string $defaultConfigName = 'default'): void
    {
        self::$configs = array_merge(self::$configs, $configs);
        self::$defaultConfigName = $defaultConfigName;
    }

    public static function button(?string $content = null, array $config = []): Button
    {
        return self::getFactory()->button($content, $config);
    }

    public static function buttonGroup(array $config = []): ButtonGroup
    {
        return self::getFactory()->buttonGroup($config);
    }

    public static function checkbox(FormModelInterface $formModel, string $attribute, array $config = []): Checkbox
    {
        return self::getFactory()->checkbox($formModel, $attribute, $config);
    }

    public static function checkboxList(
        FormModelInterface $formModel,
        string $attribute,
        array $config = []
    ): CheckboxList {
        return self::getFactory()->checkboxList($formModel, $attribute, $config);
    }

    public static function date(FormModelInterface $formModel, string $attribute, array $config = []): Date
    {
        return self::getFactory()->date($formModel, $attribute, $config);
    }

    public static function dateTime(FormModelInterface $formModel, string $attribute, array $config = []): DateTime
    {
        return self::getFactory()->dateTime($formModel, $attribute, $config);
    }

    public static function dateTimeLocal(
        FormModelInterface $formModel,
        string $attribute,
        array $config = []
    ): DateTimeLocal {
        return self::getFactory()->dateTimeLocal($formModel, $attribute, $config);
    }

    public static function email(FormModelInterface $formModel, string $attribute, array $config = []): Email
    {
        return self::getFactory()->email($formModel, $attribute, $config);
    }

    public static function errorSummary(FormModelInterface $formModel, array $config = []): ErrorSummary
    {
        return self::getFactory()->errorSummary($formModel, $config);
    }

    public static function fieldset(array $config = []): Fieldset
    {
        return self::getFactory()->fieldset($config);
    }

    public static function file(FormModelInterface $formModel, string $attribute, array $config = []): File
    {
        return self::getFactory()->file($formModel, $attribute, $config);
    }

    public static function hidden(FormModelInterface $formModel, string $attribute, array $config = []): Hidden
    {
        return self::getFactory()->hidden($formModel, $attribute, $config);
    }

    public static function image(array $config = []): Image
    {
        return self::getFactory()->image($config);
    }

    public static function number(FormModelInterface $formModel, string $attribute, array $config = []): Number
    {
        return self::getFactory()->number($formModel, $attribute, $config);
    }

    public static function password(FormModelInterface $formModel, string $attribute, array $config = []): Password
    {
        return self::getFactory()->password($formModel, $attribute, $config);
    }

    public static function radioList(FormModelInterface $formModel, string $attribute, array $config = []): RadioList
    {
        return self::getFactory()->radioList($formModel, $attribute, $config);
    }

    public static function range(FormModelInterface $formModel, string $attribute, array $config = []): Range
    {
        return self::getFactory()->range($formModel, $attribute, $config);
    }

    public static function resetButton(?string $content = null, array $config = []): ResetButton
    {
        return self::getFactory()->resetButton($content, $config);
    }

    public static function select(FormModelInterface $formModel, string $attribute, array $config = []): Select
    {
        return self::getFactory()->select($formModel, $attribute, $config);
    }

    public static function submitButton(?string $content = null, array $config = []): SubmitButton
    {
        return self::getFactory()->submitButton($content, $config);
    }

    public static function telephone(FormModelInterface $formModel, string $attribute, array $config = []): Telephone
    {
        return self::getFactory()->telephone($formModel, $attribute, $config);
    }

    public static function text(FormModelInterface $formModel, string $attribute, array $config = []): Text
    {
        return self::getFactory()->text($formModel, $attribute, $config);
    }

    public static function textarea(FormModelInterface $formModel, string $attribute, array $config = []): Textarea
    {
        return self::getFactory()->textarea($formModel, $attribute, $config);
    }

    public static function time(FormModelInterface $formModel, string $attribute, array $config = []): Time
    {
        return self::getFactory()->time($formModel, $attribute, $config);
    }

    public static function url(FormModelInterface $formModel, string $attribute, array $config = []): Url
    {
        return self::getFactory()->url($formModel, $attribute, $config);
    }

    public static function label(FormModelInterface $formModel, string $attribute, array $config = []): Label
    {
        return self::getFactory()->label($formModel, $attribute, $config);
    }

    public static function hint(FormModelInterface $formModel, string $attribute, array $config = []): Hint
    {
        return self::getFactory()->hint($formModel, $attribute, $config);
    }

    public static function error(FormModelInterface $formModel, string $attribute, array $config = []): Error
    {
        return self::getFactory()->error($formModel, $attribute, $config);
    }

    /**
     * @psalm-template T
     * @psalm-param class-string<T> $class
     * @psalm-return T
     */
    public static function input(string $class, FormModelInterface $formModel, string $attribute, array $config = []): object
    {
        return self::getFactory()->input($class, $formModel, $attribute, $config);
    }

    /**
     * @psalm-template T
     * @psalm-param class-string<T> $class
     * @psalm-return T
     */
    public static function field(string $class, array $config = []): object
    {
        return self::getFactory()->field($class, $config);
    }

    public static function getFactory(?string $name = null): FieldFactory
    {
        $name = $name ?? self::$defaultConfigName;

        if (!array_key_exists($name, self::$factories)) {
            if (!array_key_exists($name, self::$configs)) {
                throw new RuntimeException(
                    sprintf('Configuration with name "%s" not found.', $name)
                );
            }

            /** @psalm-suppress MixedArgument */
            self::$factories[$name] = new FieldFactory(...self::$configs[$name]);
            self::$factories[$name] = new FieldFactory(/** @scrutinizer ignore-type */ ...self::$configs[$name]);
        }

        return self::$factories[$name];
    }
}

yiisoft / form

Pull Request — master (#238)

Field::image() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
