@@ -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 | } |
@@ -182,11 +182,15 @@ |
||
| 182 | 182 | * |
| 183 | 183 | * @param mixed $mixed Any information returned from the readContents() method. |
| 184 | 184 | */ |
| 185 | - protected function afterReadContents($mixed) {} |
|
| 185 | + protected function afterReadContents($mixed) |
|
| 186 | + { |
|
| 187 | +} |
|
| 186 | 188 | |
| 187 | 189 | /** |
| 188 | 190 | * Functionality that needs to take place before this document is considered "compiled," meaning everything has been |
| 189 | 191 | * processed, configured, and built. |
| 190 | 192 | */ |
| 191 | - protected function beforeCompile() {} |
|
| 193 | + protected function beforeCompile() |
|
| 194 | + { |
|
| 195 | +} |
|
| 192 | 196 | } |
@@ -42,7 +42,8 @@ |
||
| 42 | 42 | */ |
| 43 | 43 | public function offsetSet($offset, $value) |
| 44 | 44 | { |
| 45 | - if ($offset === null) { |
|
| 45 | + if ($offset === null) |
|
| 46 | + { |
|
| 46 | 47 | return; |
| 47 | 48 | } |
| 48 | 49 | |
@@ -76,6 +76,7 @@ |
||
| 76 | 76 | |
| 77 | 77 | /** |
| 78 | 78 | * {@inheritdoc} |
| 79 | + * @param string $filePath |
|
| 79 | 80 | */ |
| 80 | 81 | public function createNewItem($filePath) |
| 81 | 82 | { |
@@ -24,6 +24,9 @@ discard block |
||
| 24 | 24 | private $themeData; |
| 25 | 25 | private $themeName; |
| 26 | 26 | |
| 27 | + /** |
|
| 28 | + * @param string $themeName |
|
| 29 | + */ |
|
| 27 | 30 | public function __construct($themeName, EventDispatcherInterface $eventDispatcher, LoggerInterface $logger) |
| 28 | 31 | { |
| 29 | 32 | parent::__construct($eventDispatcher, $logger); |
@@ -57,6 +60,7 @@ discard block |
||
| 57 | 60 | |
| 58 | 61 | /** |
| 59 | 62 | * {@inheritdoc} |
| 63 | + * @param string $filePath |
|
| 60 | 64 | */ |
| 61 | 65 | public function refreshItem($filePath) |
| 62 | 66 | { |
@@ -70,6 +74,7 @@ discard block |
||
| 70 | 74 | |
| 71 | 75 | /** |
| 72 | 76 | * {@inheritdoc} |
| 77 | + * @param string $filePath |
|
| 73 | 78 | */ |
| 74 | 79 | public function shouldBeTracked($filePath) |
| 75 | 80 | { |
@@ -80,6 +85,7 @@ discard block |
||
| 80 | 85 | |
| 81 | 86 | /** |
| 82 | 87 | * {@inheritdoc} |
| 88 | + * @param string $filePath |
|
| 83 | 89 | */ |
| 84 | 90 | public function createNewItem($filePath) |
| 85 | 91 | { |
@@ -39,7 +39,7 @@ |
||
| 39 | 39 | |
| 40 | 40 | if (!fs::exists($this->themeFolder)) |
| 41 | 41 | { |
| 42 | - throw new FileNotFoundException("The '${themeName}' theme folder could not be found.'"); |
|
| 42 | + throw new FileNotFoundException("The '${themename}' theme folder could not be found.'"); |
|
| 43 | 43 | } |
| 44 | 44 | |
| 45 | 45 | if (fs::exists($this->themeFile)) |
@@ -78,9 +78,9 @@ discard block |
||
| 78 | 78 | protected $trackedItems = []; |
| 79 | 79 | |
| 80 | 80 | /** |
| 81 | - * @param File|string $filePath |
|
| 81 | + * @param string $filePath |
|
| 82 | 82 | * |
| 83 | - * @return mixed|null |
|
| 83 | + * @return \allejo\stakx\Document\BasePageView |
|
| 84 | 84 | */ |
| 85 | 85 | public function createNewItem($filePath) |
| 86 | 86 | { |
@@ -125,9 +125,9 @@ discard block |
||
| 125 | 125 | /** |
| 126 | 126 | * Update the contents of a specified file. |
| 127 | 127 | * |
| 128 | - * @param File|string $filePath The relative path of the file |
|
| 128 | + * @param string $filePath The relative path of the file |
|
| 129 | 129 | * |
| 130 | - * @return mixed|null |
|
| 130 | + * @return \allejo\stakx\Document\BasePageView |
|
| 131 | 131 | */ |
| 132 | 132 | public function refreshItem($filePath) |
| 133 | 133 | { |
@@ -30,6 +30,9 @@ |
||
| 30 | 30 | return self::$workingDirectory; |
| 31 | 31 | } |
| 32 | 32 | |
| 33 | + /** |
|
| 34 | + * @param string|null $directory |
|
| 35 | + */ |
|
| 33 | 36 | public static function setWorkingDirectory($directory) |
| 34 | 37 | { |
| 35 | 38 | self::$workingDirectory = $directory; |
@@ -25,7 +25,9 @@ |
||
| 25 | 25 | public static function getWorkingDirectory() |
| 26 | 26 | { |
| 27 | 27 | if (!self::$workingDirectory) |
| 28 | - return getcwd(); |
|
| 28 | + { |
|
| 29 | + return getcwd(); |
|
| 30 | + } |
|
| 29 | 31 | |
| 30 | 32 | return self::$workingDirectory; |
| 31 | 33 | } |
@@ -32,6 +32,9 @@ |
||
| 32 | 32 | )); |
| 33 | 33 | } |
| 34 | 34 | |
| 35 | + /** |
|
| 36 | + * @param boolean $absolute |
|
| 37 | + */ |
|
| 35 | 38 | private function getUrl($absolute) |
| 36 | 39 | { |
| 37 | 40 | $url = '/'; |
@@ -95,6 +95,6 @@ |
||
| 95 | 95 | } |
| 96 | 96 | } |
| 97 | 97 | |
| 98 | - return preg_replace('#(?<!:)/+#','/', join('/', $paths)); |
|
| 98 | + return preg_replace('#(?<!:)/+#', '/', join('/', $paths)); |
|
| 99 | 99 | } |
| 100 | 100 | } |
@@ -31,7 +31,8 @@ |
||
| 31 | 31 | { |
| 32 | 32 | $parent = $this->template->getParent([]); |
| 33 | 33 | |
| 34 | - if ($parent === false) { |
|
| 34 | + if ($parent === false) |
|
| 35 | + { |
|
| 35 | 36 | return false; |
| 36 | 37 | } |
| 37 | 38 | |