Code generator is a PHP tool that provides an interface for generating code. Currently only PHP class generation is supported.
Require the package using composer composer require cwssrl/code-generator --dev. Code generator is usually intended to be installed only in dev environment. Installation in prod environment is not recommended.
<?phpuseCws\CodeGenerator\Model\ArgumentModel;
useCws\CodeGenerator\Model\ClassModel;
useCws\CodeGenerator\Model\ConstantModel;
useCws\CodeGenerator\Model\ClassNameModel;
useCws\CodeGenerator\Model\DocBlockModel;
useCws\CodeGenerator\Model\MethodModel;
useCws\CodeGenerator\Model\NamespaceModel;
useCws\CodeGenerator\Model\PropertyModel;
useCws\CodeGenerator\Model\UseTraitModel;
useCws\CodeGenerator\Model\UseClassModel;
useCws\CodeGenerator\Model\VirtualMethodModel;
useCws\CodeGenerator\Model\VirtualPropertyModel;
require'vendor/autoload.php';
$phpClass = newClassModel();
$phpClass->setNamespace(newNamespaceModel('NamespaceOfTheClass'));
$name = newClassNameModel('TestClass', 'BaseTestClass');
$name->addImplements('\\NamespaceOne\\InterfaceOne');
$phpClass->addUses(newUseClassModel('NamespaceTwo'));
$name->addImplements('InterfaceTwo');
$phpClass->setName($name);
$phpClass->addTrait(newUseTraitModel('TraitOne'));
$phpClass->addTrait(newUseTraitModel('TraitTwo'));
$phpClass->addConstant(newConstantModel('CONST_ONE', 'value'));
$phpClass->addConstant(newConstantModel('CONST_TWO', 1));
$phpClass->addProperty(newPropertyModel('propertyOne'));
$phpClass->addProperty(newPropertyModel('propertyTwo', 'protected'));
$privateProperty = newPropertyModel('propertyThree', 'private', 'defaultValue');
$privateProperty->setDocBlock(newDocBlockModel('@var string'));
$phpClass->addProperty($privateProperty);
$phpClass->addProperty(newVirtualPropertyModel('virtualPropertyOne', 'int'));
$phpClass->addProperty(newVirtualPropertyModel('virtualPropertyTwo', 'mixed'));
$phpClass->addMethod(newMethodModel('methodOne'));
$phpClass->addMethod(newMethodModel('methodTwo', 'protected'));
$privateMethod = newMethodModel('methodThree', 'private');
$privateMethod->addArgument(newArgumentModel('arg1'));
$privateMethod->addArgument(newArgumentModel('arg2', 'array', 'array()'));
$privateMethod->setBody('return \'result\';');
$privateMethod->setDocBlock(newDocBlockModel('@var mixed arg1', '@var array arg2', '@return string'));
$phpClass->addMethod($privateMethod);
$phpClass->addMethod(newVirtualMethodModel('virtualMethodOne'));
$virtualMethodTwo = newVirtualMethodModel('virtualMethodTwo', 'array');
$virtualMethodTwo->addArgument(newArgumentModel('arg1', 'array'));
$phpClass->addMethod($virtualMethodTwo);
echo$phpClass->render();Output
<?phpnamespaceNamespaceOfTheClass;
useNamespaceTwo;
/** * @property int $virtualPropertyOne * @property mixed $virtualPropertyTwo * @method void virtualMethodOne() * @method array virtualMethodTwo(array $arg1) */class TestClass extends BaseTestClass implements \NamespaceOne\InterfaceOne, InterfaceTwo
{
use TraitOne;
use TraitTwo;
constCONST_ONE = 'value';
constCONST_TWO = 1;
public$propertyOne;
protected$propertyTwo;
/** * @var string */private$propertyThree = 'defaultValue';
publicfunctionmethodOne()
{
}
protectedfunctionmethodTwo()
{
}
/** * @var mixed arg1 * @var array arg2 * @return string */privatefunctionmethodThree($arg1, array$arg2)
{
return'result';
}
}Please see CONTRIBUTING for details.
composer testPlease see CHANGELOG for more information what has changed recently.
This package is heavily based on Cws Code Generator that is a fork of the krlove/code-generator package
The MIT License (MIT). Please see License File for more information.