create-berna-stencil 1.0.46 → 1.0.48

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (185) hide show
  1. package/_tools/res/templates/template.scss +6 -0
  2. package/bin/create.js +2 -1
  3. package/docs/Assistant CLI.md +36 -0
  4. package/docs/Components.md +63 -0
  5. package/docs/Creating pages.md +46 -0
  6. package/docs/Head and SEO.md +44 -0
  7. package/docs/Javascript.md +53 -0
  8. package/docs/Styling with SCSS.md +114 -0
  9. package/package.json +3 -15
  10. package/src/backend/_core/vendor/composer/autoload_static.php +10 -10
  11. package/src/backend/_core/vendor/composer/installed.json +6 -6
  12. package/src/backend/_core/vendor/composer/installed.php +2 -2
  13. package/src/backend/_core/vendor/graham-campbell/result-type/LICENSE +21 -21
  14. package/src/backend/_core/vendor/graham-campbell/result-type/composer.json +33 -33
  15. package/src/backend/_core/vendor/graham-campbell/result-type/src/Error.php +121 -121
  16. package/src/backend/_core/vendor/graham-campbell/result-type/src/Result.php +69 -69
  17. package/src/backend/_core/vendor/graham-campbell/result-type/src/Success.php +120 -120
  18. package/src/backend/_core/vendor/phpoption/phpoption/LICENSE +200 -200
  19. package/src/backend/_core/vendor/phpoption/phpoption/composer.json +50 -50
  20. package/src/backend/_core/vendor/phpoption/phpoption/src/PhpOption/LazyOption.php +175 -175
  21. package/src/backend/_core/vendor/phpoption/phpoption/src/PhpOption/None.php +136 -136
  22. package/src/backend/_core/vendor/phpoption/phpoption/src/PhpOption/Option.php +434 -434
  23. package/src/backend/_core/vendor/phpoption/phpoption/src/PhpOption/Some.php +169 -169
  24. package/src/backend/_core/vendor/symfony/polyfill-ctype/Ctype.php +232 -232
  25. package/src/backend/_core/vendor/symfony/polyfill-ctype/LICENSE +19 -19
  26. package/src/backend/_core/vendor/symfony/polyfill-ctype/README.md +12 -12
  27. package/src/backend/_core/vendor/symfony/polyfill-ctype/bootstrap.php +50 -50
  28. package/src/backend/_core/vendor/symfony/polyfill-ctype/bootstrap80.php +46 -46
  29. package/src/backend/_core/vendor/symfony/polyfill-ctype/composer.json +38 -38
  30. package/src/backend/_core/vendor/symfony/polyfill-mbstring/LICENSE +19 -19
  31. package/src/backend/_core/vendor/symfony/polyfill-mbstring/Mbstring.php +1077 -1077
  32. package/src/backend/_core/vendor/symfony/polyfill-mbstring/README.md +13 -13
  33. package/src/backend/_core/vendor/symfony/polyfill-mbstring/Resources/unidata/caseFolding.php +119 -119
  34. package/src/backend/_core/vendor/symfony/polyfill-mbstring/Resources/unidata/lowerCase.php +1397 -1397
  35. package/src/backend/_core/vendor/symfony/polyfill-mbstring/Resources/unidata/titleCaseRegexp.php +5 -5
  36. package/src/backend/_core/vendor/symfony/polyfill-mbstring/Resources/unidata/upperCase.php +1489 -1489
  37. package/src/backend/_core/vendor/symfony/polyfill-mbstring/bootstrap.php +171 -171
  38. package/src/backend/_core/vendor/symfony/polyfill-mbstring/bootstrap80.php +167 -167
  39. package/src/backend/_core/vendor/symfony/polyfill-mbstring/composer.json +39 -39
  40. package/src/backend/_core/vendor/symfony/polyfill-php80/LICENSE +19 -19
  41. package/src/backend/_core/vendor/symfony/polyfill-php80/Php80.php +115 -115
  42. package/src/backend/_core/vendor/symfony/polyfill-php80/PhpToken.php +106 -106
  43. package/src/backend/_core/vendor/symfony/polyfill-php80/README.md +25 -25
  44. package/src/backend/_core/vendor/symfony/polyfill-php80/Resources/stubs/Attribute.php +31 -31
  45. package/src/backend/_core/vendor/symfony/polyfill-php80/Resources/stubs/PhpToken.php +16 -16
  46. package/src/backend/_core/vendor/symfony/polyfill-php80/Resources/stubs/Stringable.php +20 -20
  47. package/src/backend/_core/vendor/symfony/polyfill-php80/Resources/stubs/UnhandledMatchError.php +16 -16
  48. package/src/backend/_core/vendor/symfony/polyfill-php80/Resources/stubs/ValueError.php +16 -16
  49. package/src/backend/_core/vendor/symfony/polyfill-php80/bootstrap.php +42 -42
  50. package/src/backend/_core/vendor/symfony/polyfill-php80/composer.json +37 -37
  51. package/src/backend/_core/vendor/vlucas/phpdotenv/LICENSE +30 -30
  52. package/src/backend/_core/vendor/vlucas/phpdotenv/composer.json +60 -60
  53. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Dotenv.php +267 -267
  54. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Exception/ExceptionInterface.php +12 -12
  55. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Exception/InvalidEncodingException.php +12 -12
  56. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Exception/InvalidFileException.php +12 -12
  57. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Exception/InvalidPathException.php +12 -12
  58. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Exception/ValidationException.php +12 -12
  59. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Loader/Loader.php +48 -48
  60. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Loader/LoaderInterface.php +20 -20
  61. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Loader/Resolver.php +65 -65
  62. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Parser/Entry.php +59 -59
  63. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Parser/EntryParser.php +299 -299
  64. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Parser/Lexer.php +58 -58
  65. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Parser/Lines.php +127 -127
  66. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Parser/Parser.php +53 -53
  67. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Parser/ParserInterface.php +19 -19
  68. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Parser/Value.php +88 -88
  69. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Repository/Adapter/AdapterInterface.php +15 -15
  70. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Repository/Adapter/ApacheAdapter.php +89 -89
  71. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Repository/Adapter/ArrayAdapter.php +80 -80
  72. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Repository/Adapter/EnvConstAdapter.php +88 -88
  73. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Repository/Adapter/GuardedWriter.php +85 -85
  74. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Repository/Adapter/ImmutableWriter.php +110 -110
  75. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Repository/Adapter/MultiReader.php +48 -48
  76. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Repository/Adapter/MultiWriter.php +64 -64
  77. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Repository/Adapter/PutenvAdapter.php +91 -91
  78. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Repository/Adapter/ReaderInterface.php +17 -17
  79. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Repository/Adapter/ReplacingWriter.php +104 -104
  80. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Repository/Adapter/ServerConstAdapter.php +88 -88
  81. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Repository/Adapter/WriterInterface.php +27 -27
  82. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Repository/AdapterRepository.php +107 -107
  83. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Repository/RepositoryBuilder.php +272 -272
  84. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Repository/RepositoryInterface.php +51 -51
  85. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Store/File/Paths.php +44 -44
  86. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Store/File/Reader.php +81 -81
  87. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Store/FileStore.php +72 -72
  88. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Store/StoreBuilder.php +141 -141
  89. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Store/StoreInterface.php +17 -17
  90. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Store/StringStore.php +37 -37
  91. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Util/Regex.php +112 -112
  92. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Util/Str.php +108 -108
  93. package/src/backend/_core/vendor/vlucas/phpdotenv/src/Validator.php +207 -207
  94. package/src/backend/api/protected/subfolder/example-protected.php +0 -4
  95. package/src/backend/api/public/example-public.php +0 -4
  96. package/src/frontend/components/layouts/includes.njk +0 -3
  97. package/src/frontend/data/site.json +0 -10
  98. package/src/frontend/scss/modules/_root.scss +2 -4
  99. package/src/frontend/scss/modules/frameworks/_bootstrap.scss +0 -1
  100. package/src/frontend/scss/modules/frameworks/_bulma.scss +0 -1
  101. package/src/frontend/scss/modules/frameworks/_foundation.scss +0 -1
  102. package/src/frontend/scss/modules/frameworks/_uikit.scss +0 -1
  103. package/src/frontend/scss/pages/404.scss +3 -1
  104. package/src/frontend/scss/pages/homepage.scss +3 -1
  105. package/src/backend/_core/vendor/graham-campbell/result-type/.gitattributes +0 -9
  106. package/src/backend/_core/vendor/graham-campbell/result-type/.github/CODE_OF_CONDUCT.md +0 -132
  107. package/src/backend/_core/vendor/graham-campbell/result-type/.github/CONTRIBUTING.md +0 -31
  108. package/src/backend/_core/vendor/graham-campbell/result-type/.github/FUNDING.yml +0 -2
  109. package/src/backend/_core/vendor/graham-campbell/result-type/.github/SECURITY.md +0 -14
  110. package/src/backend/_core/vendor/graham-campbell/result-type/.github/workflows/stale.yml +0 -11
  111. package/src/backend/_core/vendor/graham-campbell/result-type/.github/workflows/tests.yml +0 -40
  112. package/src/backend/_core/vendor/graham-campbell/result-type/CHANGELOG.md +0 -53
  113. package/src/backend/_core/vendor/graham-campbell/result-type/README.md +0 -42
  114. package/src/backend/_core/vendor/graham-campbell/result-type/phpunit.xml.dist +0 -13
  115. package/src/backend/_core/vendor/graham-campbell/result-type/tests/ResultTest.php +0 -95
  116. package/src/backend/_core/vendor/phpoption/phpoption/.gitattributes +0 -13
  117. package/src/backend/_core/vendor/phpoption/phpoption/.github/CODE_OF_CONDUCT.md +0 -132
  118. package/src/backend/_core/vendor/phpoption/phpoption/.github/CONTRIBUTING.md +0 -30
  119. package/src/backend/_core/vendor/phpoption/phpoption/.github/FUNDING.yml +0 -2
  120. package/src/backend/_core/vendor/phpoption/phpoption/.github/SECURITY.md +0 -14
  121. package/src/backend/_core/vendor/phpoption/phpoption/.github/workflows/static.yml +0 -40
  122. package/src/backend/_core/vendor/phpoption/phpoption/.github/workflows/tests.yml +0 -40
  123. package/src/backend/_core/vendor/phpoption/phpoption/Makefile +0 -17
  124. package/src/backend/_core/vendor/phpoption/phpoption/README.md +0 -201
  125. package/src/backend/_core/vendor/phpoption/phpoption/phpstan-baseline.neon +0 -44
  126. package/src/backend/_core/vendor/phpoption/phpoption/phpstan.neon.dist +0 -7
  127. package/src/backend/_core/vendor/phpoption/phpoption/phpunit.xml.dist +0 -13
  128. package/src/backend/_core/vendor/phpoption/phpoption/tests/PhpOption/Tests/EnsureTest.php +0 -72
  129. package/src/backend/_core/vendor/phpoption/phpoption/tests/PhpOption/Tests/LazyOptionTest.php +0 -357
  130. package/src/backend/_core/vendor/phpoption/phpoption/tests/PhpOption/Tests/NoneTest.php +0 -153
  131. package/src/backend/_core/vendor/phpoption/phpoption/tests/PhpOption/Tests/OptionTest.php +0 -166
  132. package/src/backend/_core/vendor/phpoption/phpoption/tests/PhpOption/Tests/SomeTest.php +0 -194
  133. package/src/backend/_core/vendor/phpoption/phpoption/tests/bootstrap.php +0 -8
  134. package/src/backend/_core/vendor/phpoption/phpoption/vendor-bin/phpstan/composer.json +0 -8
  135. package/src/backend/_core/vendor/vlucas/phpdotenv/.editorconfig +0 -15
  136. package/src/backend/_core/vendor/vlucas/phpdotenv/.gitattributes +0 -15
  137. package/src/backend/_core/vendor/vlucas/phpdotenv/.github/CODE_OF_CONDUCT.md +0 -132
  138. package/src/backend/_core/vendor/vlucas/phpdotenv/.github/CONTRIBUTING.md +0 -30
  139. package/src/backend/_core/vendor/vlucas/phpdotenv/.github/FUNDING.yml +0 -2
  140. package/src/backend/_core/vendor/vlucas/phpdotenv/.github/SECURITY.md +0 -14
  141. package/src/backend/_core/vendor/vlucas/phpdotenv/.github/workflows/static.yml +0 -40
  142. package/src/backend/_core/vendor/vlucas/phpdotenv/.github/workflows/tests.yml +0 -70
  143. package/src/backend/_core/vendor/vlucas/phpdotenv/Makefile +0 -17
  144. package/src/backend/_core/vendor/vlucas/phpdotenv/README.md +0 -370
  145. package/src/backend/_core/vendor/vlucas/phpdotenv/UPGRADING.md +0 -196
  146. package/src/backend/_core/vendor/vlucas/phpdotenv/phpstan-baseline.neon +0 -157
  147. package/src/backend/_core/vendor/vlucas/phpdotenv/phpstan.neon.dist +0 -7
  148. package/src/backend/_core/vendor/vlucas/phpdotenv/phpunit.xml.dist +0 -13
  149. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/Dotenv/DotenvTest.php +0 -387
  150. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/Dotenv/Loader/LoaderTest.php +0 -86
  151. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/Dotenv/Parser/EntryParserTest.php +0 -234
  152. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/Dotenv/Parser/LexerTest.php +0 -40
  153. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/Dotenv/Parser/LinesTest.php +0 -53
  154. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/Dotenv/Parser/ParserTest.php +0 -98
  155. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/Dotenv/Repository/Adapter/ArrayAdapterTest.php +0 -57
  156. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/Dotenv/Repository/Adapter/EnvConstAdapterTest.php +0 -75
  157. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/Dotenv/Repository/Adapter/PutenvAdapterTest.php +0 -52
  158. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/Dotenv/Repository/Adapter/ServerConstAdapterTest.php +0 -75
  159. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/Dotenv/Repository/RepositoryTest.php +0 -305
  160. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/Dotenv/Store/StoreTest.php +0 -141
  161. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/Dotenv/ValidatorTest.php +0 -479
  162. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/fixtures/env/.env +0 -5
  163. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/fixtures/env/assertions.env +0 -18
  164. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/fixtures/env/booleans.env +0 -33
  165. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/fixtures/env/commented.env +0 -15
  166. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/fixtures/env/empty.env +0 -1
  167. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/fixtures/env/example.env +0 -1
  168. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/fixtures/env/exported.env +0 -7
  169. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/fixtures/env/immutable.env +0 -1
  170. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/fixtures/env/integers.env +0 -17
  171. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/fixtures/env/large.env +0 -2
  172. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/fixtures/env/multibyte.env +0 -3
  173. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/fixtures/env/multiline.env +0 -14
  174. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/fixtures/env/multiple.env +0 -4
  175. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/fixtures/env/mutable.env +0 -1
  176. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/fixtures/env/nested.env +0 -15
  177. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/fixtures/env/quoted.env +0 -11
  178. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/fixtures/env/specialchars.env +0 -8
  179. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/fixtures/env/unicodevarnames.env +0 -2
  180. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/fixtures/env/utf8-with-bom-encoding.env +0 -3
  181. package/src/backend/_core/vendor/vlucas/phpdotenv/tests/fixtures/env/windows.env +0 -1
  182. package/src/backend/_core/vendor/vlucas/phpdotenv/vendor-bin/phpstan/composer.json +0 -15
  183. package/src/frontend/_routes/example-page.njk +0 -9
  184. package/src/frontend/js/pages/examplePage.js +0 -19
  185. package/src/frontend/scss/pages/examplePage.scss +0 -17
@@ -1,44 +1,44 @@
1
- <?php
2
-
3
- declare(strict_types=1);
4
-
5
- namespace Dotenv\Store\File;
6
-
7
- /**
8
- * @internal
9
- */
10
- final class Paths
11
- {
12
- /**
13
- * This class is a singleton.
14
- *
15
- * @codeCoverageIgnore
16
- *
17
- * @return void
18
- */
19
- private function __construct()
20
- {
21
- //
22
- }
23
-
24
- /**
25
- * Returns the full paths to the files.
26
- *
27
- * @param string[] $paths
28
- * @param string[] $names
29
- *
30
- * @return string[]
31
- */
32
- public static function filePaths(array $paths, array $names)
33
- {
34
- $files = [];
35
-
36
- foreach ($paths as $path) {
37
- foreach ($names as $name) {
38
- $files[] = \rtrim($path, \DIRECTORY_SEPARATOR).\DIRECTORY_SEPARATOR.$name;
39
- }
40
- }
41
-
42
- return $files;
43
- }
44
- }
1
+ <?php
2
+
3
+ declare(strict_types=1);
4
+
5
+ namespace Dotenv\Store\File;
6
+
7
+ /**
8
+ * @internal
9
+ */
10
+ final class Paths
11
+ {
12
+ /**
13
+ * This class is a singleton.
14
+ *
15
+ * @codeCoverageIgnore
16
+ *
17
+ * @return void
18
+ */
19
+ private function __construct()
20
+ {
21
+ //
22
+ }
23
+
24
+ /**
25
+ * Returns the full paths to the files.
26
+ *
27
+ * @param string[] $paths
28
+ * @param string[] $names
29
+ *
30
+ * @return string[]
31
+ */
32
+ public static function filePaths(array $paths, array $names)
33
+ {
34
+ $files = [];
35
+
36
+ foreach ($paths as $path) {
37
+ foreach ($names as $name) {
38
+ $files[] = \rtrim($path, \DIRECTORY_SEPARATOR).\DIRECTORY_SEPARATOR.$name;
39
+ }
40
+ }
41
+
42
+ return $files;
43
+ }
44
+ }
@@ -1,81 +1,81 @@
1
- <?php
2
-
3
- declare(strict_types=1);
4
-
5
- namespace Dotenv\Store\File;
6
-
7
- use Dotenv\Exception\InvalidEncodingException;
8
- use Dotenv\Util\Str;
9
- use PhpOption\Option;
10
-
11
- /**
12
- * @internal
13
- */
14
- final class Reader
15
- {
16
- /**
17
- * This class is a singleton.
18
- *
19
- * @codeCoverageIgnore
20
- *
21
- * @return void
22
- */
23
- private function __construct()
24
- {
25
- //
26
- }
27
-
28
- /**
29
- * Read the file(s), and return their raw content.
30
- *
31
- * We provide the file path as the key, and its content as the value. If
32
- * short circuit mode is enabled, then the returned array with have length
33
- * at most one. File paths that couldn't be read are omitted entirely.
34
- *
35
- * @param string[] $filePaths
36
- * @param bool $shortCircuit
37
- * @param string|null $fileEncoding
38
- *
39
- * @throws \Dotenv\Exception\InvalidEncodingException
40
- *
41
- * @return array<string, string>
42
- */
43
- public static function read(array $filePaths, bool $shortCircuit = true, ?string $fileEncoding = null)
44
- {
45
- $output = [];
46
-
47
- foreach ($filePaths as $filePath) {
48
- $content = self::readFromFile($filePath, $fileEncoding);
49
- if ($content->isDefined()) {
50
- $output[$filePath] = $content->get();
51
- if ($shortCircuit) {
52
- break;
53
- }
54
- }
55
- }
56
-
57
- return $output;
58
- }
59
-
60
- /**
61
- * Read the given file.
62
- *
63
- * @param string $path
64
- * @param string|null $encoding
65
- *
66
- * @throws \Dotenv\Exception\InvalidEncodingException
67
- *
68
- * @return \PhpOption\Option<string>
69
- */
70
- private static function readFromFile(string $path, ?string $encoding = null)
71
- {
72
- /** @var Option<string> */
73
- $content = Option::fromValue(@\file_get_contents($path), false);
74
-
75
- return $content->flatMap(static function (string $content) use ($encoding) {
76
- return Str::utf8($content, $encoding)->mapError(static function (string $error) {
77
- throw new InvalidEncodingException($error);
78
- })->success();
79
- });
80
- }
81
- }
1
+ <?php
2
+
3
+ declare(strict_types=1);
4
+
5
+ namespace Dotenv\Store\File;
6
+
7
+ use Dotenv\Exception\InvalidEncodingException;
8
+ use Dotenv\Util\Str;
9
+ use PhpOption\Option;
10
+
11
+ /**
12
+ * @internal
13
+ */
14
+ final class Reader
15
+ {
16
+ /**
17
+ * This class is a singleton.
18
+ *
19
+ * @codeCoverageIgnore
20
+ *
21
+ * @return void
22
+ */
23
+ private function __construct()
24
+ {
25
+ //
26
+ }
27
+
28
+ /**
29
+ * Read the file(s), and return their raw content.
30
+ *
31
+ * We provide the file path as the key, and its content as the value. If
32
+ * short circuit mode is enabled, then the returned array with have length
33
+ * at most one. File paths that couldn't be read are omitted entirely.
34
+ *
35
+ * @param string[] $filePaths
36
+ * @param bool $shortCircuit
37
+ * @param string|null $fileEncoding
38
+ *
39
+ * @throws \Dotenv\Exception\InvalidEncodingException
40
+ *
41
+ * @return array<string, string>
42
+ */
43
+ public static function read(array $filePaths, bool $shortCircuit = true, ?string $fileEncoding = null)
44
+ {
45
+ $output = [];
46
+
47
+ foreach ($filePaths as $filePath) {
48
+ $content = self::readFromFile($filePath, $fileEncoding);
49
+ if ($content->isDefined()) {
50
+ $output[$filePath] = $content->get();
51
+ if ($shortCircuit) {
52
+ break;
53
+ }
54
+ }
55
+ }
56
+
57
+ return $output;
58
+ }
59
+
60
+ /**
61
+ * Read the given file.
62
+ *
63
+ * @param string $path
64
+ * @param string|null $encoding
65
+ *
66
+ * @throws \Dotenv\Exception\InvalidEncodingException
67
+ *
68
+ * @return \PhpOption\Option<string>
69
+ */
70
+ private static function readFromFile(string $path, ?string $encoding = null)
71
+ {
72
+ /** @var Option<string> */
73
+ $content = Option::fromValue(@\file_get_contents($path), false);
74
+
75
+ return $content->flatMap(static function (string $content) use ($encoding) {
76
+ return Str::utf8($content, $encoding)->mapError(static function (string $error) {
77
+ throw new InvalidEncodingException($error);
78
+ })->success();
79
+ });
80
+ }
81
+ }
@@ -1,72 +1,72 @@
1
- <?php
2
-
3
- declare(strict_types=1);
4
-
5
- namespace Dotenv\Store;
6
-
7
- use Dotenv\Exception\InvalidPathException;
8
- use Dotenv\Store\File\Reader;
9
-
10
- final class FileStore implements StoreInterface
11
- {
12
- /**
13
- * The file paths.
14
- *
15
- * @var string[]
16
- */
17
- private $filePaths;
18
-
19
- /**
20
- * Should file loading short circuit?
21
- *
22
- * @var bool
23
- */
24
- private $shortCircuit;
25
-
26
- /**
27
- * The file encoding.
28
- *
29
- * @var string|null
30
- */
31
- private $fileEncoding;
32
-
33
- /**
34
- * Create a new file store instance.
35
- *
36
- * @param string[] $filePaths
37
- * @param bool $shortCircuit
38
- * @param string|null $fileEncoding
39
- *
40
- * @return void
41
- */
42
- public function __construct(array $filePaths, bool $shortCircuit, ?string $fileEncoding = null)
43
- {
44
- $this->filePaths = $filePaths;
45
- $this->shortCircuit = $shortCircuit;
46
- $this->fileEncoding = $fileEncoding;
47
- }
48
-
49
- /**
50
- * Read the content of the environment file(s).
51
- *
52
- * @throws \Dotenv\Exception\InvalidEncodingException|\Dotenv\Exception\InvalidPathException
53
- *
54
- * @return string
55
- */
56
- public function read()
57
- {
58
- if ($this->filePaths === []) {
59
- throw new InvalidPathException('At least one environment file path must be provided.');
60
- }
61
-
62
- $contents = Reader::read($this->filePaths, $this->shortCircuit, $this->fileEncoding);
63
-
64
- if (\count($contents) > 0) {
65
- return \implode("\n", $contents);
66
- }
67
-
68
- throw new InvalidPathException(
69
- \sprintf('Unable to read any of the environment file(s) at [%s].', \implode(', ', $this->filePaths))
70
- );
71
- }
72
- }
1
+ <?php
2
+
3
+ declare(strict_types=1);
4
+
5
+ namespace Dotenv\Store;
6
+
7
+ use Dotenv\Exception\InvalidPathException;
8
+ use Dotenv\Store\File\Reader;
9
+
10
+ final class FileStore implements StoreInterface
11
+ {
12
+ /**
13
+ * The file paths.
14
+ *
15
+ * @var string[]
16
+ */
17
+ private $filePaths;
18
+
19
+ /**
20
+ * Should file loading short circuit?
21
+ *
22
+ * @var bool
23
+ */
24
+ private $shortCircuit;
25
+
26
+ /**
27
+ * The file encoding.
28
+ *
29
+ * @var string|null
30
+ */
31
+ private $fileEncoding;
32
+
33
+ /**
34
+ * Create a new file store instance.
35
+ *
36
+ * @param string[] $filePaths
37
+ * @param bool $shortCircuit
38
+ * @param string|null $fileEncoding
39
+ *
40
+ * @return void
41
+ */
42
+ public function __construct(array $filePaths, bool $shortCircuit, ?string $fileEncoding = null)
43
+ {
44
+ $this->filePaths = $filePaths;
45
+ $this->shortCircuit = $shortCircuit;
46
+ $this->fileEncoding = $fileEncoding;
47
+ }
48
+
49
+ /**
50
+ * Read the content of the environment file(s).
51
+ *
52
+ * @throws \Dotenv\Exception\InvalidEncodingException|\Dotenv\Exception\InvalidPathException
53
+ *
54
+ * @return string
55
+ */
56
+ public function read()
57
+ {
58
+ if ($this->filePaths === []) {
59
+ throw new InvalidPathException('At least one environment file path must be provided.');
60
+ }
61
+
62
+ $contents = Reader::read($this->filePaths, $this->shortCircuit, $this->fileEncoding);
63
+
64
+ if (\count($contents) > 0) {
65
+ return \implode("\n", $contents);
66
+ }
67
+
68
+ throw new InvalidPathException(
69
+ \sprintf('Unable to read any of the environment file(s) at [%s].', \implode(', ', $this->filePaths))
70
+ );
71
+ }
72
+ }
@@ -1,141 +1,141 @@
1
- <?php
2
-
3
- declare(strict_types=1);
4
-
5
- namespace Dotenv\Store;
6
-
7
- use Dotenv\Store\File\Paths;
8
-
9
- final class StoreBuilder
10
- {
11
- /**
12
- * The of default name.
13
- */
14
- private const DEFAULT_NAME = '.env';
15
-
16
- /**
17
- * The paths to search within.
18
- *
19
- * @var string[]
20
- */
21
- private $paths;
22
-
23
- /**
24
- * The file names to search for.
25
- *
26
- * @var string[]
27
- */
28
- private $names;
29
-
30
- /**
31
- * Should file loading short circuit?
32
- *
33
- * @var bool
34
- */
35
- private $shortCircuit;
36
-
37
- /**
38
- * The file encoding.
39
- *
40
- * @var string|null
41
- */
42
- private $fileEncoding;
43
-
44
- /**
45
- * Create a new store builder instance.
46
- *
47
- * @param string[] $paths
48
- * @param string[] $names
49
- * @param bool $shortCircuit
50
- * @param string|null $fileEncoding
51
- *
52
- * @return void
53
- */
54
- private function __construct(array $paths = [], array $names = [], bool $shortCircuit = false, ?string $fileEncoding = null)
55
- {
56
- $this->paths = $paths;
57
- $this->names = $names;
58
- $this->shortCircuit = $shortCircuit;
59
- $this->fileEncoding = $fileEncoding;
60
- }
61
-
62
- /**
63
- * Create a new store builder instance with no names.
64
- *
65
- * @return \Dotenv\Store\StoreBuilder
66
- */
67
- public static function createWithNoNames()
68
- {
69
- return new self();
70
- }
71
-
72
- /**
73
- * Create a new store builder instance with the default name.
74
- *
75
- * @return \Dotenv\Store\StoreBuilder
76
- */
77
- public static function createWithDefaultName()
78
- {
79
- return new self([], [self::DEFAULT_NAME]);
80
- }
81
-
82
- /**
83
- * Creates a store builder with the given path added.
84
- *
85
- * @param string $path
86
- *
87
- * @return \Dotenv\Store\StoreBuilder
88
- */
89
- public function addPath(string $path)
90
- {
91
- return new self(\array_merge($this->paths, [$path]), $this->names, $this->shortCircuit, $this->fileEncoding);
92
- }
93
-
94
- /**
95
- * Creates a store builder with the given name added.
96
- *
97
- * @param string $name
98
- *
99
- * @return \Dotenv\Store\StoreBuilder
100
- */
101
- public function addName(string $name)
102
- {
103
- return new self($this->paths, \array_merge($this->names, [$name]), $this->shortCircuit, $this->fileEncoding);
104
- }
105
-
106
- /**
107
- * Creates a store builder with short circuit mode enabled.
108
- *
109
- * @return \Dotenv\Store\StoreBuilder
110
- */
111
- public function shortCircuit()
112
- {
113
- return new self($this->paths, $this->names, true, $this->fileEncoding);
114
- }
115
-
116
- /**
117
- * Creates a store builder with the specified file encoding.
118
- *
119
- * @param string|null $fileEncoding
120
- *
121
- * @return \Dotenv\Store\StoreBuilder
122
- */
123
- public function fileEncoding(?string $fileEncoding = null)
124
- {
125
- return new self($this->paths, $this->names, $this->shortCircuit, $fileEncoding);
126
- }
127
-
128
- /**
129
- * Creates a new store instance.
130
- *
131
- * @return \Dotenv\Store\StoreInterface
132
- */
133
- public function make()
134
- {
135
- return new FileStore(
136
- Paths::filePaths($this->paths, $this->names),
137
- $this->shortCircuit,
138
- $this->fileEncoding
139
- );
140
- }
141
- }
1
+ <?php
2
+
3
+ declare(strict_types=1);
4
+
5
+ namespace Dotenv\Store;
6
+
7
+ use Dotenv\Store\File\Paths;
8
+
9
+ final class StoreBuilder
10
+ {
11
+ /**
12
+ * The of default name.
13
+ */
14
+ private const DEFAULT_NAME = '.env';
15
+
16
+ /**
17
+ * The paths to search within.
18
+ *
19
+ * @var string[]
20
+ */
21
+ private $paths;
22
+
23
+ /**
24
+ * The file names to search for.
25
+ *
26
+ * @var string[]
27
+ */
28
+ private $names;
29
+
30
+ /**
31
+ * Should file loading short circuit?
32
+ *
33
+ * @var bool
34
+ */
35
+ private $shortCircuit;
36
+
37
+ /**
38
+ * The file encoding.
39
+ *
40
+ * @var string|null
41
+ */
42
+ private $fileEncoding;
43
+
44
+ /**
45
+ * Create a new store builder instance.
46
+ *
47
+ * @param string[] $paths
48
+ * @param string[] $names
49
+ * @param bool $shortCircuit
50
+ * @param string|null $fileEncoding
51
+ *
52
+ * @return void
53
+ */
54
+ private function __construct(array $paths = [], array $names = [], bool $shortCircuit = false, ?string $fileEncoding = null)
55
+ {
56
+ $this->paths = $paths;
57
+ $this->names = $names;
58
+ $this->shortCircuit = $shortCircuit;
59
+ $this->fileEncoding = $fileEncoding;
60
+ }
61
+
62
+ /**
63
+ * Create a new store builder instance with no names.
64
+ *
65
+ * @return \Dotenv\Store\StoreBuilder
66
+ */
67
+ public static function createWithNoNames()
68
+ {
69
+ return new self();
70
+ }
71
+
72
+ /**
73
+ * Create a new store builder instance with the default name.
74
+ *
75
+ * @return \Dotenv\Store\StoreBuilder
76
+ */
77
+ public static function createWithDefaultName()
78
+ {
79
+ return new self([], [self::DEFAULT_NAME]);
80
+ }
81
+
82
+ /**
83
+ * Creates a store builder with the given path added.
84
+ *
85
+ * @param string $path
86
+ *
87
+ * @return \Dotenv\Store\StoreBuilder
88
+ */
89
+ public function addPath(string $path)
90
+ {
91
+ return new self(\array_merge($this->paths, [$path]), $this->names, $this->shortCircuit, $this->fileEncoding);
92
+ }
93
+
94
+ /**
95
+ * Creates a store builder with the given name added.
96
+ *
97
+ * @param string $name
98
+ *
99
+ * @return \Dotenv\Store\StoreBuilder
100
+ */
101
+ public function addName(string $name)
102
+ {
103
+ return new self($this->paths, \array_merge($this->names, [$name]), $this->shortCircuit, $this->fileEncoding);
104
+ }
105
+
106
+ /**
107
+ * Creates a store builder with short circuit mode enabled.
108
+ *
109
+ * @return \Dotenv\Store\StoreBuilder
110
+ */
111
+ public function shortCircuit()
112
+ {
113
+ return new self($this->paths, $this->names, true, $this->fileEncoding);
114
+ }
115
+
116
+ /**
117
+ * Creates a store builder with the specified file encoding.
118
+ *
119
+ * @param string|null $fileEncoding
120
+ *
121
+ * @return \Dotenv\Store\StoreBuilder
122
+ */
123
+ public function fileEncoding(?string $fileEncoding = null)
124
+ {
125
+ return new self($this->paths, $this->names, $this->shortCircuit, $fileEncoding);
126
+ }
127
+
128
+ /**
129
+ * Creates a new store instance.
130
+ *
131
+ * @return \Dotenv\Store\StoreInterface
132
+ */
133
+ public function make()
134
+ {
135
+ return new FileStore(
136
+ Paths::filePaths($this->paths, $this->names),
137
+ $this->shortCircuit,
138
+ $this->fileEncoding
139
+ );
140
+ }
141
+ }