@@ -13,6 +13,7 @@ discard block |
||
| 13 | 13 | * Evaluate the FrontMatter in this object by merging a custom array of data. |
| 14 | 14 | * |
| 15 | 15 | * @param array|null $variables An array of YAML variables to use in evaluating the `$permalink` value |
| 16 | + * @return void |
|
| 16 | 17 | */ |
| 17 | 18 | public function evaluateFrontMatter($variables = null); |
| 18 | 19 | |
@@ -36,6 +37,7 @@ discard block |
||
| 36 | 37 | * Append a custom FrontMatter value. |
| 37 | 38 | * |
| 38 | 39 | * @param array $frontMatter |
| 40 | + * @return void |
|
| 39 | 41 | */ |
| 40 | 42 | public function appendFrontMatter(array $frontMatter); |
| 41 | 43 | |
@@ -45,6 +47,7 @@ discard block |
||
| 45 | 47 | * This will not delete a FrontMatter value parsed from the file |
| 46 | 48 | * |
| 47 | 49 | * @param string $key |
| 50 | + * @return void |
|
| 48 | 51 | */ |
| 49 | 52 | public function deleteFrontMatter($key); |
| 50 | 53 | |
@@ -55,6 +58,7 @@ discard block |
||
| 55 | 58 | * available to Twig templates |
| 56 | 59 | * |
| 57 | 60 | * @param array $frontMatter |
| 61 | + * @return void |
|
| 58 | 62 | */ |
| 59 | 63 | public function setFrontMatter(array $frontMatter); |
| 60 | 64 | } |
@@ -185,7 +185,7 @@ |
||
| 185 | 185 | $this->bodyContentEvaluated = true; |
| 186 | 186 | } |
| 187 | 187 | |
| 188 | - return (string)$this->bodyContent; |
|
| 188 | + return (string) $this->bodyContent; |
|
| 189 | 189 | } |
| 190 | 190 | |
| 191 | 191 | /** |
@@ -89,7 +89,7 @@ |
||
| 89 | 89 | /** |
| 90 | 90 | * @TODO 1.0.0 Remove support for 'base' in next major release; it has been replaced by 'baseurl' |
| 91 | 91 | * |
| 92 | - * @return mixed|null |
|
| 92 | + * @return string |
|
| 93 | 93 | */ |
| 94 | 94 | public function getBaseUrl() |
| 95 | 95 | { |
@@ -13,6 +13,9 @@ |
||
| 13 | 13 | { |
| 14 | 14 | private $import; |
| 15 | 15 | |
| 16 | + /** |
|
| 17 | + * @param string $import |
|
| 18 | + */ |
|
| 16 | 19 | public function __construct($import, $message = "", $code = 0, Exception $previous = null) |
| 17 | 20 | { |
| 18 | 21 | $this->import = $import; |
@@ -21,6 +21,9 @@ |
||
| 21 | 21 | protected $absolutePath; |
| 22 | 22 | protected $targetDirectories; |
| 23 | 23 | |
| 24 | + /** |
|
| 25 | + * @param string $folderPath |
|
| 26 | + */ |
|
| 24 | 27 | public function __construct($folderPath) |
| 25 | 28 | { |
| 26 | 29 | $this->fs = new Filesystem(); |
@@ -149,7 +149,7 @@ |
||
| 149 | 149 | * |
| 150 | 150 | * @param SplFileInfo|string $filePath The relative path of the file |
| 151 | 151 | * |
| 152 | - * @return mixed|null |
|
| 152 | + * @return \allejo\stakx\Document\PageView |
|
| 153 | 153 | */ |
| 154 | 154 | public function refreshItem($filePath) |
| 155 | 155 | { |
@@ -309,6 +309,9 @@ discard block |
||
| 309 | 309 | $this->confLess = $status; |
| 310 | 310 | } |
| 311 | 311 | |
| 312 | + /** |
|
| 313 | + * @param string $filePath |
|
| 314 | + */ |
|
| 312 | 315 | private function creationWatcher($filePath) |
| 313 | 316 | { |
| 314 | 317 | $this->output->writeln(sprintf('File creation detected: %s', $filePath)); |
@@ -350,6 +353,9 @@ discard block |
||
| 350 | 353 | } |
| 351 | 354 | } |
| 352 | 355 | |
| 356 | + /** |
|
| 357 | + * @param string $filePath |
|
| 358 | + */ |
|
| 353 | 359 | private function modificationWatcher($filePath) |
| 354 | 360 | { |
| 355 | 361 | $this->output->writeln(sprintf('File change detected: %s', $filePath)); |
@@ -400,7 +406,6 @@ discard block |
||
| 400 | 406 | /** |
| 401 | 407 | * Prepare the Stakx environment by creating necessary cache folders. |
| 402 | 408 | * |
| 403 | - * @param bool $cleanDirectory Clean the target directory |
|
| 404 | 409 | */ |
| 405 | 410 | private function createFolderStructure() |
| 406 | 411 | { |
@@ -218,8 +218,12 @@ |
||
| 218 | 218 | $exclusions, FileExplorer::$vcsPatterns, array(Configuration::CACHE_FOLDER) |
| 219 | 219 | )) |
| 220 | 220 | ->setIterator($fileExplorer->getExplorer()) |
| 221 | - ->addListener(Create::NAME, function ($e) { $this->watchListenerFunction($e); }) |
|
| 222 | - ->addListener(Modify::NAME, function ($e) { $this->watchListenerFunction($e); }) |
|
| 221 | + ->addListener(Create::NAME, function ($e) |
|
| 222 | + { |
|
| 223 | +$this->watchListenerFunction($e); }) |
|
| 224 | + ->addListener(Modify::NAME, function ($e) |
|
| 225 | + { |
|
| 226 | +$this->watchListenerFunction($e); }) |
|
| 223 | 227 | ; |
| 224 | 228 | |
| 225 | 229 | $this->output->writeln('Watch started successfully'); |
@@ -89,7 +89,7 @@ |
||
| 89 | 89 | * @param InputInterface $input |
| 90 | 90 | * @param string $param |
| 91 | 91 | */ |
| 92 | - private function setServiceParameter(InputInterface &$input, $param) |
|
| 92 | + private function setServiceParameter(InputInterface & $input, $param) |
|
| 93 | 93 | { |
| 94 | 94 | Service::setParameter($param, $input->getOption($param)); |
| 95 | 95 | } |
@@ -14,6 +14,9 @@ |
||
| 14 | 14 | { |
| 15 | 15 | private $templateMappings; |
| 16 | 16 | |
| 17 | + /** |
|
| 18 | + * @param string[] $templateMappings |
|
| 19 | + */ |
|
| 17 | 20 | public function setTemplateMappings($templateMappings) |
| 18 | 21 | { |
| 19 | 22 | $this->templateMappings = $templateMappings; |