Slick\Template\Extension\Twig\TwigTextExtension

Complexity

Total Complexity

7

Size/Duplication

Total Lines	62
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	preserveBreakpoint()	0	9	3
A	wordwrap()	0	3	1
A	truncate()	0	8	2
A	getFilters()	0	5	1

<?php

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

declare(strict_types=1);

namespace Slick\Template\Extension\Twig;

use Twig\Extension\AbstractExtension;
use Twig\TwigFilter;

/**
 * TwigTextExtension
 *
 * @package Slick\Template\Extension\Twig
 */
final class TwigTextExtension extends AbstractExtension
{
    /**
     * Retrieves the filters of this extension.
     *
     * @return array<TwigFilter> The filters.
     */
    public function getFilters(): array
    {
        return [
            new TwigFilter('truncate', [$this, 'truncate']),
            new TwigFilter('wordwrap', [$this, 'wordwrap']),
        ];
    }

    /**
     * Truncates a given string to a specified length and appends a terminator.
     *
     * @param string $value The string to truncate.
     * @param int $len The maximum length of the truncated string. Default is 75.
     * @param string $ter The terminator to append to the truncated string. Default is "...".
     * @return string The truncated string.
     */
    public function truncate(string $value, int $len = 75, string $ter = "..."): string
    {
        $truncated = $value;
        $length = $this->preserveBreakpoint($value, $len);
        if (mb_strlen($value) > $length) {
            $truncated = rtrim(mb_substr($value, 0, $length)). $ter;
        }
        return $truncated;
    }

    /**
     * Wrap a string into lines of a specified length.
     *
     * @param string $value The input string to be wrapped.
     * @param int $len The number of characters at which the string will be wrapped.
     * @param string $break The character used to break the lines.
     * @return string The wrapped string.
     */
    public function wordwrap(string $value, int $len = 75, string $break = "\n"): string
    {
        return wordwrap($value, $len, $break, false);
    }

    /**
     * Returns the length to preserve the breakpoint for truncating a given string.
     *
     * @param string $value The string to calculate the breakpoint for.
     * @param int $length The maximum length of the truncated string.
     * @return int The length to preserve the breakpoint.
     */
    private function preserveBreakpoint(string $value, int $length): int
    {
        if (strlen($value) <= $length) {
            return $length;
        }

        $breakpoint = mb_strpos($value, ' ', $length);
        $length = false === $breakpoint ? mb_strlen($value) : $breakpoint;
        return (int) $length;
    }
}