---
title: "Phalcon Config"
version: "5.20"
---
> Documentation Index
> Fetch the complete documentation index at: https://docs.phalcon.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Phalcon Config
:::info[NOTE]
All classes are prefixed with `Phalcon`
:::
## Config\Adapter\Grouped
Class
Reads multiple files (or arrays) and merges them all together.
See `Phalcon\Config\ConfigFactory::load` To load Config Adapter class using 'adapter' option.
```php
use Phalcon\Config\Adapter\Grouped;
$config = new Grouped(
[
"path/to/config.php",
"path/to/config.dist.php",
]
);
```
```php
use Phalcon\Config\Adapter\Grouped;
$config = new Grouped(
[
"path/to/config.json",
"path/to/config.dist.json",
],
"json"
);
```
```php
use Phalcon\Config\Adapter\Grouped;
$config = new Grouped(
[
[
"filePath" => "path/to/config.php",
"adapter" => "php",
],
[
"filePath" => "path/to/config.json",
"adapter" => "json",
],
[
"adapter" => "array",
"config" => [
"property" => "value",
],
],
],
);
```
- [`Phalcon\Support\Collection`](/5.20/api/phalcon_support/#supportcollection)
- [`Phalcon\Config\Config`](#configconfig)
- **`Phalcon\Config\Adapter\Grouped`**
`Phalcon\Config\Config` · `Phalcon\Config\ConfigFactory` · `Phalcon\Config\ConfigInterface` · `Phalcon\Config\Exception` · `Phalcon\Config\Exceptions\GroupedAdapterRequiresArray` · `Phalcon\Factory\Exception`
### Method Summary
Phalcon\Config\Adapter\Grouped constructor
### Methods
__construct()
```php
public function __construct(
array $arrayConfig,
string $defaultAdapter = "php",
ConfigFactory|null $factory = null
);
```
Phalcon\Config\Adapter\Grouped constructor
## Config\Adapter\Ini
Class
Reads ini files and converts them to Phalcon\Config\Config objects.
Given the next configuration file:
```ini
[database]
adapter = Mysql
host = localhost
username = scott
password = cheetah
dbname = test_db
[phalcon]
controllersDir = "../app/controllers/"
modelsDir = "../app/models/"
viewsDir = "../app/views/"
```
You can read it as follows:
```php
use Phalcon\Config\Adapter\Ini;
$config = new Ini("path/config.ini");
echo $config->phalcon->controllersDir;
echo $config->database->username;
```
PHP constants may also be parsed in the ini file, so if you define a constant
as an ini value before calling the constructor, the constant's value will be
integrated into the results. To use it this way you must specify the optional
second parameter as `INI_SCANNER_NORMAL` when calling the constructor:
```php
$config = new \Phalcon\Config\Adapter\Ini(
"path/config-with-constants.ini",
INI_SCANNER_NORMAL
);
```
- [`Phalcon\Support\Collection`](/5.20/api/phalcon_support/#supportcollection)
- [`Phalcon\Config\Config`](#configconfig)
- **`Phalcon\Config\Adapter\Ini`**
`Phalcon\Config\Config` · `Phalcon\Config\Exception` · `Phalcon\Config\Exceptions\CannotLoadConfigFile` · `Phalcon\Traits\Php\IniTrait`
### Method Summary
Ini constructor.
We have to cast values manually because parse_ini_file() has a poor
Build multidimensional array from string
### Methods
__construct()
```php
public function __construct(
string $filePath,
int $mode = 1
);
```
Ini constructor.
cast()
```php
protected function cast( mixed $ini ): mixed;
```
We have to cast values manually because parse_ini_file() has a poor
implementation.
Note: this casting is an ini-format compensation and is deliberately
specific to this adapter. Ini files carry untyped strings, so
`on/yes/true`, `off/no/false`, `null` and numeric strings are decoded
here. The json, yaml and php adapters receive natively typed values
from their parsers and perform no casting.
castArray()
```php
protected function castArray( array $ini ): array;
```
parseIniString()
```php
protected function parseIniString(
string $path,
mixed $value
): array;
```
Build multidimensional array from string
## Config\Adapter\Json
Class
Reads JSON files and converts them to Phalcon\Config\Config objects.
Given the following configuration file:
```json
{"phalcon":{"baseuri":"\/phalcon\/"},"models":{"metadata":"memory"}}
```
You can read it as follows:
```php
use Phalcon\Config\Adapter\Json;
$config = new Json("path/config.json");
echo $config->phalcon->baseuri;
echo $config->models->metadata;
```
- [`Phalcon\Support\Collection`](/5.20/api/phalcon_support/#supportcollection)
- [`Phalcon\Config\Config`](#configconfig)
- **`Phalcon\Config\Adapter\Json`**
`Phalcon\Config\Config` · `Phalcon\Config\Exceptions\CannotLoadConfigFile` · `Phalcon\Support\Helper\Json\Decode` · `Phalcon\Traits\Php\FileTrait`
### Method Summary
Phalcon\Config\Adapter\Json constructor
### Methods
__construct()
```php
public function __construct( string $filePath );
```
Phalcon\Config\Adapter\Json constructor
## Config\Adapter\Php
Class
Reads php files and converts them to Phalcon\Config\Config objects.
Given the next configuration file:
```php
[
"adapter" => "Mysql",
"host" => "localhost",
"username" => "scott",
"password" => "cheetah",
"dbname" => "test_db",
],
"phalcon" => [
"controllersDir" => "../app/controllers/",
"modelsDir" => "../app/models/",
"viewsDir" => "../app/views/",
],
];
```
You can read it as follows:
```php
use Phalcon\Config\Adapter\Php;
$config = new Php("path/config.php");
echo $config->phalcon->controllersDir;
echo $config->database->username;
```
- [`Phalcon\Support\Collection`](/5.20/api/phalcon_support/#supportcollection)
- [`Phalcon\Config\Config`](#configconfig)
- **`Phalcon\Config\Adapter\Php`**
`Phalcon\Config\Config` · `Phalcon\Config\Exceptions\CannotLoadConfigFile`
### Method Summary
Phalcon\Config\Adapter\Php constructor
### Methods
__construct()
```php
public function __construct( string $filePath );
```
Phalcon\Config\Adapter\Php constructor
## Config\Adapter\Yaml
Class
Reads YAML files and converts them to Phalcon\Config\Config objects.
Given the following configuration file:
```yaml
phalcon:
baseuri: /phalcon/
controllersDir: !approot /app/controllers/
models:
metadata: memory
```
You can read it as follows:
```php
define(
"APPROOT",
dirname(__DIR__)
);
use Phalcon\Config\Adapter\Yaml;
$config = new Yaml(
"path/config.yaml",
[
"!approot" => function($value) {
return APPROOT . $value;
},
]
);
echo $config->phalcon->controllersDir;
echo $config->phalcon->baseuri;
echo $config->models->metadata;
```
- [`Phalcon\Support\Collection`](/5.20/api/phalcon_support/#supportcollection)
- [`Phalcon\Config\Config`](#configconfig)
- **`Phalcon\Config\Adapter\Yaml`**
`Phalcon\Config\Config` · `Phalcon\Config\Exception` · `Phalcon\Config\Exceptions\CannotLoadConfigFile` · `Phalcon\Config\Exceptions\MissingYamlExtension` · `Phalcon\Traits\Php\InfoTrait` · `Phalcon\Traits\Php\YamlTrait`
### Method Summary
Phalcon\Config\Adapter\Yaml constructor
### Methods
__construct()
```php
public function __construct(
string $filePath,
array|null $callbacks = null
);
```
Phalcon\Config\Adapter\Yaml constructor
## Config\Config
Class
`Phalcon\Config` is designed to simplify the access to, and the use of,
configuration data within applications. It provides a nested object property
based user interface for accessing this configuration data within application
code.
```php
$config = new \Phalcon\Config\Config(
[
"database" => [
"adapter" => "Mysql",
"host" => "localhost",
"username" => "scott",
"password" => "cheetah",
"dbname" => "test_db",
],
"phalcon" => [
"controllersDir" => "../app/controllers/",
"modelsDir" => "../app/models/",
"viewsDir" => "../app/views/",
],
]
);
```
- [`Phalcon\Support\Collection`](/5.20/api/phalcon_support/#supportcollection)
- **`Phalcon\Config\Config`** - implements [`Phalcon\Config\ConfigInterface`](#configconfiginterface)
- [`Phalcon\Config\Adapter\Grouped`](#configadaptergrouped)
- [`Phalcon\Config\Adapter\Ini`](#configadapterini)
- [`Phalcon\Config\Adapter\Json`](#configadapterjson)
- [`Phalcon\Config\Adapter\Php`](#configadapterphp)
- [`Phalcon\Config\Adapter\Yaml`](#configadapteryaml)
`Phalcon\Config\Exceptions\InvalidMergeData` · `Phalcon\Support\Collection`
### Method Summary
Gets the default path delimiter
Merges a configuration into the current one
Returns a value from current config using a dot separated path.
Sets the default path delimiter
Converts recursively the object to an array
Builds a new collection with the given data, carrying over the
Performs a merge recursively
Sets the collection data
### Constants
### Properties
### Methods
getPathDelimiter()
```php
public function getPathDelimiter(): string;
```
Gets the default path delimiter
merge()
```php
public function merge( mixed $toMerge ): ConfigInterface;
```
Merges a configuration into the current one
```php
$appConfig = new \Phalcon\Config\Config(
[
"database" => [
"host" => "localhost",
],
]
);
$globalConfig->merge($appConfig);
```
path()
```php
public function path(
string $path,
mixed $defaultValue = null,
string|null $delimiter = null
): mixed;
```
Returns a value from current config using a dot separated path.
```php
echo $config->path("unknown.path", "default", ".");
```
setPathDelimiter()
```php
public function setPathDelimiter( string|null $delimiter = null ): ConfigInterface;
```
Sets the default path delimiter
toArray()
```php
public function toArray(): array;
```
Converts recursively the object to an array
```php
print_r(
$config->toArray()
);
```
cloneEmpty()
```php
protected function cloneEmpty( array $data = [] ): static;
```
Builds a new collection with the given data, carrying over the
configuration of the current one. Clone-based instead of
constructor-based: adapter subclasses (Ini, Json, Php, Yaml, Grouped)
define file-loading constructors that are incompatible with the
parent's `(array data, ...)` signature, so `filter()`, `map()`,
`sort()` and `where()` would otherwise fail on any adapter instance.
internalMerge()
```php
final protected function internalMerge(
array $source,
array $target
): array;
```
Performs a merge recursively
setData()
```php
protected function setData(
mixed $element,
mixed $value
): void;
```
Sets the collection data
Array values become nested Config objects carrying the `insensitive`,
`strictNull` and `type` flags of this instance. The `type` guard is
applied to leaf values only - arrays are not validated themselves;
the nested Config validates its own leaves.
## Config\ConfigFactory
Class
Loads Config Adapter class using 'adapter' option, if no extension is
provided it will be added to filePath
```php
use Phalcon\Config\ConfigFactory;
$options = [
"filePath" => "path/config",
"adapter" => "php",
];
$config = (new ConfigFactory())->load($options);
```
- [`Phalcon\Factory\AbstractConfigFactory`](/5.20/api/phalcon_factory/#factoryabstractconfigfactory)
- [`Phalcon\Factory\AbstractFactory`](/5.20/api/phalcon_factory/#factoryabstractfactory)
- **`Phalcon\Config\ConfigFactory`**
`Phalcon\Config\Adapter\Grouped` · `Phalcon\Config\Adapter\Ini` · `Phalcon\Config\Adapter\Json` · `Phalcon\Config\Adapter\Php` · `Phalcon\Config\Adapter\Yaml` · `Phalcon\Config\Config` · `Phalcon\Config\ConfigInterface` · `Phalcon\Config\Exceptions\ConfigNotArrayOrObject` · `Phalcon\Config\Exceptions\MissingConfigOption` · `Phalcon\Config\Exceptions\MissingFileExtension` · `Phalcon\Factory\AbstractFactory`
### Method Summary
ConfigFactory constructor.
Load a config to create a new instance
Returns a new Config instance
Adapter name aliases resolved by `load()` (file extensions that map
Adapters accepting an extra constructor argument, with the config
Returns the available adapters
### Methods
__construct()
```php
public function __construct( array $services = [] );
```
ConfigFactory constructor.
load()
```php
public function load( mixed $config ): ConfigInterface;
```
Load a config to create a new instance
newInstance()
```php
public function newInstance(
string $name,
string $fileName,
mixed $params = null
): ConfigInterface;
```
Returns a new Config instance
getAdapterAliases()
```php
protected function getAdapterAliases(): array;
```
Adapter name aliases resolved by `load()` (file extensions that map
to a registered adapter)
getExceptionClass()
```php
protected function getExceptionClass(): string;
```
```php
protected function getExtraArguments(): array;
```
Adapters accepting an extra constructor argument, with the config
option carrying it and its default value. Single source for the
parameter-forwarding knowledge used by `load()` and `newInstance()`.
getServices()
```php
protected function getServices(): array;
```
Returns the available adapters
parseConfig()
```php
protected function parseConfig( mixed $config ): array;
```
## Config\ConfigInterface
Interface
Phalcon\Config\ConfigInterface
Interface for Phalcon\Config\Config class
- `\ArrayAccess`
- [`Phalcon\Contracts\Support\Collection`](/5.20/api/phalcon_contracts/#contractssupportcollection)
- [`Phalcon\Support\Collection\CollectionInterface`](/5.20/api/phalcon_support/#supportcollectioncollectioninterface)
- **`Phalcon\Config\ConfigInterface`**
`Phalcon\Support\Collection\CollectionInterface`
### Method Summary
### Methods
getPathDelimiter()
```php
public function getPathDelimiter(): string;
```
merge()
```php
public function merge( mixed $toMerge ): ConfigInterface;
```
path()
```php
public function path(
string $path,
mixed $defaultValue = null,
string|null $delimiter = null
): mixed;
```
setPathDelimiter()
```php
public function setPathDelimiter( string|null $delimiter = null ): ConfigInterface;
```
## Config\Exception
Class
Exceptions thrown in Phalcon\Config will use this class
- `\Exception`
- **`Phalcon\Config\Exception`**
- [`Phalcon\Config\Exceptions\CannotLoadConfigFile`](#configexceptionscannotloadconfigfile)
- [`Phalcon\Config\Exceptions\ConfigNotArrayOrObject`](#configexceptionsconfignotarrayorobject)
- [`Phalcon\Config\Exceptions\GroupedAdapterRequiresArray`](#configexceptionsgroupedadapterrequiresarray)
- [`Phalcon\Config\Exceptions\InvalidMergeData`](#configexceptionsinvalidmergedata)
- [`Phalcon\Config\Exceptions\MissingConfigOption`](#configexceptionsmissingconfigoption)
- [`Phalcon\Config\Exceptions\MissingFileExtension`](#configexceptionsmissingfileextension)
- [`Phalcon\Config\Exceptions\MissingYamlExtension`](#configexceptionsmissingyamlextension)
## Config\Exceptions\CannotLoadConfigFile
Class
- `\Exception`
- [`Phalcon\Config\Exception`](#configexception)
- **`Phalcon\Config\Exceptions\CannotLoadConfigFile`**
`Phalcon\Config\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct( string $fileName );
```
getFileName()
```php
public function getFileName(): string;
```
## Config\Exceptions\ConfigNotArrayOrObject
Class
- `\Exception`
- [`Phalcon\Config\Exception`](#configexception)
- **`Phalcon\Config\Exceptions\ConfigNotArrayOrObject`**
`Phalcon\Config\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct();
```
## Config\Exceptions\GroupedAdapterRequiresArray
Class
- `\Exception`
- [`Phalcon\Config\Exception`](#configexception)
- **`Phalcon\Config\Exceptions\GroupedAdapterRequiresArray`**
`Phalcon\Config\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct();
```
## Config\Exceptions\InvalidMergeData
Class
- `\Exception`
- [`Phalcon\Config\Exception`](#configexception)
- **`Phalcon\Config\Exceptions\InvalidMergeData`**
`Phalcon\Config\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct();
```
## Config\Exceptions\MissingConfigOption
Class
- `\Exception`
- [`Phalcon\Config\Exception`](#configexception)
- **`Phalcon\Config\Exceptions\MissingConfigOption`**
`Phalcon\Config\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct( string $option );
```
getOption()
```php
public function getOption(): string;
```
## Config\Exceptions\MissingFileExtension
Class
- `\Exception`
- [`Phalcon\Config\Exception`](#configexception)
- **`Phalcon\Config\Exceptions\MissingFileExtension`**
`Phalcon\Config\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct();
```
## Config\Exceptions\MissingYamlExtension
Class
- `\Exception`
- [`Phalcon\Config\Exception`](#configexception)
- **`Phalcon\Config\Exceptions\MissingYamlExtension`**
`Phalcon\Config\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct();
```
Source: https://docs.phalcon.io/5.20/api/phalcon_config/index.mdx