Overview

Namespaces

  • Charcoal
    • Config

Classes

  • Charcoal\Config\AbstractConfig
  • Charcoal\Config\AbstractEntity
  • Charcoal\Config\GenericConfig

Interfaces

  • Charcoal\Config\ConfigInterface
  • Charcoal\Config\ConfigurableInterface
  • Charcoal\Config\DelegatesAwareInterface
  • Charcoal\Config\EntityInterface
  • Charcoal\Config\FileAwareInterface
  • Charcoal\Config\SeparatorAwareInterface

Traits

  • Charcoal\Config\ConfigurableTrait
  • Charcoal\Config\DelegatesAwareTrait
  • Charcoal\Config\FileAwareTrait
  • Charcoal\Config\SeparatorAwareTrait
  • Overview
  • Namespace
  • Class
 1: <?php
 2: 
 3: namespace Charcoal\Config;
 4: 
 5: /**
 6:  * Describes an object that can read file contents.
 7:  *
 8:  * This interface can be fully implemented with its accompanying {@see FileAwareTrait}.
 9:  */
10: interface FileAwareInterface
11: {
12:     /**
13:      * Loads a configuration file.
14:      *
15:      * @param  string $path A path to a supported file.
16:      * @return array An array on success.
17:      */
18:     public function loadFile($path);
19: }
20: 
API documentation generated by ApiGen