变量和超全局变量

时间:2012-08-28 16:01:14

标签: php variable-variables superglobals

我正在将一个庞大的PHP软件从PHP4过渡到PHP5以及我面临的许多(很多)问题中,迄今为止最大的问题似乎是前一个程序员刚刚对register_globals功能进行了抨击,现在扔掉了然后是一些变量而没有指明来源,并且在地毯下隐藏着警告和通知。

我尝试通过创建迭代数组的函数(作为参数传递)并通过“变量变量”功能创建全局变量,然后在$_POST的每个页面中调用它来解决此问题, $_GET$_SESSION。这是代码:

function fix_global_array($array) {
  foreach($array as $key => $value){
    if(!isset($$key)) {
      global $$key;
      $$key = $value;
    }
  }
}

这个函数的问题是条件isset($$key)永远不会为真,因此括号内的代码总是被执行并覆盖先前的声明。

这种行为有什么解释吗?我阅读了PHP文档,其中说明了

  

请注意,变量变量不能与函数或类方法中的PHP超全局数组一起使用。

但我不明白这是否与我的问题有关(说实话,我也不明白它的意思,我找不到任何例子)。

PS:拜托,请不要打扰告诉我使用全局变量和/或变量变量是糟糕的编程,我自己也很清楚这一点,但另一个选择就是用千行修改大约2.700个文件每行编码每一行,我是这里唯一的程序员...但如果你知道一个更好的解决方案来摆脱所有那些“未定义的变量”警告,你可以度过我的一天。

PPS:对我的英语也很耐心^ _ ^

2 个答案:

答案 0 :(得分:2)

在您给定的代码中,isset($$key)永远不会是真的原因是因为您在条件检查后调用了global $$key;在变量注册global之前,变量不在范围内。要解决此问题,只需将该行移至if-statement上方即可,因此您的功能将如下所示:

function fix_global_array($array) {
    foreach($array as $key => $value){
        global $$key;
        if(!isset($$key)) {
            $$key = $value;
        }
    }
}

即使所述数组为$_POST$_GET,这在传递数组时也能正常工作。您在数组中传递的顺序很重要。如果在$_POST$_GET中定义了索引/键,并且您首先将$_POST传递给函数,则$_GET中的值将不会存储到变量中

或者,如果您想避免使用变量变量,无论是出于可读性问题还是简单偏好,您都可以以相同的方式使用$GLOBALS超全局:

function fix_global_array($array) {
    foreach($array as $key => $value){
        if(!isset($GLOBALS[$key])) {
            $GLOBALS[$key] = $value;
        }
    }
}

使用此方法,仍然可以访问变量,就好像它们是正常定义的一样。例如:

$data = array('first' => 'one', 'second' => 'two');
fix_global_array($data);
echo $first;    // outputs: one
echo $second;   // outputs: two

此示例适用于上述两个代码示例。

另外,您也可以使用PHP的extract()功能。它的目的是完全按照fix_global_array()方法做的 - 甚至有一个标志来覆盖现有的变量值。用法示例:

extract($data);
echo $first; // outputs: one

有关extract()的警告,直接适用于这种情况,来自PHP网站:

  

不要对不受信任的数据使用extract(),例如用户输入(即$ _GET,   $ _FILES等)。如果您这样做,例如,如果您想运行旧代码   暂时依赖register_globals,请确保使用其中一个   非重写的extract_type值,如EXTR_SKIP,并且要注意   您应该按照定义的顺序提取   php.ini中的variables_order

答案 1 :(得分:1)

  

但是如果你知道一个更好的解决办法来摆脱所有那些“未定义的变量”警告,那么你可以度过我的一天。

有。解决了没有使用超全球的问题。现在,当然,我并不是说你应该自己手动更改每个翻转变量调用,但我想这可能是你可以自动化的东西。看看你能否跟随我的脑波。

首先,您必须获得所有“未定义变量”通知的列表。这就像注册错误处理程序,检查E_NOTICE调用并检查它是否是未定义的变量调用一样简单。我冒昧地编写了一小段代码,正是这样做的。

<?php

/**
 * GlobalsLog is a class which can be used to set an error handler which will 
 * check for undefined variables and checks whether they exist in superglobals.
 * 
 * @author Berry Langerak
 */
class GlobalsLog {
    /**
     * Contains an array of all undefined variables which *are* present in one of the superglobals.
     * 
     * @var array 
     */
    protected $globals;

    /**
     * This contains the order in which to test for presence in the superglobals.
     * 
     * @var array 
     */
    protected $order = array( 'SERVER', 'COOKIE', 'POST', 'GET', 'ENV' );

    /**
     * This is where the undefined variables should be stored in, so we can replace them later.
     * 
     * @var string 
     */
    protected $logfile;

    /**
     * Construct the logger. All undefined variables which are present in one of the superglobals will be stored in $logfile.
     * 
     * @param string $logfile 
     */
    public function __construct( $logfile ) {
        $this->logfile = $logfile;

        set_error_handler( array( $this, 'errorHandler' ), E_NOTICE );
    }

    /**
     * The error handler.
     * 
     * @param int $errno
     * @param string $errstr
     * @param string $errfile
     * @param int $errline
     * @return boolean
     */
    public function errorHandler( $errno, $errstr, $errfile, $errline ) {
        $matches = array( );
        if( preg_match( '~^Undefined variable: (.+)$~', $errstr, $matches ) !== 0 ) {
            foreach( $this->order as $superglobal ) {
                if( $this->hasSuperglobal( $superglobal, $matches[1] ) ) {
                    $this->globals[$errfile][] = array( $matches[1], $superglobal, $errline );
                    return true;
                }
            }
        }
    }

    /**
     * Called upon destruction of the object, and writes the undefined variables to the logfile.
     */
    public function __destruct( ) {
        $globals = array_merge( $this->globals, $this->existing( ) );

        file_put_contents( 
            $this->logfile,
            sprintf( "<?php\nreturn %s;\n", var_export( $globals, true ) )
        );
    }

    /**
     * Gets the undefined variables that were previously discovered, if any.
     * 
     * @return array
     */
    protected function existing( ) {
        if( file_exists( $this->logfile ) ) {
            $globals = require $this->logfile;
            return $globals;
        }
        return array( );
    }

    /**
     * Checks to see if the variable $index exists in the superglobal $superglobal.
     * 
     * @param string $superglobal
     * @param string $index
     * @return bool
     */
    protected function hasSuperglobal( $superglobal, $index ) {
        return array_key_exists( $index, $this->getSuperglobal( $superglobal ) );
    }

    /**
     * Returns the value of the superglobal. This has to be done on each undefined variable, because
     * the session superglobal maybe created *after* GlobalsLogger has been created.
     * 
     * @param string $superglobal
     * @return array
     */
    protected function getSuperglobal( $superglobal ) {
        $globals = array(
            'SERVER' => $_SERVER,
            'COOKIE' => $_COOKIE,
            'POST' => $_POST,
            'GET' => $_GET,
            'ENV' => $_ENV
        );
        return isset( $globals[$superglobal] ) ? $globals[$superglobal] : array( );
    }
}

/**
 * Lastly, instantiate the object, and store all undefined variables that exist
 * in one of the superglobals in a file called "undefined.php", in the same 
 * directory as this file.
 */
$globalslog = new GlobalsLog( __DIR__ . '/undefined.php' );

如果您要在请求的每个页面中包含此文件(可选择使用php_prepend_file),则在单击整个应用程序后,您将最终得到'undefined.php'中的所有未定义变量。

这是一个相当有趣的信息,因为您现在知道哪个未定义的变量位于哪个文件中,哪个行以及哪个超全局实际存在。在确定超全局时,我始终牢记环境,获取,发布,Cookie和服务器的顺序,以确定哪个优先。

对于我们整洁的小技巧的下一部分,我们必须遍历发现undefined variable通知的所有文件,并尝试用其超全局对应替换未定义的变量。这实际上也很简单,我再次创建了一个脚本:

#!/usr/bin/php
<?php
/**
 * A simple script to replace non globals with their globals counterpart.
 */
$script = array_shift( $argv );

$logfile = array_shift( $argv );

$backup = array_shift( $argv ) === '--backup';

if( $logfile === false || !is_file( $logfile ) || !is_readable( $logfile ) ) {
    print "Usage: php $script <logfile> [--backup].\n";
    exit;
}

$globals = require $logfile;

if( !is_array( $globals ) || count( $globals ) === 0 ) {
    print "No superglobals missing found, nothing to do here.\n";
    exit;
}

$replaced = 0;

/**
 * So we have the files where superglobals are missing, but shouldn't be.
 * Loop through the files.
 */
foreach( $globals as $filename => $variables ) {
    if( !is_file( $filename ) || !is_writable( $filename ) ) {
        print "Can't write to file $filename.\n";
        exit;
    }

    foreach( $variables as $variable ) {
        $lines[$variable[2]] = $variable;
    }

    /**
     * We can write to the file. Read it in, line by line,
     * and see if there's anything to do on that line.
     */
    $fp = fopen( $filename, 'rw+' );
    $i = 0;
    $buffer = '';
    while( $line = fgets( $fp, 1000 ) ) {
        ++$i;
        if( array_key_exists( $i, $lines ) ) {
            $search = sprintf( '$%s', $lines[$i][0] );
            $replace = sprintf( "\$_%s['%s']", $lines[$i][1], $lines[$i][0] );
            $line = str_replace( $search, $replace, $line );
            $replaced ++;
        }
        $buffer .= $line;
    }

    if( $backup ) {
        $backupfile = $filename . '.bck';
        file_put_contents( $backupfile, file_get_contents( $filename ) );
    }

    file_put_contents( $filename, $buffer );
}

echo "Executed $replaced replacements.\n";
unlink( $logfile );

现在,只需调用此脚本即可。我已经测试了这个,这是我用它测试过的文件:

<?php

require 'logger.php';

$_GET['foo'] = 'This is a value';
$_POST['foo'] = 'This is a value';

$_GET['bar'] = 'test';

function foo( ) {
    echo $foo;
}

foo( );

echo $bar;

有两个未定义的变量($foo$bar),它们都存在于一个(或多个)超全球中。在浏览器中访问该页面后,我的日志文件undefined.php中有两个条目;即foo和bar。然后,我运行了命令php globalsfix.php undefined.php --backup,它给了我以下输出:

berry@berry-pc:/www/public/globalfix% php globalsfix.php undefined.php --backup
Executed 2 replacements.

好奇结果是什么?嗯,我也是。这是:

<?php

require 'logger.php';

$_GET['foo'] = 'This is a value';
$_POST['foo'] = 'This is a value';

$_GET['bar'] = 'test';

function foo( ) {
    echo $_POST['foo'];
}

foo( );

echo $_GET['bar'];

<强>乌拉!没有更多未定义的变量,那些正在从正确的超全球中读取。 Big fat免责声明:首先创建备份。此外,这不会立即解决您的所有问题。如果你有一个if( $foo )语句,那么未定义的变量将确保永远不会执行相应的块,这意味着很可能不会一次性捕获所有未定义的变量(但它会在第二个或第三个上解决该问题)用这个脚本)。尽管如此;这是开始“清理”代码库的好地方。

另外,恭喜阅读我的全部答案。 :)