Overview

Namespaces

  • Charcoal
    • Config

Classes

  • AbstractConfig
  • AbstractEntity
  • GenericConfig

Interfaces

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

Traits

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

Interface FileAwareInterface

Describes an object that can read file contents.

This interface can be fully implemented with its accompanying Charcoal\Config\FileAwareTrait.

Direct known implementers

Charcoal\Config\ConfigInterface

Indirect known implementers

Charcoal\Config\AbstractConfig, Charcoal\Config\GenericConfig
Namespace: Charcoal\Config
Located at Charcoal/Config/FileAwareInterface.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.
API documentation generated by ApiGen