Your IP : 216.73.216.220
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Magento\Setup\Module\Di\Code\Reader;
use Magento\Framework\App\Filesystem\DirectoryList;
use Magento\Framework\App\ObjectManager;
use Magento\Framework\Exception\FileSystemException;
/**
* Class ClassesScanner
*/
class ClassesScanner implements ClassesScannerInterface
{
/**
* @var array
*/
protected $excludePatterns = [];
/**
* @var array
*/
private $fileResults = [];
/**
* @var string
*/
private $generationDirectory;
/**
* @param array $excludePatterns
* @param DirectoryList|null $directoryList
* @throws FileSystemException
*/
public function __construct(array $excludePatterns = [], DirectoryList $directoryList = null)
{
$this->excludePatterns = $excludePatterns;
if ($directoryList === null) {
$directoryList = ObjectManager::getInstance()->get(DirectoryList::class);
}
$this->generationDirectory = $directoryList->getPath(DirectoryList::GENERATION);
}
/**
* Adds exclude patterns
*
* @param array $excludePatterns
* @return void
*/
public function addExcludePatterns(array $excludePatterns)
{
$this->excludePatterns = array_merge($this->excludePatterns, $excludePatterns);
}
/**
* Retrieves list of classes for given path
*
* @param string $path
* @return array
* @throws FileSystemException
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
*/
public function getList($path)
{
// phpcs:ignore
$realPath = realpath($path);
$isGeneration = strpos($realPath, $this->generationDirectory) === 0;
// Generation folders should not have their results cached since they may actually change during compile
if (!$isGeneration && isset($this->fileResults[$realPath])) {
return $this->fileResults[$realPath];
}
if (!(bool)$realPath) {
throw new FileSystemException(
new \Magento\Framework\Phrase('The "%1" path is invalid. Verify the path and try again.', [$path])
);
}
$recursiveIterator = new \RecursiveIteratorIterator(
new \RecursiveDirectoryIterator($realPath, \FilesystemIterator::FOLLOW_SYMLINKS),
\RecursiveIteratorIterator::SELF_FIRST
);
$classes = $this->extract($recursiveIterator);
if (!$isGeneration) {
$this->fileResults[$realPath] = $classes;
}
return $classes;
}
/**
* Extracts all the classes from the recursive iterator
*
* @param \RecursiveIteratorIterator $recursiveIterator
* @return array
*/
private function extract(\RecursiveIteratorIterator $recursiveIterator)
{
$classes = [];
foreach ($recursiveIterator as $fileItem) {
/** @var $fileItem \SplFileInfo */
if ($fileItem->isDir() || $fileItem->getExtension() !== 'php' || $fileItem->getBasename()[0] == '.') {
continue;
}
$fileItemPath = $fileItem->getRealPath();
foreach ($this->excludePatterns as $excludePatterns) {
if ($this->isExclude($fileItemPath, $excludePatterns)) {
continue 2;
}
}
$fileScanner = new FileClassScanner($fileItemPath);
$className = $fileScanner->getClassName();
if (!empty($className)) {
$this->includeClass($className, $fileItemPath);
$classes[] = $className;
}
}
return $classes;
}
/**
* Include class from file path.
*
* @param string $className
* @param string $fileItemPath
* @return bool Whether the class is included or not
*/
private function includeClass(string $className, string $fileItemPath): bool
{
if (!class_exists($className)) {
// phpcs:ignore
require_once $fileItemPath;
return true;
}
return false;
}
/**
* Find out if file should be excluded
*
* @param string $fileItemPath
* @param string $patterns
* @return bool
*/
private function isExclude($fileItemPath, $patterns)
{
if (!is_array($patterns)) {
$patterns = (array)$patterns;
}
foreach ($patterns as $pattern) {
if (preg_match($pattern, str_replace('\\', '/', $fileItemPath))) {
return true;
}
}
return false;
}
}