Overview

Namespaces

  • Charcoal
    • Config

Classes

  • AbstractConfig
  • AbstractEntity
  • GenericConfig

Interfaces

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

Traits

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

Interface ConfigInterface

Describes a configuration container / registry.

Charcoal\Config\ConfigInterface implements Charcoal\Config\DelegatesAwareInterface, Charcoal\Config\EntityInterface, Charcoal\Config\FileAwareInterface, Charcoal\Config\SeparatorAwareInterface

Direct known implementers

Charcoal\Config\AbstractConfig

Indirect known implementers

Charcoal\Config\GenericConfig
Namespace: Charcoal\Config
Located at Charcoal/Config/ConfigInterface.php
Methods summary
public array
# defaults( )

Gets the default data.

Gets the default data.

Pre-populates new configsets.

Returns

array
Key-value array of data
public Charcoal\Config\ConfigInterface
# merge( array|Traversable $data )

Adds new data, replacing / merging existing data with the same key.

Adds new data, replacing / merging existing data with the same key.

Parameters

$data
Key-value array of data to merge.

Returns

Charcoal\Config\ConfigInterface
Chainable
public Charcoal\Config\ConfigInterface
# addFile( string $path )

Add a configuration file to the configset.

Add a configuration file to the configset.

Parameters

$path
The file to load and add.

Returns

Charcoal\Config\ConfigInterface
Chainable
Methods inherited from Charcoal\Config\DelegatesAwareInterface
addDelegate(), prependDelegate(), setDelegates()
Methods inherited from Charcoal\Config\EntityInterface
data(), get(), has(), keys(), set(), setData()
Methods inherited from Serializable
serialize(), unserialize()
Methods inherited from JsonSerializable
jsonSerialize()
Methods inherited from ArrayAccess
offsetExists(), offsetGet(), offsetSet(), offsetUnset()
Methods inherited from Charcoal\Config\FileAwareInterface
loadFile()
Methods inherited from Charcoal\Config\SeparatorAwareInterface
setSeparator()
API documentation generated by ApiGen