Generator Class Reference

Inheritance diagram for Generator:

Public Member Functions
	__construct (Io $ioObject=null, array $generatedEntities=[], DefinedClasses $definedClasses=null, LoggerInterface $logger=null)
	getGeneratedEntities ()
	setGeneratedEntities ($generatedEntities)
	setObjectManager (ObjectManagerInterface $objectManager)
	getObjectManager ()

Data Fields
const	GENERATION_SUCCESS = 'success'
const	GENERATION_ERROR = 'error'
const	GENERATION_SKIP = 'skip'

Protected Member Functions
	createGeneratorInstance ($generatorClass, $entityName, $className)
	tryToLoadSourceClass ($className, $generator)
	shouldSkipGeneration ($resultEntityType, $sourceClassName, $resultClass)

Protected Attributes
	$_ioObject
	$_generatedEntities
	$definedClasses
	$objectManager

Detailed Description

Definition at line 16 of file Generator.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Io	$ioObject = null,
		array	$generatedEntities = [],
		DefinedClasses	$definedClasses = null,
		LoggerInterface	$logger = null
	)

Parameters

Generator\Io	$ioObject
array	$generatedEntities
DefinedClasses	$definedClasses
LoggerInterface | null	$logger

Definition at line 57 of file Generator.php.

      {
        $this->_ioObject = $ioObject ?: new Io(new File());
        $this->definedClasses = $definedClasses ?: new DefinedClasses();
        $this->_generatedEntities = $generatedEntities;
        $this->logger = $logger;
    }

Member Function Documentation

createGeneratorInstance()

createGeneratorInstance (   $generatorClass,   $entityName,   $className  )

protected

Create entity generator

Parameters

string	$generatorClass
string	$entityName
string	$className

Returns

EntityAbstract

Definition at line 165 of file Generator.php.

    {
        return $this->getObjectManager()->create(
            $generatorClass,
            ['sourceClassName' => $entityName, 'resultClassName' => $className, 'ioObject' => $this->_ioObject]
        );
    }

getGeneratedEntities()

getGeneratedEntities

(

)

Get generated entities

Returns

array

Definition at line 74 of file Generator.php.

    {
        return $this->_generatedEntities;
    }

getObjectManager()

getObjectManager

(

)

Get object manager instance.

Returns

ObjectManagerInterface

Definition at line 190 of file Generator.php.

    {
        if (!($this->objectManager instanceof ObjectManagerInterface)) {
            throw new \LogicException(
                "Object manager was expected to be set using setObjectManger() "
                . "before getObjectManager() invocation."
            );
        }
        return $this->objectManager;
    }

setGeneratedEntities()

setGeneratedEntities

(

$generatedEntities

)

Set entity-to-generator map

Parameters

array

$generatedEntities

Returns

$this

Definition at line 85 of file Generator.php.

    {
        $this->_generatedEntities = $generatedEntities;
        return $this;
    }

setObjectManager()

setObjectManager

(

ObjectManagerInterface

$objectManager

)

Set object manager instance.

Parameters

ObjectManagerInterface

$objectManager

Returns

$this

Definition at line 179 of file Generator.php.

    {
        $this->objectManager = $objectManager;
        return $this;
    }

shouldSkipGeneration()

shouldSkipGeneration (   $resultEntityType,   $sourceClassName,   $resultClass  )

protected

Perform validation surrounding source and result classes and entity type

Parameters

string	$resultEntityType
string	$sourceClassName
string	$resultClass

Returns

string|bool

Must handle two edge cases: a competing process has generated the class and written it to disc already, or the class exists in committed code, despite matching pattern to be generated.

Definition at line 231 of file Generator.php.

    {
        if (!$resultEntityType || !$sourceClassName) {
            return self::GENERATION_ERROR;
        } elseif ($this->definedClasses->isClassLoadableFromDisk($resultClass)) {
            $generatedFileName = $this->_ioObject->generateResultFileName($resultClass);
            if ($this->_ioObject->fileExists($generatedFileName)
                && !$this->definedClasses->isClassLoadableFromMemory($resultClass)
            ) {
                $this->_ioObject->includeFile($generatedFileName);
            }
            return self::GENERATION_SKIP;
        } elseif (!isset($this->_generatedEntities[$resultEntityType])) {
            throw new \InvalidArgumentException('Unknown generation entity.');
        }
        return false;
    }

tryToLoadSourceClass()

tryToLoadSourceClass (   $className,   $generator  )

protected

Try to load/generate source class to check if it is valid or not.

Parameters

string	$className
EntityAbstract	$generator

Returns

void

Exceptions

Definition at line 209 of file Generator.php.

    {
        $sourceClassName = $generator->getSourceClassName();
        if (!$this->definedClasses->isClassLoadable($sourceClassName)) {
            if ($this->generateClass($sourceClassName) !== self::GENERATION_SUCCESS) {
                $phrase = new Phrase(
                    'Source class "%1" for "%2" generation does not exist.',
                    [$sourceClassName, $className]
                );
                throw new \RuntimeException($phrase->__toString());
            }
        }
    }

Field Documentation

$_generatedEntities

$_generatedEntities

protected

Definition at line 32 of file Generator.php.

$_ioObject

$_ioObject

protected

Definition at line 27 of file Generator.php.

$definedClasses

$definedClasses

protected

Definition at line 37 of file Generator.php.

$objectManager

$objectManager

protected

Definition at line 42 of file Generator.php.

GENERATION_ERROR

const GENERATION_ERROR = 'error'

Definition at line 20 of file Generator.php.

GENERATION_SKIP

const GENERATION_SKIP = 'skip'

Definition at line 22 of file Generator.php.

GENERATION_SUCCESS

const GENERATION_SUCCESS = 'success'

Definition at line 18 of file Generator.php.

---

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

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