1. class
  2. Neos
  3. \
  4. Flow
  5. \
  6. Configuration
  7. \
  8. Source
  9. \
  10. YamlSource

YamlSource

class YamlSource (View source)

Configuration source based on YAML files

Properties

protected bool $usePhpYamlExtension

Will be set if the PHP YAML Extension is installed.

Methods

__construct()

No description

bool
has(string $pathAndFilename, bool $allowSplitSource = false)

Checks for the specified configuration file and returns true if it exists.

array
load(string $pathAndFilename, bool $allowSplitSource = false)

Loads the specified configuration file and returns its content as an array. If the file does not exist or could not be loaded, an empty array is returned

detectFilesWithWrongExtension(string $pathAndFilename, bool $allowSplitSource = false)

No description

array
mergeFileContent(string $pathAndFilename, array $configuration)

Loads the file with the given path and merge it's contents into the configuration array.

void
save(string $pathAndFilename, array $configuration)

Save the specified configuration array to the given file in YAML format.

string
getHeaderFromFile(string $pathAndFilename)

Read the header part from the given file. That means, every line until the first non comment line is found.

Details

at line 39
__construct()

No description

at line 53
bool has(string $pathAndFilename, bool $allowSplitSource = false)

Checks for the specified configuration file and returns true if it exists.

Parameters

string $pathAndFilename

Full path and filename of the file to load, excluding the file extension (ie. ".yaml")
bool $allowSplitSource

If true, the type will be used as a prefix when looking for configuration files

Return Value

bool

at line 83
array load(string $pathAndFilename, bool $allowSplitSource = false)

Loads the specified configuration file and returns its content as an array. If the file does not exist or could not be loaded, an empty array is returned

Parameters

string $pathAndFilename

Full path and filename of the file to load, excluding the file extension (ie. ".yaml")
bool $allowSplitSource

If true, the type will be used as a prefix when looking for configuration files

Return Value

array

Exceptions

ParseErrorException
Exception

at line 107
protected detectFilesWithWrongExtension(string $pathAndFilename, bool $allowSplitSource = false)

No description

Parameters

string $pathAndFilename
bool $allowSplitSource

Exceptions

Exception

at line 132
protected array mergeFileContent(string $pathAndFilename, array $configuration)

Loads the file with the given path and merge it's contents into the configuration array.

Parameters

string $pathAndFilename
array $configuration

Return Value

array

Exceptions

ParseErrorException

at line 171
void save(string $pathAndFilename, array $configuration)

Save the specified configuration array to the given file in YAML format.

Parameters

string $pathAndFilename

Full path and filename of the file to write to, excluding the dot and file extension (i.e. ".yaml")
array $configuration

The configuration to save

Return Value

void

at line 188
protected string getHeaderFromFile(string $pathAndFilename)

Read the header part from the given file. That means, every line until the first non comment line is found.

Parameters

string $pathAndFilename

Return Value

string

The header of the given YAML file