TextFilter::yamlFrontMatter() - Code Metrics - Inspection of "Extracted from mos/ctextfilter to be an anax modul..." - canax/textfilter - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 2ec628...6a2b22 )

by Mikael

created 2017-05-03 16:27 UTC

TextFilter::yamlFrontMatter() A

↳ Parent: TextFilter

Complexity

Conditions	2
Paths	2

Size

Total Lines	13
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	13
ccs	0
cts	7
cp	0
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	7
nc	2
nop	1
crap	6

<?php

namespace Anax\TextFilter;

/**
 * Filter and format content.
 *
 */
class TextFilter
{
    use TTextUtilities,
        TShortcode;



    /**
     * Supported filters.
     */
    private $filters = [
        "jsonfrontmatter",
        "yamlfrontmatter",
        "bbcode",
        "clickable",
        "shortcode",
        "markdown",
//        "geshi",
        "nl2br",
        "htmlentities",
        "purify",
        "titlefromh1",
        "titlefromheader",
        "anchor4Header",
     ];



     /**
      * Current document parsed.
      */
    private $current;



    /**
     * Hold meta information for filters to use.
     */
    private $meta = [];



    /**
     * Call each filter.
     *
     * @deprecated deprecated since version 1.2 in favour of parse().
     *
     * @param string       $text    the text to filter.
     * @param string|array $filters as comma separated list of filter,
     *                              or filters sent in as array.
     *
     * @return string the formatted text.
     */
    public function doFilter($text, $filters)
    {
        // Define all valid filters with their callback function.
        $callbacks = [
            'bbcode'    => 'bbcode2html',
            'clickable' => 'makeClickable',
            'shortcode' => 'shortCode',
            'markdown'  => 'markdown',
            'nl2br'     => 'nl2br',
            'purify'    => 'purify',
        ];

        // Make an array of the comma separated string $filters
        if (is_array($filters)) {
            $filter = $filters;
        } else {
            $filters = strtolower($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])) {
                throw new Exception("The filter '$filters' is not a valid filter string due to '$key'.");
            }
            $text = call_user_func_array([$this, $callbacks[$key]], [$text]);
        }

        return $text;
    }



    /**
     * Set meta information that some filters can use.
     *
     * @param array $meta values for filters to use.
     *
     * @return void
     */
    public function setMeta($meta)
    {
        return $this->meta = $meta;
    }



    /**
     * Return an array of all filters supported.
     *
     * @return array with strings of filters supported.
     */
    public function getFilters()
    {
        return $this->filters;
    }



    /**
     * Check if filter is supported.
     *
     * @param string $filter to use.
     *
     * @throws mos/TextFilter/Exception  when filter does not exists.
     *
     * @return boolean true if filter exists, false othwerwise.
     */
    public function hasFilter($filter)
    {
        return in_array($filter, $this->filters);
    }



    /**
     * Add array items to frontmatter.
     *
     * @param array|null $matter key value array with items to add
     *                           or null if empty.
     *
     * @return $this
     */
    private function addToFrontmatter($matter)
    {
        if (empty($matter) || !is_array($matter)) {
            return $this;
        }

        if (is_null($this->current->frontmatter)) {
            $this->current->frontmatter = [];
        }

        $this->current->frontmatter = array_merge($this->current->frontmatter, $matter);
        return $this;
    }



    /**
     * Call a specific filter and store its details.
     *
     * @param string $filter to use.
     *
     * @throws mos/TextFilter/Exception when filter does not exists.
     *
     * @return string the formatted text.
     */
    private function parseFactory($filter)
    {
        // Define single tasks filter with a callback.
        $callbacks = [
            "bbcode"    => "bbcode2html",
            "clickable" => "makeClickable",
            "shortcode" => "shortCode",
            "markdown"  => "markdown",
            //"geshi"     => "syntaxHighlightGeSHi",
            "nl2br"     => "nl2br",
            "htmlentities" => "htmlentities",
            "purify"    => "purify",
            'anchor4Header' => 'createAnchor4Header',
        ];

        // Do the specific filter
        $text = $this->current->text;
        switch ($filter) {
            case "jsonfrontmatter":
                $res = $this->jsonFrontMatter($text);
                $this->current->text = $res["text"];
                $this->addToFrontmatter($res["frontmatter"]);
                break;

            case "yamlfrontmatter":
                $res = $this->yamlFrontMatter($text);
                $this->current->text = $res["text"];
                $this->addToFrontmatter($res["frontmatter"]);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
                break;

            case "titlefromh1":

                $title = $this->getTitleFromFirstH1($text);
                $this->current->text = $text;
                if (!isset($this->current->frontmatter["title"])) {
                    $this->addToFrontmatter(["title" => $title]);
                }
                break;

            case "titlefromheader":

                $title = $this->getTitleFromFirstHeader($text);
                $this->current->text = $text;
                if (!isset($this->current->frontmatter["title"])) {
                    $this->addToFrontmatter(["title" => $title]);
                }
                break;

            case "bbcode":
            case "clickable":
            case "shortcode":
            case "markdown":
            //case "geshi":
            case "nl2br":
            case "htmlentities":
            case "purify":
            case "anchor4Header":
                $this->current->text = call_user_func_array(
                    [$this, $callbacks[$filter]],
                    [$text]
                );
                break;

            default:
                throw new Exception("The filter '$filter' is not a valid filter     string.");
        }
    }



    /**
     * Call each filter and return array with details of the formatted content.
     *
     * @param string $text   the text to filter.
     * @param array  $filter array of filters to use.
     *
     * @throws mos/TextFilter/Exception  when filterd does not exists.
     *
     * @return array with the formatted text and additional details.
     */
    public function parse($text, $filter)
    {
        $this->current = new \stdClass();
        $this->current->frontmatter = [];
        $this->current->text = $text;

        foreach ($filter as $key) {
            $this->parseFactory($key);
        }

        $this->current->text = $this->getUntilStop($this->current->text);

        return $this->current;
    }



    /**
     * Add excerpt as short version of text if available.
     *
     * @param object &$current same structure as returned by parse().
     *
     * @return void.

     */
    public function addExcerpt($current)
    {
        list($excerpt, $hasMore) = $this->getUntilMore($current->text);
        $current->excerpt = $excerpt;
        $current->hasMore = $hasMore;
    }



    /**
     * Extract front matter from text.
     *
     * @param string $text       the text to be parsed.
     * @param string $startToken the start token.
     * @param string $stopToken  the stop token.
     *
     * @return array with the formatted text and the front matter.
     */
    private function extractFrontMatter($text, $startToken, $stopToken)
    {
        $tokenLength = strlen($startToken);

        $start = strpos($text, $startToken);
        // Is a valid start?
        if ($start !== false && $start !== 0) {
            if ($text[$start - 1] !== "\n") {
                $start = false;
            }
        }

        $frontmatter = null;
        if ($start !== false) {
            $stop = strpos($text, $stopToken, $tokenLength - 1);

            if ($stop !== false && $text[$stop - 1] === "\n") {
                $length = $stop - ($start + $tokenLength);

                $frontmatter = substr($text, $start + $tokenLength, $length);
                $textStart = substr($text, 0, $start);
                $text = $textStart . substr($text, $stop + $tokenLength);
            }
        }

        return [$text, $frontmatter];
    }



    /**
     * Extract JSON front matter from text.
     *
     * @param string $text the text to be parsed.
     *
     * @return array with the formatted text and the front matter.
     */
    public function jsonFrontMatter($text)
    {
        list($text, $frontmatter) = $this->extractFrontMatter($text, "{{{\n", "}}}\n");

        if (!empty($frontmatter)) {
            $frontmatter = json_decode($frontmatter, true);

            if (is_null($frontmatter)) {
                throw new Exception("Failed parsing JSON frontmatter.");
            }
        }

        return [
            "text" => $text,
            "frontmatter" => $frontmatter
        ];
    }



    /**
     * Extract YAML front matter from text.
     *
     * @param string $text the text to be parsed.
     *
     * @return array with the formatted text and the front matter.
     */
    public function yamlFrontMatter($text)
    {
        list($text, $frontmatter) = $this->extractFrontMatter($text, "---\n", "...\n");

        if (!empty($frontmatter)) {
            $frontmatter = $this->yamlParse("---\n$frontmatter...\n");
        }

        return [
            "text" => $text,
            "frontmatter" => $frontmatter
        ];
    }



    /**
     * Extract YAML front matter from text, use one of several available
     * implementations of a YAML parser.
     *
     * @param string $text the text to be parsed.
     *
     * @throws: Exception when parsing frontmatter fails.
     *
     * @return array with the formatted text and the front matter.
     */
    public function yamlParse($text)
    {
        if (function_exists("yaml_parse")) {
            // Prefer php5-yaml extension
            $parsed = yaml_parse($text);

            if ($parsed === false) {
                throw new Exception("Failed parsing YAML frontmatter.");
            }

            return $parsed;
        }

        if (method_exists("Symfony\Component\Yaml\Yaml", "parse")) {
            // symfony/yaml
            $parsed = \Symfony\Component\Yaml\Yaml::parse($text);
            return $parsed;
        }

        if (function_exists("spyc_load")) {
            // mustangostang/spyc
            $parsed = spyc_load($text);
            return $parsed;
        }

        throw new Exception("Could not find support for YAML.");
    }



    /**
     * Get the title from the first H1.
     *
     * @param string $text the text to be parsed.
     *
     * @return string|null with the title, if its found.
     */
    public function getTitleFromFirstH1($text)

    {
        $matches = [];
        $title = null;

        if (preg_match("#<h1.*?>(.*)</h1>#", $text, $matches)) {
            $title = strip_tags($matches[1]);
        }

        return $title;
    }



    /**
     * Get the title from the first header.
     *
     * @param string $text the text to be parsed.
     *
     * @return string|null with the title, if its found.
     */
    public function getTitleFromFirstHeader($text)

    {
        $matches = [];
        $title = null;

        if (preg_match("#<h[1-6].*?>(.*)</h[1-6]>#", $text, $matches)) {
            $title = strip_tags($matches[1]);
        }

        return $title;
    }



    /**
     * 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
        );
    }



    /**
     * Syntax highlighter using GeSHi http://qbnz.com/highlighter/.
     *
     * @param string $text     text to be converted.
     * @param string $language which language to use for highlighting syntax.
     *
     * @return string the formatted text.
     */
     /*
    public function syntaxHighlightGeSHi($text, $language = "text")
    {
        $language = $language ?: "text";
        //$language = ($language === 'html') ? 'html4strict' : $language;
        $language = ($language === 'html') ? 'html5' : $language;

        $geshi = new \GeSHi($text, $language);
        $geshi->set_overall_class('geshi');
        $geshi->enable_classes('geshi');
        //$geshi->set_header_type(GESHI_HEADER_PRE_VALID);
        //$geshi->enable_line_numbers(GESHI_NORMAL_LINE_NUMBERS);
        $code = $geshi->parse_code();

        //echo "<pre>$language\n$code\n", $geshi->get_stylesheet(false) , "</pre>"; exit;

        // Replace last &nbsp;</pre>, -strlen("&nbsp;</pre>") == 12
        $length = strlen("&nbsp;</pre>");
        if (substr($code, -$length) == "&nbsp;</pre>") {
            $code = substr_replace($code, "</pre>", -$length);
        }

        return $code;
    }
*/



    /**
     * Syntax highlighter using highlight.php, a port of highlight.js
     * https://packagist.org/packages/scrivo/highlight.php.
     *
     * @param string $text     text to be converted.
     * @param string $language which language to use for highlighting syntax.
     *
     * @return string the formatted text.
     */
    public function syntaxHighlightJs($text, $language = "text")
    {
        if ($language === "text" || empty($language)) {
            return "<pre class=\"hljs\">" . htmlentities($text) . "</pre>";
        }

        $highlight = new \Highlight\Highlighter();
        $res = $highlight->highlight($language, $text);

        return "<pre class=\"hljs\">$res->value</pre>";
    }



    /**
     * Format text according to HTML Purifier.
     *
     * @param string $text that should be formatted.
     *
     * @return string as the formatted html-text.
     */
    public function purify($text)
    {
        $config   = \HTMLPurifier_Config::createDefault();
        $config->set("Cache.DefinitionImpl", null);
        //$config->set('Cache.SerializerPath', '/home/user/absolute/path');

        $purifier = new \HTMLPurifier($config);
    
        return $purifier->purify($text);
    }



    /**
     * Format text according to Markdown syntax.
     *
     * @param string $text the text that should be formatted.
     *
     * @return string as the formatted html-text.
     */
    public function markdown($text)
    {
        $text = \Michelf\MarkdownExtra::defaultTransform($text);
        $text = \Michelf\SmartyPantsTypographer::defaultTransform(
            $text,
            "2"
        );
        return $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);
    }



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


1			<?php
2
3			namespace Anax\TextFilter;
4
5			/**
6			* Filter and format content.
7			*
8			*/
9			class TextFilter
10			{
11			use TTextUtilities,
12			TShortcode;
13
14
15
16			/**
17			* Supported filters.
18			*/
19			private $filters = [
20			"jsonfrontmatter",
21			"yamlfrontmatter",
22			"bbcode",
23			"clickable",
24			"shortcode",
25			"markdown",
26			// "geshi",
27			"nl2br",
28			"htmlentities",
29			"purify",
30			"titlefromh1",
31			"titlefromheader",
32			"anchor4Header",
33			];
34
35
36
37			/**
38			* Current document parsed.
39			*/
40			private $current;
41
42
43
44			/**
45			* Hold meta information for filters to use.
46			*/
47			private $meta = [];
48
49
50
51			/**
52			* Call each filter.
53			*
54			* @deprecated deprecated since version 1.2 in favour of parse().
55			*
56			* @param string $text the text to filter.
57			* @param string\|array $filters as comma separated list of filter,
58			* or filters sent in as array.
59			*
60			* @return string the formatted text.
61			*/
62			public function doFilter($text, $filters)
63			{
64			// Define all valid filters with their callback function.
65			$callbacks = [
66			'bbcode' => 'bbcode2html',
67			'clickable' => 'makeClickable',
68			'shortcode' => 'shortCode',
69			'markdown' => 'markdown',
70			'nl2br' => 'nl2br',
71			'purify' => 'purify',
72			];
73
74			// Make an array of the comma separated string $filters
75			if (is_array($filters)) {
76			$filter = $filters;
77			} else {
78			$filters = strtolower($filters);
79			$filter = preg_replace('/\s/', '', explode(',', $filters));
80			}
81
82			// For each filter, call its function with the $text as parameter.
83			foreach ($filter as $key) {
84			if (!isset($callbacks[$key])) {
85			throw new Exception("The filter '$filters' is not a valid filter string due to '$key'.");
86			}
87			$text = call_user_func_array([$this, $callbacks[$key]], [$text]);
88			}
89
90			return $text;
91			}
92
93
94
95			/**
96			* Set meta information that some filters can use.
97			*
98			* @param array $meta values for filters to use.
99			*
100			* @return void
101			*/
102			public function setMeta($meta)
103			{
104			return $this->meta = $meta;
105			}
106
107
108
109			/**
110			* Return an array of all filters supported.
111			*
112			* @return array with strings of filters supported.
113			*/
114	1		public function getFilters()
115			{
116	1		return $this->filters;
117	1		}
118
119
120
121			/**
122			* Check if filter is supported.
123			*
124			* @param string $filter to use.
125			*
126			* @throws mos/TextFilter/Exception when filter does not exists.
127			*
128			* @return boolean true if filter exists, false othwerwise.
129			*/
130	2		public function hasFilter($filter)
131			{
132	2		return in_array($filter, $this->filters);
133			}
134
135
136
137			/**
138			* Add array items to frontmatter.
139			*
140			* @param array\|null $matter key value array with items to add
141			* or null if empty.
142			*
143			* @return $this
144			*/
145	3		private function addToFrontmatter($matter)
146			{
147	3		if (empty($matter) \|\| !is_array($matter)) {
148	2		return $this;
149			}
150
151	2		if (is_null($this->current->frontmatter)) {
152			$this->current->frontmatter = [];
153	1		}
154
155	3		$this->current->frontmatter = array_merge($this->current->frontmatter, $matter);
156	3		return $this;
157			}
158
159
160
161			/**
162			* Call a specific filter and store its details.
163			*
164			* @param string $filter to use.
165			*
166			* @throws mos/TextFilter/Exception when filter does not exists.
167			*
168			* @return string the formatted text.
169			*/
170	4		private function parseFactory($filter)
171			{
172			// Define single tasks filter with a callback.
173			$callbacks = [
174	4		"bbcode" => "bbcode2html",
175	4		"clickable" => "makeClickable",
176	4		"shortcode" => "shortCode",
177	4		"markdown" => "markdown",
178			//"geshi" => "syntaxHighlightGeSHi",
179	4		"nl2br" => "nl2br",
180	4		"htmlentities" => "htmlentities",
181	4		"purify" => "purify",
182	4		'anchor4Header' => 'createAnchor4Header',
183	4		];
184
185			// Do the specific filter
186	4		$text = $this->current->text;
187			switch ($filter) {
188	4		case "jsonfrontmatter":
189	3		$res = $this->jsonFrontMatter($text);
190	3		$this->current->text = $res["text"];
191	3		$this->addToFrontmatter($res["frontmatter"]);
192	3		break;
193
194	2		case "yamlfrontmatter":
195			$res = $this->yamlFrontMatter($text);
196			$this->current->text = $res["text"];
197			$this->addToFrontmatter($res["frontmatter"]);
			0 ignored issues – show Bug introduced 2017-05-03 16:29 UTC by Report Bug Copy Issue Report It seems like `$res['frontmatter']` can also be of type `string`; however, `Anax\TextFilter\TextFilter::addToFrontmatter()` does only seem to accept `array\|null`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
198			break;
199
200	2	View Code Duplication	case "titlefromh1":
			0 ignored issues – show Duplication introduced 2017-04-07 23:37 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
201	1		$title = $this->getTitleFromFirstH1($text);
202	1		$this->current->text = $text;
203	1		if (!isset($this->current->frontmatter["title"])) {
204	1		$this->addToFrontmatter(["title" => $title]);
205	1		}
206	1		break;
207
208	2	View Code Duplication	case "titlefromheader":
			0 ignored issues – show Duplication introduced 2017-04-07 23:37 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
209			$title = $this->getTitleFromFirstHeader($text);
210			$this->current->text = $text;
211			if (!isset($this->current->frontmatter["title"])) {
212			$this->addToFrontmatter(["title" => $title]);
213			}
214			break;
215
216	2		case "bbcode":
217	2		case "clickable":
218	2		case "shortcode":
219	2		case "markdown":
220			//case "geshi":
221	2		case "nl2br":
222	2		case "htmlentities":
223	2		case "purify":
224	2		case "anchor4Header":
225	2		$this->current->text = call_user_func_array(
226	2		[$this, $callbacks[$filter]],
227	2		[$text]
228	2		);
229	2		break;
230
231			default:
232			throw new Exception("The filter '$filter' is not a valid filter string.");
233			}
234	4		}
235
236
237
238			/**
239			* Call each filter and return array with details of the formatted content.
240			*
241			* @param string $text the text to filter.
242			* @param array $filter array of filters to use.
243			*
244			* @throws mos/TextFilter/Exception when filterd does not exists.
245			*
246			* @return array with the formatted text and additional details.
247			*/
248	6		public function parse($text, $filter)
249			{
250	6		$this->current = new \stdClass();
251	6		$this->current->frontmatter = [];
252	6		$this->current->text = $text;
253
254	6		foreach ($filter as $key) {
255	4		$this->parseFactory($key);
256	6		}
257
258	6		$this->current->text = $this->getUntilStop($this->current->text);
259
260	6		return $this->current;
261			}
262
263
264
265			/**
266			* Add excerpt as short version of text if available.
267			*
268			* @param object &$current same structure as returned by parse().
269			*
270			* @return void.
			0 ignored issues – show Documentation introduced 2017-04-07 23:37 UTC by Report Bug Copy Issue Report The doc-type `void.` could not be parsed: Unknown type name "void." at position 0. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
271			*/
272	2		public function addExcerpt($current)
273			{
274	2		list($excerpt, $hasMore) = $this->getUntilMore($current->text);
275	2		$current->excerpt = $excerpt;
276	2		$current->hasMore = $hasMore;
277	2		}
278
279
280
281			/**
282			* Extract front matter from text.
283			*
284			* @param string $text the text to be parsed.
285			* @param string $startToken the start token.
286			* @param string $stopToken the stop token.
287			*
288			* @return array with the formatted text and the front matter.
289			*/
290	3		private function extractFrontMatter($text, $startToken, $stopToken)
291			{
292	3		$tokenLength = strlen($startToken);
293
294	3		$start = strpos($text, $startToken);
295			// Is a valid start?
296	3		if ($start !== false && $start !== 0) {
297			if ($text[$start - 1] !== "\n") {
298			$start = false;
299			}
300			}
301
302	3		$frontmatter = null;
303	3		if ($start !== false) {
304	3		$stop = strpos($text, $stopToken, $tokenLength - 1);
305
306	3		if ($stop !== false && $text[$stop - 1] === "\n") {
307	2		$length = $stop - ($start + $tokenLength);
308
309	2		$frontmatter = substr($text, $start + $tokenLength, $length);
310	2		$textStart = substr($text, 0, $start);
311	2		$text = $textStart . substr($text, $stop + $tokenLength);
312	2		}
313	3		}
314
315	3		return [$text, $frontmatter];
316			}
317
318
319
320			/**
321			* Extract JSON front matter from text.
322			*
323			* @param string $text the text to be parsed.
324			*
325			* @return array with the formatted text and the front matter.
326			*/
327	3		public function jsonFrontMatter($text)
328			{
329	3		list($text, $frontmatter) = $this->extractFrontMatter($text, "{{{\n", "}}}\n");
330
331	3		if (!empty($frontmatter)) {
332	2		$frontmatter = json_decode($frontmatter, true);
333
334	2		if (is_null($frontmatter)) {
335			throw new Exception("Failed parsing JSON frontmatter.");
336			}
337	2		}
338
339			return [
340	3		"text" => $text,
341			"frontmatter" => $frontmatter
342	3		];
343			}
344
345
346
347			/**
348			* Extract YAML front matter from text.
349			*
350			* @param string $text the text to be parsed.
351			*
352			* @return array with the formatted text and the front matter.
353			*/
354			public function yamlFrontMatter($text)
355			{
356			list($text, $frontmatter) = $this->extractFrontMatter($text, "---\n", "...\n");
357
358			if (!empty($frontmatter)) {
359			$frontmatter = $this->yamlParse("---\n$frontmatter...\n");
360			}
361
362			return [
363			"text" => $text,
364			"frontmatter" => $frontmatter
365			];
366			}
367
368
369
370			/**
371			* Extract YAML front matter from text, use one of several available
372			* implementations of a YAML parser.
373			*
374			* @param string $text the text to be parsed.
375			*
376			* @throws: Exception when parsing frontmatter fails.
377			*
378			* @return array with the formatted text and the front matter.
379			*/
380			public function yamlParse($text)
381			{
382			if (function_exists("yaml_parse")) {
383			// Prefer php5-yaml extension
384			$parsed = yaml_parse($text);
385
386			if ($parsed === false) {
387			throw new Exception("Failed parsing YAML frontmatter.");
388			}
389
390			return $parsed;
391			}
392
393			if (method_exists("Symfony\Component\Yaml\Yaml", "parse")) {
394			// symfony/yaml
395			$parsed = \Symfony\Component\Yaml\Yaml::parse($text);
396			return $parsed;
397			}
398
399			if (function_exists("spyc_load")) {
400			// mustangostang/spyc
401			$parsed = spyc_load($text);
402			return $parsed;
403			}
404
405			throw new Exception("Could not find support for YAML.");
406			}
407
408
409
410			/**
411			* Get the title from the first H1.
412			*
413			* @param string $text the text to be parsed.
414			*
415			* @return string\|null with the title, if its found.
416			*/
417	1	View Code Duplication	public function getTitleFromFirstH1($text)
			0 ignored issues – show Duplication introduced 2017-04-07 23:37 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
418			{
419	1		$matches = [];
420	1		$title = null;
421
422	1		if (preg_match("#<h1.?>(.)</h1>#", $text, $matches)) {
423	1		$title = strip_tags($matches[1]);
424	1		}
425
426	1		return $title;
427			}
428
429
430
431			/**
432			* Get the title from the first header.
433			*
434			* @param string $text the text to be parsed.
435			*
436			* @return string\|null with the title, if its found.
437			*/
438		View Code Duplication	public function getTitleFromFirstHeader($text)
			0 ignored issues – show Duplication introduced 2017-04-07 23:37 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
439			{
440			$matches = [];
441			$title = null;
442
443			if (preg_match("#<h[1-6].?>(.)</h[1-6]>#", $text, $matches)) {
444			$title = strip_tags($matches[1]);
445			}
446
447			return $title;
448			}
449
450
451
452			/**
453			* Helper, BBCode formatting converting to HTML.
454			*
455			* @param string $text The text to be converted.
456			*
457			* @return string the formatted text.
458			*
459			* @link http://dbwebb.se/coachen/reguljara-uttryck-i-php-ger-bbcode-formattering
460			*/
461	3		public function bbcode2html($text)
462			{
463			$search = [
464	3		'/\[b\](.*?)\[\/b\]/is',
465	3		'/\[i\](.*?)\[\/i\]/is',
466	3		'/\[u\](.*?)\[\/u\]/is',
467	3		'/\[img\](https?.*?)\[\/img\]/is',
468	3		'/\[url\](https?.*?)\[\/url\]/is',
469			'/\[url=(https?.?)\](.?)\[\/url\]/is'
470	3		];
471
472			$replace = [
473	3		'<strong>$1</strong>',
474	3		'<em>$1</em>',
475	3		'<u>$1</u>',
476	3		'<img src="$1" />',
477	3		'<a href="$1">$1</a>',
478			'<a href="$1">$2</a>'
479	3		];
480
481	3		return preg_replace($search, $replace, $text);
482			}
483
484
485
486			/**
487			* Make clickable links from URLs in text.
488			*
489			* @param string $text the text that should be formatted.
490			*
491			* @return string with formatted anchors.
492			*
493			* @link http://dbwebb.se/coachen/lat-php-funktion-make-clickable-automatiskt-skapa-klickbara-lankar
494			*/
495	1		public function makeClickable($text)
496			{
497	1		return preg_replace_callback(
498	1		'#\b(?<![href\|src]=[\'"])https?://[^\s()<>]+(?:\([\w\d]+\)\|([^[:punct:]\s]\|/))#',
499	1		function ($matches) {
500	1		return "<a href='{$matches[0]}'>{$matches[0]}</a>";
501	1		},
502			$text
503	1		);
504			}
505
506
507
508			/**
509			* Syntax highlighter using GeSHi http://qbnz.com/highlighter/.
510			*
511			* @param string $text text to be converted.
512			* @param string $language which language to use for highlighting syntax.
513			*
514			* @return string the formatted text.
515			*/
516			/*
517			public function syntaxHighlightGeSHi($text, $language = "text")
518			{
519			$language = $language ?: "text";
520			//$language = ($language === 'html') ? 'html4strict' : $language;
521			$language = ($language === 'html') ? 'html5' : $language;
522
523			$geshi = new \GeSHi($text, $language);
524			$geshi->set_overall_class('geshi');
525			$geshi->enable_classes('geshi');
526			//$geshi->set_header_type(GESHI_HEADER_PRE_VALID);
527			//$geshi->enable_line_numbers(GESHI_NORMAL_LINE_NUMBERS);
528			$code = $geshi->parse_code();
529
530			//echo "<pre>$language\n$code\n", $geshi->get_stylesheet(false) , "</pre>"; exit;
531
532			// Replace last  </pre>, -strlen(" </pre>") == 12
533			$length = strlen(" </pre>");
534			if (substr($code, -$length) == " </pre>") {
535			$code = substr_replace($code, "</pre>", -$length);
536			}
537
538			return $code;
539			}
540			*/
541
542
543
544			/**
545			* Syntax highlighter using highlight.php, a port of highlight.js
546			* https://packagist.org/packages/scrivo/highlight.php.
547			*
548			* @param string $text text to be converted.
549			* @param string $language which language to use for highlighting syntax.
550			*
551			* @return string the formatted text.
552			*/
553			public function syntaxHighlightJs($text, $language = "text")
554			{
555			if ($language === "text" \|\| empty($language)) {
556			return "<pre class=\"hljs\">" . htmlentities($text) . "</pre>";
557			}
558
559			$highlight = new \Highlight\Highlighter();
560			$res = $highlight->highlight($language, $text);
561
562			return "<pre class=\"hljs\">$res->value</pre>";
563			}
564
565
566
567			/**
568			* Format text according to HTML Purifier.
569			*
570			* @param string $text that should be formatted.
571			*
572			* @return string as the formatted html-text.
573			*/
574	1		public function purify($text)
575			{
576	1		$config = \HTMLPurifier_Config::createDefault();
577	1		$config->set("Cache.DefinitionImpl", null);
578			//$config->set('Cache.SerializerPath', '/home/user/absolute/path');
579
580	1		$purifier = new \HTMLPurifier($config);
581
582	1		return $purifier->purify($text);
583			}
584
585
586
587			/**
588			* Format text according to Markdown syntax.
589			*
590			* @param string $text the text that should be formatted.
591			*
592			* @return string as the formatted html-text.
593			*/
594	8		public function markdown($text)
595			{
596	8		$text = \Michelf\MarkdownExtra::defaultTransform($text);
597	8		$text = \Michelf\SmartyPantsTypographer::defaultTransform(
598	8		$text,
599			"2"
600	8		);
601	8		return $text;
602			}
603
604
605
606			/**
607			* For convenience access to nl2br
608			*
609			* @param string $text text to be converted.
610			*
611			* @return string the formatted text.
612			*/
613	1		public function nl2br($text)
614			{
615	1		return nl2br($text);
616			}
617
618
619
620			/**
621			* For convenience access to htmlentities
622			*
623			* @param string $text text to be converted.
624			*
625			* @return string the formatted text.
626			*/
627			public function htmlentities($text)
628			{
629			return htmlentities($text);
630			}
631			}
632

canax / textfilter

Push — master ( 2ec628...6a2b22 )

TextFilter::yamlFrontMatter() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like