FileLoader

class FileLoader implements LoaderInterface (View source)

Properties

protected Filesystem $files The filesystem instance.
protected string $defaultPath The default configuration path.
protected array $hints All of the named path hints.
protected array $exists A cache of whether namespaces and groups exists.

Methods

void __construct(Filesystem $files, string $defaultPath)

Create a new file configuration loader.
array load(string $environment, string $group, string $namespace = null)

Load the given configuration group.
array mergeEnvironment(array $items, string $file)

Merge the items in the given file into the items.
bool exists(string $group, string $namespace = null)

Determine if the given group exists.
array cascadePackage(string $env, string $package, string $group, array $items)

Apply any cascades to an array of package options.
string getPackagePath(string $env, string $package, string $group)

Get the package path for an environment and group.
string getPath(string $namespace)

Get the configuration path for a namespace.
void addNamespace(string $namespace, string $hint)

Add a new namespace to the loader.
array getNamespaces()

Returns all registered namespaces with the config loader.
mixed getRequire(string $path)

Get a file's contents by requiring it.
Filesystem getFilesystem()

Get the Filesystem instance.

Details

void __construct(Filesystem $files, string $defaultPath)

Create a new file configuration loader.

Parameters

Filesystem $files
string $defaultPath

Return Value

void

array load(string $environment, string $group, string $namespace = null)

Load the given configuration group.

Parameters

string $environment
string $group
string $namespace

Return Value

array

protected array mergeEnvironment(array $items, string $file)

Merge the items in the given file into the items.

Parameters

array $items
string $file

Return Value

array

bool exists(string $group, string $namespace = null)

Determine if the given group exists.

Parameters

string $group
string $namespace

Return Value

bool

array cascadePackage(string $env, string $package, string $group, array $items)

Apply any cascades to an array of package options.

Parameters

string $env
string $package
string $group
array $items

Return Value

array

protected string getPackagePath(string $env, string $package, string $group)

Get the package path for an environment and group.

Parameters

string $env
string $package
string $group

Return Value

string

protected string getPath(string $namespace)

Get the configuration path for a namespace.

Parameters

string $namespace

Return Value

string

void addNamespace(string $namespace, string $hint)

Add a new namespace to the loader.

Parameters

string $namespace
string $hint

Return Value

void

array getNamespaces()

Returns all registered namespaces with the config loader.

Return Value

array

protected mixed getRequire(string $path)

Get a file's contents by requiring it.

Parameters

string $path

Return Value

mixed

Filesystem getFilesystem()

Get the Filesystem instance.

Return Value

Filesystem

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/Config/FileLoader.html