PhpScanner Class Reference

Inheritance diagram for PhpScanner:

Public Member Functions
	__construct (Log $log, TypeProcessor $typeProcessor=null)
	collectEntities (array $files)

Protected Member Functions
	getSourceClassName ($missingClassName, $entityType)
	_fetchFactories ($reflectionClass, $file)
	_fetchMissingExtensionAttributesClasses ($reflectionClass, $file)
	_fetchNamespace ($tokenIterator, $count, $tokens)
	_fetchClasses ($namespace, $tokenIterator, $count, $tokens)
	_getDeclaredClasses ($file)

Protected Attributes
	$_log

Detailed Description

Definition at line 14 of file PhpScanner.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Log	$log,
		TypeProcessor	$typeProcessor = null
	)

Initialize dependencies.

Parameters

Log	$log
TypeProcessor | null	$typeProcessor

Definition at line 32 of file PhpScanner.php.

    {
        $this->_log = $log;
        $this->typeProcessor = $typeProcessor
            ?: \Magento\Framework\App\ObjectManager::getInstance()->get(TypeProcessor::class);
    }

Member Function Documentation

_fetchClasses()

_fetchClasses (   $namespace,   $tokenIterator,   $count,   $tokens  )

protected

Parameters

$namespace	string
$tokenIterator	int
$count	int
$tokens	array

Returns

array

Definition at line 214 of file PhpScanner.php.

    {
        $classes = [];
        for ($tokenOffset = $tokenIterator + 1; $tokenOffset < $count; ++$tokenOffset) {
            if ($tokens[$tokenOffset] === '{') {
                $classes[] = $namespace . "\\" . $tokens[$tokenIterator + 2][1];
            }
        }
        return $classes;
    }

_fetchFactories()

_fetchFactories (   $reflectionClass,   $file  )

protected

Fetch factories from class constructor

Parameters

\ReflectionClass	$reflectionClass
string	$file

Returns

string[]

Definition at line 106 of file PhpScanner.php.

    {
        $factorySuffix = '\\' . ucfirst(FactoryGenerator::ENTITY_TYPE);
        $absentFactories = $this->_findMissingClasses(
            $file,
            $reflectionClass,
            '__construct',
            ucfirst(FactoryGenerator::ENTITY_TYPE)
        );
        foreach ($absentFactories as $key => $absentFactory) {
            if (substr($absentFactory, -strlen($factorySuffix)) == $factorySuffix) {
                $entityName = rtrim(substr($absentFactory, 0, -strlen($factorySuffix)), '\\');
                $this->_log->add(
                    Log::CONFIGURATION_ERROR,
                    $absentFactory,
                    'Invalid Factory declaration for class ' . $entityName . ' in file ' . $file
                );
                unset($absentFactories[$key]);
            }
        }
        return $absentFactories;
    }

_fetchMissingExtensionAttributesClasses()

_fetchMissingExtensionAttributesClasses (   $reflectionClass,   $file  )

protected

Find missing extension attributes related classes, interfaces and factories.

Parameters

\ReflectionClass	$reflectionClass
string	$file

Returns

string[]

Definition at line 136 of file PhpScanner.php.

    {
        $missingExtensionInterfaces = [];
        $methodName = 'getExtensionAttributes';
        $entityType = ucfirst(\Magento\Framework\Api\Code\Generator\ExtensionAttributesInterfaceGenerator::ENTITY_TYPE);
        if ($reflectionClass->hasMethod($methodName) && $reflectionClass->isInterface()) {
            $returnType = $this->typeProcessor->getGetterReturnType(
                (new \Zend\Code\Reflection\ClassReflection($reflectionClass->getName()))->getMethod($methodName)
            );
            $missingClassName = $returnType['type'];
            if ($this->shouldGenerateClass($missingClassName, $entityType, $file)) {
                $missingExtensionInterfaces[] = $missingClassName;
            }
        }
        $missingExtensionClasses = [];
        $missingExtensionFactories = [];
        foreach ($missingExtensionInterfaces as $missingExtensionInterface) {
            $extension = rtrim(substr($missingExtensionInterface, 0, -strlen('Interface')), '\\');
            if (!class_exists($extension)) {
                $missingExtensionClasses[] = $extension;
            }
            $extensionFactory = $extension . 'Factory';
            if (!class_exists($extensionFactory)) {
                $missingExtensionFactories[] = $extensionFactory;
            }
        }
        return array_merge($missingExtensionInterfaces, $missingExtensionClasses, $missingExtensionFactories);
    }

_fetchNamespace()

_fetchNamespace (   $tokenIterator,   $count,   $tokens  )

protected

Parameters

$tokenIterator	int
$count	int
$tokens	array

Returns

string

Definition at line 194 of file PhpScanner.php.

    {
        $namespace = '';
        for ($tokenOffset = $tokenIterator + 1; $tokenOffset < $count; ++$tokenOffset) {
            if ($tokens[$tokenOffset][0] === T_STRING) {
                $namespace .= "\\" . $tokens[$tokenOffset][1];
            } elseif ($tokens[$tokenOffset] === '{' || $tokens[$tokenOffset] === ';') {
                break;
            }
        }
        return $namespace;
    }

_getDeclaredClasses()

_getDeclaredClasses (   $file )

protected

Get classes and interfaces declared in the file

Parameters

string

$file

Returns

array

Definition at line 231 of file PhpScanner.php.

    {
        $classes = [];
        $namespace = '';
        $tokens = token_get_all(file_get_contents($file));
        $count = count($tokens);

        for ($tokenIterator = 0; $tokenIterator < $count; $tokenIterator++) {
            if ($tokens[$tokenIterator][0] == T_NAMESPACE) {
                $namespace .= $this->_fetchNamespace($tokenIterator, $count, $tokens);
            }

            if (($tokens[$tokenIterator][0] == T_CLASS || $tokens[$tokenIterator][0] == T_INTERFACE)
                && $tokens[$tokenIterator - 1][0] != T_DOUBLE_COLON
            ) {
                $classes = array_merge($classes, $this->_fetchClasses($namespace, $tokenIterator, $count, $tokens));
            }
        }
        return array_unique($classes);
    }

collectEntities()

collectEntities

(

array

$files

)

Get array of class names

Parameters

array

$files

Returns

array

Implements ScannerInterface.

Definition at line 171 of file PhpScanner.php.

    {
        $output = [];
        foreach ($files as $file) {
            $classes = $this->_getDeclaredClasses($file);
            foreach ($classes as $className) {
                $reflectionClass = new \ReflectionClass($className);
                $output = array_merge(
                    $output,
                    $this->_fetchFactories($reflectionClass, $file),
                    $this->_fetchMissingExtensionAttributesClasses($reflectionClass, $file)
                );
            }
        }
        return array_unique($output);
    }

getSourceClassName()

getSourceClassName (   $missingClassName,   $entityType  )

protected

Identify source class name for the provided class.

Parameters

string	$missingClassName
string	$entityType

Returns

string

Process special cases for extension class and extension interface

Process special case for extension factories

Definition at line 75 of file PhpScanner.php.

    {
        $sourceClassName = rtrim(substr($missingClassName, 0, -strlen($entityType)), '\\');
        $entityType = lcfirst($entityType);
        if ($entityType == ExtensionAttributesInterfaceGenerator::ENTITY_TYPE
            || $entityType == ExtensionAttributesGenerator::ENTITY_TYPE
        ) {
            return $sourceClassName . 'Interface';
        } elseif ($entityType == FactoryGenerator::ENTITY_TYPE) {
            $extensionAttributesSuffix = ucfirst(ExtensionAttributesGenerator::ENTITY_TYPE);
            if (substr($sourceClassName, -strlen($extensionAttributesSuffix)) == $extensionAttributesSuffix) {
                $extensionAttributesClass = substr(
                    $sourceClassName,
                    0,
                    -strlen(ExtensionAttributesGenerator::ENTITY_TYPE)
                );
                $sourceClassName = $extensionAttributesClass . 'Interface';
            }
        }
        return $sourceClassName;
    }

Field Documentation

$_log

$_log

protected

Definition at line 19 of file PhpScanner.php.

---

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

• vendor/magento/magento2-base/setup/src/Magento/Setup/Module/Di/Code/Scanner/PhpScanner.php