This commit is contained in:
Paolo A
2024-08-13 13:44:16 +00:00
parent 1bbb23088d
commit e796d76612
4001 changed files with 30101 additions and 40075 deletions

View File

@@ -1,9 +1,26 @@
<?php
declare(strict_types=1);
namespace Dotenv\Store\File;
class Paths
/**
* @internal
*/
final class Paths
{
/**
* This class is a singleton.
*
* @codeCoverageIgnore
*
* @return void
*/
private function __construct()
{
//
}
/**
* Returns the full paths to the files.
*
@@ -18,7 +35,7 @@ class Paths
foreach ($paths as $path) {
foreach ($names as $name) {
$files[] = rtrim($path, DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR.$name;
$files[] = \rtrim($path, \DIRECTORY_SEPARATOR).\DIRECTORY_SEPARATOR.$name;
}
}

View File

@@ -1,11 +1,30 @@
<?php
declare(strict_types=1);
namespace Dotenv\Store\File;
use Dotenv\Exception\InvalidEncodingException;
use Dotenv\Util\Str;
use PhpOption\Option;
class Reader
/**
* @internal
*/
final class Reader
{
/**
* This class is a singleton.
*
* @codeCoverageIgnore
*
* @return void
*/
private function __construct()
{
//
}
/**
* Read the file(s), and return their raw content.
*
@@ -13,17 +32,20 @@ class Reader
* short circuit mode is enabled, then the returned array with have length
* at most one. File paths that couldn't be read are omitted entirely.
*
* @param string[] $filePaths
* @param bool $shortCircuit
* @param string[] $filePaths
* @param bool $shortCircuit
* @param string|null $fileEncoding
*
* @throws \Dotenv\Exception\InvalidEncodingException
*
* @return array<string,string>
*/
public static function read(array $filePaths, $shortCircuit = true)
public static function read(array $filePaths, bool $shortCircuit = true, ?string $fileEncoding = null)
{
$output = [];
foreach ($filePaths as $filePath) {
$content = self::readFromFile($filePath);
$content = self::readFromFile($filePath, $fileEncoding);
if ($content->isDefined()) {
$output[$filePath] = $content->get();
if ($shortCircuit) {
@@ -38,15 +60,22 @@ class Reader
/**
* Read the given file.
*
* @param string $filePath
* @param string $path
* @param string|null $encoding
*
* @throws \Dotenv\Exception\InvalidEncodingException
*
* @return \PhpOption\Option<string>
*/
private static function readFromFile($filePath)
private static function readFromFile(string $path, ?string $encoding = null)
{
$content = @file_get_contents($filePath);
/** @var Option<string> */
$content = Option::fromValue(@\file_get_contents($path), false);
/** @var \PhpOption\Option<string> */
return Option::fromValue($content, false);
return $content->flatMap(static function (string $content) use ($encoding) {
return Str::utf8($content, $encoding)->mapError(static function (string $error) {
throw new InvalidEncodingException($error);
})->success();
});
}
}

View File

@@ -1,44 +1,55 @@
<?php
declare(strict_types=1);
namespace Dotenv\Store;
use Dotenv\Exception\InvalidPathException;
use Dotenv\Store\File\Reader;
class FileStore implements StoreInterface
final class FileStore implements StoreInterface
{
/**
* The file paths.
*
* @var string[]
*/
protected $filePaths;
private $filePaths;
/**
* Should file loading short circuit?
*
* @var bool
*/
protected $shortCircuit;
private $shortCircuit;
/**
* The file encoding.
*
* @var string|null
*/
private $fileEncoding;
/**
* Create a new file store instance.
*
* @param string[] $filePaths
* @param bool $shortCircuit
* @param string[] $filePaths
* @param bool $shortCircuit
* @param string|null $fileEncoding
*
* @return void
*/
public function __construct(array $filePaths, $shortCircuit)
public function __construct(array $filePaths, bool $shortCircuit, ?string $fileEncoding = null)
{
$this->filePaths = $filePaths;
$this->shortCircuit = $shortCircuit;
$this->fileEncoding = $fileEncoding;
}
/**
* Read the content of the environment file(s).
*
* @throws \Dotenv\Exception\InvalidPathException
* @throws \Dotenv\Exception\InvalidEncodingException|\Dotenv\Exception\InvalidPathException
*
* @return string
*/
@@ -48,14 +59,14 @@ class FileStore implements StoreInterface
throw new InvalidPathException('At least one environment file path must be provided.');
}
$contents = Reader::read($this->filePaths, $this->shortCircuit);
$contents = Reader::read($this->filePaths, $this->shortCircuit, $this->fileEncoding);
if (count($contents) > 0) {
return implode("\n", $contents);
if (\count($contents) > 0) {
return \implode("\n", $contents);
}
throw new InvalidPathException(
sprintf('Unable to read any of the environment file(s) at [%s].', implode(', ', $this->filePaths))
\sprintf('Unable to read any of the environment file(s) at [%s].', \implode(', ', $this->filePaths))
);
}
}

View File

@@ -1,11 +1,18 @@
<?php
declare(strict_types=1);
namespace Dotenv\Store;
use Dotenv\Store\File\Paths;
class StoreBuilder
final class StoreBuilder
{
/**
* The of default name.
*/
private const DEFAULT_NAME = '.env';
/**
* The paths to search within.
*
@@ -16,7 +23,7 @@ class StoreBuilder
/**
* The file names to search for.
*
* @var string[]|null
* @var string[]
*/
private $names;
@@ -25,56 +32,75 @@ class StoreBuilder
*
* @var bool
*/
protected $shortCircuit;
private $shortCircuit;
/**
* The file encoding.
*
* @var string|null
*/
private $fileEncoding;
/**
* Create a new store builder instance.
*
* @param string[] $paths
* @param string[]|null $names
* @param bool $shortCircuit
* @param string[] $paths
* @param string[] $names
* @param bool $shortCircuit
* @param string|null $fileEncoding
*
* @return void
*/
private function __construct(array $paths = [], array $names = null, $shortCircuit = false)
private function __construct(array $paths = [], array $names = [], bool $shortCircuit = false, ?string $fileEncoding = null)
{
$this->paths = $paths;
$this->names = $names;
$this->shortCircuit = $shortCircuit;
$this->fileEncoding = $fileEncoding;
}
/**
* Create a new store builder instance.
* Create a new store builder instance with no names.
*
* @return \Dotenv\Store\StoreBuilder
*/
public static function create()
public static function createWithNoNames()
{
return new self();
}
/**
* Creates a store builder with the given paths.
*
* @param string|string[] $paths
* Create a new store builder instance with the default name.
*
* @return \Dotenv\Store\StoreBuilder
*/
public function withPaths($paths)
public static function createWithDefaultName()
{
return new self((array) $paths, $this->names, $this->shortCircuit);
return new self([], [self::DEFAULT_NAME]);
}
/**
* Creates a store builder with the given names.
* Creates a store builder with the given path added.
*
* @param string|string[]|null $names
* @param string $path
*
* @return \Dotenv\Store\StoreBuilder
*/
public function withNames($names = null)
public function addPath(string $path)
{
return new self($this->paths, $names === null ? null : (array) $names, $this->shortCircuit);
return new self(\array_merge($this->paths, [$path]), $this->names, $this->shortCircuit, $this->fileEncoding);
}
/**
* Creates a store builder with the given name added.
*
* @param string $name
*
* @return \Dotenv\Store\StoreBuilder
*/
public function addName(string $name)
{
return new self($this->paths, \array_merge($this->names, [$name]), $this->shortCircuit, $this->fileEncoding);
}
/**
@@ -84,7 +110,19 @@ class StoreBuilder
*/
public function shortCircuit()
{
return new self($this->paths, $this->names, true);
return new self($this->paths, $this->names, true, $this->fileEncoding);
}
/**
* Creates a store builder with the specified file encoding.
*
* @param string|null $fileEncoding
*
* @return \Dotenv\Store\StoreBuilder
*/
public function fileEncoding(?string $fileEncoding = null)
{
return new self($this->paths, $this->names, $this->shortCircuit, $fileEncoding);
}
/**
@@ -95,8 +133,9 @@ class StoreBuilder
public function make()
{
return new FileStore(
Paths::filePaths($this->paths, $this->names === null ? ['.env'] : $this->names),
$this->shortCircuit
Paths::filePaths($this->paths, $this->names),
$this->shortCircuit,
$this->fileEncoding
);
}
}

View File

@@ -1,5 +1,7 @@
<?php
declare(strict_types=1);
namespace Dotenv\Store;
interface StoreInterface
@@ -7,7 +9,7 @@ interface StoreInterface
/**
* Read the content of the environment file(s).
*
* @throws \Dotenv\Exception\InvalidPathException
* @throws \Dotenv\Exception\InvalidEncodingException|\Dotenv\Exception\InvalidPathException
*
* @return string
*/

View File

@@ -1,5 +1,7 @@
<?php
declare(strict_types=1);
namespace Dotenv\Store;
final class StringStore implements StoreInterface
@@ -18,7 +20,7 @@ final class StringStore implements StoreInterface
*
* @return void
*/
public function __construct($content)
public function __construct(string $content)
{
$this->content = $content;
}