Diese Seite bei php.net
The PHP manual text and comments are covered by the Creative Commons Attribution 3.0 License © the PHP Documentation Group - Impressum - mail("TO:Reinhard Neidl",...)
(PHP 4, PHP 5)
unset — Löschen einer angegebenen Variablen
unset() löscht die angegebene Variable.
Das Verhalten von unset() innerhalb einer Funktion kann abhängig davon, was für einen Variablentyp Sie zu löschen versuchen, variieren.
Wenn eine globalisierte Variable innerhalb einer Funktion mit unset() behandelt wird, wird nur die lokale Variable gelöscht. Die Variable innerhalb der aufrufenden Umgebung behält den selben Wert wie vor dem Aufruf von unset().
<?php
function destroy_foo()
{
global $foo;
unset($foo);
}
$foo = 'bar';
destroy_foo();
echo $foo;
?>
Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
bar
Um eine globale Variable innerhalb einer Funktion zu löschen, kann das $GLOBALS-Array verwendet werden:
<?php
function foo()
{
unset($GLOBALS['bar']);
}
$bar = "something";
foo();
?>
Wenn eine Variable, die als Referenz übergeben wird ("Passed by Reference"), innerhalb einer Funktion gelöscht wird, wird nur die lokale Variable gelöscht. Die Variable im aufrufenden Environment enthält den selben Wert wie vor dem Aufruf von unset().
<?php
function foo(&$bar)
{
unset($bar);
$bar = "blah";
}
$bar = 'something';
echo "$bar\n";
foo($bar);
echo "$bar\n";
?>
Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
something something
Wenn eine statische Variable innerhalb einer Funktion gelöscht wird, löscht unset() die Variable nur im Kontext des verbleibenden Funktionsablaufs. Die folgenden Aufrufe stellen den vorhergehenden Wert der Variablen wieder her.
<?php
function foo()
{
static $bar;
$bar++;
echo "Vor unset: $bar, ";
unset($bar);
$bar = 23;
echo "nach unset: $bar\n";
}
foo();
foo();
foo();
?>
Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
Vor unset: 1, nach unset: 23 Vor unset: 2, nach unset: 23 Vor unset: 3, nach unset: 23
Die zu löschende Variable.
Eine weitere Variable ...
Es wird kein Wert zurückgegeben.
| Version | Beschreibung |
|---|---|
| 4.0.1 | Unterstützung für multiple Argumente hinzugefügt. |
Beispiel #1 unset()-Beispiel
<?php
// löscht eine einzelne Variable
unset($foo);
// löscht ein einzelnes Element eines Arrays
unset($bar['quux']);
// löscht mehr als eine Variable
unset($foo1, $foo2, $foo3);
?>
Beispiel #2 Verwendung von (unset) Casting
<?php
$name = 'Felipe';
var_dump((unset) $name);
?>
Hinweis: Da dies ein Sprachkonstrukt und keine Funktion ist, können Sie dieses nicht mit Variablenfunktionen verwenden.
Hinweis:
Es ist möglich, sogar Objekteigenschaften zu löschen, die im aktuellen Kontext sichtbar sind.
Hinweis:
Es ist ab PHP 5 nicht mehr möglich, $this innerhalb einer Objektmethode zu löschen.
Hinweis:
Wenn unset() auf Objekteigenschaften angewendet wird, auf die nicht direkt zugegriffen werden kann, wird, sofern sie deklariert wurde, die Überladungsmethode __unset aufgerufen.
Warning!
When unset from an array, if you unset all elements, the array is always set
$tab=array('A'=>1,'B'=>2);
unset($tab['A']);
unset($tab['B']);
echo isset($tab)." ".count($tab);
output: 1 0
You can not unset a numeric key of an array, if key is a string. See this example:
// Create a simple array with 3 different key types
$test[1] = array(
10 => array('apples'),
"20" => array('bananas'),
'30' => array('peaches')
);
$test[2] = (array) json_decode(json_encode($test[1]));
$test[3] = (array) (object) $test[1];
// array form a stdClass object
$testClass = new stdClass();
$testClass->{10} = array('apples');
$testClass->{"20"} = array('bananas');
$test[4] = (array) $testClass[6];
echo "<pre>";
foreach($test as $testNum => $arr) {
echo "\nTest: " . $testNum . " \n";
var_dump($arr);
foreach($arr as $key => $fruit) {
echo "key: " . $key . "\n";
echo "key exists: ";
var_dump(array_key_exists(strval($key), $arr));
echo "typeof key is: " . gettype($key) . "\n";
unset($arr[$key]);
}
var_dump($arr);
echo "\n" . str_repeat("-", 80);
}
echo "</pre>";
And here is the output:
Test: 1
array(3) {
[10]=>
array(1) {
[0]=>
string(6) "apples"
}
[20]=>
array(1) {
[0]=>
string(7) "bananas"
}
[30]=>
array(1) {
[0]=>
string(7) "peaches"
}
}
key: 10
key exists: bool(true)
typeof key is: integer
key: 20
key exists: bool(true)
typeof key is: integer
key: 30
key exists: bool(true)
typeof key is: integer
array(0) {
}
--------------------------------------------------------------
Test: 2
array(3) {
["10"]=>
array(1) {
[0]=>
string(6) "apples"
}
["20"]=>
array(1) {
[0]=>
string(7) "bananas"
}
["30"]=>
array(1) {
[0]=>
string(7) "peaches"
}
}
key: 10
key exists: bool(false)
typeof key is: string
key: 20
key exists: bool(false)
typeof key is: string
key: 30
key exists: bool(false)
typeof key is: string
array(3) {
["10"]=>
array(1) {
[0]=>
string(6) "apples"
}
["20"]=>
array(1) {
[0]=>
string(7) "bananas"
}
["30"]=>
array(1) {
[0]=>
string(7) "peaches"
}
}
--------------------------------------------------------------
Test: 3
array(3) {
[10]=>
array(1) {
[0]=>
string(6) "apples"
}
[20]=>
array(1) {
[0]=>
string(7) "bananas"
}
[30]=>
array(1) {
[0]=>
string(7) "peaches"
}
}
key: 10
key exists: bool(true)
typeof key is: integer
key: 20
key exists: bool(true)
typeof key is: integer
key: 30
key exists: bool(true)
typeof key is: integer
array(0) {
}
--------------------------------------------------------------
Test: 4
array(2) {
["10"]=>
array(1) {
[0]=>
string(6) "apples"
}
["20"]=>
array(1) {
[0]=>
string(7) "bananas"
}
}
key: 10
key exists: bool(false)
typeof key is: string
key: 20
key exists: bool(false)
typeof key is: string
array(2) {
["10"]=>
array(1) {
[0]=>
string(6) "apples"
}
["20"]=>
array(1) {
[0]=>
string(7) "bananas"
}
}
--------------------------------------------------------------
Fix the problem with a rebuild of the array:
$oldArray = $array();
$array = array();
foreach($oldArray as $key => $item) {
$array[intval($key)] = $item;
}
A sample how to unset array elements from an array result coming from a mysql request. In this sample it is checking if a file exists and removes the row from the array if it not exists.
<?php
$db->set_query("select * from documents where document_in_user = 0"); //1
$documents = $db->result_to_array($db->get_result()); //1
foreach ($documents as $key => $row) { //2
$file = "uploads/".rawurldecode($row['document_name']);
if ( file_exists ( $file ) == FALSE ) {
unset($documents[$key]); //3
}
}
$documents = array_values($documents); // reindex the array (4)
?>
variables:
mysql table = documents,
array = $documents
array key (index) = $key
array row (record sort of speak) = $row
explanation:
1.
it gets the array from the table (mysql)
2.
foreach goes through the array $documents
3.
unset if record does not exist
4.
the array_values($documents) reindexes the $documents array, for otherwise you might end up in trouble when your process will start expecting an array starting with key ($key) 0 (zero).
further I realized that an object, when getting detroyed, does care about destroying variable in object space visibility but not those in local visibility, be aware of the found pattern:
<?php
class release_test{
private $buffer;
private $other_object;
public function __construct(){
$this->other_object=new other_object_class();
}
public function __destruct(){
//note that you always have to unset class objects, in order to get the resources released
unset($this->other_object);
}
public allocate_mem_A(){
$this->buffer=file("/tmp/bigfile");
}
public allocate_mem_B(){
$buffer=file("/tmp/bigfile");
}
public allocate_mem_C(){
$buffer=file("/tmp/bigfile");
unset($buffer);
}
public allocate_mem_D(){
$this->other_buffer=file("/tmp/bigfile");
}
}
//this does not lead to a resource problem
$A=new release_test();
$A->allocate_mem_A();
$A->__destruct();
unset($A);
//this DOES lead to a resource problem
$B=new release_test();
$B->allocate_mem_B();
$B->__destruct();
unset($B);
//this does not lead to a resource problem
$C=new release_test();
$C->allocate_mem_C();
$C->__destruct();
unset($C);
//this does not lead to a resource problem
$D=new release_test();
$D->allocate_mem_D();
$D->__destruct();
unset($D);
?>
unset($class_object) does not release resources allocated by the object. If used in loops, which create and destroy objects, that might easily lead to a resource problem. Explicitly call the destructor to circumvent the problem.
<?php
//this causes a resource problem
for($f=0;$f<10000;$f++){
$my_class_object=new my_class_name();
unset($my_class_object);
}
//this releases the resources allocate by the object
for($f=0;$f<10000;$f++){
$my_class_object=new my_class_name();
$my_class_object->__destruct();
unset($my_class_object);
}
?>
I have noticed that sometimes if you have a globally declared instantiation of a class, unsetting that instance does not always call destruct like you think it should.
For instance, something like this might actually call the destruct later than implied by the "unset":
<?php
class Data {
public function __destruct() {
echo "These are my last words...";
}
}
function main(){
$data = new Data;
one();
two();
}
function one ()
{
global $data;
echo "Running 1st";
unset($data);
}
function two()
{
echo "Running 2nd";
}
main();
//"Running 1stRunning 2ndThese are my last words..."
?>
Note that PHP 4 will generate a warning if you try to unset an array index that doesn't exist and whose parent doesn't exist.
Example:
<?php
$foo = array();
unset($foo['Bar']['Baz']);
?>
RESULT: "Notice: Undefined index: Bar"
On PHP5 no error is raised, which seems to me like the correct behaviour.
Note that using unset($foo['Bar']) in the above example does not generate a warning in either version.
(Tested on 4.4.9 and 5.2.4)
A quick note on (unset) vs unset().
<?php
$a="test";
unset($a);
var_dump($a);
?>
will return
Notice: Undefined variable: a
NULL
<?php
$a="test";
var_dump((unset) $a);
?>
will return
NULL
When using unset() php will throw an E_NOTICE if you try and access the variable after it has been unset, (unset) won't.
This has been tested in PHP 5.3.0
Here's a simple function to remove a variable from an HTTP Query String:
<?php
function unset_query_string_var($varname,$query_string) {
$query_array = array();
parse_str($query_string,$query_array);
unset($query_array[$varname]);
$query_string = http_build_query($query_array);
return $query_string;
}
?>
----------------------------
Example Usage #1:
Let's say you want to remove the variable "fruit" from $page_url below...
<?php
$page_url = "http://www.example.com/script.php?fruit=apple&color=red";
$url_data = parse_url($page_url);
$query_string = unset_query_string_var("fruit",$url_data['query']);
$page_url_new = $url_data['scheme'].'://'.$url_data['host'].$url_data['path'];
if (!empty($query_string)) $page_url_new .= '?'.$query_string;
$page_url_new .= $url_data['fragment'];
print $page_url_new;
?>
Output:
http://www.example.com/script.php?color=red
----------------------------
Example Usage #2:
To remove the variable "q" from the query string of the current page, try something like...
<?php
$page_url = 'http://'.$_SERVER["SERVER_NAME"].$_SERVER['PHP_SELF'];
$query_string = unset_query_string_var("q",$_SERVER["QUERY_STRING"]);
if (!empty($query_string)) $page_url .= '?'.$query_string;
?>
Two ways of unsetting values within an array:
<?php
# remove by key:
function array_remove_key ()
{
$args = func_get_args();
return array_diff_key($args[0],array_flip(array_slice($args,1)));
}
# remove by value:
function array_remove_value ()
{
$args = func_get_args();
return array_diff($args[0],array_slice($args,1));
}
$fruit_inventory = array(
'apples' => 52,
'bananas' => 78,
'peaches' => 'out of season',
'pears' => 'out of season',
'oranges' => 'no longer sold',
'carrots' => 15,
'beets' => 15,
);
echo "<pre>Original Array:\n",
print_r($fruit_inventory,TRUE),
'</pre>';
# For example, beets and carrots are not fruits...
$fruit_inventory = array_remove_key($fruit_inventory,
"beets",
"carrots");
echo "<pre>Array after key removal:\n",
print_r($fruit_inventory,TRUE),
'</pre>';
# Let's also remove 'out of season' and 'no longer sold' fruit...
$fruit_inventory = array_remove_value($fruit_inventory,
"out of season",
"no longer sold");
echo "<pre>Array after value removal:\n",
print_r($fruit_inventory,TRUE),
'</pre>';
?>
about unset for arrays
if you unset the last array member
$ar[0]==2
$ar[1]==7
$ar[2]==9
unset ($ar[2])
after addition a new member by $ar[]=7,
you will get
$ar[0]==2
$ar[1]==7
$ar[3]==7,
So, unset has no effect to internal array counter!!!
"It is possible to unset even object properties visible in current context"
Although the note is clear, in my case it required a little example to grasp its full impact:
If your object uses overloaded properties (using the "__set()" magic method) and you unset one of your "real" properties, the "__set()" method will take over if you try to assign a value to this property again.
In most cases, the "__set()" method is very much limited in the properties it can set. In my case, I only allow "__set()" to change a limited, predefined, set of properties. Most of them through their "public" name instead of their actual name...
This generates a somewhat counter-intuitive situation: If you unset a variable, you expect its value to become "null", which remains true. You also expect to be able to set it again to another value.
In the example described above this is not the case: The "__get()" method is invoked and, in my case, doesn't allow the property to be set again!
unset() does just what it's name says - unset a variable. It does not force immediate memory freeing. PHP's garbage collector will do it when it see fits - by intention as soon, as those CPU cycles aren't needed anyway, or as late as before the script would run out of memory, whatever occurs first.
If you are doing $whatever = null; then you are rewriting variable's data. You might get memory freed / shrunk faster, but it may steal CPU cycles from the code that truly needs them sooner, resulting in a longer overall execution time.
if you try to unset an object, please be careful about references.
Objects will only free their resources and trigger their __destruct method when *all* references are unsetted.
Even when they are *in* the object... sigh!
<?php
class A {
function __destruct() {
echo "cYa later!!\n";
}
}
$a = new A();
$a -> a = $a;
#unset($a); # Just uncomment, and you'll see
echo "No Message ... hm, what now?\n";
unset($a -> a);
unset($a);
echo "Finally that thing is gone\n";
?>
Of course the object completely dies at the end of the script.
Sometimes you need to assigne values to an array index in some loop (if, while, foreach etc.) but you wish to set starting index key to some number greater then zero (lets say 5). One idea how to do this is:
<?php
$values = array(5, 10, 15, 100); //array of values that we wish to add to our new array
$myArray = array(4=>0); //sets starting key to be 4 and assigns some value (lets say 0)
unset($myArray[4]); //delete this index key, but preserves further enumeration
foreach($values as $value){
$myArray[] = $value; //asign values to our array
}
print_r($myArray);
/* Output:
Array ( [5] => 5 [6] => 10 [7] => 15 [8] => 100 )
*/
?>
Here's my variation on the slightly dull unset method. It throws in a bit of 80's Stallone action spice into the mix. Enjoy!
<?php
/**
* function rambo (first blood)
*
* Completely and utterly destroys everything, returning the kill count of victims
*
* @param It don't matter, it’s Rambo baby
* @return Integer Body count (but any less than 500 and it's not really worth mentioning)
*/
function rambo() {
// Get the victims and initiate that body count status
$victims = func_get_args();
$body_count = 0;
// Kill those damn punks
foreach($victims as $victim) {
if($death_and_suffering = @unset($victim)) {
$body_count++;
}
}
// How many kills did Rambo tally up on this mission?
return($body_count);
}
?>
Since unset() is a language construct, it cannot be passed anything other than a variable. It's sole purpose is to "unset" this variable, ie. to remove it from the current scope and destroy it's associated data. This is true especially for reference variables, where not the actual value is destroyed but the reference to that value. This is why you can't wrap 'unset()' in a user defined function: You would either unset a copy of the data if the parameter is passed by value, or you would just unset the reference variable within the functions scope if the parameter is passed by reference. There is no workaround for that, as you cannot pass 'scope' to a function in PHP. Such a function can only work for variables that exist in a common or global scope (compare 'unset($_GLOBALS[variable])').
I don't know how PHP handles garbage collection internally, but I guess this behavior can result in a huge memory leak: if a value variable goes out of scope with a second variable still holding a reference to the in-memory value, then unsetting that reference would still hold the value in memory but potentially unset the last reference to that in-memory data, hence: occupied memory that is rendered useless as you cannot reference it anymore.
>> shame, but it doesn't seem to pop the stack.
There is a simple solution to that. Delete the value, then use array_merge() on your array:
<?php $folders= array_merge($folders) ; ?>
Note that since unset() returns void, you can't do this:
isset($some_var) && unset($some_var);
You'll get: Parse error: syntax error, unexpected T_UNSET in ...
The reason is because it would parse as
<bool> && <void>;
which is not a valid PHP statement.
Thus, the only alternative is to actually use if statement.
Quote from http://fr.php.net/session_unset
"Do NOT unset the whole $_SESSION with unset($_SESSION) as this will disable the registering of session variables through the $_SESSION superglobal."
So basically don't do:
unset($_SESSION)
Instead do:
$_SESSION = array();
In regard to some confusion earlier in these notes about what causes unset() to trigger notices when unsetting variables that don't exist....
Unsetting variables that don't exist, as in
<?php
unset($undefinedVariable);
?>
does not trigger an "Undefined variable" notice. But
<?php
unset($undefinedArray[$undefinedKey]);
?>
triggers two notices, because this code is for unsetting an element of an array; neither $undefinedArray nor $undefinedKey are themselves being unset, they're merely being used to locate what should be unset. After all, if they did exist, you'd still expect them to both be around afterwards. You would NOT want your entire array to disappear just because you unset() one of its elements!
The main difference between <?php unset($var);?> and <?php $var = null;?> is, that unset() will reset the state to $var to something like "not set at all".
<?php
// register_globals = Off
error_reporting(E_ALL);
echo $var; // Notice
$var = null;
echo $var; // Nothing
unset($var);
echo $var; // Notice
?>
Regarding the 14-May-2007 note from anonymous:
As far as array elements go, unset() is really only useful for removing named keys. For numeric keys, you can use array_splice to "unset" the element.
<?php
$a = array(
'foo' => array('a', 'b', 'c'),
'bar' => array('d', 'e', 'f')
);
print_r($a);
array_splice($a['foo'], 1, 1);
print_r($a);
unset($a['foo']);
print_r($a);
?>
It is observed on PHP 5.1.6 that <?php unset($this); ?> inside of a method will remove the reference to $this in that method. $this isn't considered "special" as far as unset() is concerned.
shame, but it doesn't seem to pop the stack.
Array( [1\=>1
[2\=>2
[3\=>3
)
then unset($array[2\)
results in:
Array( [1\=>1
[3\=>3
)
not
Array( [1\=>1
[2\=>3
)
Shame really
If you want to remove a value from an array, then there is no direct mechanism.
The following function uses the array_keys() function to find the key(s) of the value that you want to remove and then removes the elements for that key.
I've also given some examples and the output.
<?php
/**
* array array_remove ( array input, mixed search_value [, bool strict] )
**/
function array_remove(array &$a_Input, $m_SearchValue, $b_Strict = False) {
$a_Keys = array_keys($a_Input, $m_SearchValue, $b_Strict);
foreach($a_Keys as $s_Key) {
unset($a_Input[$s_Key]);
}
return $a_Input;
}
?>
Beside scalar variables (integers, floats, strings, boolean), you can also use arrays as the values you want to remove.
<?php
// Results in array(8, 8.0, '8', '8.0')
array_remove(array(8, 8.0, '8', '8.0', array(8), array('8')), array(8));
// Results in array(8, 8.0, '8', '8.0', array('8'))
array_remove(array(8, 8.0, '8', '8.0', array(8), array('8')), array(8), True);
?>
Just to confirm, USING UNSET CAN DESTROY AN ENTIRE ARRAY. I couldn't find reference to this anywhere so I decided to write this.
The difference between using unset and using $myarray=array(); to unset is that obviously the array will just be overwritten and will still exist.
<?php
$myarray=array("Hello","World");
echo $myarray[0].$myarray[1];
unset($myarray);
//$myarray=array();
echo $myarray[0].$myarray[1];
echo $myarray;
?>
Output with unset is:
<?
HelloWorld
Notice: Undefined offset: 0 in C:\webpages\dainsider\myarray.php on line 10
Notice: Undefined offset: 1 in C:\webpages\dainsider\myarray.php on line 10
Output with $myarray=array(); is:
?>
<?
HelloWorld
Notice: Undefined offset: 0 in C:\webpages\dainsider\myarray.php on line 10
Notice: Undefined offset: 1 in C:\webpages\dainsider\myarray.php on line 10
Array
?>
To clarify what hugo dot dworak at gmail dot com said about unsetting things that aren't already set:
unsetting a non-existent key within an array does NOT throw an error.
<?
$array = array();
unset($array[2]);
//this does not throw an error
unset($array[$undefinedVar]);
//Throws an error because of the undefined variable, not because of a non-existent key.
?>
Instead of using the unset function for unregistering your session or other array values you can also do this samll feature and get this task done with just 1 line code.
Suppose, if you like to unregister your session store values.
You can use:
$_SESSION = array();
Well this syntax saves lot's of time instead of unsetting each values.
If one tries to unset a typical variable that does not exist, no errors, warning or noticies will occur. However, if one tries to unset a non-existent array or an array with non-existent key, this will result in a notice. For instance:
<?php
$true = true;
$array = array ();
unset ($true, $undefinedVariable, $array [$undefinedKey], $undefinedArray [$undefinedKey]);
?>
The output is (PHP 5.0.5):
Notice: Undefined variable: undefinedKey
Notice: Undefined variable: undefinedKey
Notice: Undefined variable: undefinedArray
In PHP 5.0.4, at least, one CAN unset array elements inside functions from arrays passed by reference to the function.
As implied by the manual, however, one can't unset the entire array by passing it by reference.
<?php
function remove_variable (&$variable) // pass variable by reference
{
unset($variable);
}
function remove_element (&$array, $key) // pass array by reference
{
unset($array[$key]);
}
$scalar = 'Hello, there';
echo 'Value of $scalar is: ';
print_r ($scalar); echo '<br />';
// Value of $scalar is: Hello, there
remove_variable($scalar); // try to unset the variable
echo 'Value of $scalar is: ';
print_r ($scalar); echo '<br />';
// Value of $scalar is: Hello, there
$array = array('one' => 1, 'two' => 2, 'three' => 3);
echo 'Value of $array is: ';
print_r ($array); echo '<br />';
// Value of $array is: Array ( [one] => 1 [two] => 2 [three] => 3 )
remove_variable($array); // try to unset the array
echo 'Value of $array is: ';
print_r ($array); echo '<br />';
// Value of $array is: Array ( [one] => 1 [two] => 2 [three] => 3 )
remove_element($array, 'two'); // successfully remove an element from the array
echo 'Value of $array is: ';
print_r ($array); echo '<br />';
// Value of $array is: Array ( [one] => 1 [three] => 3 )
?>
In addition to what timo dot hummel at 4fb dot de said;
>For the curious: unset also frees memory of the variable used.
>
>It might be possible that the in-memory size of the PHP Interpreter isn't reduced, but your scripts won't touch the memory_limit boundary. Memory is reused if you declare new variables.
It might be worth adding that functions apparently don't free up memory on exit the same way unset does..
Maybe this is common knowledge, but although functions destroys variables on exit, it (apparently) doesn't help the memory.
So if you use huge variables inside functions, be sure to unset them if you can before returning from the function.
In my case, if I did not unset before return, then the script would use 20 MB more of memory than if I did unset.
This was tested with php 5.0.4 on apache 2 on windows xp, with no memory limit.
Before I did the test, I was under the impression that when you exit from functions, the memory used inside it would be cleared and reused. Maybe this should be made clear in the manual, for either unset() or in the chapter for functions.
when working with $_SESSION or any other array like that and you want to delete part of the session array it's always worked for me to do:
$_SESSION['data'] = NULL;
unset($_SESSION['data']);
We have experienced when we applied 'unset' to the overloaded properties (PHP5), consider the code below:
<?php
class TheObj {
public $RealVar1, $RealVar2, $RealVar3, $RealVar4;
public $Var = array();
function __set($var, $val) {
$this->Var[$var] = $val;
}
function __get($var) {
if(isset($this->Var[$var])) return $this->Var[$var];
else return -1;
}
}
$SomeObj = new TheObj;
// here we set for real variables
$SomeObj->RealVar1 = 'somevalue';
$SomeObj->{'RealVar2'} = 'othervalue';
$SomeObj->{'RealVar'.(3)} = 'othervaluetoo';
$SomeObj->{'RealVar'.'4'} = 'anothervalue';
// and here we set for virtual variables
$SomeObj->Virtual1 = 'somevalue';
$SomeObj->{'Virtual2'} = 'othervalue';
$SomeObj->{'Virtual'.(3)} = 'othervaluetoo';
$SomeObj->{'Virtual'.'4'} = 'anothervalue';
// now we will try to unset these variables
unset($SomeObj->RealVar1);
unset($SomeObj->{'RealVar'.(3)});
//the lines below will catch by '__get' magic method since these variables are unavailable anymore
print $SomeObj->RealVar1."\n";
print $SomeObj->{'RealVar'.(3)}."\n";
// now we will try to unset these variables
unset($SomeObj->Virtual1);
unset($SomeObj->{'Virtual'.(3)});
//but, these variables are still available??? eventhough they're "unset"-ed
print $SomeObj->Virtual1."\n";
print $SomeObj->{'Virtual'.(3)}."\n";
?>
Please note that PHP doesn't have magic callback to unset overloaded properties. This is the reason why unset($SomeObj->Virtual1) doesn't work.
But it does work when we set 'null' value such as the following code:
<?php
// now we will set 'null' value instead of using unset statement
$SomeObj->Virtual1 = null;
$SomeObj->{'Virtual'.(3)} = null;
// and now these variables are no longer available
print $SomeObj->Virtual1."\n";
print $SomeObj->{'Virtual'.(3)}."\n";
?>
Sound ugly, yeah?
This applied to the "virtual" array variable too, see more at http://bugs.php.net/bug.php?id=33513 (at feedback) about it.
PS: we used PHP version 5.1.0-dev from the CVS snapshot when we wrote the above codes.
Here is another way to make 'unset' work with session variables from within a function :
<?php
function unsetSessionVariable ($sessionVariableName) {
unset($GLOBALS[_SESSION][$sessionVariableName]);
}
?>
May it work with others than me...
F.
usefull tip:
if you have session variables like these.
<?php
echo "<pre>";
$_SESSION["num"] = array(1,2,3,4);
var_dump($_SESSION);
echo "-<br>";
unset($_SESSION);
var_dump($_SESSION);
?>
gives out:
array(1) {
["num"]=>
array(4) {
[0]=>
int(1)
[1]=>
int(2)
[2]=>
int(3)
[3]=>
int(4)
}
}
-
NULL
if you use empty instead unset you get same output as first var_dump($_SESSION) gives.
I hope help sb.
I saw this mentioned somewhere else but if you do
$var = NULL
then I've noticed less memory usuage than with unset(). In fact, unset didn't do anything.
This might be useful if you're doing a php-gtk app, thats starting to consume significant memory over a long period of time. This was the code I used to test
// Check memory before here
for($i = 0; $i < 100; $i++)
{
$dialog = &new GtkDialog();
$dialog->realize();
$dialog->destroy();
$dialog = NULL;
//unset($dialog);
}
// Check memory after here
Doing a difference between after and before results in:
Using destroy() and unset() -> ~31kb
Using $dialog = NULL -> ~13 kb
The expected memory usuage should be 0kb or around there.
If you ever have to unset all the variables of a class from within a funciton of that class use the following code:
<?php
class User
{
function User_login ( ... )
{...}
function User_logout ( $greeting )
{
...
foreach ( array_keys ( get_object_vars ( &$this ) ) as $val)
{ unset( $this->$val ); }
$this->greeting = $greeting;
...
}
}
?>
If anyone knows of a more effective way please post a reply.
If you want to remove one element of Query String use this function, than place the returned values in <a href="script.php?'. remove_query("arg1") .'">
function remove_query($key) {
$arrquery = explode("&", $_SERVER["QUERY_STRING"]);
foreach ($arrquery as $query_value) {
$valor = substr($query_value, strpos($query_value, "=") + 1);
$chave = substr($query_value, 0, strpos($query_value, "="));
$querystring[$chave] = $valor;
}
unset($querystring[$key]);
foreach ($querystring as $query_key => $query_value) {
$query[] = "{$query_key}={$query_value}";
}
$query = implode("&", $query);
return $query;
}
dh at argosign dot de -
it is possible to unset globals from within functions thanks to the $GLOBALS array:
<?php
$x = 10;
function test() {
// don't need to do ' global $x; '
unset ($GLOBALS['x']);
echo 'x: ' . $GLOBALS['x'] . '<br />';
}
test();
echo "x: $x<br />";
// will result in
/*
x:
x:
*/
?>
For the curious: unset also frees memory of the variable used.
It might be possible that the in-memory size of the PHP Interpreter isn't reduced, but your scripts won't touch the memory_limit boundary. Memory is reused if you declare new variables.
The documentation is not entirely clear when it comes to static variables. It says:
If a static variable is unset() inside of a function, unset() destroys the variable and all its references.
<?php
function foo()
{
static $a;
$a++;
echo "$a\n";
unset($a);
}
foo();
foo();
foo();
?>
The above example would output:
1
2
3
And it does! But the variable is NOT deleted, that's why the value keeps on increasing, otherwise the output would be:
1
1
1
The references are destroyed within the function, this handeling is the same as with global variables, the difference is a static variable is a local variable.
Be carefull using unset and static values as the output may not be what you expect it to be. It appears to be impossible to destroy a static variable. You can only destroy the references within the current executing function, a successive static statement will restore the references.
The documentation would be better if it would say:
"If a static variable is unset() inside of a function, unset() destroys all references to the variable. "
Example: (tested PHP 4.3.7)
<?php
function foo()
{
static $a;
$a++;
echo "$a\n";
unset($a);
echo "$a\n";
static $a;
echo "$a\n";
}
foo();
foo();
foo();
?>
Would output:
1
1
2
2
3
3
Adding on to what bond at noellebond dot com said, if you want to remove an index from the end of the array, if you use unset, the next index value will still be what it would have been.
Eg you have
<?php
$x = array(1, 2);
for ($i = 0; $i < 5; $i++)
{
unset($x[(count($x)-1)]); //remove last set key in the array
$x[] = $i;
}
?>
You would expect:
Array([0] => 1, [1] => 4)
as you want it to remove the last set key....
but you actually get
Array ( [0] => 1 [4] => 2 [5] => 3 [6] => 4 )
This is since even though the last key is removed, the auto indexing still keeps its previous value.
The only time where this would not seem right is when you remove a value off the end. I guess different people would want it different ways.
The way around this is to use array_pop() instead of unset() as array_pop() refreshes the autoindexing thing for the array.
<?php
$x = array(1, 2);
for ($i = 0; $i < 5; $i++)
{
array_pop($x); // removes the last item in the array
$x[] = $i;
}
?>
This returns the expected value of x = Array([0] => 1, [1] => 4);
Hope this helps someone who may need this for some odd reason, I did.
Note that though global arrays will not be altered by a function, an array in an object WILL be altered if referenced within one of its methods. For example:
function remove_index ($i)
{
unset($this->test_array[$i]);
$temp_array = array_values($this->test_array);
$this->test_array = $temp_array;
}
Will remove key $i from the object's array and reindex it.
Only This works with register_globals being 'ON'.
unset( $_SESSION['variable'] );
The above will not work with register_globals turned on (will only work outside of a function).
$variable = $_SESSION['variable'];
unset( $_SESSION['variable'], $variable );
The above will work with register_globals on & inside a function
you may wan't to unset all variables which are defined, here's one way:
<?php
function unset_all_vars($a)
{ foreach($a as $key => $val)
{ unset($GLOBALS[$key]); }
return serialize($a); }
unset_all_vars(get_defined_vars());
?>
you can also save than a serialized var of the "memory" and perhaps store this in a temporary file.. very usefull if you work with text files and/or file uploads when you've got very large variables.
greetz
As of PHP version 4.3.3, unset() results in a parse error if it is used with the @ error suppression operator.
For example:
@unset($var); // parse error
unset(@$var); // parse error
unset($var); // okay
Use array_values() after unset() to reindex your array.
Note that unset() removes the index as a key, you will need to reindex your array again to get expected behavior
for what it's worth...
in php 4.1, using unset to destroy a session variable, i.e. unset($_SESSION['variable']); destroys it by erasing variable information but leaves behind the variable name appended with a '!' in front of the name in the session file... leaving the session file larger and x bytes wasted depending on the variable name length
Diese Seite bei php.net