|
php.net | support | documentation | report a bug | advanced search | search howto | statistics | random bug | login |
[2007-02-23 17:59 UTC] Webbed dot Pete at gmail dot com
Description:
------------
Pass an unset array element by reference, without doing anything at all.
The passed array will gain an element.
(Note: We use isset() in our real function, which is what pointed us to the bug, but it is not necessary for demoing the defect.)
Reproduce code:
---------------
<?php
// NOP function with pass-by-reference (PBR) parameter
function refTest( &$param ) { }
// Do test with empty and non-empty arrays
$aEmpty = array(); $aOne = array( 'corn' );
// Initial state is fine
echo "<pre>BEFORE\n";
echo "aEmpty contains ".count($aEmpty)." element(s)\n",print_r( $aEmpty, TRUE ); echo "aOne contains ".count($aOne)." element(s)\n",print_r( $aOne, TRUE );
// Pass by reference modifies the arrays. (we use with 'isset()' and saw this; I've reduced to basic issue.)
$aEmpty = array(); $aOne = array( 'corn' );
refTest( $aEmpty['wheat'] ); refTest( $aOne['wheat'] );
echo "\nAFTER PASS BY REFERENCE\n";
echo "aEmpty contains ".count($aEmpty)." element(s)\n",print_r( $aEmpty, TRUE ); echo "aOne contains ".count($aOne)." element(s)\n",print_r( $aOne, TRUE );
?>
Expected result:
----------------
BEFORE
aEmpty contains 0 element(s)
Array
(
)
aOne contains 1 element(s)
Array
(
[0] => corn
)
[Same if you directly reference, or use isset() outside of a function, etc etc]
[If you don't pass by reference you get notice error so that is not a solution]
Actual result:
--------------
AFTER PASS BY REFERENCE
aEmpty contains 1 element(s)
Array
(
[wheat] =>
)
aOne contains 2 element(s)
Array
(
[0] => corn
[wheat] =>
)
PatchesPull RequestsHistoryAllCommentsChangesGit/SVN commits
|
|||||||||||||||||||||||||||||||||||||
Copyright © 2001-2025 The PHP GroupAll rights reserved. |
Last updated: Sat Nov 15 09:00:01 2025 UTC |
Even simpler: $x=&$aEmpty['wheat']; Adds element 'wheat' to the array. This creates a nasty side effect for a couple of valuable and common functions, which basically extend isset() for default values and so forth: function varset(&$val,$default='') { if (isset($val)) return $val; return $default; } function varsettrue(&$val,$default='') { if (isset($val) && $val) return $val; return $default; } $myVal = varset($pref['maxsize'],1000); // set myVal to pref or default NOTE: all of the following leave $aEmpty alone. I understand why this might be the case, yet it still is wrong to break references IMHO, not least because of losing ability to create functions like those above. $aEmpty['wheat']; // simple reference isset($aEmpty['wheat']); // built-in function myFunc($aEmpty['wheat']); // pass-by-value to user func<<<When you pass a non-existent variable by reference of course it HAS to be created, or what do you think should be referenced?>>> Funny thing is, passing a reference to a non-existent normal variable works fine. Only array elements require something to be created. If we accept this as a requirement, I believe we arrive at the following set of conclusions: What we're declarng here is that a) isset() is not identical to "is created". b) A php app has no way to discover if a variable is created. c) Array elements must be treated distinctly from other variables whenever the number of created keys is important. d) For array elements, key references must be carried separately from value references. Thus, to accomplish the equivalent of "isset() with default," without causing side effects, can still be accomplished with some pain. It requires separate functions for variables, constants and array elements. I believe the following patterns would be correct: function varset(&$val,$default='') { if (isset($val)) return $val; return $default; } function defset($str,$default='') { if (defined($str)) return constant($str); return $default; } function arrset(&$arr,$key,$default='') { if ( isset($arr) && is_array($arr) && array_key_exists($key,$arr) && isset($arr[$key]) ) return $val; return $default; } Corrections welcome. Thanks!Typo on function arrset(). Instead of ... return $val; it should be ... return $arr[$key];function foo(&$a) {} foo($a); // will "create" $a $b = new stdclass; foo($b->c); // will "create" the public property "c" $d = array(); foo($d['index']); // Will "create" the array index In each case, it will be assigned to null. Calling isset will return false because isset() returns false on variables assigned to NULL. However, there are other functions like array_key_exist() or property_exist() that are able to detect the NULL value. Conclusion: there is simply no solution to effectively emulate the isset() construct with default value using an user land function.If we require a single function, to *fully* emulate 'isset with default' (with only two parameters), colder@php.net is correct. A compromise is currently required involving separate functions or at least separate parameters that isolate potential array keys or object property names. The above emulations are effective userland emulations. Further emulations are also helpful, such as emulation of '(isset AND true) with default', which was noted in an earlier comment. This too can be emulated through a set of functions. It gets messy to do these workarounds, but the resulting application code is much cleaner. Instead of coding $x = (isset($var) && $var) ? $var : $default; $y = (isset($pref['key']) && $pref['key']) ? $pref['key'] : $default; one can code $x = varsettrue($var, $default); $y = arrsettrue($pref,'key',$default); by creating function varsettrue() as noted above, and now function arrsettrue($arr,$key,$default='') { if ( isset($arr) && is_array($arr) && array_key_exists($key,$arr) && isset($arr[$key]) && $arr[$key] ) return $arr[$key]; return $default; } The 'mess' is encapsulated in a set of userland functions. This frees coders to write well-protected code that never generates notices. Perhaps someday there can be built-in functions that accomplish all this, but for now at least we know there are effective (if slow/messy) workarounds. I now believe a single userland function may be possible; will think on that.Yes, a single userland function can take care of all but constants. Here is a robust workaround (if messy and/or slow) for the undocumented effect described in this bug report (i.e. that PHP creates array elements and object properties when pass-by-reference is used). // For PHP4 compatibility... if (!function_exists('property_exists')) { function property_exists($obj, $property) { return array_key_exists($property, get_object_vars($obj)); } } // Pass potentially undefined array keys and object property names separately else they get auto-created function varset(&$var,$param,$default='') { if (!isset($var)) return $default; if (is_scalar($var)) return $var; if (is_array($var)) return (array_key_exists($param,$var) && isset($var[$param])) ? $var[$param] : $default; if (is_object($var)) return (property_exists($var,$param) && isset($var->$param)) ? $var->$param : $default; die('varset used on NULL or resource'); } Notes: 1) I'll leave the argument to others over whether it is better to have a single function when scalars have no need for the second parameter. :) 2) varsettrue() is not replicated here; it simply adds "&& $var", "&& $var[$param]" or "&& $var->$param" to the end of each appropriate test. 3) This example highlights a small inconsistency between array_key_exists() and property_exists().