Phalcon\Html\Helper\AbstractList

Complexity

Total Complexity

5

Size/Duplication

Total Lines	77
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__toString()	0	17	2
A	__invoke()	0	17	3

<?php

/**
 * This file is part of the Phalcon Framework.
 *
 * For the full copyright and license information, please view the LICENSE.md
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Phalcon\Html\Helper;

use Phalcon\Html\Exception;

/**
 * Class AbstractList
 *
 * @property array  $attributes
 * @property string $elementTag
 * @property array  $store
 */
abstract class AbstractList extends AbstractHelper
{
    /**
     * @var array
     */
    protected $attributes = [];

    /**
     * @var string
     */
    protected $elementTag = "li";

    /**
     * @var array
     */
    protected $store = [];

    /**
     * @param string $indent
     * @param string $delimiter
     * @param array  $attributes
     *
     * @return AbstractList
     */
    public function __invoke(
        string $indent = null,
        string $delimiter = null,
        array $attributes = []
    ): AbstractList {
        $this->attributes = $attributes;
        if (null !== $delimiter) {
            $this->delimiter = $delimiter;
        }

        if (null !== $indent) {
            $this->indent = $indent;
        }

        $this->store = [];

        return $this;
    }

    /**
     * Generates and returns the HTML for the list.
     *
     * @return string
     * @throws Exception
     */
    public function __toString()
    {
        if (empty($this->store)) {
            return "";
        }

        $contents = $this->delimiter .
            $this->renderArrayElements(
                $this->store,
                $this->delimiter
            );

        return $this->renderFullElement(
            $this->getTag(),
            $contents,
            $this->attributes,
            true
        );
    }

    /**
     *
     * Returns the tag name.
     *
     * @return string
     *
     */
    abstract protected function getTag();
}