CTextFilter - Code Metrics - donami/ctable - Measure and Improve Code Quality continuously with Scrutinizer

CTextFilter A
last analyzed 2016-05-07 20:10 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	304
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	304
rs	10
wmc	27
lcom	1
cbo	3

11 Methods

Rating	Name	Size	Complexity
B	doFilter()	26	3
A	bbcode2html()	22	1
A	makeClickable()	10	1
A	markdown()	4	1
A	nl2br()	4	1
B	shortCode()	37	5
A	shortCodeInit()	18	3
C	shortCodeFigure()	48	9
A	shortCodeBaseurl()	4	1
A	shortCodeRelurl()	4	1
A	shortCodeAsset()	4	1

<?php

namespace Anax\Content;

/**
 * Filter and format content.
 *
 */
class CTextFilter
{
    use \Anax\TConfigure,
        \Anax\DI\TInjectionAware;



    /**
     * Call each filter.
     *
     * @param string $text    the text to filter.
     * @param string $filters as comma separated list of filter.
     *
     * @return string the formatted text.
     */
    public function doFilter($text, $filters)
    {
        // Define all valid filters with their callback function.
        $callbacks = array(
            'bbcode'    => 'bbcode2html',
            'clickable' => 'makeClickable',
            'markdown'  => 'markdown',
            'nl2br'     => 'nl2br',
            'shortcode' => 'shortCode',
        );

        // Make an array of the comma separated string $filters
        $filter = preg_replace('/\s/', '', explode(',', $filters));

        // For each filter, call its function with the $text as parameter.
        foreach ($filter as $key) {

            if (isset($callbacks[$key])) {
                $text = call_user_func_array([$this, $callbacks[$key]], [$text]);
            } else {
                throw new \Exception("The filter '$filter' is not a valid filter string.");
            }
        }

        return $text;
    }



    /**
     * Helper, BBCode formatting converting to HTML.
     *
     * @param string $text The text to be converted.
     *
     * @return string the formatted text.
     *
     * @link http://dbwebb.se/coachen/reguljara-uttryck-i-php-ger-bbcode-formattering
     */
    public function bbcode2html($text)
    {
        $search = [
            '/\[b\](.*?)\[\/b\]/is',
            '/\[i\](.*?)\[\/i\]/is',
            '/\[u\](.*?)\[\/u\]/is',
            '/\[img\](https?.*?)\[\/img\]/is',
            '/\[url\](https?.*?)\[\/url\]/is',
            '/\[url=(https?.*?)\](.*?)\[\/url\]/is'
        ];

        $replace = [
            '<strong>$1</strong>',
            '<em>$1</em>',
            '<u>$1</u>',
            '<img src="$1" />',
            '<a href="$1">$1</a>',
            '<a href="$1">$2</a>'
        ];

        return preg_replace($search, $replace, $text);
    }



    /**
     * Make clickable links from URLs in text.
     *
     * @param string $text the text that should be formatted.
     *
     * @return string with formatted anchors.
     *
     * @link http://dbwebb.se/coachen/lat-php-funktion-make-clickable-automatiskt-skapa-klickbara-lankar
     */
    public function makeClickable($text)
    {
        return preg_replace_callback(
            '#\b(?<![href|src]=[\'"])https?://[^\s()<>]+(?:\([\w\d]+\)|([^[:punct:]\s]|/))#',
            function ($matches) {
                return "<a href=\'{$matches[0]}\'>{$matches[0]}</a>";
            },
            $text
        );
    }



    /**
     * Format text according to Markdown syntax.
     *
     * @param string $text the text that should be formatted.
     *
     * @return string as the formatted html-text.
     *
     * @link http://dbwebb.se/coachen/skriv-for-webben-med-markdown-och-formattera-till-html-med-php
     */
    public function markdown($text)
    {
        return \Michelf\MarkdownExtra::defaultTransform($text);
    }



    /**
     * For convenience access to nl2br
     *
     * @param string $text text to be converted.
     *
     * @return string the formatted text.
     */
    public function nl2br($text)
    {
        return nl2br($text);
    }



    /**
     * Shortcode to to quicker format text as HTML.
     *
     * @param string $text text to be converted.
     *
     * @return string the formatted text.
     */
    public function shortCode($text)
    {
        $patterns = [
            '/\[(FIGURE)[\s+](.+)\]/',
            '/\[(BASEURL)\]/',
            '/\[(RELURL)\]/',
            '/\[(ASSET)\]/',
        ];

        return preg_replace_callback(
            $patterns,
            function ($matches) {
                switch ($matches[1]) {

                    case 'FIGURE':
                        return CTextFilter::ShortCodeFigure($matches[2]);
                        break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

                    case 'BASEURL':
                        return CTextFilter::ShortCodeBaseurl();
                        break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

                    case 'RELURL':
                        return CTextFilter::ShortCodeRelurl();
                        break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

                    case 'ASSET':
                        return CTextFilter::ShortCodeAsset();
                        break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

                    default:
                        return "{$matches[1]} is unknown shortcode.";
                }
            },
            $text
        );
    }



    /**
    * Init shortcode handling by preparing the option list to an array, for those using arguments.
    *
    * @param string $options for the shortcode.
    *
    * @return array with all the options.
    */
    protected static function shortCodeInit($options)
    {
        preg_match_all('/[a-zA-Z0-9]+="[^"]+"|\S+/', $options, $matches);

        $res = [];
        foreach ($matches[0] as $match) {
            $pos = strpos($match, '=');
            if ($pos == false) {

                $res[$match] = true;
            } else {
                $key = substr($match, 0, $pos);
                $val = trim(substr($match, $pos+1), '"');
                $res[$key] = $val;
            }
        }

        return $res;
    }



    /**
     * Shortcode for <figure>.
     *
     * Usage example: [FIGURE src="img/home/me.jpg" caption="Me" alt="Bild på mig" nolink="nolink"]
     *
     * @param string $options for the shortcode.
     *
     * @return array with all the options.
     */
    protected static function shortCodeFigure($options)
    {
        extract(
            array_merge(

                [
                    'id' => null,
                    'class' => null,
                    'src' => null,
                    'title' => null,
                    'alt' => null,
                    'caption' => null,
                    'href' => null,
                    'nolink' => false,
                ],
                CTextFilter::ShortCodeInit($options)
            ),
            EXTR_SKIP
        );

        $id = $id ? " id='$id'" : null;
        $class = $class ? " class='figure $class'" : " class='figure'";
        $title = $title ? " title='$title'" : null;

        if (!$alt && $caption) {
            $alt = $caption;
        }

        if (!$href) {
            $pos = strpos($src, '?');
            $href = $pos ? substr($src, 0, $pos) : $src;
        }

        $a_start = null;
        $a_end = null;
        if (!$nolink) {
            $a_start = "<a href='{$href}'>";
            $a_end = "</a>";
        }

        $html = <<<EOD
<figure{$id}{$class}>
{$a_start}<img src='{$src}' alt='{$alt}'{$title}/>{$a_end}
<figcaption markdown=1>{$caption}</figcaption>
</figure>
EOD;

        return $html;
    }



    /**
     * Shortcode for adding BASEURL to links.
     *
     * Usage example: [BASEURL]
     *
     * @return array with all the options.
     */
    protected function shortCodeBaseurl()
    {
        return $this->di->url->create() . "/";
    }



    /**
     * Shortcode for adding RELURL to links.
     *
     * Usage example: [RELURL]
     *
     * @return array with all the options.
     */
    protected function shortCodeRelurl()
    {
        return $this->di->url->createRelative() . "/";
    }


    /**
    * Shortcode for adding RELURL to links.
    *
    * Usage example: [RELURL]
    *
    * @return array with all the options.
    */
    protected function shortCodeAsset()
    {
        return $this->di->url->asset() . "/";
    }
}


1			<?php
2
3			namespace Anax\Content;
4
5			/**
6			* Filter and format content.
7			*
8			*/
9			class CTextFilter
10			{
11			use \Anax\TConfigure,
12			\Anax\DI\TInjectionAware;
13
14
15
16			/**
17			* Call each filter.
18			*
19			* @param string $text the text to filter.
20			* @param string $filters as comma separated list of filter.
21			*
22			* @return string the formatted text.
23			*/
24			public function doFilter($text, $filters)
25			{
26			// Define all valid filters with their callback function.
27			$callbacks = array(
28			'bbcode' => 'bbcode2html',
29			'clickable' => 'makeClickable',
30			'markdown' => 'markdown',
31			'nl2br' => 'nl2br',
32			'shortcode' => 'shortCode',
33			);
34
35			// Make an array of the comma separated string $filters
36			$filter = preg_replace('/\s/', '', explode(',', $filters));
37
38			// For each filter, call its function with the $text as parameter.
39			foreach ($filter as $key) {
40
41			if (isset($callbacks[$key])) {
42			$text = call_user_func_array([$this, $callbacks[$key]], [$text]);
43			} else {
44			throw new \Exception("The filter '$filter' is not a valid filter string.");
45			}
46			}
47
48			return $text;
49			}
50
51
52
53			/**
54			* Helper, BBCode formatting converting to HTML.
55			*
56			* @param string $text The text to be converted.
57			*
58			* @return string the formatted text.
59			*
60			* @link http://dbwebb.se/coachen/reguljara-uttryck-i-php-ger-bbcode-formattering
61			*/
62			public function bbcode2html($text)
63			{
64			$search = [
65			'/\[b\](.*?)\[\/b\]/is',
66			'/\[i\](.*?)\[\/i\]/is',
67			'/\[u\](.*?)\[\/u\]/is',
68			'/\[img\](https?.*?)\[\/img\]/is',
69			'/\[url\](https?.*?)\[\/url\]/is',
70			'/\[url=(https?.?)\](.?)\[\/url\]/is'
71			];
72
73			$replace = [
74			'<strong>$1</strong>',
75			'<em>$1</em>',
76			'<u>$1</u>',
77			'<img src="$1" />',
78			'<a href="$1">$1</a>',
79			'<a href="$1">$2</a>'
80			];
81
82			return preg_replace($search, $replace, $text);
83			}
84
85
86
87			/**
88			* Make clickable links from URLs in text.
89			*
90			* @param string $text the text that should be formatted.
91			*
92			* @return string with formatted anchors.
93			*
94			* @link http://dbwebb.se/coachen/lat-php-funktion-make-clickable-automatiskt-skapa-klickbara-lankar
95			*/
96			public function makeClickable($text)
97			{
98			return preg_replace_callback(
99			'#\b(?<![href\|src]=[\'"])https?://[^\s()<>]+(?:\([\w\d]+\)\|([^[:punct:]\s]\|/))#',
100			function ($matches) {
101			return "<a href=\'{$matches[0]}\'>{$matches[0]}</a>";
102			},
103			$text
104			);
105			}
106
107
108
109			/**
110			* Format text according to Markdown syntax.
111			*
112			* @param string $text the text that should be formatted.
113			*
114			* @return string as the formatted html-text.
115			*
116			* @link http://dbwebb.se/coachen/skriv-for-webben-med-markdown-och-formattera-till-html-med-php
117			*/
118			public function markdown($text)
119			{
120			return \Michelf\MarkdownExtra::defaultTransform($text);
121			}
122
123
124
125			/**
126			* For convenience access to nl2br
127			*
128			* @param string $text text to be converted.
129			*
130			* @return string the formatted text.
131			*/
132			public function nl2br($text)
133			{
134			return nl2br($text);
135			}
136
137
138
139			/**
140			* Shortcode to to quicker format text as HTML.
141			*
142			* @param string $text text to be converted.
143			*
144			* @return string the formatted text.
145			*/
146			public function shortCode($text)
147			{
148			$patterns = [
149			'/\[(FIGURE)[\s+](.+)\]/',
150			'/\[(BASEURL)\]/',
151			'/\[(RELURL)\]/',
152			'/\[(ASSET)\]/',
153			];
154
155			return preg_replace_callback(
156			$patterns,
157			function ($matches) {
158			switch ($matches[1]) {
159
160			case 'FIGURE':
161			return CTextFilter::ShortCodeFigure($matches[2]);
162			break;
			0 ignored issues – show Unused Code introduced 2016-05-07 19:47 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
163
164			case 'BASEURL':
165			return CTextFilter::ShortCodeBaseurl();
166			break;
			0 ignored issues – show Unused Code introduced 2016-05-07 19:47 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
167
168			case 'RELURL':
169			return CTextFilter::ShortCodeRelurl();
170			break;
			0 ignored issues – show Unused Code introduced 2016-05-07 19:47 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
171
172			case 'ASSET':
173			return CTextFilter::ShortCodeAsset();
174			break;
			0 ignored issues – show Unused Code introduced 2016-05-07 19:47 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
175
176			default:
177			return "{$matches[1]} is unknown shortcode.";
178			}
179			},
180			$text
181			);
182			}
183
184
185
186			/**
187			* Init shortcode handling by preparing the option list to an array, for those using arguments.
188			*
189			* @param string $options for the shortcode.
190			*
191			* @return array with all the options.
192			*/
193			protected static function shortCodeInit($options)
194			{
195			preg_match_all('/[a-zA-Z0-9]+="[^"]+"\|\S+/', $options, $matches);
196
197			$res = [];
198			foreach ($matches[0] as $match) {
199			$pos = strpos($match, '=');
200			if ($pos == false) {
			0 ignored issues – show Bug Best Practice introduced 2016-05-07 19:47 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `$pos` of type `integer` to the boolean `false`. If you are specifically checking for 0, consider using something more explicit like `=== 0` instead. Loading history...
201			$res[$match] = true;
202			} else {
203			$key = substr($match, 0, $pos);
204			$val = trim(substr($match, $pos+1), '"');
205			$res[$key] = $val;
206			}
207			}
208
209			return $res;
210			}
211
212
213
214			/**
215			* Shortcode for <figure>.
216			*
217			* Usage example: [FIGURE src="img/home/me.jpg" caption="Me" alt="Bild på mig" nolink="nolink"]
218			*
219			* @param string $options for the shortcode.
220			*
221			* @return array with all the options.
222			*/
223			protected static function shortCodeFigure($options)
224			{
225			extract(
226			array_merge(
			0 ignored issues – show Bug introduced 2016-05-07 19:47 UTC by Report Bug Copy Issue Report `array_merge(array('id' =...hortCodeInit($options))` cannot be passed to `extract()` as the parameter `$var_array` expects a reference. Loading history...
227			[
228			'id' => null,
229			'class' => null,
230			'src' => null,
231			'title' => null,
232			'alt' => null,
233			'caption' => null,
234			'href' => null,
235			'nolink' => false,
236			],
237			CTextFilter::ShortCodeInit($options)
238			),
239			EXTR_SKIP
240			);
241
242			$id = $id ? " id='$id'" : null;
243			$class = $class ? " class='figure $class'" : " class='figure'";
244			$title = $title ? " title='$title'" : null;
245
246			if (!$alt && $caption) {
247			$alt = $caption;
248			}
249
250			if (!$href) {
251			$pos = strpos($src, '?');
252			$href = $pos ? substr($src, 0, $pos) : $src;
253			}
254
255			$a_start = null;
256			$a_end = null;
257			if (!$nolink) {
258			$a_start = "<a href='{$href}'>";
259			$a_end = "</a>";
260			}
261
262			$html = <<<EOD
263			<figure{$id}{$class}>
264			{$a_start}<img src='{$src}' alt='{$alt}'{$title}/>{$a_end}
265			<figcaption markdown=1>{$caption}</figcaption>
266			</figure>
267			EOD;
268
269			return $html;
270			}
271
272
273
274			/**
275			* Shortcode for adding BASEURL to links.
276			*
277			* Usage example: [BASEURL]
278			*
279			* @return array with all the options.
280			*/
281			protected function shortCodeBaseurl()
282			{
283			return $this->di->url->create() . "/";
284			}
285
286
287
288			/**
289			* Shortcode for adding RELURL to links.
290			*
291			* Usage example: [RELURL]
292			*
293			* @return array with all the options.
294			*/
295			protected function shortCodeRelurl()
296			{
297			return $this->di->url->createRelative() . "/";
298			}
299
300
301			/**
302			* Shortcode for adding RELURL to links.
303			*
304			* Usage example: [RELURL]
305			*
306			* @return array with all the options.
307			*/
308			protected function shortCodeAsset()
309			{
310			return $this->di->url->asset() . "/";
311			}
312			}
313

donami / ctable

CTextFilter A last analyzed 2016-05-07 20:10 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

11 Methods

Duplication Side-by-Side

Filter issues like

CTextFilter A
last analyzed 2016-05-07 20:10 UTC