Overview

Namespaces

  • Charcoal
    • Config

Classes

  • AbstractConfig
  • AbstractEntity
  • GenericConfig

Interfaces

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

Traits

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

Interface ConfigurableInterface

Describes an object that can be configured with an instance of Charcoal\Config\ConfigInterface.

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

Namespace: Charcoal\Config
Located at Charcoal/Config/ConfigurableInterface.php
Methods summary
public Charcoal\Config\ConfigurableInterface
# setConfig( mixed $config )

Sets the object's configuration container.

Sets the object's configuration container.

Parameters

$config
The Config object or dataset.

Returns

Charcoal\Config\ConfigurableInterface
Chainable
public mixed
# config( string|null $key = null )

Gets the object's configuration container or a specific key from the container.

Gets the object's configuration container or a specific key from the container.

Parameters

$key
If provided, the data key to retrieve.

Returns

mixed

If $key is NULL, the Config object is returned. If $key is given, its value on the Config object is returned.

API documentation generated by ApiGen