Documentation / NEON

Readers for NEON input.

⚠️ NEON readers require nette/neon to be installed

The NeonReader

$reader = new NeonReader();

// Read from Neon string
$configuration = $reader->createConfiguration('a: 1');

Constructor options

public function __construct(
    string $class = Configuration::class,
);

• class - An instance of any class implementing ConfigurationInterface to be returned (default Configuration).

createConfiguration options

public function createConfiguration(
    string $neon = '{}',
): ConfigurationInterface;

• neon - NEON string to parse.

The NeonFileReader

$reader = new NeonFileReader();

// Read from file
$configuration = $reader->createConfiguration(path: 'path/to/file.neon');

Constructor options

public function __construct(
    string $class = Configuration::class,
    string $prefix = '',
    bool $optional = false,
);

• class - An instance of any class implementing ConfigurationInterface to be returned (default Configuration).
• prefix - File path prefix.
• optional - If true, reader will return empty configuration if file is missing.

createConfiguration options

public function createConfiguration(
    string $path = 'config.neon',
): ConfigurationInterface;

• path - File to be read.