@@ -17,5 +17,8 @@ |
||
17 | 17 | |
18 | 18 | interface OutputAwareInterface |
19 | 19 | { |
20 | + /** |
|
21 | + * @return void |
|
22 | + */ |
|
20 | 23 | public function setOutput(OutputInterface $output): void; |
21 | 24 | } |
@@ -20,6 +20,9 @@ |
||
20 | 20 | |
21 | 21 | interface ConfigurationSourceFactoryInterface |
22 | 22 | { |
23 | + /** |
|
24 | + * @return void |
|
25 | + */ |
|
23 | 26 | public function buildConfiguration(ArrayNodeDefinition $node): void; |
24 | 27 | |
25 | 28 | /** |
@@ -17,12 +17,19 @@ |
||
17 | 17 | { |
18 | 18 | public function findAll(): array; |
19 | 19 | |
20 | + /** |
|
21 | + * @return void |
|
22 | + */ |
|
20 | 23 | public function add(array $configuration): void; |
21 | 24 | |
25 | + /** |
|
26 | + * @return void |
|
27 | + */ |
|
22 | 28 | public function remove(string $themeName): void; |
23 | 29 | |
24 | 30 | /** |
25 | 31 | * Clear currently used configurations storage. |
32 | + * @return void |
|
26 | 33 | */ |
27 | 34 | public function clear(): void; |
28 | 35 | } |
@@ -19,6 +19,7 @@ |
||
19 | 19 | { |
20 | 20 | /** |
21 | 21 | * Should not throw any exception if failed to get theme. |
22 | + * @return null|ThemeInterface |
|
22 | 23 | */ |
23 | 24 | public function getTheme(): ?ThemeInterface; |
24 | 25 | } |
@@ -33,6 +33,7 @@ discard block |
||
33 | 33 | * |
34 | 34 | * @throws FileNotFoundException When originFile doesn't exist |
35 | 35 | * @throws IOException When copy fails |
36 | + * @return void |
|
36 | 37 | */ |
37 | 38 | public function copy($originFile, $targetFile, $override = false); |
38 | 39 | |
@@ -43,13 +44,14 @@ discard block |
||
43 | 44 | * @param int $mode The directory mode |
44 | 45 | * |
45 | 46 | * @throws IOException On any directory creation failure |
47 | + * @return void |
|
46 | 48 | */ |
47 | 49 | public function mkdir($dirs, $mode = 0777); |
48 | 50 | |
49 | 51 | /** |
50 | 52 | * Checks the existence of files or directories. |
51 | 53 | * |
52 | - * @param string|array|\Traversable $files A filename, an array of files, or a \Traversable instance to check |
|
54 | + * @param string $files A filename, an array of files, or a \Traversable instance to check |
|
53 | 55 | * |
54 | 56 | * @return bool true if the file exists, false otherwise |
55 | 57 | */ |
@@ -63,6 +65,7 @@ discard block |
||
63 | 65 | * @param int $atime The access time as a Unix timestamp |
64 | 66 | * |
65 | 67 | * @throws IOException When touch fails |
68 | + * @return void |
|
66 | 69 | */ |
67 | 70 | public function touch($files, $time = null, $atime = null); |
68 | 71 | |
@@ -72,6 +75,7 @@ discard block |
||
72 | 75 | * @param string|array|\Traversable $files A filename, an array of files, or a \Traversable instance to remove |
73 | 76 | * |
74 | 77 | * @throws IOException When removal fails |
78 | + * @return void |
|
75 | 79 | */ |
76 | 80 | public function remove($files); |
77 | 81 | |
@@ -84,6 +88,7 @@ discard block |
||
84 | 88 | * @param bool $recursive Whether change the mod recursively or not |
85 | 89 | * |
86 | 90 | * @throws IOException When the change fail |
91 | + * @return void |
|
87 | 92 | */ |
88 | 93 | public function chmod($files, $mode, $umask = 0000, $recursive = false); |
89 | 94 | |
@@ -95,6 +100,7 @@ discard block |
||
95 | 100 | * @param bool $recursive Whether change the owner recursively or not |
96 | 101 | * |
97 | 102 | * @throws IOException When the change fail |
103 | + * @return void |
|
98 | 104 | */ |
99 | 105 | public function chown($files, $user, $recursive = false); |
100 | 106 | |
@@ -106,6 +112,7 @@ discard block |
||
106 | 112 | * @param bool $recursive Whether change the group recursively or not |
107 | 113 | * |
108 | 114 | * @throws IOException When the change fail |
115 | + * @return void |
|
109 | 116 | */ |
110 | 117 | public function chgrp($files, $group, $recursive = false); |
111 | 118 | |
@@ -118,6 +125,7 @@ discard block |
||
118 | 125 | * |
119 | 126 | * @throws IOException When target file or directory already exists |
120 | 127 | * @throws IOException When origin cannot be renamed |
128 | + * @return void |
|
121 | 129 | */ |
122 | 130 | public function rename($origin, $target, $overwrite = false); |
123 | 131 | |
@@ -129,6 +137,7 @@ discard block |
||
129 | 137 | * @param bool $copyOnWindows Whether to copy files if on Windows |
130 | 138 | * |
131 | 139 | * @throws IOException When symlink fails |
140 | + * @return void |
|
132 | 141 | */ |
133 | 142 | public function symlink($originDir, $targetDir, $copyOnWindows = false); |
134 | 143 | |
@@ -145,6 +154,7 @@ discard block |
||
145 | 154 | * - $options['delete'] Whether to delete files that are not in the source directory (defaults to false) |
146 | 155 | * |
147 | 156 | * @throws IOException When file type is unknown |
157 | + * @return void |
|
148 | 158 | */ |
149 | 159 | public function mirror($originDir, $targetDir, \Traversable $iterator = null, $options = []); |
150 | 160 |
@@ -19,6 +19,7 @@ |
||
19 | 19 | { |
20 | 20 | /** |
21 | 21 | * @throws CircularDependencyFoundException |
22 | + * @return void |
|
22 | 23 | */ |
23 | 24 | public function check(ThemeInterface $theme): void; |
24 | 25 | } |
@@ -19,12 +19,24 @@ discard block |
||
19 | 19 | |
20 | 20 | public function getPath(): string; |
21 | 21 | |
22 | + /** |
|
23 | + * @return string|null |
|
24 | + */ |
|
22 | 25 | public function getTitle(): ?string; |
23 | 26 | |
27 | + /** |
|
28 | + * @return void |
|
29 | + */ |
|
24 | 30 | public function setTitle(?string $title): void; |
25 | 31 | |
32 | + /** |
|
33 | + * @return string|null |
|
34 | + */ |
|
26 | 35 | public function getDescription(): ?string; |
27 | 36 | |
37 | + /** |
|
38 | + * @return void |
|
39 | + */ |
|
28 | 40 | public function setDescription(?string $description): void; |
29 | 41 | |
30 | 42 | /** |
@@ -32,8 +44,14 @@ discard block |
||
32 | 44 | */ |
33 | 45 | public function getAuthors(): array; |
34 | 46 | |
47 | + /** |
|
48 | + * @return void |
|
49 | + */ |
|
35 | 50 | public function addAuthor(ThemeAuthor $author): void; |
36 | 51 | |
52 | + /** |
|
53 | + * @return void |
|
54 | + */ |
|
37 | 55 | public function removeAuthor(ThemeAuthor $author): void; |
38 | 56 | |
39 | 57 | /** |
@@ -43,11 +61,13 @@ discard block |
||
43 | 61 | |
44 | 62 | /** |
45 | 63 | * @param ThemeInterface $theme |
64 | + * @return void |
|
46 | 65 | */ |
47 | 66 | public function addParent(self $theme): void; |
48 | 67 | |
49 | 68 | /** |
50 | 69 | * @param ThemeInterface $theme |
70 | + * @return void |
|
51 | 71 | */ |
52 | 72 | public function removeParent(self $theme): void; |
53 | 73 | |
@@ -56,7 +76,13 @@ discard block |
||
56 | 76 | */ |
57 | 77 | public function getScreenshots(): array; |
58 | 78 | |
79 | + /** |
|
80 | + * @return void |
|
81 | + */ |
|
59 | 82 | public function addScreenshot(ThemeScreenshot $screenshot): void; |
60 | 83 | |
84 | + /** |
|
85 | + * @return void |
|
86 | + */ |
|
61 | 87 | public function removeScreenshot(ThemeScreenshot $screenshot): void; |
62 | 88 | } |
@@ -22,7 +22,13 @@ |
||
22 | 22 | */ |
23 | 23 | public function findAll(): array; |
24 | 24 | |
25 | + /** |
|
26 | + * @return ThemeInterface|null |
|
27 | + */ |
|
25 | 28 | public function findOneByName(string $name): ?ThemeInterface; |
26 | 29 | |
30 | + /** |
|
31 | + * @return ThemeInterface|null |
|
32 | + */ |
|
27 | 33 | public function findOneByTitle(string $title): ?ThemeInterface; |
28 | 34 | } |
@@ -104,6 +104,9 @@ |
||
104 | 104 | return $webDirectory; |
105 | 105 | } |
106 | 106 | |
107 | + /** |
|
108 | + * @param string $webDirectory |
|
109 | + */ |
|
107 | 110 | private function assertFileContent($lines, $webDirectory): void |
108 | 111 | { |
109 | 112 | foreach ($lines as $line) { |