AloFramework Config 1.1 API
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Namespaces

  • AloFramework
    • Config
  • PHP

Classes

  • AbstractConfig

Interfaces

  • Configurable

Traits

  • ConfigurableTrait

Class AbstractConfig

The abstract configuration class

AloFramework\Config\AbstractConfig implements ArrayAccess, JsonSerializable, Serializable
Abstract
Namespace: AloFramework\Config
Author: Art a.molcanovas@gmail.com
Since: 1.1 Implements JsonSerializable, Serializable
Located at AbstractConfig.php

Methods summary

public
# __construct( array $defaults = [], array $custom = [] )

Constructor

Constructor

Parameters

$defaults
The default configuration
$custom
The custom/user-supplied configuration

Author

Art a.molcanovas@gmail.com
public string
# serialize( )

Serializes the object

Serializes the object

Returns

string

Author

Art a.molcanovas@gmail.com

Since

1.1

Implementation of

Serializable::serialize()
public
# unserialize( string $serialized )

Unserializes the object

Unserializes the object

Parameters

$serialized
The serialised string

Author

Art a.molcanovas@gmail.com

Since

1.1

Implementation of

Serializable::unserialize()
public array
# jsonSerialize( )

Returns a json-encodable version of the object

Returns a json-encodable version of the object

Returns

array

Author

Art a.molcanovas@gmail.com

Since

1.1

Implementation of

JsonSerializable::jsonSerialize()
public array
# getDefaultConfig( )

Returns default configuration

Returns default configuration

Returns

array
public array
# getCustomConfig( )

Returns custom-set configuration

Returns custom-set configuration

Returns

array

Author

Art a.molcanovas@gmail.com
public AloFramework\Config\AbstractConfig
# set( string $k, mixed $v )

Sets a configuration key

Sets a configuration key

Parameters

$k
The config key
$v
The config value

Returns

AloFramework\Config\AbstractConfig

Author

Art a.molcanovas@gmail.com

Used by

AloFramework\Config\AbstractConfig::__set()
public AloFramework\Config\AbstractConfig
# __set( string $k, mixed $v )

Sets a configuration key

Sets a configuration key

Parameters

$k
The config key
$v
The config value

Returns

AloFramework\Config\AbstractConfig

Author

Art a.molcanovas@gmail.com

Uses

AloFramework\Config\AbstractConfig::set()
public mixed
# get( string $k )

Returns a configuration item or NULL if it's not set

Returns a configuration item or NULL if it's not set

Parameters

$k
The configuration item key

Returns

mixed

Author

Art a.molcanovas@gmail.com

Used by

AloFramework\Config\AbstractConfig::__get()
public mixed
# __get( string $k )

Returns a configuration item or NULL if it's not set

Returns a configuration item or NULL if it's not set

Parameters

$k
The configuration item key

Returns

mixed

Author

Art a.molcanovas@gmail.com

Uses

AloFramework\Config\AbstractConfig::get()
public array
# getAll( )

Returns all the config items

Returns all the config items

Returns

array

Author

Art a.molcanovas@gmail.com
public boolean
# remove( string $k )

Removes a custom configuration item

Removes a custom configuration item

Parameters

$k
The custom configuration item key

Returns

boolean
TRUE if the key was present, false if it wasn't

Author

Art a.molcanovas@gmail.com
public string
# __toString( )

Returns a string representation of the config

Returns a string representation of the config

Returns

string

Author

Art a.molcanovas@gmail.com
public
# offsetSet( string|integer|null $offset, mixed $value )

Sets a custom config item

Sets a custom config item

Parameters

$offset
The config item key
$value
The config item value

Author

Art a.molcanovas@gmail.com

Implementation of

ArrayAccess::offsetSet()
public boolean
# offsetExists( mixed $offset )

Checks if a merged config item exists

Checks if a merged config item exists

Parameters

$offset
Config item key

Returns

boolean

Author

Art a.molcanovas@gmail.com

Implementation of

ArrayAccess::offsetExists()
public
# offsetUnset( string|integer $offset )

Removes a custom config item key

Removes a custom config item key

Parameters

$offset
The config item key

Author

Art a.molcanovas@gmail.com

Implementation of

ArrayAccess::offsetUnset()
public mixed
# offsetGet( string|integer $offset )

Returns a merged config item

Returns a merged config item

Parameters

$offset
The config item key

Returns

mixed

Author

Art a.molcanovas@gmail.com

Implementation of

ArrayAccess::offsetGet()
AloFramework Config 1.1 API API documentation generated by ApiGen