gnu-social/vendor/zendframework/zend-config/doc/book/factory.md
2021-07-16 19:44:40 +01:00

1.8 KiB

The Factory

Zend\Config\Factory provides the ability to load configuration files to an array or to a Zend\Config\Config object. The factory has two purposes

  • Loading configuration file(s)
  • Storing a configuration file

Storage writes to a single file

Storing the configuration always writes to a single file. The factory is not aware of merged configuration files, and as such cannot split configuration to multiple files. If you want to store particular configuration sections to separate files, you should separate them manually.

Loading configuration files

The first example illustrates loading a single configuration file:

// Load a PHP file as array:
$config = Zend\Config\Factory::fromFile(__DIR__ . '/config/my.config.php');

// Load an XML file as Config object; the second parameter, when true,
// casts the configuration to a Config instance:
$config = Zend\Config\Factory::fromFile(__DIR__.'/config/my.config.xml', true);

The next example demonstrates merging multiple files; note that they are in separate formats!

$config = Zend\Config\Factory::fromFiles([
    __DIR__.'/config/my.config.php',
    __DIR__.'/config/my.config.xml',
]);

Storing configuration

Sometimes you may want to write configuration to a file. To do this, use the factory's toFile() method:

$config = new Zend\Config\Config([], true);
$config->settings = [];
$config->settings->myname = 'framework';
$config->settings->date   = '2012-12-12 12:12:12';

//Store the configuration
Zend\Config\Factory::toFile(__DIR__ . '/config/my.config.php', $config);

//Store an array
$config = [
    'settings' => [
        'myname' => 'framework',
        'data'   => '2012-12-12 12:12:12',
    ],
];

Zend\Config\Factory::toFile(__DIR__ . '/config/my.config.php', $config);