<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/

namespace Magento\Framework\Code\Generator;

use Laminas\Code\Generator\MethodGenerator;
use Laminas\Code\Generator\PropertyGenerator;

/**
* Class code generator
*/
class ClassGenerator extends \Laminas\Code\Generator\ClassGenerator implements
CodeGeneratorInterface
{
/**
* Possible doc block options
*
* @var array
*/
protected $_docBlockOptions = [
'shortDescription' => 'setShortDescription',
'longDescription' => 'setLongDescription',
'tags' => 'setTags',
];

/**
* Possible class property options
*
* @var array
*/
protected $_propertyOptions = [
'name' => 'setName',
'const' => 'setConst',
'static' => 'setStatic',
'visibility' => 'setVisibility',
'defaultValue' => 'setDefaultValue',
];

/**
* Possible class method options
*
* @var array
*/
protected $_methodOptions = [
'name' => 'setName',
'final' => 'setFinal',
'static' => 'setStatic',
'abstract' => 'setAbstract',
'visibility' => 'setVisibility',
'body' => 'setBody',
'returntype' => 'setReturnType'
];

/**
* Possible method parameter options
*
* @var array
*/
protected $_parameterOptions = [
'name' => 'setName',
'type' => 'setType',
'defaultValue' => 'setDefaultValue',
'passedByReference' => 'setPassedByReference',
'variadic' => 'setVariadic',
];

/**
* Set data to object
*
* @param object $object
* @param array $data
* @param array $map
* @return void
*/
protected function _setDataToObject($object, array $data, array $map)
{
foreach ($map as $arrayKey => $setterName) {
if (isset($data[$arrayKey])) {
$object->{$setterName}($data[$arrayKey]);
}
}
}

/**
* Set class dock block
*
* @param array $docBlock
* @return $this
*/
public function setClassDocBlock(array $docBlock)
{
$docBlockObject = new \Laminas\Code\Generator\DocBlockGenerator();
$docBlockObject->setWordWrap(false);
$this->_setDataToObject($docBlockObject, $docBlock, $this->_docBlockOptions);

return parent::setDocBlock($docBlockObject);
}

/**
* Add methods
*
* @param array $methods
* @return $this
*/
public function addMethods(array $methods)
{
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 \Laminas\Code\Generator\ParameterGenerator();
$this->_setDataToObject($parameterObject, $parameterOptions, $this->_parameterOptions);
$parametersArray[] = $parameterObject;
}

$methodObject->setParameters($parametersArray);
}

if (isset($methodOptions['docblock']) && is_array($methodOptions['docblock'])) {
$docBlockObject = new \Laminas\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;
}

/**
* Add method from MethodGenerator
*
* @param MethodGenerator $method
* @return $this
* @throws \InvalidArgumentException
*/
public function addMethodFromGenerator(MethodGenerator $method)
{
if (!is_string($method->getName())) {
throw new \InvalidArgumentException('addMethodFromGenerator() expects string for name');
}

return parent::addMethodFromGenerator($method);
}

/**
* Add properties
*
* @param array $properties
* @return $this
* @throws \InvalidArgumentException
*/
public function addProperties(array $properties)
{
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 \Laminas\Code\Generator\DocBlockGenerator();
$docBlockObject->setWordWrap(false);
$this->_setDataToObject($docBlockObject, $docBlock, $this->_docBlockOptions);
$propertyObject->setDocBlock($docBlockObject);
}
}

$this->addPropertyFromGenerator($propertyObject);
}

return $this;
}

/**
* Add property from PropertyGenerator
*
* @param PropertyGenerator $property
* @return $this
* @throws \InvalidArgumentException
*/
public function addPropertyFromGenerator(PropertyGenerator $property)
{
if (!is_string($property->getName())) {
throw new \InvalidArgumentException('addPropertyFromGenerator() expects string for name');
}

return parent::addPropertyFromGenerator($property);
}

/**
* Instantiate method generator object.
*
* @return MethodGenerator
*/
protected function createMethodGenerator()
{
return new MethodGenerator();
}

/**
* Get namespace name
*
* @return string|null
*/
public function getNamespaceName()
{
return ltrim(parent::getNamespaceName(), '\\') ?: null;
}
}