View GitHub Repository silverstripe-autotoc

Schedule Inspection
Subscribe
Completed
Push — master ( 82560b...033da7 )
by Nicola
02:33 queued 10s
created
Status
Category
Toggle Patches
code/Autotoc.php 2 patches
Spacing   +3 added lines, -3 removed lines patch added patch discarded remove patch 
@@ -63,12 +63,12 @@  discard block
 
 block discarded – undo
63 63 
     {
64 64 
         $c = $this->owner;
65 65 
         $model = $c->customisedObject ? $c->customisedObject : $c->data();
66 
-        if (! $model) {
66 
+        if (!$model) {
67 67 
             return null;
68 68 
         }
69 69
70 70 
         $field = $this->_contentField();
71 
-        if (! $model->hasField($field)) {
71 
+        if (!$model->hasField($field)) {
72 72 
             return null;
73 73 
         }
74 74 
 
@@ -88,7 +88,7 @@  discard block
 
 block discarded – undo
88 88 
     public function getAutotoc()
89 89 
     {
90 90 
         $tocifier = $this->_getTocifier();
91 
-        if (! $tocifier) {
91 
+        if (!$tocifier) {
92 92 
             return null;
93 93 
         }
94 94
Please login to merge, or discard this patch.
Doc Comments   +3 added lines patch added patch discarded remove patch 
@@ -59,6 +59,9 @@
 
 block discarded – undo
59 59 
         }
60 60 
     }
61 61
62 
+    /**
63 
+     * @return string
64 
+     */
62 65 
     private function _getHtml()
63 66 
     {
64 67 
         $c = $this->owner;
Please login to merge, or discard this patch.
code/Tocifier.php 3 patches
Indentation   +1 added lines, -1 removed lines patch added patch discarded remove patch 
@@ -89,7 +89,7 @@
 
 block discarded – undo
89 89
90 90 
         $body = $doc->getElementsByTagName('body')->item(0);
91 91 
         $this->_html = str_replace(array('<body>', '</body>'), '',
92 
-                                   $doc->saveHTML($body));
92 
+                                    $doc->saveHTML($body));
93 93 
     }
94 94
95 95 
     private function _dumpBranch($node, $indent = '')
Please login to merge, or discard this patch.
Spacing   +9 added lines, -9 removed lines patch added patch discarded remove patch 
@@ -57,28 +57,28 @@  discard block
 
 block discarded – undo
57 57 
         }
58 58
59 59 
         // Consider this node a potential dangling parent
60 
-        $this->_dangling[$level] =& $node;
60 
+        $this->_dangling[$level] = & $node;
61 61
62 62 
         return $node;
63 63 
     }
64 64
65 65 
     private function _processDocument($doc)
66 66 
     {
67 
-        $this->_tree =& $this->_newNode(self::$prefix, '', 0);
67 
+        $this->_tree = & $this->_newNode(self::$prefix, '', 0);
68 68 
         $n = 1;
69 69
70 70 
         $xpath = new DOMXPath($doc);
71 71 
         foreach ($xpath->query('//h1|//h2|//h3|//h4|//h5|//h6') as $h) {
72 72 
             $text = $this->_getPlainText($h);
73 73 
             $level = (int) substr($h->tagName, 1);
74 
-            $id = self::$prefix . $n;
74 
+            $id = self::$prefix.$n;
75 75 
             ++$n;
76 76
77 77 
             // Build the tree
78 
-            $parent =& $this->_getParent($level);
79 
-            $node =& $this->_newNode($id, $text, $level);
78 
+            $parent = & $this->_getParent($level);
79 
+            $node = & $this->_newNode($id, $text, $level);
80 80 
             isset($parent['children']) or $parent['children'] = array();
81 
-            $parent['children'][] =& $node;
81 
+            $parent['children'][] = & $node;
82 82
83 83 
             // Prepend the anchor
84 84 
             $anchor = $doc->createElement('a');
 
@@ -94,7 +94,7 @@  discard block
 
 block discarded – undo
94 94
95 95 
     private function _dumpBranch($node, $indent = '')
96 96 
     {
97 
-        echo $indent . $node['title'] . "\n";
97 
+        echo $indent.$node['title']."\n";
98 98 
         if (isset($node['children'])) {
99 99 
             foreach ($node['children'] as &$child) {
100 100 
                 $this->_dumpBranch($child, "$indent\t");
 
@@ -136,7 +136,7 @@  discard block
 
 block discarded – undo
136 136 
     public function process()
137 137 
     {
138 138 
         // Check if $this->_raw_html is valid
139 
-        if (! is_string($this->_raw_html) || empty($this->_raw_html)) {
139 
+        if (!is_string($this->_raw_html) || empty($this->_raw_html)) {
140 140 
             return false;
141 141 
         }
142 142 
 
@@ -147,7 +147,7 @@  discard block
 
 block discarded – undo
147 147
148 148 
         // Parse the HTML into a DOMDocument tree
149 149 
         $doc = new DOMDocument();
150 
-        if (! @$doc->loadHTML($html)) {
150 
+        if (!@$doc->loadHTML($html)) {
151 151 
             return false;
152 152 
         }
153 153
Please login to merge, or discard this patch.
Doc Comments   +10 added lines patch added patch discarded remove patch 
@@ -18,6 +18,9 @@  discard block
 
 block discarded – undo
18 18 
     private $_dangling = array();
19 19
20 20
21 
+    /**
22 
+     * @param integer $level
23 
+     */
21 24 
     private function &_getParent($level)
22 25 
     {
23 26 
         while (--$level >= 0) {
 
@@ -42,6 +45,10 @@  discard block
 
 block discarded – undo
42 45 
         return $clone->textContent;
43 46 
     }
44 47
48 
+    /**
49 
+     * @param string $id
50 
+     * @param integer $level
51 
+     */
45 52 
     private function &_newNode($id, $text, $level)
46 53 
     {
47 54 
         $node = array(
 
@@ -62,6 +69,9 @@  discard block
 
 block discarded – undo
62 69 
         return $node;
63 70 
     }
64 71
72 
+    /**
73 
+     * @param DOMDocument $doc
74 
+     */
65 75 
     private function _processDocument($doc)
66 76 
     {
67 77 
         $this->_tree =& $this->_newNode(self::$prefix, '', 0);
Please login to merge, or discard this patch.
tests/TocifierTest.php 1 patch
Spacing   +6 added lines, -6 removed lines patch added patch discarded remove patch 
@@ -22,15 +22,15 @@  discard block
 
 block discarded – undo
22 22
23 23 
     public function testHtml()
24 24 
     {
25 
-        $tocifier = new Tocifier(file_get_contents(__DIR__ . '/test1'));
25 
+        $tocifier = new Tocifier(file_get_contents(__DIR__.'/test1'));
26 26 
         $this->assertEquals($tocifier->getHtml(), '');
27 27 
         $this->assertTrue($tocifier->process());
28 
-        $this->assertStringEqualsFile(__DIR__ . '/html1', $tocifier->getHtml());
28 
+        $this->assertStringEqualsFile(__DIR__.'/html1', $tocifier->getHtml());
29 29 
     }
30 30
31 31 
     public function testTOC()
32 32 
     {
33 
-        $tocifier = new Tocifier(file_get_contents(__DIR__ . '/test1'));
33 
+        $tocifier = new Tocifier(file_get_contents(__DIR__.'/test1'));
34 34 
         $this->assertEquals($tocifier->getTOC(), array());
35 35 
         $this->assertTrue($tocifier->process());
36 36 
         $this->assertNotNull($tocifier->getTOC());
 
@@ -38,17 +38,17 @@  discard block
 
 block discarded – undo
38 38 
         ob_start();
39 39 
         $tocifier->dumpTOC();
40 40 
         $returned = ob_get_clean();
41 
-        $this->assertStringEqualsFile(__DIR__ . '/toc1', $returned);
41 
+        $this->assertStringEqualsFile(__DIR__.'/toc1', $returned);
42 42 
     }
43 43
44 44 
     public function testDataHideFromTOC()
45 45 
     {
46 
-        $tocifier = new Tocifier(file_get_contents(__DIR__ . '/test2'));
46 
+        $tocifier = new Tocifier(file_get_contents(__DIR__.'/test2'));
47 47 
         $this->assertEquals($tocifier->getHtml(), '');
48 48 
         $this->assertTrue($tocifier->process());
49 49
50 50 
         // Check the augmented HTML is equal to the original one
51 
-        $this->assertStringEqualsFile(__DIR__ . '/test2', $tocifier->getHtml());
51 
+        $this->assertStringEqualsFile(__DIR__.'/test2', $tocifier->getHtml());
52 52
53 53 
         ob_start();
54 54 
         $tocifier->dumpTOC();
Please login to merge, or discard this patch.
tests/Bootstrap.php 2 patches
Switch Indentation   +3 added lines, -3 removed lines patch added patch discarded remove patch 
@@ -8,8 +8,8 @@
 
 block discarded – undo
8 8 
 spl_autoload_register(function ($class) {
9 9 
     switch ($class) {
10 10
11 
-    case 'Tocifier':
12 
-        require_once __DIR__ . '/../code/Tocifier.php';
13 
-        break;
11 
+        case 'Tocifier':
12 
+            require_once __DIR__ . '/../code/Tocifier.php';
13 
+            break;
14 14 
     }
15 15 
 });
Please login to merge, or discard this patch.
Spacing   +2 added lines, -2 removed lines patch added patch discarded remove patch 
@@ -5,11 +5,11 @@
 
 block discarded – undo
5 5 
  * phpunit --bootstrap tests/Bootstrap.php tests/
6 6 
  */
7 7
8 
-spl_autoload_register(function ($class) {
8 
+spl_autoload_register(function($class) {
9 9 
     switch ($class) {
10 10
11 11 
     case 'Tocifier':
12 
-        require_once __DIR__ . '/../code/Tocifier.php';
12 
+        require_once __DIR__.'/../code/Tocifier.php';
13 13 
         break;
14 14 
     }
15 15 
 });
Please login to merge, or discard this patch.