@@ -28,7 +28,6 @@ |
||
28 | 28 | use Yosymfony\Spress\Core\DataSource\DataSourceManagerBuilder; |
29 | 29 | use Yosymfony\Spress\Core\DataWriter\FilesystemDataWriter; |
30 | 30 | use Yosymfony\Spress\Core\IO\NullIO; |
31 | -use Yosymfony\Spress\Core\Plugin\PluginManager; |
|
32 | 31 | use Yosymfony\Spress\Core\Plugin\PluginManagerBuilder; |
33 | 32 | |
34 | 33 | /** |
@@ -113,7 +113,6 @@ |
||
113 | 113 | /** |
114 | 114 | * Sets the license of the plugin. MIT by default. |
115 | 115 | * |
116 | - * @param string $value |
|
117 | 116 | */ |
118 | 117 | public function setLicense($name) |
119 | 118 | { |
@@ -36,7 +36,6 @@ discard block |
||
36 | 36 | * Constructor. |
37 | 37 | * |
38 | 38 | * @param IOInterface $io |
39 | - * @param TwigFactory $twigFactory |
|
40 | 39 | * @param string $serverroot |
41 | 40 | * @param string $documentroot |
42 | 41 | * @param int $port |
@@ -160,6 +159,11 @@ discard block |
||
160 | 159 | return $finalResponse; |
161 | 160 | } |
162 | 161 | |
162 | + /** |
|
163 | + * @param string $ip |
|
164 | + * @param string $path |
|
165 | + * @param integer $statusCode |
|
166 | + */ |
|
163 | 167 | private function logRequest($ip, $path, $statusCode) |
164 | 168 | { |
165 | 169 | $date = new \Datetime(); |
@@ -176,6 +180,9 @@ discard block |
||
176 | 180 | $this->io->write($data); |
177 | 181 | } |
178 | 182 | |
183 | + /** |
|
184 | + * @param string $templateDir |
|
185 | + */ |
|
179 | 186 | private function buildTwig($templateDir) |
180 | 187 | { |
181 | 188 | $options = [ |
@@ -189,6 +196,10 @@ discard block |
||
189 | 196 | $this->twig = new \Twig_Environment($loader, $options); |
190 | 197 | } |
191 | 198 | |
199 | + /** |
|
200 | + * @param integer $statusCode |
|
201 | + * @param string $data |
|
202 | + */ |
|
192 | 203 | private function getErrorModel($statusCode, $data) |
193 | 204 | { |
194 | 205 | switch ($statusCode) { |
@@ -100,6 +100,9 @@ discard block |
||
100 | 100 | return $result; |
101 | 101 | } |
102 | 102 | |
103 | + /** |
|
104 | + * @param string $sitePath |
|
105 | + */ |
|
103 | 106 | private function loadEnvironmentConfiguration($sitePath, $env) |
104 | 107 | { |
105 | 108 | $filename = $this->getConfigEnvFilename($env); |
@@ -133,6 +136,9 @@ discard block |
||
133 | 136 | return $filename; |
134 | 137 | } |
135 | 138 | |
139 | + /** |
|
140 | + * @param string $sitePath |
|
141 | + */ |
|
136 | 142 | private function isSpressSite($sitePath) |
137 | 143 | { |
138 | 144 | return file_exists($sitePath.'/'.$this->configFilename); |
@@ -57,6 +57,7 @@ discard block |
||
57 | 57 | * @param string $name The name of the collection |
58 | 58 | * |
59 | 59 | * @throws RuntimeException If invalid collection name |
60 | + * @return void |
|
60 | 61 | */ |
61 | 62 | public function setCollection($name); |
62 | 63 | |
@@ -80,8 +81,9 @@ discard block |
||
80 | 81 | /** |
81 | 82 | * Set the compiled content. |
82 | 83 | * |
83 | - * @param $content Mixed The compiled content |
|
84 | + * @param string $content Mixed The compiled content |
|
84 | 85 | * @param $snapshotName The name of the snapshot. The snapshot "last" is not valid |
86 | + * @return void |
|
85 | 87 | */ |
86 | 88 | public function setContent($content, $snapshotName); |
87 | 89 | |
@@ -95,7 +97,8 @@ discard block |
||
95 | 97 | /** |
96 | 98 | * Set the attributes of this item. |
97 | 99 | * |
98 | - * @param array $value |
|
100 | + * @param array $values |
|
101 | + * @return void |
|
99 | 102 | */ |
100 | 103 | public function setAttributes(array $values); |
101 | 104 | |
@@ -120,6 +123,7 @@ discard block |
||
120 | 123 | * |
121 | 124 | * @param string $value e.g: "index.html" or "my-page/index.html" |
122 | 125 | * @param $snapshotName The name of the snapshot. The snapshot "last" is not valid |
126 | + * @return void |
|
123 | 127 | */ |
124 | 128 | public function setPath($value, $snapshotName); |
125 | 129 |
@@ -29,7 +29,7 @@ discard block |
||
29 | 29 | * @param string $siteDir Root directory of an Spress site. "./" if this |
30 | 30 | * value is null |
31 | 31 | * |
32 | - * @return Spress A Spress instance |
|
32 | + * @return \Yosymfony\Spress\Core\Spress A Spress instance |
|
33 | 33 | */ |
34 | 34 | public function getSpress($siteDir = null) |
35 | 35 | { |
@@ -55,6 +55,9 @@ discard block |
||
55 | 55 | /** |
56 | 56 | * Returns an EmbeddedComposer instance. |
57 | 57 | * |
58 | + * @param string $siteDir |
|
59 | + * @param string $composerFilename |
|
60 | + * @param string $vendorDir |
|
58 | 61 | * @return Dflydev\EmbeddedComposer\Core\EmbeddedComposer |
59 | 62 | */ |
60 | 63 | protected function getEmbeddedComposer($siteDir, $composerFilename, $vendorDir) |
@@ -145,7 +145,7 @@ discard block |
||
145 | 145 | /** |
146 | 146 | * Formats a success result bar. |
147 | 147 | * |
148 | - * @param string|array $message The message |
|
148 | + * @param string $message The message |
|
149 | 149 | */ |
150 | 150 | public function success($message) |
151 | 151 | { |
@@ -165,7 +165,7 @@ discard block |
||
165 | 165 | /** |
166 | 166 | * Formats an warning result bar. |
167 | 167 | * |
168 | - * @param string|array $message The message |
|
168 | + * @param string $message The message |
|
169 | 169 | */ |
170 | 170 | public function warning($message) |
171 | 171 | { |
@@ -33,7 +33,7 @@ discard block |
||
33 | 33 | /** |
34 | 34 | * Sets a list of directories in which templates are located. |
35 | 35 | * |
36 | - * @param array $value |
|
36 | + * @param string[] $value |
|
37 | 37 | */ |
38 | 38 | public function setSkeletonDirs(array $value) |
39 | 39 | { |
@@ -58,7 +58,7 @@ discard block |
||
58 | 58 | /** |
59 | 59 | * Return an instance of Twig. |
60 | 60 | * |
61 | - * @return Twig_Environment The Twig instance |
|
61 | + * @return \Twig_Environment The Twig instance |
|
62 | 62 | */ |
63 | 63 | protected function getTwig() |
64 | 64 | { |
@@ -208,6 +208,7 @@ discard block |
||
208 | 208 | /** |
209 | 209 | * Determines if package is a Spress theme. |
210 | 210 | * |
211 | + * @param string $packageName |
|
211 | 212 | * @return bool |
212 | 213 | * |
213 | 214 | * @throws RuntimeException If the package doesn't exist |
@@ -331,7 +332,7 @@ discard block |
||
331 | 332 | /** |
332 | 333 | * Returns a DownloadManager instance. |
333 | 334 | * |
334 | - * @return Composer\Downloader\DownloadManager |
|
335 | + * @return \Composer\Downloader\DownloadManager |
|
335 | 336 | */ |
336 | 337 | protected function createDownloadManager(Config $config) |
337 | 338 | { |