README

The Effectra\Generator package provides a set of tools for generating PHP class files and configuration files.

Installation

You can install the package via Composer:

composer require effectra/generator

Usage

Generate Class

To generate a PHP class file using the GeneratorClass class, follow these steps:

Create an instance of the Creator class:

$creator = new Creator();

Create an instance of the GeneratorClass class, providing the creator and the desired class name:

$generator = new GeneratorClass($creator, 'MyClass');

Customize the class by adding properties, methods, and other elements using the available methods provided by the GeneratorClass and Creator classes.
Generate the PHP code for the class:

$template = $generator->generate();

Save the generated code to a file:

$template->save('/path/to/MyClass.php');

Generate Config File

To generate a configuration file using the GeneratorConfigFile class, follow these steps:

Create an instance of the Creator class:

$creator = new Creator();

Create an instance of the GeneratorConfigFile class, providing the creator and the ConfigFile instance:

$configFile = new ConfigFile('/path/to/config.php');
$generator = new GeneratorConfigFile($creator, $configFile);

Generate a new section in the configuration file:

$section = 'database';
$config = [
    'driver' => 'mysql',
    'host' => 'localhost',
    'database' => 'mydatabase',
    'username' => 'myusername',
    'password' => 'mypassword',
];

$template = $generator->createSection($section, $config);

Save the updated configuration file:

$template->save('/path/to/config.php');

Contributing

Contributions are welcome! If you find any issues or would like to suggest new features, please open an issue on the GitHub repository.

License

This package is open-source software licensed under the MIT license.

effectra / generator

Maintainers

Details