Overview

Namespaces

  • Charcoal
    • Config

Classes

  • AbstractConfig
  • AbstractEntity
  • GenericConfig

Interfaces

  • ConfigInterface
  • ConfigurableInterface
  • DelegatesAwareInterface
  • EntityInterface
  • FileAwareInterface
  • SeparatorAwareInterface

Traits

  • ConfigurableTrait
  • DelegatesAwareTrait
  • FileAwareTrait
  • SeparatorAwareTrait
  • Overview
  • Namespace
  • Class

Trait FileAwareTrait

Provides an object with the ability to read file contents.

Supported file formats: INI, JSON, PHP, YAML*.

Note: YAML requires the Symfony YAML component.

This is a full implementation of Charcoal\Config\FileAwareInterface.

Direct Known Users

Charcoal\Config\AbstractConfig

Indirect Known Users

Charcoal\Config\GenericConfig
Namespace: Charcoal\Config
Located at Charcoal/Config/FileAwareTrait.php
Methods summary
public array
# loadFile( string $path )

Loads a configuration file.

Loads a configuration file.

Parameters

$path
A path to a supported file.

Returns

array
An array on success.

Throws

InvalidArgumentException
If the path is invalid.

Used by

Charcoal\Config\AbstractConfig::addFile()
API documentation generated by ApiGen