Jasny\Twig\TextExtension

Complexity

Total Complexity

29

Size/Duplication

Total Lines	207
Duplicated Lines	0 %

Test Coverage

Coverage

97.01%

Importance

Changes	2
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	less()	0	8	3
A	truncate()	0	7	3
A	linkifyOther()	0	14	4
A	line()	0	9	3
A	linkifyMail()	0	8	1
A	getName()	0	3	1
A	linkifyHttp()	0	13	4
A	paragraph()	0	8	2
B	linkify()	0	33	7
A	getFilters()	0	8	1

<?php

Missing file doc comment

namespace Jasny\Twig;

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

/**
 * Text functions for Twig.
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class TextExtension extends AbstractExtension
{
    /**
     * Return extension name
     *
     * @return string
     */
    public function getName()
    {
        return 'jasny/text';
    }

    /**
     * {@inheritdoc}
     */

Missing @return tag in function comment

    public function getFilters()
    {
        return [
            new TwigFilter('paragraph', [$this, 'paragraph'], ['pre_escape' => 'html', 'is_safe' => ['html']]),
            new TwigFilter('line', [$this, 'line']),
            new TwigFilter('less', [$this, 'less'], ['pre_escape' => 'html', 'is_safe' => ['html']]),
            new TwigFilter('truncate', [$this, 'truncate'], ['pre_escape' => 'html', 'is_safe' => ['html']]),
            new TwigFilter('linkify', [$this, 'linkify'], ['pre_escape' => 'html', 'is_safe' => ['html']])
        ];
    }

    /**
     * Add paragraph and line breaks to text.
     *
     * @param string $value

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function paragraph($value)
    {
        if (!isset($value)) {
            return null;
        }

        return '<p>' . preg_replace(['~\n(\s*)\n\s*~', '~(?<!</p>)\n\s*~'], ["</p>\n\$1<p>", "<br>\n"], trim($value)) .
            '</p>';
    }

    /**
     * Get a single line
     *
     * @param string $value

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param int    $line   Line number (starts at 1)

Expected 2 spaces after parameter name; 3 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function line($value, $line = 1)
    {
        if (!isset($value)) {
            return null;
        }

        $lines = explode("\n", $value);

        return isset($lines[$line - 1]) ? $lines[$line - 1] : null;
    }

    /**
     * Cut of text on a pagebreak.
     *
     * @param string $value

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param string $replace

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param string $break

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function less($value, $replace = '...', $break = '<!-- pagebreak -->')
    {
        if (!isset($value)) {
            return null;
        }

        $pos = stripos($value, $break);
        return $pos === false ? $value : substr($value, 0, $pos) . $replace;
    }

    /**
     * Cut of text if it's to long.
     *
     * @param string $value

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param int    $length

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param string $replace

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function truncate($value, $length, $replace = '...')
    {
        if (!isset($value)) {
            return null;
        }

        return strlen($value) <= $length ? $value : substr($value, 0, $length - strlen($replace)) . $replace;
    }

    /**
     * Linkify a HTTP(S) link.
     *
     * @param string $protocol  'http' or 'https'

Expected 1 spaces after parameter name; 2 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param string $text

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param array  $links     OUTPUT

Expected 4 spaces after parameter name; 5 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param string $attr

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param string $mode

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    protected function linkifyHttp($protocol, $text, array &$links, $attr, $mode)
    {
        $regexp = $mode != 'all'
            ? '~(?:(https?)://([^\s<>]+)|(?<!\w@)\b(www\.[^\s<>]+?\.[^\s<>]+))(?<![\.,:;\?!\'"\|])~i'
            : '~(?:(https?)://([^\s<>]+)|(?<!\w@)\b([^\s<>@]+?\.[^\s<>]+)(?<![\.,:]))~i';

        return preg_replace_callback($regexp, function ($match) use ($protocol, &$links, $attr) {

The opening parenthesis of a multi-line function call should be the last content on the line.

            if ($match[1]) $protocol = $match[1];

Inline control structures are discouraged

            $link = $match[2] ?: $match[3];

            return '<' . array_push($links, '<a' . $attr . ' href="' . $protocol . '://' . $link . '">'

The opening parenthesis of a multi-line function call should be the last content on the line.

                . rtrim($link, '/') . '</a>') . '>';

This line of the multi-line function call does not seem to be indented correctly. Expected 12 spaces, but found 16.

For multi-line function calls, the closing parenthesis should be on a new line.

        }, $text);

For multi-line function calls, the closing parenthesis should be on a new line.

    }

    /**
     * Linkify a mail link.
     *
     * @param string $text

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param array  $links     OUTPUT

Expected 1 spaces after parameter name; 5 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param string $attr

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    protected function linkifyMail($text, array &$links, $attr)
    {
        $regexp = '~([^\s<>]+?@[^\s<>]+?\.[^\s<>]+)(?<![\.,:;\?!\'"\|])~';

        return preg_replace_callback($regexp, function ($match) use (&$links, $attr) {

The opening parenthesis of a multi-line function call should be the last content on the line.

            return '<' . array_push($links, '<a' . $attr . ' href="mailto:' . $match[1] . '">' . $match[1] . '</a>')
                . '>';
        }, $text);

For multi-line function calls, the closing parenthesis should be on a new line.

    }


    /**
     * Linkify a link.
     *
     * @param string $protocol

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param string $text

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param array  $links     OUTPUT

Expected 4 spaces after parameter name; 5 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param string $attr

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param string $mode

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    protected function linkifyOther($protocol, $text, array &$links, $attr, $mode)
    {
        if (strpos($protocol, ':') === false) {
            $protocol .= in_array($protocol, ['ftp', 'tftp', 'ssh', 'scp']) ? '://' : ':';
        }

        $regexp = $mode != 'all'
            ? '~' . preg_quote($protocol, '~') . '([^\s<>]+)(?<![\.,:;\?!\'"\|])~i'
            : '~([^\s<>]+)(?<![\.,:])~i';

        return preg_replace_callback($regexp, function ($match) use ($protocol, &$links, $attr) {

The opening parenthesis of a multi-line function call should be the last content on the line.

            return '<' . array_push($links, '<a' . $attr . ' href="' . $protocol . $match[1] . '">' . $match[1]

The opening parenthesis of a multi-line function call should be the last content on the line.

                . '</a>') . '>';

This line of the multi-line function call does not seem to be indented correctly. Expected 12 spaces, but found 16.

For multi-line function calls, the closing parenthesis should be on a new line.

        }, $text);

For multi-line function calls, the closing parenthesis should be on a new line.

    }

    /**
     * Turn all URLs in clickable links.
     *
     * @param string $value

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param array  $protocols   'http'/'https', 'mail' and also 'ftp', 'scp', 'tel', etc

Expected 2 spaces after parameter name; 3 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param array  $attributes  HTML attributes for the link

Expected 1 spaces after parameter name; 2 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param string $mode        normal or all

Expected 7 spaces after parameter name; 8 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function linkify($value, $protocols = ['http', 'mail'], array $attributes = [], $mode = 'normal')
    {
        if (!isset($value)) {
            return null;
        }

        // Link attributes
        $attr = '';
        foreach ($attributes as $key => $val) {
            $attr .= ' ' . $key . '="' . htmlentities($val) . '"';
        }

        $links = [];

        // Extract existing links and tags
        $text = preg_replace_callback('~(<a .*?>.*?</a>|<.*?>)~i', function ($match) use (&$links) {

The opening parenthesis of a multi-line function call should be the last content on the line.

            return '<' . array_push($links, $match[1]) . '>';
        }, $value);

For multi-line function calls, the closing parenthesis should be on a new line.

        // Extract text links for each protocol
        foreach ((array)$protocols as $protocol) {
            switch ($protocol) {
                case 'http':

Line indented incorrectly; expected 12 spaces, found 16

                case 'https':   $text = $this->linkifyHttp($protocol, $text, $links, $attr, $mode); break;

Line indented incorrectly; expected 12 spaces, found 16

Closing brace must be on a line by itself

                case 'mail':    $text = $this->linkifyMail($text, $links, $attr); break;

Line indented incorrectly; expected 12 spaces, found 16

Closing brace must be on a line by itself

                default:        $text = $this->linkifyOther($protocol, $text, $links, $attr, $mode); break;

Line indented incorrectly; expected 12 spaces, found 16

Closing brace must be on a line by itself

            }
        }

        // Insert all link
        return preg_replace_callback('/<(\d+)>/', function ($match) use (&$links) {

The opening parenthesis of a multi-line function call should be the last content on the line.

            return $links[$match[1] - 1];
        }, $text);

For multi-line function calls, the closing parenthesis should be on a new line.

    }
}