According to my tests, isset() is 4 times faster than property_exists(), so use a combination of these functions in your programming for best performance.
For example:
<?php
$fld = 'somevar';
if (isset($this->$fld) || property_exists($this, $fld)) {
}
?>
If your programming routinely checks a larger number of property names that are expected to exist, whereas a smaller number may not, then using isset(), as above, will result in faster execution of the programming.
property_exists
(PHP 5 >= 5.1.0)
property_exists — Checks if the object or class has a property
Description
This function checks if the given property exists in
the specified class.
Note:
As opposed with isset(), property_exists() returns
TRUEeven if the property has the valueNULL.
Parameters
-
class -
The class name or an object of the class to test for
-
property -
The name of the property
Return Values
Returns TRUE if the property exists, FALSE if it doesn't exist or
NULL in case of an error.
Notes
Note:
Using this function will use any registered autoloaders if the class is not already known.
Note:
The property_exists() function cannot detect properties that are magically accessible using the __get magic method.
Changelog
| Version | Description |
|---|---|
| 5.3.0 | This function checks the existence of a property independent of accessibility. |
Examples
Example #1 A property_exists() example
<?php
class myClass {
public $mine;
private $xpto;
static protected $test;
static function test() {
var_dump(property_exists('myClass', 'xpto')); //true
}
}
var_dump(property_exists('myClass', 'mine')); //true
var_dump(property_exists(new myClass, 'mine')); //true
var_dump(property_exists('myClass', 'xpto')); //true, as of PHP 5.3.0
var_dump(property_exists('myClass', 'bar')); //false
var_dump(property_exists('myClass', 'test')); //true, as of PHP 5.3.0
myClass::test();
?>
To check the existance of a property from outside the scope (even if it's not accessible) try/consider the following:
<?php
function property_exists_safe($class, $prop)
{
$r = property_exists($class, $prop);
if (!$r) {
$x = new ReflectionClass($class);
$r = $x->hasProperty($prop);
}
return $r;
}
class myClass {
public $mine;
private $xpto;
static function test1() {
// true, it can be accessed from here
var_dump(property_exists('myClass', 'xpto'));
}
static function test2() {
// true, it can be accessed from everywhere!
var_dump(property_exists_safe('myClass', 'xpto'));
}
}
var_dump(property_exists('myClass', 'mine')); //true
var_dump(property_exists(new myClass, 'mine')); //true
var_dump(property_exists('myClass', 'xpto')); //false, isn't public
myClass::test1();
echo("\n");
var_dump(property_exists_safe('myClass', 'mine')); //true
var_dump(property_exists_safe(new myClass, 'mine')); //true
var_dump(property_exists_safe('myClass', 'xpto')); //true
myClass::test2(); //true
?>
bool(true)
bool(true)
bool(false)
bool(true)
bool(true)
bool(true)
bool(true)
bool(true)
This function is case-sensitive, so :
<?php
class Test {
public $property;
public foo() { echo($property); }
}
property_exists('Test', 'property'); // will return true
property_exists('Test', 'Property'); // will return false
?>
(under PHP5.1.2)
The documentation leaves out the important case of new properties you add to objects at run time. In fact, property_exists will return true if you ask it about such properties.
<?php
class Y {}
$y = new Y;
echo isset( $y->prop ) ? "yes\\n" : "no\\n"; // no;
echo property_exists( 'Y', 'prop' ) ? "yes\\n" : "no\\n"; // no
echo property_exists( $y, 'prop' ) ? "yes\\n" : "no\\n"; // no
$y->prop = null;
echo isset( $y->prop ) ? "yes\\n" : "no\\n"; // no;
echo property_exists( 'Y', 'prop' ) ? "yes\\n" : "no\\n"; // no
echo property_exists( $y, 'prop' ) ? "yes\\n" : "no\\n"; // yes
?>
I haven't tested this with the exact function semantics of 5.1, but this code should implement this function in php < 5.1:
<?php
if (!function_exists('property_exists')) {
function property_exists($class, $property) {
if (is_object($class))
$class = get_class($class);
return array_key_exists($property, get_class_vars($class));
}
}
?>
