UiBuilder::scope() - Code Metrics - Inspection of "Deleted unused functions declarations." - lagdo/ui-builder - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( ed843a...1402e3 )

by Thierry

created 2024-07-21 21:48 UTC

UiBuilder::scope() A

↳ Parent: UiBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	1
b	0
f	0

<?php

namespace Lagdo\UiBuilder\Scope;

use Closure;
use Lagdo\UiBuilder\BuilderInterface;
use Lagdo\UiBuilder\Html\HtmlBuilder;
use Lagdo\UiBuilder\Scope\Scope;
use LogicException;

use function preg_replace;
use function stripos;
use function strlen;
use function strtolower;
use function substr;
use function trim;

class UiBuilder extends HtmlBuilder
{
    /**
     * @var array<string, Closure>
     */
    protected $tagBuilders = [];

    /**
     * @var Scope
     */
    protected $scope;

    /**
     * The constructor
     */
    public function __construct()
    {
        $this->addTagBuilder('set', function(BuilderInterface $builder, string $tagName, string $method, array $arguments) {
            if ($this->scope === null) {
                throw new LogicException('Attributes can be set for elements only');
            }
            $this->scope->attributes[$tagName] = $arguments[0] ?? null;
        });
        $this->addTagBuilder('form', function(BuilderInterface $builder, string $tagName, string $method, array $arguments) {
            $this->createScope($tagName, $arguments);
            // Prepend the UI framework class to the tag.
            $this->prependClass($this->_formTagClass($tagName));
            $this->prependClass($this->/** @scrutinizer ignore-call */ _formTagClass($tagName));
        });
    }

    /**
     * @return Scope|null
     */
    public function scope(): ?Scope
    {
        return $this->scope;
    }

    /**
     * @param string $tagPrefix
     * @param Closure $tagBuilder
     *
     * @return void
     */
    public function addTagBuilder(string $tagPrefix, Closure $tagBuilder)
    {
        // Do not overwrite existing builders.
        if(!isset($this->tagBuilders[$tagPrefix]))
        {
            $this->tagBuilders[$tagPrefix] = $tagBuilder;
        }
    }

    /**
     * @param string $method
     * @param array $arguments
     *
     * @return void
     * @throws LogicException When element is not initialized yet
     */
    public function make(string $method, array $arguments)
    {
        $tagName = strtolower(preg_replace('/(?<!^)([A-Z])/', '-$1', $method));
        foreach($this->tagBuilders as $tagPrefix => $tagBuilder)
        {
            if (stripos($tagName, $tagPrefix . '-') === 0) {
                $tagName = substr($tagName, strlen($tagPrefix) + 1);
                $tagBuilder($this, $tagName, $method, $arguments);
                return;
            }
        }
        $this->createScope($tagName, $arguments);
    }

    /**
     * @param string $name
     * @param string $value
     *
     * @return void
     */
    public function setAttribute(string $name, string $value)
    {
        $this->scope->attributes[$name] = $value;
    }

    /**
     * @param array $attributes
     *
     * @return self
     */
    public function setAttributes(array $attributes): self
    {
        foreach ($attributes as $name => $value) {
            $this->scope->attributes[$name] = $value;
        }
        return $this;
    }

    /**
     * @param string $name
     * @param array $arguments
     *
     * @return void
     */
    public function createScope(string $name, array $arguments = [])
    {
        $this->scope = new Scope($name, $arguments, $this->scope);
    }

    /**
     * @param string $name
     * @param array $arguments
     *
     * @return void
     */
    public function createWrapper(string $name, array $arguments = [])
    {
        $this->createScope($name, [$arguments]);
        $this->scope->isWrapper = true;
    }

    /**
     * Append a class to the existing one.
     *
     * @param string $class
     *
     * @return void
     */
    public function appendClass(string $class)
    {
        if ($this->scope === null) {
            throw new LogicException('Attributes can be set for elements only');
        }
        $class = ($this->scope->attributes['class'] ?? '') . ' ' . $class;
        $this->scope->attributes['class'] = trim($class);
    }

    /**
     * Prepend a class to the existing one.
     *
     * @param string $class
     *
     * @return void
     */
    public function prependClass(string $class)
    {
        if ($this->scope === null) {
            throw new LogicException('Attributes can be set for elements only');
        }
        $class .= ' ' . ($this->scope->attributes['class'] ?? '');
        $this->scope->attributes['class'] = trim($class);
    }

    /**
     * @return void
     */
    public function end()
    {
        parent::end();
        // Wrappers are scopes that were automatically added.
        // They also need to be automatically ended.
        while ($this->scope !== null && $this->scope->isWrapper) {
            parent::end();
        }
    }

    /**
     * @return void
     */
    public function endShorted()
    {
        parent::endShorted();
        // Wrappers are scopes that were automatically added.
        // They also need to be automatically ended.
        while ($this->scope !== null && $this->scope->isWrapper) {
            parent::end();
        }
    }

    /**
     * @return bool
     */
    public function isInputGroup(): bool
    {
        return $this->scope !== null && $this->scope->isInputGroup;
    }
}


lagdo / ui-builder

Push — main ( ed843a...1402e3 )

UiBuilder::scope() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like