is_a
(PHP 4 >= 4.2.0, PHP 5)
is_a — Checks if the object is of this class or has this class as one of its parents
Description
bool is_a
( object
$object
, string $class_name
[, bool $allow_string = FALSE
] )
Checks if the given object is of this class or has
this class as one of its parents.
Parameters
-
object -
The tested object
-
class_name -
The class name
-
allow_string -
If this parameter set to
FALSE, string class name asobjectis not allowed. This also prevents from calling autoloader if the class doesn't exist.
Return Values
Returns TRUE if the object is of this class or has this class as one of
its parents, FALSE otherwise.
Changelog
| Version | Description |
|---|---|
| 5.3.9 |
Added allow_string parameter
|
| 5.3.0 |
This function is no longer deprecated, and will therefore
no longer throw E_STRICT warnings.
|
| 5.0.0 |
This function became deprecated in favour of the
instanceof
operator. Calling this function will result in an
E_STRICT warning.
|
Examples
Example #1 is_a() example
<?php
// define a class
class WidgetFactory
{
var $oink = 'moo';
}
// create a new object
$WF = new WidgetFactory();
if (is_a($WF, 'WidgetFactory')) {
echo "yes, \$WF is still a WidgetFactory\n";
}
?>
Example #2 Using the instanceof operator in PHP 5
<?php
if ($WF instanceof WidgetFactory) {
echo 'Yes, $WF is a WidgetFactory';
}
?>
See Also
- get_class() - Returns the name of the class of an object
- get_parent_class() - Retrieves the parent class name for object or class
- is_subclass_of() - Checks if the object has this class as one of its parents
- PHP Руководство
- Функции по категориям
- Индекс функций
- Справочник функций
- Расширения, относящиеся к переменным и типам
- Функции работы с классами и объектами
- __autoload
- call_user_method_array
- call_user_method
- class_alias
- class_exists
- get_called_class
- get_class_methods
- get_class_vars
- get_class
- get_declared_classes
- get_declared_interfaces
- get_declared_traits
- get_object_vars
- get_parent_class
- interface_exists
- is_a
- is_subclass_of
- method_exists
- property_exists
- trait_exists
Коментарии
is_a returns TRUE for instances of children of the class.
For example:
class Animal
{}
class Dog extends Animal
{}
$test = new Dog();
In this example is_a($test, "Animal") would evaluate to TRUE as well as is_a($test, "Dog").
This seemed intuitive to me, but did not seem to be documented.
At least in PHP 5.1.6 this works as well with Interfaces.
<?php
interface test {
public function A();
}
class TestImplementor implements test {
public function A () {
print "A";
}
}
$testImpl = new TestImplementor();
var_dump(is_a($testImpl,'test'));
?>
will return true
Be careful! Starting in PHP 5.3.7 the behavior of is_a() has changed slightly: when calling is_a() with a first argument that is not an object, __autoload() is triggered!
In practice, this means that calling is_a('23', 'User'); will trigger __autoload() on "23". Previously, the above statement simply returned 'false'.
More info can be found here:
https://bugs.php.net/bug.php?id=55475
Whether this change is considered a bug and whether it will be reverted or kept in future versions is yet to be determined, but nevertheless it is how it is, for now...
As of PHP 5.3.9, is_a() seems to return false when passed a string for the first argument. Instead, use is_subclass_of() and, if necessary for your purposes, also check if the two arguments are equal, since is_subclass_of('foo', 'foo') will return false, while is_a('foo', 'foo') used to return true.Please note that you have to fully qualify the class name in the second parameter.
A use statement will not resolve namespace dependencies in that is_a() function.
<?php
namespace foo\bar;
class A {};
class B extends A {};
?>
<?php
namespace har\var;
use foo\bar\A;
$foo = new foo\bar\B();
is_a($foo, 'A'); // returns false;
is_a($foo, 'foo\bar\A'); // returns true;
?>
Just adding that note here because all examples are without namespaces.
Looks like the function signature given in description is wrong. Actually it can take a string as a first parameter in the case if $allow_string is set to true.
It took some time to find out how the last parameter should be used. Please consider the following example
<?php
class Foo{}
spl_autoload_register(
function($classname){
printf('autoload has been triggered for %s%s', $classname, PHP_EOL);
}
);
var_dump(is_a('UndefinedClassName', Foo::class, true));
?>
For anyone wondering, this does not work with traits :(