| @@ -203,7 +203,8 @@ | ||
| 203 | 203 | } | 
| 204 | 204 | |
| 205 | 205 | if (strpos($haystack, $query, $offset) !== false) | 
| 206 | -            { // stop on first true result | |
| 206 | +            { | |
| 207 | +// stop on first true result | |
| 207 | 208 | return true; | 
| 208 | 209 | } | 
| 209 | 210 | } | 
| @@ -26,6 +26,9 @@ | ||
| 26 | 26 | } | 
| 27 | 27 | } | 
| 28 | 28 | |
| 29 | + /** | |
| 30 | + * @param string $extension | |
| 31 | + */ | |
| 29 | 32 | public function getTransformer($extension) | 
| 30 | 33 |      { | 
| 31 | 34 | if (isset($this->transformers[$extension])) | 
| @@ -63,7 +63,8 @@ | ||
| 63 | 63 | */ | 
| 64 | 64 | public function getJailedDataItems() | 
| 65 | 65 |      { | 
| 66 | -        return self::getJailedTrackedItems($this->trackedItemsFlattened, function (DataItem $dataItem) { | |
| 66 | + return self::getJailedTrackedItems($this->trackedItemsFlattened, function (DataItem $dataItem) | |
| 67 | +        { | |
| 67 | 68 | return $dataItem->getBasename(); | 
| 68 | 69 | }); | 
| 69 | 70 | } | 
| @@ -55,14 +55,20 @@ | ||
| 55 | 55 | |
| 56 | 56 |              $headingID = $heading->attributes->getNamedItem('id'); | 
| 57 | 57 | |
| 58 | - if ($curr > $last) // If the current level is greater than the last level indent one level | |
| 58 | + if ($curr > $last) | |
| 59 | +            { | |
| 60 | + // If the current level is greater than the last level indent one level | |
| 59 | 61 |              { | 
| 60 | 62 | $toc .= '<ul>'; | 
| 61 | 63 | } | 
| 62 | - elseif ($curr < $last) // If the current level is less than the last level go up appropriate amount. | |
| 64 | + } | |
| 65 | + elseif ($curr < $last) | |
| 66 | +            { | |
| 67 | + // If the current level is less than the last level go up appropriate amount. | |
| 63 | 68 |              { | 
| 64 | 69 |                  $toc .= str_repeat('</li></ul>', $last - $curr) . '</li>'; | 
| 65 | 70 | } | 
| 71 | + } | |
| 66 | 72 | else // If the current level is equal to the last. | 
| 67 | 73 |              { | 
| 68 | 74 | $toc .= '</li>'; | 
| @@ -53,6 +53,9 @@ | ||
| 53 | 53 | throw new UnsupportedMarkupException($tag, 'There is no support to handle this markup format.'); | 
| 54 | 54 | } | 
| 55 | 55 | |
| 56 | + /** | |
| 57 | + * @param string $extension | |
| 58 | + */ | |
| 56 | 59 | public function getEngineByExtension($extension) | 
| 57 | 60 |      { | 
| 58 | 61 | if (isset($this->enginesByExtension[$extension])) | 
| @@ -38,6 +38,9 @@ | ||
| 38 | 38 | return $this->parseMarkup($arguments[0], $tag); | 
| 39 | 39 | } | 
| 40 | 40 | |
| 41 | + /** | |
| 42 | + * @param string $tag | |
| 43 | + */ | |
| 41 | 44 | public function parseMarkup($content, $tag) | 
| 42 | 45 |      { | 
| 43 | 46 | return $this->markupManager->getEngineByTag($tag)->parse($content); | 
| @@ -12,6 +12,9 @@ discard block | ||
| 12 | 12 | */ | 
| 13 | 13 | interface CollectableItem | 
| 14 | 14 |  { | 
| 15 | + /** | |
| 16 | + * @return string | |
| 17 | + */ | |
| 15 | 18 | public function getRelativeFilePath(); | 
| 16 | 19 | |
| 17 | 20 | /** | 
| @@ -59,6 +62,7 @@ discard block | ||
| 59 | 62 | * | 
| 60 | 63 | * @param array $variables An array of YAML variables to use in evaluating the `$permalink` value | 
| 61 | 64 | * @param array $complexVariables complex variables that will be available to the FrontMatter scope of this document | 
| 65 | + * @return void | |
| 62 | 66 | */ | 
| 63 | 67 | public function evaluateFrontMatter(array $variables = [], array $complexVariables = []); | 
| 64 | 68 | } | 
| @@ -33,6 +33,9 @@ | ||
| 33 | 33 | ]); | 
| 34 | 34 | } | 
| 35 | 35 | |
| 36 | + /** | |
| 37 | + * @param boolean $absolute | |
| 38 | + */ | |
| 36 | 39 | private function getUrl($absolute) | 
| 37 | 40 |      { | 
| 38 | 41 | $url = '/'; | 
| @@ -9,6 +9,9 @@ discard block | ||
| 9 | 9 | |
| 10 | 10 | abstract class HtmlUtils | 
| 11 | 11 |  { | 
| 12 | + /** | |
| 13 | + * @param string $xpathQuery | |
| 14 | + */ | |
| 12 | 15 | public static function htmlXPath(\DOMDocument &$DOMDocument, $html, $xpathQuery) | 
| 13 | 16 |      { | 
| 14 | 17 | $html = self::normalizeHTML($html); | 
| @@ -38,6 +41,9 @@ discard block | ||
| 38 | 41 | return $xpath->query($xpathQuery); | 
| 39 | 42 | } | 
| 40 | 43 | |
| 44 | + /** | |
| 45 | + * @return string | |
| 46 | + */ | |
| 41 | 47 | private static function normalizeHTML($html) | 
| 42 | 48 |      { | 
| 43 | 49 | if (strpos($html, '<body>' === false) || strpos($html, '</body>') === false) |