TTextUtilities::createToc() - Code Metrics - Inspection of "Added toc for article based on HTML headers." - mosbth/ctextfilter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 127e50...2728da )

by Mikael

created 2016-03-18 16:38 UTC

TTextUtilities::createToc() B

↳ Parent: TTextUtilities

Complexity

Conditions	5
Paths	9

Size

Total Lines	24
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	30

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	24
ccs	0
cts	19
cp	0
rs	8.5125
cc	5
eloc	18
nc	9
nop	3
crap	30

<?php

namespace Mos\TextFilter;

/**
 * Utilities when working with text.
 *
 */
trait TTextUtilities
{
    /**
     * Get text until <!--stop--> or all text.
     *
     * @param string $text with content
     *
     * @return string with text
     */
    public function getUntilStop($text)
    {
        $pos = stripos($text, "<!--stop-->");
        if ($pos) {
            $text = substr($text, 0, $pos);
        }
        return $text;
    }



    /**
     * Get text until <!--more--> or all text.
     *
     * @param string $text with content
     *
     * @return array with text and boolean if more was detected.
     */
    public function getUntilMore($text)
    {
        $pos = stripos($text, "<!--more-->");
        $hasMore = $pos;
        if ($pos) {
            $text = substr($text, 0, $pos);
        }
        return [$text, $hasMore];
    }



    /**
     * Wrap HTML element with with start and end.
     *
     * @param string  $text  with content
     * @param string  $tag   HTML tag to search for
     * @param string  $start wrap start part
     * @param string  $end   wrap end part
     * @param number  $count hits to search for
     *
     * @return array with text and boolean if more was detected.
     */
    public function wrapElementWithStartEnd($text, $tag, $start, $end, $count)
    {
        return preg_replace(
            "#(<$tag>)(.*?)(</$tag>)#",
            "$start$1$2$3$end</a>",
            $text,
            $count
        );
    }



    /**
    * Wrap content of a HTML element with start and end.
     *
     * @param string  $text  with content
     * @param string  $tag   HTML tag to search for
     * @param string  $start wrap start part
     * @param string  $end   wrap end part
     * @param number  $count hits to search for
     *
     * @return array with text and boolean if more was detected.
     */
    public function wrapElementContentWithStartEnd($text, $tag, $start, $end, $count)
    {
        return preg_replace(
            "#(<$tag>)(.*?)(</$tag>)#",
            "$1$start$2$end$3</a>",
            $text,
            $count
        );
    }



    /**
     * Create a TOC of HTML headings from and to a certain level.
     *
     * @param string  $text  with content
     * @param integer $start level of headings to use for toc.
     * @param integer $stop  level of headings to use for toc.
     *
     * @return array with entries to generate a TOC.
     */
    public function createToc($text, $start = 2, $stop = 4)
    {
        $level = "$start-$stop";
        $pattern = "/<(h[$level])([^>]*)>(.*)<\/h[$level]>/";
        preg_match_all($pattern, $text, $matches, PREG_SET_ORDER);

        $toc = [];
        foreach ($matches as $val) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            preg_match("/id=['\"]([^>\"']+)/", $val[2], $id);
            $id = isset($id[1]) ? $id[1] : null;
            var_dump($matches[1]);

            $toc[] = [
                "level" => isset($val[1])
                    ? $val[1]
                    : null,
                "title" => isset($val[3])
                    ? $val[3]
                    : null,
                "id" => $id,
            ];
        }

        return $toc;
    }



    /**
     * Get content as pure text.
     *
     * @return string with the pure text.
     */
/*    public function GetPureText() {
      return preg_replace('/\s+/', ' ', strip_tags($this->GetFilteredData()));
    }
*/



    /**
     * Returns the excerpt of the text with at most the specified amount of characters.
     *
     * @param int $chars the number of characters to return.
     * @param boolean $hard do a hard break at exactly $chars characters or find closest space.
     * @return string as the excerpt.
     */
/*    public function GetExcerpt($chars=139, $hard=false) {
      if(!isset($this->data['data_filtered'])) {
        return null;
      }
      $excerpt = strip_tags($this->data['data_filtered']);

      if(strlen($excerpt) > $chars) {
        $excerpt   = substr($excerpt, 0, $chars-1);
      }

      if(!$hard) {
        $lastSpace = strrpos($excerpt, ' ');
        $excerpt   = substr($excerpt, 0, $lastSpace);
      }

      return $excerpt;
    }
    
    
    /**
     * Returns the first paragraph ot the text.
     * 
     * @return string as the first paragraph.
     */
/*    public function GetFirstParagraph() {
      if(!isset($this->data['data_filtered'])) {
        return null;
      }
      $excerpt = $this->data['data_filtered'];

      $firstPara = strpos($excerpt, '</p>');
      $excerpt   = substr($excerpt, 0, $firstPara + 4);

      return $excerpt;
    }
*/
}


1		<?php
2
3		namespace Mos\TextFilter;
4
5		/**
6		* Utilities when working with text.
7		*
8		*/
9		trait TTextUtilities
10		{
11		/**
12		* Get text until <!--stop--> or all text.
13		*
14		* @param string $text with content
15		*
16		* @return string with text
17		*/
18	8	public function getUntilStop($text)
19		{
20	8	$pos = stripos($text, "<!--stop-->");
21	8	if ($pos) {
22	2	$text = substr($text, 0, $pos);
23	2	}
24	8	return $text;
25		}
26
27
28
29		/**
30		* Get text until <!--more--> or all text.
31		*
32		* @param string $text with content
33		*
34		* @return array with text and boolean if more was detected.
35		*/
36	8	public function getUntilMore($text)
37		{
38	8	$pos = stripos($text, "<!--more-->");
39	8	$hasMore = $pos;
40	8	if ($pos) {
41	1	$text = substr($text, 0, $pos);
42	1	}
43	8	return [$text, $hasMore];
44		}
45
46
47
48		/**
49		* Wrap HTML element with with start and end.
50		*
51		* @param string $text with content
52		* @param string $tag HTML tag to search for
53		* @param string $start wrap start part
54		* @param string $end wrap end part
55		* @param number $count hits to search for
56		*
57		* @return array with text and boolean if more was detected.
58		*/
59		public function wrapElementWithStartEnd($text, $tag, $start, $end, $count)
60		{
61		return preg_replace(
62		"#(<$tag>)(.*?)(</$tag>)#",
63		"$start$1$2$3$end</a>",
64		$text,
65		$count
66		);
67		}
68
69
70
71		/**
72		* Wrap content of a HTML element with start and end.
73		*
74		* @param string $text with content
75		* @param string $tag HTML tag to search for
76		* @param string $start wrap start part
77		* @param string $end wrap end part
78		* @param number $count hits to search for
79		*
80		* @return array with text and boolean if more was detected.
81		*/
82		public function wrapElementContentWithStartEnd($text, $tag, $start, $end, $count)
83		{
84		return preg_replace(
85		"#(<$tag>)(.*?)(</$tag>)#",
86		"$1$start$2$end$3</a>",
87		$text,
88		$count
89		);
90		}
91
92
93
94		/**
95		* Create a TOC of HTML headings from and to a certain level.
96		*
97		* @param string $text with content
98		* @param integer $start level of headings to use for toc.
99		* @param integer $stop level of headings to use for toc.
100		*
101		* @return array with entries to generate a TOC.
102		*/
103		public function createToc($text, $start = 2, $stop = 4)
104		{
105		$level = "$start-$stop";
106		$pattern = "/<(h[$level])([^>])>(.)<\/h[$level]>/";
107		preg_match_all($pattern, $text, $matches, PREG_SET_ORDER);
108
109		$toc = [];
110		foreach ($matches as $val) {
		0 ignored issues – show Bug introduced 2016-03-18 16:40 UTC by Report Bug Copy Issue Report The expression `$matches` of type `null\|array<integer,array<integer,string>>` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
111		preg_match("/id=['\"]([^>\"']+)/", $val[2], $id);
112		$id = isset($id[1]) ? $id[1] : null;
113		var_dump($matches[1]);
		0 ignored issues – show Security Debugging Code introduced 2016-03-18 16:40 UTC by Report Bug Copy Issue Report `var_dump($matches[1]);` looks like debug code. Are you sure you do not want to remove it? This might expose sensitive data. Loading history...
114		$toc[] = [
115		"level" => isset($val[1])
116		? $val[1]
117		: null,
118		"title" => isset($val[3])
119		? $val[3]
120		: null,
121		"id" => $id,
122		];
123		}
124
125		return $toc;
126		}
127
128
129
130		/**
131		* Get content as pure text.
132		*
133		* @return string with the pure text.
134		*/
135		/* public function GetPureText() {
136		return preg_replace('/\s+/', ' ', strip_tags($this->GetFilteredData()));
137		}
138		*/
139
140
141
142		/**
143		* Returns the excerpt of the text with at most the specified amount of characters.
144		*
145		* @param int $chars the number of characters to return.
146		* @param boolean $hard do a hard break at exactly $chars characters or find closest space.
147		* @return string as the excerpt.
148		*/
149		/* public function GetExcerpt($chars=139, $hard=false) {
150		if(!isset($this->data['data_filtered'])) {
151		return null;
152		}
153		$excerpt = strip_tags($this->data['data_filtered']);
154
155		if(strlen($excerpt) > $chars) {
156		$excerpt = substr($excerpt, 0, $chars-1);
157		}
158
159		if(!$hard) {
160		$lastSpace = strrpos($excerpt, ' ');
161		$excerpt = substr($excerpt, 0, $lastSpace);
162		}
163
164		return $excerpt;
165		}
166
167
168		/**
169		* Returns the first paragraph ot the text.
170		*
171		* @return string as the first paragraph.
172		*/
173		/* public function GetFirstParagraph() {
174		if(!isset($this->data['data_filtered'])) {
175		return null;
176		}
177		$excerpt = $this->data['data_filtered'];
178
179		$firstPara = strpos($excerpt, '</p>');
180		$excerpt = substr($excerpt, 0, $firstPara + 4);
181
182		return $excerpt;
183		}
184		*/
185		}
186

mosbth / ctextfilter

Push — master ( 127e50...2728da )

TTextUtilities::createToc() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like