@package PHPUnit @subpackage Util @author Sebastian Bergmann <sebastian@phpunit.de> @copyright 2001-2013 Sebastian Bergmann <sebastian@phpunit.de> @license http://www.opensource.org/licenses/BSD-3-Clause The BSD 3-Clause License @link http://www.phpunit.de/ @since Class available since Release 3.4.0
Expanded class hierarchy of PHPUnit_Util_GlobalState
class PHPUnit_Util_GlobalState {
/**
* @var array
*/
protected static $globals = array();
/**
* @var array
*/
protected static $staticAttributes = array();
/**
* @var array
*/
protected static $superGlobalArrays = array(
'_ENV',
'_POST',
'_GET',
'_COOKIE',
'_SERVER',
'_FILES',
'_REQUEST',
);
/**
* @var array
*/
protected static $superGlobalArraysLong = array(
'HTTP_ENV_VARS',
'HTTP_POST_VARS',
'HTTP_GET_VARS',
'HTTP_COOKIE_VARS',
'HTTP_SERVER_VARS',
'HTTP_POST_FILES',
);
/**
* @var array
*/
protected static $phpunitFiles;
public static function backupGlobals(array $blacklist) {
self::$globals = array();
$superGlobalArrays = self::getSuperGlobalArrays();
foreach ($superGlobalArrays as $superGlobalArray) {
if (!in_array($superGlobalArray, $blacklist)) {
self::backupSuperGlobalArray($superGlobalArray);
}
}
foreach (array_keys($GLOBALS) as $key) {
if ($key != 'GLOBALS' && !in_array($key, $superGlobalArrays) && !in_array($key, $blacklist) && !$GLOBALS[$key] instanceof Closure) {
self::$globals['GLOBALS'][$key] = serialize($GLOBALS[$key]);
}
}
}
public static function restoreGlobals(array $blacklist) {
if (ini_get('register_long_arrays') == '1') {
$superGlobalArrays = array_merge(self::$superGlobalArrays, self::$superGlobalArraysLong);
}
else {
$superGlobalArrays = self::$superGlobalArrays;
}
foreach ($superGlobalArrays as $superGlobalArray) {
if (!in_array($superGlobalArray, $blacklist)) {
self::restoreSuperGlobalArray($superGlobalArray);
}
}
foreach (array_keys($GLOBALS) as $key) {
if ($key != 'GLOBALS' && !in_array($key, $superGlobalArrays) && !in_array($key, $blacklist)) {
if (isset(self::$globals['GLOBALS'][$key])) {
$GLOBALS[$key] = unserialize(self::$globals['GLOBALS'][$key]);
}
else {
unset($GLOBALS[$key]);
}
}
}
self::$globals = array();
}
protected static function backupSuperGlobalArray($superGlobalArray) {
self::$globals[$superGlobalArray] = array();
if (isset($GLOBALS[$superGlobalArray]) && is_array($GLOBALS[$superGlobalArray])) {
foreach ($GLOBALS[$superGlobalArray] as $key => $value) {
self::$globals[$superGlobalArray][$key] = serialize($value);
}
}
}
protected static function restoreSuperGlobalArray($superGlobalArray) {
if (isset($GLOBALS[$superGlobalArray]) && is_array($GLOBALS[$superGlobalArray]) && isset(self::$globals[$superGlobalArray])) {
$keys = array_keys(array_merge($GLOBALS[$superGlobalArray], self::$globals[$superGlobalArray]));
foreach ($keys as $key) {
if (isset(self::$globals[$superGlobalArray][$key])) {
$GLOBALS[$superGlobalArray][$key] = unserialize(self::$globals[$superGlobalArray][$key]);
}
else {
unset($GLOBALS[$superGlobalArray][$key]);
}
}
}
self::$globals[$superGlobalArray] = array();
}
public static function getIncludedFilesAsString() {
$blacklist = self::phpunitFiles();
$files = get_included_files();
$prefix = FALSE;
$result = '';
if (defined('__PHPUNIT_PHAR__')) {
$prefix = 'phar://' . __PHPUNIT_PHAR__ . '/';
}
for ($i = count($files) - 1; $i > 0; $i--) {
$file = $files[$i];
if ($prefix !== FALSE) {
$file = str_replace($prefix, '', $file);
}
if (!isset($blacklist[$file]) && is_file($file)) {
$result = 'require_once \'' . $file . "';\n" . $result;
}
}
return $result;
}
public static function getConstantsAsString() {
$constants = get_defined_constants(TRUE);
$result = '';
if (isset($constants['user'])) {
foreach ($constants['user'] as $name => $value) {
$result .= sprintf('if (!defined(\'%s\')) define(\'%s\', %s);' . "\n", $name, $name, self::exportVariable($value));
}
}
return $result;
}
public static function getGlobalsAsString() {
$result = '';
$superGlobalArrays = self::getSuperGlobalArrays();
foreach ($superGlobalArrays as $superGlobalArray) {
if (isset($GLOBALS[$superGlobalArray]) && is_array($GLOBALS[$superGlobalArray])) {
foreach (array_keys($GLOBALS[$superGlobalArray]) as $key) {
if ($GLOBALS[$superGlobalArray][$key] instanceof Closure) {
continue;
}
$result .= sprintf('$GLOBALS[\'%s\'][\'%s\'] = %s;' . "\n", $superGlobalArray, $key, self::exportVariable($GLOBALS[$superGlobalArray][$key]));
}
}
}
$blacklist = $superGlobalArrays;
$blacklist[] = 'GLOBALS';
$blacklist[] = '_PEAR_Config_instance';
foreach (array_keys($GLOBALS) as $key) {
if (!in_array($key, $blacklist) && !$GLOBALS[$key] instanceof Closure) {
$result .= sprintf('$GLOBALS[\'%s\'] = %s;' . "\n", $key, self::exportVariable($GLOBALS[$key]));
}
}
return $result;
}
protected static function getSuperGlobalArrays() {
if (ini_get('register_long_arrays') == '1') {
return array_merge(self::$superGlobalArrays, self::$superGlobalArraysLong);
}
else {
return self::$superGlobalArrays;
}
}
public static function backupStaticAttributes(array $blacklist) {
self::$staticAttributes = array();
$declaredClasses = get_declared_classes();
$declaredClassesNum = count($declaredClasses);
for ($i = $declaredClassesNum - 1; $i >= 0; $i--) {
if (strpos($declaredClasses[$i], 'PHPUnit') !== 0 && strpos($declaredClasses[$i], 'File_Iterator') !== 0 && strpos($declaredClasses[$i], 'PHP_CodeCoverage') !== 0 && strpos($declaredClasses[$i], 'PHP_Invoker') !== 0 && strpos($declaredClasses[$i], 'PHP_Timer') !== 0 && strpos($declaredClasses[$i], 'PHP_TokenStream') !== 0 && strpos($declaredClasses[$i], 'Symfony') !== 0 && strpos($declaredClasses[$i], 'Text_Template') !== 0 && !$declaredClasses[$i] instanceof PHPUnit_Framework_Test) {
$class = new ReflectionClass($declaredClasses[$i]);
if (!$class
->isUserDefined()) {
break;
}
$backup = array();
foreach ($class
->getProperties() as $attribute) {
if ($attribute
->isStatic()) {
$name = $attribute
->getName();
if (!isset($blacklist[$declaredClasses[$i]]) || !in_array($name, $blacklist[$declaredClasses[$i]])) {
$attribute
->setAccessible(TRUE);
$value = $attribute
->getValue();
if (!$value instanceof Closure) {
$backup[$name] = serialize($value);
}
}
}
}
if (!empty($backup)) {
self::$staticAttributes[$declaredClasses[$i]] = $backup;
}
}
}
}
public static function restoreStaticAttributes() {
foreach (self::$staticAttributes as $className => $staticAttributes) {
foreach ($staticAttributes as $name => $value) {
$reflector = new ReflectionProperty($className, $name);
$reflector
->setAccessible(TRUE);
$reflector
->setValue(unserialize($value));
}
}
self::$staticAttributes = array();
}
protected static function exportVariable($variable) {
if (is_scalar($variable) || is_null($variable) || is_array($variable) && self::arrayOnlyContainsScalars($variable)) {
return var_export($variable, TRUE);
}
return 'unserialize(\'' . str_replace("'", "\\'", serialize($variable)) . '\')';
}
protected static function arrayOnlyContainsScalars(array $array) {
$result = TRUE;
foreach ($array as $element) {
if (is_array($element)) {
$result = self::arrayOnlyContainsScalars($element);
}
else {
if (!is_scalar($element) && !is_null($element)) {
$result = FALSE;
}
}
if ($result === FALSE) {
break;
}
}
return $result;
}
/**
* @return array
* @since Method available since Release 3.6.0
*/
public static function phpunitFiles() {
if (self::$phpunitFiles === NULL) {
self::addDirectoryContainingClassToPHPUnitFilesList('File_Iterator');
self::addDirectoryContainingClassToPHPUnitFilesList('PHP_CodeCoverage');
self::addDirectoryContainingClassToPHPUnitFilesList('PHP_Invoker');
self::addDirectoryContainingClassToPHPUnitFilesList('PHP_Timer');
self::addDirectoryContainingClassToPHPUnitFilesList('PHP_Token');
self::addDirectoryContainingClassToPHPUnitFilesList('PHPUnit_Framework_TestCase', 2);
self::addDirectoryContainingClassToPHPUnitFilesList('PHPUnit_Extensions_Database_TestCase', 2);
self::addDirectoryContainingClassToPHPUnitFilesList('PHPUnit_Framework_MockObject_Generator', 2);
self::addDirectoryContainingClassToPHPUnitFilesList('PHPUnit_Extensions_SeleniumTestCase', 2);
self::addDirectoryContainingClassToPHPUnitFilesList('PHPUnit_Extensions_Story_TestCase', 2);
self::addDirectoryContainingClassToPHPUnitFilesList('Text_Template');
}
return self::$phpunitFiles;
}
/**
* @param string $className
* @param integer $parent
* @since Method available since Release 3.7.2
*/
protected static function addDirectoryContainingClassToPHPUnitFilesList($className, $parent = 1) {
if (!class_exists($className)) {
return;
}
$reflector = new ReflectionClass($className);
$directory = $reflector
->getFileName();
for ($i = 0; $i < $parent; $i++) {
$directory = dirname($directory);
}
$facade = new File_Iterator_Facade();
foreach ($facade
->getFilesAsArray($directory, '.php') as $file) {
self::$phpunitFiles[$file] = TRUE;
}
}
}