ClassGenerator Class Reference

Inheritance diagram for ClassGenerator:

Public Member Functions
	setClassDocBlock (array $docBlock)
	addMethods (array $methods)
	addMethodFromGenerator (MethodGenerator $method)
	addProperties (array $properties)
	addPropertyFromGenerator (PropertyGenerator $property)
	getNamespaceName ()
Public Member Functions inherited from CodeGeneratorInterface
	setName ($name)
	setExtendedClass ($extendedClass)
	setImplementedInterfaces (array $interfaces)
	addTrait ($trait)

Protected Member Functions
	_setDataToObject ($object, array $data, array $map)
	createMethodGenerator ()

Protected Attributes
	$_docBlockOptions
	$_propertyOptions
	$_methodOptions
	$_parameterOptions

Detailed Description

Definition at line 11 of file ClassGenerator.php.

Member Function Documentation

_setDataToObject()

_setDataToObject (   $object, array  $data, array  $map  )

protected

Parameters

object	$object
array	$data
array	$map

Returns

void

Definition at line 72 of file ClassGenerator.php.

    {
        foreach ($map as $arrayKey => $setterName) {
            if (isset($data[$arrayKey])) {
                $object->{$setterName}($data[$arrayKey]);
            }
        }
    }

addMethodFromGenerator()

addMethodFromGenerator

(

MethodGenerator

$method

)

Add method from MethodGenerator

Parameters

MethodGenerator

$method

Returns

$this

Exceptions

Definition at line 150 of file ClassGenerator.php.

    {
        if (!is_string($method->getName())) {
            throw new \InvalidArgumentException('addMethodFromGenerator() expects string for name');
        }

        return parent::addMethodFromGenerator($method);
    }

addMethods()

addMethods

(

array

$methods

)

addMethods()

Parameters

array

$methods

Returns

$this

Implements CodeGeneratorInterface.

Definition at line 102 of file ClassGenerator.php.

    {
        foreach ($methods as $methodOptions) {
            $methodObject = $this->createMethodGenerator();
            $this->_setDataToObject($methodObject, $methodOptions, $this->_methodOptions);

            if (isset(
                $methodOptions['parameters']
            ) && is_array(
                $methodOptions['parameters']
            ) && count(
                $methodOptions['parameters']
            ) > 0
            ) {
                $parametersArray = [];
                foreach ($methodOptions['parameters'] as $parameterOptions) {
                    $parameterObject = new \Zend\Code\Generator\ParameterGenerator();
                    $this->_setDataToObject($parameterObject, $parameterOptions, $this->_parameterOptions);
                    $parametersArray[] = $parameterObject;
                }

                $methodObject->setParameters($parametersArray);
            }

            if (isset($methodOptions['docblock']) && is_array($methodOptions['docblock'])) {
                $docBlockObject = new \Zend\Code\Generator\DocBlockGenerator();
                $docBlockObject->setWordWrap(false);
                $this->_setDataToObject($docBlockObject, $methodOptions['docblock'], $this->_docBlockOptions);

                $methodObject->setDocBlock($docBlockObject);
            }

            if (!empty($methodOptions['returnType'])) {
                $methodObject->setReturnType($methodOptions['returnType']);
            }

            $this->addMethodFromGenerator($methodObject);
        }
        return $this;
    }

addProperties()

addProperties

(

array

$properties

)

addProperties()

Parameters

array

$properties

Returns

$this

Exceptions

Implements CodeGeneratorInterface.

Definition at line 166 of file ClassGenerator.php.

    {
        foreach ($properties as $propertyOptions) {
            $propertyObject = new PropertyGenerator();
            $this->_setDataToObject($propertyObject, $propertyOptions, $this->_propertyOptions);

            if (isset($propertyOptions['docblock'])) {
                $docBlock = $propertyOptions['docblock'];
                if (is_array($docBlock)) {
                    $docBlockObject = new \Zend\Code\Generator\DocBlockGenerator();
                    $docBlockObject->setWordWrap(false);
                    $this->_setDataToObject($docBlockObject, $docBlock, $this->_docBlockOptions);
                    $propertyObject->setDocBlock($docBlockObject);
                }
            }

            $this->addPropertyFromGenerator($propertyObject);
        }

        return $this;
    }

addPropertyFromGenerator()

addPropertyFromGenerator

(

PropertyGenerator

$property

)

Add property from PropertyGenerator

Parameters

PropertyGenerator

$property

Returns

$this

Exceptions

Definition at line 195 of file ClassGenerator.php.

    {
        if (!is_string($property->getName())) {
            throw new \InvalidArgumentException('addPropertyFromGenerator() expects string for name');
        }

        return parent::addPropertyFromGenerator($property);
    }

createMethodGenerator()

createMethodGenerator ( )

protected

Instantiate method generator object.

Returns

MethodGenerator

Definition at line 209 of file ClassGenerator.php.

    {
        return new MethodGenerator();
    }

getNamespaceName()

getNamespaceName

(

)

Returns

string|null

Definition at line 217 of file ClassGenerator.php.

    {
        return ltrim(parent::getNamespaceName(), '\\') ?: null;
    }

setClassDocBlock()

setClassDocBlock

(

array

$docBlock

)

Set class dock block

Parameters

array

$docBlock

Returns

$this

Implements CodeGeneratorInterface.

Definition at line 87 of file ClassGenerator.php.

    {
        $docBlockObject = new \Zend\Code\Generator\DocBlockGenerator();
        $docBlockObject->setWordWrap(false);
        $this->_setDataToObject($docBlockObject, $docBlock, $this->_docBlockOptions);

        return parent::setDocBlock($docBlockObject);
    }

Field Documentation

$_docBlockOptions

$_docBlockOptions

protected

Initial value:

= [
        'shortDescription' => 'setShortDescription',
        'longDescription' => 'setLongDescription',
        'tags' => 'setTags',
    ]

Definition at line 19 of file ClassGenerator.php.

$_methodOptions

$_methodOptions

protected

Initial value:

= [
        'name' => 'setName',
        'final' => 'setFinal',
        'static' => 'setStatic',
        'abstract' => 'setAbstract',
        'visibility' => 'setVisibility',
        'body' => 'setBody',
        'returntype' => 'setReturnType'
    ]

Definition at line 43 of file ClassGenerator.php.

$_parameterOptions

$_parameterOptions

protected

Initial value:

= [
        'name' => 'setName',
        'type' => 'setType',
        'defaultValue' => 'setDefaultValue',
        'passedByReference' => 'setPassedByReference',
        'variadic' => 'setVariadic',
    ]

Definition at line 58 of file ClassGenerator.php.

$_propertyOptions

$_propertyOptions

protected

Initial value:

= [
        'name' => 'setName',
        'const' => 'setConst',
        'static' => 'setStatic',
        'visibility' => 'setVisibility',
        'defaultValue' => 'setDefaultValue',
    ]

Definition at line 30 of file ClassGenerator.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/Code/Generator/ClassGenerator.php