mimmi20/laminas-form-element-links

<?php
 
/**
 * This file is part of the mimmi20/laminas-form-element-links package.
 *
 * Copyright (c) 2021-2025, Thomas Mueller <mimmi20@live.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
 
declare(strict_types = 1);
 
namespace Mimmi20\Form\Links\View\Helper;
 
use Laminas\Form\ElementInterface;
use Laminas\Form\Exception;
use Laminas\Form\View\Helper\AbstractHelper;
use Laminas\I18n\Exception\RuntimeException;
use Laminas\I18n\View\Helper\Translate;
use Laminas\View\Exception\InvalidArgumentException;
use Laminas\View\Helper\EscapeHtml;
use Mimmi20\Form\Links\Element\LinksInterface as LinksElement;
 
use function array_filter;
use function array_key_exists;
use function array_map;
use function array_merge;
use function array_unique;
use function assert;
use function explode;
use function implode;
use function is_int;
use function is_string;
use function sprintf;
use function str_repeat;
use function trim;
 
use const PHP_EOL;
 
final class FormLinks extends AbstractHelper
{
    /**
     * Attributes valid for the current tag
     *
     * Will vary based on whether a select, option, or optgroup is being rendered
     *
     * @var array<string, bool>
     * @phpcsSuppress SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingNativeTypeHint
     */
    protected $validTagAttributes = [
        'href' => true,
        'target' => true,
    ];
 
    /**
     * @var array<string, bool>
     * @phpcsSuppress SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingNativeTypeHint
     */
    protected $translatableAttributes = ['title' => true];
    private string $indent            = '';
 
    /** @throws void */
    public function __construct(
        private readonly EscapeHtml $escapeHtml,
        private readonly Translate | null $translate = null,
    ) {
        // do nothing here
    }
 
    /**
     * Invoke helper as functor
     *
     * Proxies to {@link render()}.
     *
     * @throws Exception\InvalidArgumentException
     * @throws InvalidArgumentException
     * @throws RuntimeException
     */
    public function __invoke(ElementInterface | null $element = null): self | string
    {
        if (!$element) {
            return $this;
        }
 
        return $this->render($element);
    }
 
    /**
     * Render a form element from the provided $element
     *
     * @throws Exception\InvalidArgumentException
     * @throws InvalidArgumentException
     * @throws RuntimeException
     *
     * @api
     */
    public function render(ElementInterface $element): string
    {
        if (!$element instanceof LinksElement) {
            throw new Exception\InvalidArgumentException(
                sprintf(
                    '%s requires that the element is of type %s',
                    __METHOD__,
                    LinksElement::class,
                ),
            );
        }
 
        $renderedLinks = [];
 
        foreach ($element->getLinks() as $link) {
            $classes = [];
            $label   = $link['label'] ?? '';
            unset($link['label']);
 
            $attributes = $element->getAttributes();
 
            if (array_key_exists('class', $attributes)) {
                $classes = explode(' ', (string) $attributes['class']);
                unset($attributes['class']);
            }
 
            if (array_key_exists('class', $link)) {
                $classes = array_merge($classes, explode(' ', (string) $link['class']));
                unset($link['class']);
            }
 
            $linkAttributes          = array_merge($attributes, $link);
            $linkAttributes['class'] = implode(
                ' ',
                array_filter(
                    array_map(
                        static fn (string $value): string => trim($value),
                        array_unique($classes),
                    ),
                    static fn (string $value): bool => !empty($value),
                ),
            );
 
            if ($label !== '') {
                // Translate the label
                if ($this->translate !== null) {
                    $label = ($this->translate)($label, $this->getTranslatorTextDomain());
                }
 
                $label = ($this->escapeHtml)($label);
 
                assert(is_string($label));
            }
 
            $renderedLinks[] = sprintf(
                '<a %s>%s</a>',
                $this->createAttributesString($linkAttributes),
                $label,
            );
        }
 
        $indent = $this->getIndent();
 
        return $indent . implode(
            PHP_EOL . $indent . $element->getSeparator() . PHP_EOL . $indent,
            $renderedLinks,
        );
    }
 
    /**
     * Set the indentation string for using in {@link render()}, optionally a
     * number of spaces to indent with
     *
     * @throws void
     *
     * @api
     */
    public function setIndent(int | string $indent): self
    {
        $this->indent = $this->getWhitespace($indent);
 
        return $this;
    }
 
    /**
     * Returns indentation
     *
     * @throws void
     *
     * @api
     */
    public function getIndent(): string
    {
        return $this->indent;
    }
 
    /**
     * Retrieve whitespace representation of $indent
     *
     * @throws void
     */
    private function getWhitespace(int | string $indent): string
    {
        if (is_int($indent)) {
            $indent = str_repeat(' ', $indent);
        }
 
        return $indent;
    }
}