PHP Class Dotenv\Loader

Loads Variables by reading a file from disk and: - stripping comments beginning with a # - parsing lines that look shell variable setters, e.g export key = value, key="value"
Afficher le fichier Open project: vlucas/phpdotenv Class Usage Examples

Protected Properties

Свойство Type Description
$filePath string The file path.
$immutable boolean Are we immutable?

Méthodes publiques

Méthode Description
__construct ( string $filePath, boolean $immutable = false ) : void Create a new loader instance.
clearEnvironmentVariable ( string $name ) : void Clear an environment variable.
getEnvironmentVariable ( string $name ) : string | null Search the different places for environment variables and return first value found.
load ( ) : array Load .env file in given directory.
processFilters ( string $name, string $value ) : array Process the runtime filters.
setEnvironmentVariable ( string $name, string | null $value = null ) : void Set an environment variable.

Méthodes protégées

Méthode Description
beginsWithAQuote ( string $value ) : boolean Determine if the given string begins with a quote.
ensureFileIsReadable ( ) : void Ensures the given filePath is readable.
isComment ( string $line ) : boolean Determine if the line in the file is a comment, e.g. begins with a #.
looksLikeSetter ( string $line ) : boolean Determine if the given line looks like it's setting a variable.
normaliseEnvironmentVariable ( string $name, string $value ) : array Normalise the given environment variable.
readLinesFromFile ( string $filePath ) : array Read lines from the file, auto detecting line endings.
resolveNestedVariables ( string $value ) : mixed Resolve the nested variables.
sanitiseVariableName ( string $name, string $value ) : array Strips quotes and the optional leading "export " from the environment variable name.
sanitiseVariableValue ( string $name, string $value ) : array Strips quotes from the environment variable value.
splitCompoundStringIntoParts ( string $name, string $value ) : array Split the compound string into parts.

Method Details

__construct() public méthode

Create a new loader instance.
public __construct ( string $filePath, boolean $immutable = false ) : void
$filePath string
$immutable boolean
Résultat void

beginsWithAQuote() protected méthode

Determine if the given string begins with a quote.
protected beginsWithAQuote ( string $value ) : boolean
$value string
Résultat boolean

clearEnvironmentVariable() public méthode

This is not (currently) used by Dotenv but is provided as a utility method for 3rd party code. This is done using: - putenv, - unset($_ENV, $_SERVER).
See also: setEnvironmentVariable()
public clearEnvironmentVariable ( string $name ) : void
$name string
Résultat void

ensureFileIsReadable() protected méthode

Ensures the given filePath is readable.
protected ensureFileIsReadable ( ) : void
Résultat void

getEnvironmentVariable() public méthode

Search the different places for environment variables and return first value found.
public getEnvironmentVariable ( string $name ) : string | null
$name string
Résultat string | null

isComment() protected méthode

Determine if the line in the file is a comment, e.g. begins with a #.
protected isComment ( string $line ) : boolean
$line string
Résultat boolean

load() public méthode

Load .env file in given directory.
public load ( ) : array
Résultat array

looksLikeSetter() protected méthode

Determine if the given line looks like it's setting a variable.
protected looksLikeSetter ( string $line ) : boolean
$line string
Résultat boolean

normaliseEnvironmentVariable() protected méthode

Takes value as passed in by developer and: - ensures we're dealing with a separate name and value, breaking apart the name string if needed, - cleaning the value of quotes, - cleaning the name of quotes, - resolving nested variables.
protected normaliseEnvironmentVariable ( string $name, string $value ) : array
$name string
$value string
Résultat array

processFilters() public méthode

Called from the VariableFactory, passed as a callback in $this->loadFromFile().
public processFilters ( string $name, string $value ) : array
$name string
$value string
Résultat array

readLinesFromFile() protected méthode

Read lines from the file, auto detecting line endings.
protected readLinesFromFile ( string $filePath ) : array
$filePath string
Résultat array

resolveNestedVariables() protected méthode

Look for {$varname} patterns in the variable value and replace with an existing environment variable.
protected resolveNestedVariables ( string $value ) : mixed
$value string
Résultat mixed

sanitiseVariableName() protected méthode

Strips quotes and the optional leading "export " from the environment variable name.
protected sanitiseVariableName ( string $name, string $value ) : array
$name string
$value string
Résultat array

sanitiseVariableValue() protected méthode

Strips quotes from the environment variable value.
protected sanitiseVariableValue ( string $name, string $value ) : array
$name string
$value string
Résultat array

setEnvironmentVariable() public méthode

This is done using: - putenv, - $_ENV, - $_SERVER. The environment variable value is stripped of single and double quotes.
public setEnvironmentVariable ( string $name, string | null $value = null ) : void
$name string
$value string | null
Résultat void

splitCompoundStringIntoParts() protected méthode

If the $name contains an = sign, then we split it into 2 parts, a name & value disregarding the $value passed in.
protected splitCompoundStringIntoParts ( string $name, string $value ) : array
$name string
$value string
Résultat array

Property Details

$filePath protected_oe property

The file path.
protected string $filePath
Résultat string

$immutable protected_oe property

Are we immutable?
protected bool $immutable
Résultat boolean