Can't access global variable inside function

PhpVariablesScopeGlobal Variables

Php Problem Overview


This (simplified version of my code) doesn't work:

<?php
    $sxml = new SimpleXMLElement('<somexml/>');

    function foo(){
	    $child = $sxml->addChild('child');
    }

    foo();
?>

Why? I want to access $sxml because I want to log errors on it if foo() fails. foo() calls itself recursively to create a directory listing, so I fear passing the whole $sxml onto itself (as in foo($sxml)) could hurt performance.

Is there a way to access $sxml inside $foo without passing it as an argument? (PHP 5.2.x+)

EDIT: What if the code looks like this, actually?

<?php
    bar(){
        $sxml = new SimpleXMLElement('<somexml/>');
        function foo(){
            $child = $sxml->addChild('child');
        }
        foo();
    }
    bar();
?>

Php Solutions


Solution 1 - Php

You have to pass it to the function:

<?php
    $sxml = new SimpleXMLElement('<somexml/>');

    function foo($sxml){
        $child = $sxml->addChild('child');
    }

    foo($sxml);
?>

or declare it global:

<?php
    $sxml = new SimpleXMLElement('<somexml/>');

    function foo(){
        global $sxml;
        $child = $sxml->addChild('child');
    }

    foo();
?>

If the variable isn't global but is instead defined in an outer function, the first option (passing as an argument) works just the same:

<?php
    function bar() {
        $sxml = new SimpleXMLElement('<somexml/>');
        function foo($sxml) {
            $child = $sxml->addChild('child');
        }
        foo($sxml);
    }
    bar();
?>

Alternatively, create a closure by declaring the variable in a use clause.

<?php
    function bar() {
        $sxml = new SimpleXMLElement('<somexml/>');
        function foo() use(&$xml) {
            $child = $sxml->addChild('child');
        }
        foo();
    }
    bar();
?>

Solution 2 - Php

You need to explicitly invite the global variable into the functions scope:

function foo(){
    global $sxml;
    $child = $sxml->addChild('child');
}

Solution 3 - Php

Use the global keyword to declare $sxml inside your function.

<?php
    $sxml = new SimpleXMLElement('<somexml/>');
    function foo(){
    global   $sxml;  
    $child = $sxml->addChild('child');
    }
    foo();
?>

Solution 4 - Php

another solution is to use $GLOBALS while you declare that variable:

         $my_var   = 'blabla';    // not global
$GLOBALS['my_var'] = 'blabla';    // global  (correct)

Solution 5 - Php

While the top answer provides a nice solution, I'd like to argue that the appropriate solution in most modern PHP applications is to create a class with a static variable, like so:

<?php

class xmlHelper {
	private static $sxml;

	public function getXML() {
		return self::$sxml;
	}

	public function setXML($xml) {
		self::$sxml = $xml;
	}
}

xmlHelper::setXML(new SimpleXMLElement('<somexml/>'));

function foo(){
    $child = xmlHelper::getXML()->addChild('child');
}

foo();

This approach allows you to access $sxml from within foo() just like you wanted, but it has a few advantages over the global approach.

  1. With this strategy, you will always be able to put a breakpoint inside setXML() to find out what part of your application has manipulated this value, which you cannot do when manipulating globals.
  2. You avoid polluting the global namespace with a generic variable name sxml.

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionCamilo MartinView Question on Stackoverflow
Solution 1 - PhpJavi RView Answer on Stackoverflow
Solution 2 - PhpmarioView Answer on Stackoverflow
Solution 3 - PhpShamim Hafiz - MSFTView Answer on Stackoverflow
Solution 4 - PhpT.ToduaView Answer on Stackoverflow
Solution 5 - PhpMatt KorostoffView Answer on Stackoverflow