Commaaa2
This commit is contained in:
Paolo A
@@ -1,26 +1,43 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Dotenv\Repository;
|
||||
|
||||
use Dotenv\Repository\Adapter\ApacheAdapter;
|
||||
use Dotenv\Repository\Adapter\AvailabilityInterface;
|
||||
use Dotenv\Repository\Adapter\AdapterInterface;
|
||||
use Dotenv\Repository\Adapter\EnvConstAdapter;
|
||||
use Dotenv\Repository\Adapter\PutenvAdapter;
|
||||
use Dotenv\Repository\Adapter\GuardedWriter;
|
||||
use Dotenv\Repository\Adapter\ImmutableWriter;
|
||||
use Dotenv\Repository\Adapter\MultiReader;
|
||||
use Dotenv\Repository\Adapter\MultiWriter;
|
||||
use Dotenv\Repository\Adapter\ReaderInterface;
|
||||
use Dotenv\Repository\Adapter\ServerConstAdapter;
|
||||
use Dotenv\Repository\Adapter\WriterInterface;
|
||||
use InvalidArgumentException;
|
||||
use PhpOption\Some;
|
||||
use ReflectionClass;
|
||||
|
||||
class RepositoryBuilder
|
||||
final class RepositoryBuilder
|
||||
{
|
||||
/**
|
||||
* The set of default adapters.
|
||||
*/
|
||||
private const DEFAULT_ADAPTERS = [
|
||||
ServerConstAdapter::class,
|
||||
EnvConstAdapter::class,
|
||||
];
|
||||
|
||||
/**
|
||||
* The set of readers to use.
|
||||
*
|
||||
* @var \Dotenv\Repository\Adapter\ReaderInterface[]|null
|
||||
* @var \Dotenv\Repository\Adapter\ReaderInterface[]
|
||||
*/
|
||||
private $readers;
|
||||
|
||||
/**
|
||||
* The set of writers to use.
|
||||
*
|
||||
* @var \Dotenv\Repository\Adapter\WriterInterface[]|null
|
||||
* @var \Dotenv\Repository\Adapter\WriterInterface[]
|
||||
*/
|
||||
private $writers;
|
||||
|
||||
@@ -32,57 +49,182 @@ class RepositoryBuilder
|
||||
private $immutable;
|
||||
|
||||
/**
|
||||
* Create a new repository builder instance.
|
||||
* The variable name allow list.
|
||||
*
|
||||
* @param \Dotenv\Repository\Adapter\ReaderInterface[]|null $readers
|
||||
* @param \Dotenv\Repository\Adapter\WriterInterface[]|null $writers
|
||||
* @param bool $immutable
|
||||
*
|
||||
* @return void
|
||||
* @var string[]|null
|
||||
*/
|
||||
private function __construct(array $readers = null, array $writers = null, $immutable = false)
|
||||
{
|
||||
$this->readers = $readers;
|
||||
$this->writers = $writers;
|
||||
$this->immutable = $immutable;
|
||||
}
|
||||
private $allowList;
|
||||
|
||||
/**
|
||||
* Create a new repository builder instance.
|
||||
*
|
||||
* @param \Dotenv\Repository\Adapter\ReaderInterface[] $readers
|
||||
* @param \Dotenv\Repository\Adapter\WriterInterface[] $writers
|
||||
* @param bool $immutable
|
||||
* @param string[]|null $allowList
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
private function __construct(array $readers = [], array $writers = [], bool $immutable = false, ?array $allowList = null)
|
||||
{
|
||||
$this->readers = $readers;
|
||||
$this->writers = $writers;
|
||||
$this->immutable = $immutable;
|
||||
$this->allowList = $allowList;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a new repository builder instance with no adapters added.
|
||||
*
|
||||
* @return \Dotenv\Repository\RepositoryBuilder
|
||||
*/
|
||||
public static function create()
|
||||
public static function createWithNoAdapters()
|
||||
{
|
||||
return new self();
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a repository builder with the given readers.
|
||||
*
|
||||
* @param \Dotenv\Repository\Adapter\ReaderInterface[]|null $readers
|
||||
* Create a new repository builder instance with the default adapters added.
|
||||
*
|
||||
* @return \Dotenv\Repository\RepositoryBuilder
|
||||
*/
|
||||
public function withReaders(array $readers = null)
|
||||
public static function createWithDefaultAdapters()
|
||||
{
|
||||
$readers = $readers === null ? null : self::filterByAvailability($readers);
|
||||
$adapters = \iterator_to_array(self::defaultAdapters());
|
||||
|
||||
return new self($readers, $this->writers, $this->immutable);
|
||||
return new self($adapters, $adapters);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a repository builder with the given writers.
|
||||
* Return the array of default adapters.
|
||||
*
|
||||
* @param \Dotenv\Repository\Adapter\WriterInterface[]|null $writers
|
||||
* @return \Generator<\Dotenv\Repository\Adapter\AdapterInterface>
|
||||
*/
|
||||
private static function defaultAdapters()
|
||||
{
|
||||
foreach (self::DEFAULT_ADAPTERS as $adapter) {
|
||||
$instance = $adapter::create();
|
||||
if ($instance->isDefined()) {
|
||||
yield $instance->get();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Determine if the given name if of an adapterclass.
|
||||
*
|
||||
* @param string $name
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
private static function isAnAdapterClass(string $name)
|
||||
{
|
||||
if (!\class_exists($name)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return (new ReflectionClass($name))->implementsInterface(AdapterInterface::class);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a repository builder with the given reader added.
|
||||
*
|
||||
* Accepts either a reader instance, or a class-string for an adapter. If
|
||||
* the adapter is not supported, then we silently skip adding it.
|
||||
*
|
||||
* @param \Dotenv\Repository\Adapter\ReaderInterface|string $reader
|
||||
*
|
||||
* @throws \InvalidArgumentException
|
||||
*
|
||||
* @return \Dotenv\Repository\RepositoryBuilder
|
||||
*/
|
||||
public function withWriters(array $writers = null)
|
||||
public function addReader($reader)
|
||||
{
|
||||
$writers = $writers === null ? null : self::filterByAvailability($writers);
|
||||
if (!(\is_string($reader) && self::isAnAdapterClass($reader)) && !($reader instanceof ReaderInterface)) {
|
||||
throw new InvalidArgumentException(
|
||||
\sprintf(
|
||||
'Expected either an instance of %s or a class-string implementing %s',
|
||||
ReaderInterface::class,
|
||||
AdapterInterface::class
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
return new self($this->readers, $writers, $this->immutable);
|
||||
$optional = Some::create($reader)->flatMap(static function ($reader) {
|
||||
return \is_string($reader) ? $reader::create() : Some::create($reader);
|
||||
});
|
||||
|
||||
$readers = \array_merge($this->readers, \iterator_to_array($optional));
|
||||
|
||||
return new self($readers, $this->writers, $this->immutable, $this->allowList);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a repository builder with the given writer added.
|
||||
*
|
||||
* Accepts either a writer instance, or a class-string for an adapter. If
|
||||
* the adapter is not supported, then we silently skip adding it.
|
||||
*
|
||||
* @param \Dotenv\Repository\Adapter\WriterInterface|string $writer
|
||||
*
|
||||
* @throws \InvalidArgumentException
|
||||
*
|
||||
* @return \Dotenv\Repository\RepositoryBuilder
|
||||
*/
|
||||
public function addWriter($writer)
|
||||
{
|
||||
if (!(\is_string($writer) && self::isAnAdapterClass($writer)) && !($writer instanceof WriterInterface)) {
|
||||
throw new InvalidArgumentException(
|
||||
\sprintf(
|
||||
'Expected either an instance of %s or a class-string implementing %s',
|
||||
WriterInterface::class,
|
||||
AdapterInterface::class
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
$optional = Some::create($writer)->flatMap(static function ($writer) {
|
||||
return \is_string($writer) ? $writer::create() : Some::create($writer);
|
||||
});
|
||||
|
||||
$writers = \array_merge($this->writers, \iterator_to_array($optional));
|
||||
|
||||
return new self($this->readers, $writers, $this->immutable, $this->allowList);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a repository builder with the given adapter added.
|
||||
*
|
||||
* Accepts either an adapter instance, or a class-string for an adapter. If
|
||||
* the adapter is not supported, then we silently skip adding it. We will
|
||||
* add the adapter as both a reader and a writer.
|
||||
*
|
||||
* @param \Dotenv\Repository\Adapter\WriterInterface|string $adapter
|
||||
*
|
||||
* @throws \InvalidArgumentException
|
||||
*
|
||||
* @return \Dotenv\Repository\RepositoryBuilder
|
||||
*/
|
||||
public function addAdapter($adapter)
|
||||
{
|
||||
if (!(\is_string($adapter) && self::isAnAdapterClass($adapter)) && !($adapter instanceof AdapterInterface)) {
|
||||
throw new InvalidArgumentException(
|
||||
\sprintf(
|
||||
'Expected either an instance of %s or a class-string implementing %s',
|
||||
WriterInterface::class,
|
||||
AdapterInterface::class
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
$optional = Some::create($adapter)->flatMap(static function ($adapter) {
|
||||
return \is_string($adapter) ? $adapter::create() : Some::create($adapter);
|
||||
});
|
||||
|
||||
$readers = \array_merge($this->readers, \iterator_to_array($optional));
|
||||
$writers = \array_merge($this->writers, \iterator_to_array($optional));
|
||||
|
||||
return new self($readers, $writers, $this->immutable, $this->allowList);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -92,7 +234,19 @@ class RepositoryBuilder
|
||||
*/
|
||||
public function immutable()
|
||||
{
|
||||
return new self($this->readers, $this->writers, true);
|
||||
return new self($this->readers, $this->writers, true, $this->allowList);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a repository builder with the given allow list.
|
||||
*
|
||||
* @param string[]|null $allowList
|
||||
*
|
||||
* @return \Dotenv\Repository\RepositoryBuilder
|
||||
*/
|
||||
public function allowList(?array $allowList = null)
|
||||
{
|
||||
return new self($this->readers, $this->writers, $this->immutable, $allowList);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -102,43 +256,17 @@ class RepositoryBuilder
|
||||
*/
|
||||
public function make()
|
||||
{
|
||||
if ($this->readers === null || $this->writers === null) {
|
||||
$defaults = self::defaultAdapters();
|
||||
$reader = new MultiReader($this->readers);
|
||||
$writer = new MultiWriter($this->writers);
|
||||
|
||||
if ($this->immutable) {
|
||||
$writer = new ImmutableWriter($writer, $reader);
|
||||
}
|
||||
|
||||
return new AdapterRepository(
|
||||
$this->readers === null ? $defaults : $this->readers,
|
||||
$this->writers === null ? $defaults : $this->writers,
|
||||
$this->immutable
|
||||
);
|
||||
}
|
||||
if ($this->allowList !== null) {
|
||||
$writer = new GuardedWriter($writer, $this->allowList);
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the array of default adapters.
|
||||
*
|
||||
* @return \Dotenv\Repository\Adapter\AvailabilityInterface[]
|
||||
*/
|
||||
private static function defaultAdapters()
|
||||
{
|
||||
return self::filterByAvailability([
|
||||
new ApacheAdapter(),
|
||||
new EnvConstAdapter(),
|
||||
new ServerConstAdapter(),
|
||||
new PutenvAdapter(),
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Filter an array of adapters to only those that are supported.
|
||||
*
|
||||
* @param \Dotenv\Repository\Adapter\AvailabilityInterface[] $adapters
|
||||
*
|
||||
* @return \Dotenv\Repository\Adapter\AvailabilityInterface[]
|
||||
*/
|
||||
private static function filterByAvailability(array $adapters)
|
||||
{
|
||||
return array_filter($adapters, function (AvailabilityInterface $adapter) {
|
||||
return $adapter->isSupported();
|
||||
});
|
||||
return new AdapterRepository($reader, $writer);
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user