Checking if an instance's class implements an interface?
interface IInterface
{
}
class TheClass implements IInterface
{
}
$cls = new TheClass();
if ($cls instanceof IInterface) {
echo "yes";
}
You can use the "instanceof" operator. To use it, the left operand is a class instance and the right operand is an interface. It returns true if the object implements a particular interface.
As therefromhere points out, you can use class_implements()
. Just as with Reflection, this allows you to specify the class name as a string and doesn't require an instance of the class:
interface IInterface
{
}
class TheClass implements IInterface
{
}
$interfaces = class_implements('TheClass');
if (isset($interfaces['IInterface'])) {
echo "Yes!";
}
class_implements()
is part of the SPL extension.
See: http://php.net/manual/en/function.class-implements.php
Performance Tests
Some simple performance tests show the costs of each approach:
Given an instance of an object
Object construction outside the loop (100,000 iterations) ____________________________________________ | class_implements | Reflection | instanceOf | |------------------|------------|------------| | 140 ms | 290 ms | 35 ms | '--------------------------------------------' Object construction inside the loop (100,000 iterations) ____________________________________________ | class_implements | Reflection | instanceOf | |------------------|------------|------------| | 182 ms | 340 ms | 83 ms | Cheap Constructor | 431 ms | 607 ms | 338 ms | Expensive Constructor '--------------------------------------------'
Given only a class name
100,000 iterations ____________________________________________ | class_implements | Reflection | instanceOf | |------------------|------------|------------| | 149 ms | 295 ms | N/A | '--------------------------------------------'
Where the expensive __construct() is:
public function __construct() {
$tmp = array(
'foo' => 'bar',
'this' => 'that'
);
$in = in_array('those', $tmp);
}
These tests are based on this simple code.
nlaq points out that instanceof
can be used to test if the object is an instance of a class that implements an interface.
But instanceof
doesn't distinguish between a class type and an interface. You don't know if the object is a class that happens to be called IInterface
.
You can also use the reflection API in PHP to test this more specifically:
$class = new ReflectionClass('TheClass');
if ($class->implementsInterface('IInterface'))
{
print "Yep!\n";
}
See http://php.net/manual/en/book.reflection.php