How does the code generation work?

dmitry_fedyuk · November 8, 2015, 4:59am

Step 1

\Magento\Framework\Code\Generator\Autoloader::load():

magento/magento2/blob/22629abe10f9c640fe47b6081d57fedccdea8e0f/lib/internal/Magento/Framework/Code/Generator/Autoloader.php#L32-L38


public function load($className)
{
    if (!class_exists($className)) {
        return Generator::GENERATION_ERROR != $this->_generator->generateClass($className);
    }
    return true;
}

Step 2

github.com

magento/magento2/blob/22629abe10f9c640fe47b6081d57fedccdea8e0f/lib/internal/Magento/Framework/Code/Generator.php#L96-L98


$generatorClass = $this->_generatedEntities[$resultEntityType];
/** @var EntityAbstract $generator */
$generator = $this->createGeneratorInstance($generatorClass, $sourceClassName, $className);

Generated entities:

github.com

magento/magento2/blob/22629abe10f9c640fe47b6081d57fedccdea8e0f/lib/internal/Magento/Framework/ObjectManager/DefinitionFactory.php#L182-L194


[
    Generator\Factory::ENTITY_TYPE => '\Magento\Framework\ObjectManager\Code\Generator\Factory',
    Generator\Proxy::ENTITY_TYPE => '\Magento\Framework\ObjectManager\Code\Generator\Proxy',
    Generator\Repository::ENTITY_TYPE => '\Magento\Framework\ObjectManager\Code\Generator\Repository',
    Generator\Persistor::ENTITY_TYPE => '\Magento\Framework\ObjectManager\Code\Generator\Persistor',
    InterceptionGenerator\Interceptor::ENTITY_TYPE => '\Magento\Framework\Interception\Code\Generator\Interceptor',
    MapperGenerator::ENTITY_TYPE => '\Magento\Framework\Api\Code\Generator\Mapper',
    SearchResults::ENTITY_TYPE => '\Magento\Framework\Api\Code\Generator\SearchResults',
    ConverterGenerator::ENTITY_TYPE => '\Magento\Framework\ObjectManager\Code\Generator\Converter',
    ProfilerGenerator\Logger::ENTITY_TYPE => '\Magento\Framework\ObjectManager\Profiler\Code\Generator\Logger',
    ExtensionAttributesGenerator::ENTITY_TYPE => 'Magento\Framework\Api\Code\Generator\ExtensionAttributesGenerator',
    ExtensionAttributesInterfaceGenerator::ENTITY_TYPE => 'Magento\Framework\Api\Code\Generator\ExtensionAttributesInterfaceGenerator'
]

Step 3

\Magento\Framework\Code\Generator::generateClass()

github.com

magento/magento2/blob/22629abe10f9c640fe47b6081d57fedccdea8e0f/lib/internal/Magento/Framework/Code/Generator.php#L101




if ($skipReason = $this->shouldSkipGeneration($resultEntityType, $sourceClassName, $className)) {
    return $skipReason;
}


$generatorClass = $this->_generatedEntities[$resultEntityType];
/** @var EntityAbstract $generator */
$generator = $this->createGeneratorInstance($generatorClass, $sourceClassName, $className);
if ($generator !== null) {
    $this->tryToLoadSourceClass($className, $generator);
    if (!($file = $generator->generate())) {
        $errors = $generator->getErrors();
        throw new \Magento\Framework\Exception\LocalizedException(
            new \Magento\Framework\Phrase(implode(' ', $errors))
        );
    }
    if (!$this->definedClasses->isClassLoadableFromMemory($className)) {
        $this->_ioObject->includeFile($file);
    }
    return self::GENERATION_SUCCESS;
}

dmitry_fedyuk · October 13, 2017, 12:56pm