Code Coverage
 
Classes and Traits
Functions and Methods
Lines
Total
0.00% covered (danger)
0.00%
0 / 1
31.82% covered (danger)
31.82%
7 / 22
CRAP
40.00% covered (danger)
40.00%
52 / 130
Snapshot
0.00% covered (danger)
0.00%
0 / 1
31.82% covered (danger)
31.82%
7 / 22
683.86
40.00% covered (danger)
40.00%
52 / 130
 __construct(Blacklist $blacklist = null, $includeGlobalVariables = true, $includeStaticAttributes = true, $includeConstants = true, $includeFunctions = true, $includeClasses = true, $includeInterfaces = true, $includeTraits = true, $includeIniSettings = true, $includeIncludedFiles = true)
0.00% covered (danger)
0.00%
0 / 1
28.41
51.52% covered (warning)
51.52%
17 / 33
 blacklist()
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
1 / 1
 globalVariables()
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
1 / 1
 superGlobalVariables()
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
1 / 1
 superGlobalArrays()
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
1 / 1
 staticAttributes()
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 1
 iniSettings()
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 1
 includedFiles()
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 1
 constants()
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 1
 functions()
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 1
 interfaces()
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 1
 classes()
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 1
 traits()
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 1
 snapshotConstants()
0.00% covered (danger)
0.00%
0 / 1
6
0.00% covered (danger)
0.00%
0 / 5
 snapshotFunctions()
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 3
 snapshotClasses()
0.00% covered (danger)
0.00%
0 / 1
12
0.00% covered (danger)
0.00%
0 / 8
 snapshotInterfaces()
0.00% covered (danger)
0.00%
0 / 1
12
0.00% covered (danger)
0.00%
0 / 8
 snapshotGlobals()
100.00% covered (success)
100.00%
1 / 1
7
100.00% covered (success)
100.00%
13 / 13
 snapshotSuperGlobalArray($superGlobalArray)
100.00% covered (success)
100.00%
1 / 1
4
100.00% covered (success)
100.00%
7 / 7
 snapshotStaticAttributes()
0.00% covered (danger)
0.00%
0 / 1
56
0.00% covered (danger)
0.00%
0 / 20
 setupSuperGlobalArrays()
0.00% covered (danger)
0.00%
0 / 1
2.50
50.00% covered (warning)
50.00%
10 / 20
 canBeSerialized($variable)
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
1 / 1
<?php
/**
 * GlobalState
 *
 * Copyright (c) 2001-2014, Sebastian Bergmann <sebastian@phpunit.de>.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 *
 *   * Neither the name of Sebastian Bergmann nor the names of his
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * @author     Sebastian Bergmann <sebastian@phpunit.de>
 * @copyright  2001-2014 Sebastian Bergmann <sebastian@phpunit.de>
 * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
 * @link       http://www.github.com/sebastianbergmann/global-state
 */
namespace SebastianBergmann\GlobalState;
use Closure;
use ReflectionClass;
/**
 * A snapshot of global state.
 *
 * @author     Sebastian Bergmann <sebastian@phpunit.de>
 * @copyright  2001-2014 Sebastian Bergmann <sebastian@phpunit.de>
 * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
 * @link       http://www.github.com/sebastianbergmann/global-state
 */
class Snapshot
{
    /**
     * @var Blacklist
     */
    private $blacklist;
    /**
     * @var array
     */
    private $globalVariables = array();
    /**
     * @var array
     */
    private $superGlobalArrays = array();
    /**
     * @var array
     */
    private $superGlobalVariables = array();
    /**
     * @var array
     */
    private $staticAttributes = array();
    /**
     * @var array
     */
    private $iniSettings = array();
    /**
     * @var array
     */
    private $includedFiles = array();
    /**
     * @var array
     */
    private $constants = array();
    /**
     * @var array
     */
    private $functions = array();
    /**
     * @var array
     */
    private $interfaces = array();
    /**
     * @var array
     */
    private $classes = array();
    /**
     * @var array
     */
    private $traits = array();
    /**
     * Creates a snapshot of the current global state.
     *
     * @param Blacklist $blacklist
     * @param boolean   $includeGlobalVariables
     * @param boolean   $includeStaticAttributes
     * @param boolean   $includeConstants
     * @param boolean   $includeFunctions
     * @param boolean   $includeClasses
     * @param boolean   $includeInterfaces
     * @param boolean   $includeTraits
     * @param boolean   $includeIniSettings
     * @param boolean   $includeIncludedFiles
     */
    public function __construct(Blacklist $blacklist = null, $includeGlobalVariables = true, $includeStaticAttributes = true, $includeConstants = true, $includeFunctions = true, $includeClasses = true, $includeInterfaces = true, $includeTraits = true, $includeIniSettings = true, $includeIncludedFiles = true)
    {
        if ($blacklist === null) {
            $blacklist = new Blacklist;
        }
        $this->blacklist = $blacklist;
        if ($includeConstants) {
            $this->snapshotConstants();
        }
        if ($includeFunctions) {
            $this->snapshotFunctions();
        }
        if ($includeClasses || $includeStaticAttributes) {
            $this->snapshotClasses();
        }
        if ($includeInterfaces) {
            $this->snapshotInterfaces();
        }
        if ($includeGlobalVariables) {
            $this->setupSuperGlobalArrays();
            $this->snapshotGlobals();
        }
        if ($includeStaticAttributes) {
            $this->snapshotStaticAttributes();
        }
        if ($includeIniSettings) {
            $this->iniSettings = ini_get_all(null, false);
        }
        if ($includeIncludedFiles) {
            $this->includedFiles = get_included_files();
        }
        if (function_exists('get_declared_traits')) {
            $this->traits = get_declared_traits();
        }
    }
    /**
     * @return Blacklist
     */
    public function blacklist()
    {
        return $this->blacklist;
    }
    /**
     * @return array
     */
    public function globalVariables()
    {
        return $this->globalVariables;
    }
    /**
     * @return array
     */
    public function superGlobalVariables()
    {
        return $this->superGlobalVariables;
    }
    /**
     * Returns a list of all super-global variable arrays.
     *
     * @return array
     */
    public function superGlobalArrays()
    {
        return $this->superGlobalArrays;
    }
    /**
     * @return array
     */
    public function staticAttributes()
    {
        return $this->staticAttributes;
    }
    /**
     * @return array
     */
    public function iniSettings()
    {
        return $this->iniSettings;
    }
    /**
     * @return array
     */
    public function includedFiles()
    {
        return $this->includedFiles;
    }
    /**
     * @return array
     */
    public function constants()
    {
        return $this->constants;
    }
    /**
     * @return array
     */
    public function functions()
    {
        return $this->functions;
    }
    /**
     * @return array
     */
    public function interfaces()
    {
        return $this->interfaces;
    }
    /**
     * @return array
     */
    public function classes()
    {
        return $this->classes;
    }
    /**
     * @return array
     */
    public function traits()
    {
        return $this->traits;
    }
    /**
     * Creates a snapshot user-defined constants.
     */
    private function snapshotConstants()
    {
        $constants = get_defined_constants(true);
        if (isset($constants['user'])) {
            $this->constants = $constants['user'];
        }
    }
    /**
     * Creates a snapshot user-defined functions.
     */
    private function snapshotFunctions()
    {
        $functions = get_defined_functions();
        $this->functions = $functions['user'];
    }
    /**
     * Creates a snapshot user-defined classes.
     */
    private function snapshotClasses()
    {
        foreach (array_reverse(get_declared_classes()) as $className) {
            $class = new ReflectionClass($className);
            if (!$class->isUserDefined()) {
                break;
            }
            $this->classes[] = $className;
        }
        $this->classes = array_reverse($this->classes);
    }
    /**
     * Creates a snapshot user-defined interfaces.
     */
    private function snapshotInterfaces()
    {
        foreach (array_reverse(get_declared_interfaces()) as $interfaceName) {
            $class = new ReflectionClass($interfaceName);
            if (!$class->isUserDefined()) {
                break;
            }
            $this->interfaces[] = $interfaceName;
        }
        $this->interfaces = array_reverse($this->interfaces);
    }
    /**
     * Creates a snapshot of all global and super-global variables.
     */
    private function snapshotGlobals()
    {
        $superGlobalArrays = $this->superGlobalArrays();
        foreach ($superGlobalArrays as $superGlobalArray) {
            $this->snapshotSuperGlobalArray($superGlobalArray);
        }
        foreach (array_keys($GLOBALS) as $key) {
            if ($key != 'GLOBALS' &&
                !in_array($key, $superGlobalArrays) &&
                $this->canBeSerialized($GLOBALS[$key]) &&
                !$this->blacklist->isGlobalVariableBlacklisted($key)) {
                $this->globalVariables[$key] = unserialize(serialize($GLOBALS[$key]));
            }
        }
    }
    /**
     * Creates a snapshot a super-global variable array.
     *
     * @param $superGlobalArray
     */
    private function snapshotSuperGlobalArray($superGlobalArray)
    {
        $this->superGlobalVariables[$superGlobalArray] = array();
        if (isset($GLOBALS[$superGlobalArray]) && is_array($GLOBALS[$superGlobalArray])) {
            foreach ($GLOBALS[$superGlobalArray] as $key => $value) {
                $this->superGlobalVariables[$superGlobalArray][$key] = unserialize(serialize($value));
            }
        }
    }
    /**
     * Creates a snapshot of all static attributes in user-defined classes.
     */
    private function snapshotStaticAttributes()
    {
        foreach ($this->classes as $className) {
            $class    = new ReflectionClass($className);
            $snapshot = array();
            foreach ($class->getProperties() as $attribute) {
                if ($attribute->isStatic()) {
                    $name = $attribute->getName();
                    if ($this->blacklist->isStaticAttributeBlacklisted($className, $name)) {
                        continue;
                    }
                    $attribute->setAccessible(true);
                    $value = $attribute->getValue();
                    if ($this->canBeSerialized($value)) {
                        $snapshot[$name] = unserialize(serialize($value));
                    }
                }
            }
            if (!empty($snapshot)) {
                $this->staticAttributes[$className] = $snapshot;
            }
        }
    }
    /**
     * Returns a list of all super-global variable arrays.
     *
     * @return array
     */
    private function setupSuperGlobalArrays()
    {
        $this->superGlobalArrays = array(
            '_ENV',
            '_POST',
            '_GET',
            '_COOKIE',
            '_SERVER',
            '_FILES',
            '_REQUEST'
        );
        if (ini_get('register_long_arrays') == '1') {
            $this->superGlobalArrays = array_merge(
                $this->superGlobalArrays,
                array(
                    'HTTP_ENV_VARS',
                    'HTTP_POST_VARS',
                    'HTTP_GET_VARS',
                    'HTTP_COOKIE_VARS',
                    'HTTP_SERVER_VARS',
                    'HTTP_POST_FILES'
                )
            );
        }
    }
    /**
     * @param  mixed $variable
     * @return boolean
     * @todo   Implement this properly
     */
    private function canBeSerialized($variable) {
        return !$variable instanceof Closure;
    }
}