StaticProperties Class Reference

Public Member Functions
	startTestSuite ()
	endTestSuite (\PHPUnit\Framework\TestSuite $suite)

Static Public Member Functions
static	restoreStaticVariables ()
static	backupStaticVariables ()

Static Protected Member Functions
static	_isClassCleanable (\ReflectionClass $reflectionClass)
static	_isClassInCleanableFolders ($classFile)

Static Protected Attributes
static	$_cleanableFolders
static	$backupStaticVariables = []
static	$_classesToSkip
static	$classes = []

Detailed Description

Definition at line 15 of file StaticProperties.php.

Member Function Documentation

_isClassCleanable()

static _isClassCleanable ( \ReflectionClass  $reflectionClass )

staticprotected

Check whether it is allowed to clean given class static variables

Parameters

\ReflectionClass

$reflectionClass

Returns

bool

Definition at line 71 of file StaticProperties.php.

    {
        // do not process blacklisted classes from integration framework
        foreach (self::$_classesToSkip as $notCleanableClass) {
            if ($reflectionClass->getName() == $notCleanableClass || is_subclass_of(
                $reflectionClass->getName(),
                $notCleanableClass
            )
            ) {
                return false;
            }
        }
        return true;
    }

_isClassInCleanableFolders()

static _isClassInCleanableFolders (   $classFile )

staticprotected

Check if class has to be backed up

Parameters

string

$classFile

Returns

bool

Definition at line 92 of file StaticProperties.php.

    {
        $classFile = str_replace('\\', '/', $classFile);
        foreach (self::$_cleanableFolders as $include => $excludeSet) {
            if (stripos($classFile, $include) !== false) {
                foreach ($excludeSet as $exclude) {
                    $excludeExp = '#' . str_replace('*', '[\w]+', $exclude) . '#';
                    if (preg_match($excludeExp, $classFile)) {
                        return false; // File is in an "include" directory, but also an "exclude" subdirectory of it
                    }
                }
                return true; // File is in an "include" directory, and not in an "exclude" subdirectory of it
            }
        }
        return false; // File is not in an "include" directory
    }

backupStaticVariables()

static backupStaticVariables ( )

static

Backup static variables

Definition at line 146 of file StaticProperties.php.

    {
        if (count(self::$backupStaticVariables) > 0) {
            return;
        }
        $classFiles = array_filter(
            Files::init()->getPhpFiles(
                Files::INCLUDE_APP_CODE
                | Files::INCLUDE_LIBS
                | Files::INCLUDE_TESTS
            ),
            function ($classFile) {
                return StaticProperties::_isClassInCleanableFolders($classFile)
                && strpos(file_get_contents($classFile), ' static ')  > 0;
            }
        );
        $namespacePattern = '/namespace [a-zA-Z0-9\\\\]+;/';
        $classPattern = '/\nclass [a-zA-Z0-9_]+/';
        foreach ($classFiles as $classFile) {
            $code = file_get_contents($classFile);
            preg_match($namespacePattern, $code, $namespace);
            preg_match($classPattern, $code, $class);
            if (!isset($namespace[0]) || !isset($class[0])) {
                continue;
            }
            // trim namespace and class name
            $namespace = substr($namespace[0], 10, strlen($namespace[0]) - 11);
            $class = substr($class[0], 7, strlen($class[0]) - 7);
            $className = $namespace . '\\' . $class;

            try {
                $reflectionClass = self::getReflectionClass($className);
            } catch (\Exception $e) {
                continue;
            }
            if (self::_isClassCleanable($reflectionClass)) {
                $staticProperties = $reflectionClass->getProperties(\ReflectionProperty::IS_STATIC);
                foreach ($staticProperties as $staticProperty) {
                    $staticProperty->setAccessible(true);
                    $value = $staticProperty->getValue();
                    self::$backupStaticVariables[$className][$staticProperty->getName()] = $value;
                }
            }
        }
    }

endTestSuite()

endTestSuite

(

\PHPUnit\Framework\TestSuite

$suite

)

Handler for 'endTestSuite' event

Parameters

\PHPUnit\Framework\TestSuite

$suite

Definition at line 208 of file StaticProperties.php.

    {
        $clearStatics = false;
        foreach ($suite->tests() as $test) {
            if ($test instanceof \Magento\TestFramework\TestCase\AbstractController) {
                $clearStatics = true;
                break;
            }
        }
        if ($clearStatics) {
            self::restoreStaticVariables();
        }
    }

restoreStaticVariables()

static restoreStaticVariables ( )

static

Restore static variables (after running controller test case) @TODO: refactor all code where objects are stored to static variables to use object manager instead

Definition at line 130 of file StaticProperties.php.

    {
        foreach (array_keys(self::$backupStaticVariables) as $class) {
            $reflectionClass = self::getReflectionClass($class);
            $staticProperties = $reflectionClass->getProperties(\ReflectionProperty::IS_STATIC);
            foreach ($staticProperties as $staticProperty) {
                $staticProperty->setAccessible(true);
                $staticProperty->setValue(self::$backupStaticVariables[$class][$staticProperty->getName()]);
            }
        }
    }

startTestSuite()

startTestSuite

(

)

Handler for 'startTestSuite' event

Definition at line 196 of file StaticProperties.php.

    {
        if (empty(self::$backupStaticVariables)) {
            self::backupStaticVariables();
        }
    }

Field Documentation

$_classesToSkip

$_classesToSkip

staticprotected

Initial value:

= [
        \Magento\Framework\App\ObjectManager::class,
        \Magento\TestFramework\Helper\Bootstrap::class,
        \Magento\TestFramework\Event\Magento::class,
        \Magento\TestFramework\Event\PhpUnit::class,
        \Magento\TestFramework\Annotation\AppIsolation::class,
        \Magento\TestFramework\Workaround\Cleanup\StaticProperties::class,
        \Magento\Framework\Phrase::class,
    ]

Definition at line 35 of file StaticProperties.php.

$_cleanableFolders

$_cleanableFolders

staticprotected

Initial value:

= [
        '/dev/tests/integration/framework' => [],
    ]

Definition at line 24 of file StaticProperties.php.

$backupStaticVariables

$backupStaticVariables = []

staticprotected

Definition at line 28 of file StaticProperties.php.

$classes

$classes = []

staticprotected

Definition at line 112 of file StaticProperties.php.

---

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

• vendor/magento/magento2-base/dev/tests/integration/framework/Magento/TestFramework/Workaround/Cleanup/StaticProperties.php