To declare a class that implements an interface, you include an implements clause in the class declaration. Your class can implement more than one interface, so the implements keyword is followed by a comma-separated list of the interfaces implemented by the class.
Put the cursor on the name of the interface and press F4 (Open Type Hierarchy). That will open a window that shows a tree with all classes that Eclipse can find that implement the interface.
With the aim to make the code robust, i would like to check that the class implements the interface before instantiation / casting. I would like the the keyword 'instanceof' to verify a class implements an interface, as i understand it, it only verifies class type.
The interface_exists() function checks if the interface has been defined. It returns TRUE if the interface given by name_of_interface has been defined, else FALSE is returned.
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
Some simple performance tests show the costs of each approach:
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 '--------------------------------------------'
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
Just to help future searches is_subclass_of is also a good variant (for PHP 5.3.7+):
if (is_subclass_of($my_class_instance, 'ISomeInterfaceName')){
echo 'I can do it!';
}
The is_a
function is missing here as alternative.
I did some performance tests to check which of the stated ways is the most performant.
instanceof [object] took 7.67 ms | + 0% | ..........
is_a [object] took 12.30 ms | + 60% | ................
is_a [class] took 17.43 ms | +127% | ......................
class_implements [object] took 28.37 ms | +270% | ....................................
reflection [class] took 34.17 ms | +346% | ............................................
Added some dots to actually "feel" see the difference.
Generated by this: https://3v4l.org/8Cog7
In case you have an object to check, use instanceof
like mentioned in the accepted answer.
In case you have a class to check, use is_a
.
Given the case you want to instantiate a class based on an interface you require it to have, it is more preformant to use is_a
. There is only one exception - when the constructor is empty.
Example:
is_a(<className>, <interfaceName>, true);
It will return bool
. The third parameter "allow_string" allows it to check class names without instantiating the class.
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With