TextExtension::getFilters() - Code Metrics - Inspection of "summary and toc Twig filters better handle html no..." - stakx-io/stakx - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 06332b...67b389 )

by Vladimir

created 2017-12-23 05:53 UTC

TextExtension::getFilters() A

↳ Parent: TextExtension

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	0
loc	8
ccs	5
cts	5
cp	1
rs	9.4285
c	1
b	0
f	0
cc	1
eloc	5
nc	1
nop	0
crap	1

<?php

namespace allejo\stakx\Twig;

use allejo\stakx\Utilities\HtmlUtils;
use Twig_Environment;
use Twig_Extension;
use Twig_SimpleFilter;

/**
 * This file is part of Twig.
 *
 * (c) 2009 Fabien Potencier
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author Henrik Bjornskov <[email protected]>
 */
class TextExtension extends Twig_Extension
{
    /**
     * Returns a list of filters.
     *
     * @return Twig_SimpleFilter[]
     */
    public function getFilters()
    {
        return array(
            new Twig_SimpleFilter('summary', array($this, 'twig_summary_filter')),
            new Twig_SimpleFilter('truncate', array($this, 'twig_truncate_filter'), array('needs_environment' => true)),
            new Twig_SimpleFilter('wordwrap', array($this, 'twig_wordwrap_filter'), array('needs_environment' => true)),
        );
    }

    /**
     * Name of this extension.
     *
     * @return string
     */
    public function getName()
    {
        return 'Text';
    }

    public function twig_summary_filter($value, $paragraphCount = 1)

    {
        if (!extension_loaded('dom'))
        {
            @trigger_error('The DOM Extension is not loaded and is necessary for the "summary" Twig filter.', E_WARNING);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
            return $value;
        }

        $dom = new \DOMDocument();
        $paragraphs = HtmlUtils::htmlXPath($dom, $value, sprintf('//body/p[position() <= %d]', $paragraphCount));

        $summary = '';

        foreach ($paragraphs as $paragraph)
        {
            $summary .= $dom->saveHTML($paragraph);
        }

        return $summary;
    }

    public function twig_truncate_filter(Twig_Environment $env, $value, $length = 30, $preserve = false, $separator = '...')

    {
        if (mb_strlen($value, $env->getCharset()) > $length)
        {
            if ($preserve)
            {
                // If breakpoint is on the last word, return the value without separator.
                if (false === ($breakpoint = mb_strpos($value, ' ', $length, $env->getCharset())))
                {
                    return $value;
                }

                $length = $breakpoint;

            }

            return rtrim(mb_substr($value, 0, $length, $env->getCharset())) . $separator;
        }

        return $value;
    }

    public function twig_wordwrap_filter(Twig_Environment $env, $value, $length = 80, $separator = "\n", $preserve = false)

    {
        $sentences = array();

        $previous = mb_regex_encoding();
        mb_regex_encoding($env->getCharset());

        $pieces = mb_split($separator, $value);
        mb_regex_encoding($previous);

        foreach ($pieces as $piece)
        {
            while (!$preserve && mb_strlen($piece, $env->getCharset()) > $length)
            {
                $sentences[] = mb_substr($piece, 0, $length, $env->getCharset());
                $piece = mb_substr($piece, $length, 2048, $env->getCharset());
            }

            $sentences[] = $piece;
        }

        return implode($separator, $sentences);
    }
}


1		<?php
2
3		namespace allejo\stakx\Twig;
4
5		use allejo\stakx\Utilities\HtmlUtils;
6		use Twig_Environment;
7		use Twig_Extension;
8		use Twig_SimpleFilter;
9
10		/**
11		* This file is part of Twig.
12		*
13		* (c) 2009 Fabien Potencier
14		*
15		* For the full copyright and license information, please view the LICENSE
16		* file that was distributed with this source code.
17		*
18		* @author Henrik Bjornskov <[email protected]>
19		*/
20		class TextExtension extends Twig_Extension
21		{
22		/**
23		* Returns a list of filters.
24		*
25		* @return Twig_SimpleFilter[]
26		*/
27	1	public function getFilters()
28		{
29		return array(
30	1	new Twig_SimpleFilter('summary', array($this, 'twig_summary_filter')),
31	1	new Twig_SimpleFilter('truncate', array($this, 'twig_truncate_filter'), array('needs_environment' => true)),
32	1	new Twig_SimpleFilter('wordwrap', array($this, 'twig_wordwrap_filter'), array('needs_environment' => true)),
33	1	);
34		}
35
36		/**
37		* Name of this extension.
38		*
39		* @return string
40		*/
41	14	public function getName()
42		{
43	14	return 'Text';
44		}
45
46		public function twig_summary_filter($value, $paragraphCount = 1)
		0 ignored issues – show Documentation introduced 2017-10-01 22:57 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history... Coding Style introduced 2017-10-01 22:57 UTC by Report Bug Copy Issue Report This method is not in camel caps format. This check looks for method names that are not written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection seeker becomes `databaseConnectionSeeker`. Loading history...
47		{
48		if (!extension_loaded('dom'))
49		{
50		@trigger_error('The DOM Extension is not loaded and is necessary for the "summary" Twig filter.', E_WARNING);
		0 ignored issues – show Security Best Practice introduced 2017-12-23 05:55 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
51		return $value;
52		}
53
54		$dom = new \DOMDocument();
55		$paragraphs = HtmlUtils::htmlXPath($dom, $value, sprintf('//body/p[position() <= %d]', $paragraphCount));
56
57		$summary = '';
58
59		foreach ($paragraphs as $paragraph)
60		{
61		$summary .= $dom->saveHTML($paragraph);
62		}
63
64		return $summary;
65		}
66
67		public function twig_truncate_filter(Twig_Environment $env, $value, $length = 30, $preserve = false, $separator = '...')
		0 ignored issues – show Documentation introduced 2017-10-01 22:57 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history... Coding Style introduced 2017-10-01 22:57 UTC by Report Bug Copy Issue Report This method is not in camel caps format. This check looks for method names that are not written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection seeker becomes `databaseConnectionSeeker`. Loading history...
68		{
69		if (mb_strlen($value, $env->getCharset()) > $length)
70		{
71		if ($preserve)
72		{
73		// If breakpoint is on the last word, return the value without separator.
74		if (false === ($breakpoint = mb_strpos($value, ' ', $length, $env->getCharset())))
75		{
76		return $value;
77		}
78
79		$length = $breakpoint;
		0 ignored issues – show Coding Style introduced 2017-03-25 02:33 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$length`. This often makes code more readable. Loading history...
80		}
81
82		return rtrim(mb_substr($value, 0, $length, $env->getCharset())) . $separator;
83		}
84
85		return $value;
86		}
87
88		public function twig_wordwrap_filter(Twig_Environment $env, $value, $length = 80, $separator = "\n", $preserve = false)
		0 ignored issues – show Coding Style introduced 2017-10-01 22:57 UTC by Report Bug Copy Issue Report This method is not in camel caps format. This check looks for method names that are not written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection seeker becomes `databaseConnectionSeeker`. Loading history...
89		{
90		$sentences = array();
91
92		$previous = mb_regex_encoding();
93		mb_regex_encoding($env->getCharset());
94
95		$pieces = mb_split($separator, $value);
96		mb_regex_encoding($previous);
97
98		foreach ($pieces as $piece)
99		{
100		while (!$preserve && mb_strlen($piece, $env->getCharset()) > $length)
101		{
102		$sentences[] = mb_substr($piece, 0, $length, $env->getCharset());
103		$piece = mb_substr($piece, $length, 2048, $env->getCharset());
104		}
105
106		$sentences[] = $piece;
107		}
108
109		return implode($separator, $sentences);
110		}
111		}
112

stakx-io / stakx

Push — master ( 06332b...67b389 )

TextExtension::getFilters() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like