StoreBuilder
in package
FinalYes
Table of Contents
Constants
- DEFAULT_NAME = '.env'
- The of default name.
Properties
- $fileEncoding : string|null
- The file encoding.
- $names : array<string|int, string>
- The file names to search for.
- $paths : array<string|int, string>
- The paths to search within.
- $shortCircuit : bool
- Should file loading short circuit?
Methods
- addName() : StoreBuilder
- Creates a store builder with the given name added.
- addPath() : StoreBuilder
- Creates a store builder with the given path added.
- createWithDefaultName() : StoreBuilder
- Create a new store builder instance with the default name.
- createWithNoNames() : StoreBuilder
- Create a new store builder instance with no names.
- fileEncoding() : StoreBuilder
- Creates a store builder with the specified file encoding.
- make() : StoreInterface
- Creates a new store instance.
- shortCircuit() : StoreBuilder
- Creates a store builder with short circuit mode enabled.
- __construct() : void
- Create a new store builder instance.
Constants
DEFAULT_NAME
The of default name.
private
mixed
DEFAULT_NAME
= '.env'
Properties
$fileEncoding
The file encoding.
private
string|null
$fileEncoding
$names
The file names to search for.
private
array<string|int, string>
$names
$paths
The paths to search within.
private
array<string|int, string>
$paths
$shortCircuit
Should file loading short circuit?
private
bool
$shortCircuit
Methods
addName()
Creates a store builder with the given name added.
public
addName(string $name) : StoreBuilder
Parameters
- $name : string
Return values
StoreBuilderaddPath()
Creates a store builder with the given path added.
public
addPath(string $path) : StoreBuilder
Parameters
- $path : string
Return values
StoreBuildercreateWithDefaultName()
Create a new store builder instance with the default name.
public
static createWithDefaultName() : StoreBuilder
Return values
StoreBuildercreateWithNoNames()
Create a new store builder instance with no names.
public
static createWithNoNames() : StoreBuilder
Return values
StoreBuilderfileEncoding()
Creates a store builder with the specified file encoding.
public
fileEncoding([string|null $fileEncoding = null ]) : StoreBuilder
Parameters
- $fileEncoding : string|null = null
Return values
StoreBuildermake()
Creates a new store instance.
public
make() : StoreInterface
Return values
StoreInterfaceshortCircuit()
Creates a store builder with short circuit mode enabled.
public
shortCircuit() : StoreBuilder
Return values
StoreBuilder__construct()
Create a new store builder instance.
private
__construct([array<string|int, string> $paths = [] ][, array<string|int, string> $names = [] ][, bool $shortCircuit = false ][, string|null $fileEncoding = null ]) : void
Parameters
- $paths : array<string|int, string> = []
- $names : array<string|int, string> = []
- $shortCircuit : bool = false
- $fileEncoding : string|null = null