How to Check for a Specific Type of Object in PHP

by

You can use instanceof:

if ($pdo instanceof PDO) {
    // it's PDO
}

Be aware though, you can’t negate like !instanceof, so you’d instead do:

if (!($pdo instanceof PDO)) {
    // it's not PDO
}

Also, looking over your question, you can use object type-hinting, which helps enforce requirements, as well as simplify your check logic:

function connect(PDO $pdo = null)
{
    if (null !== $pdo) {
        // it's PDO since it can only be
        // NULL or a PDO object (or a sub-type of PDO)
    }
}

connect(new SomeClass()); // fatal error, if SomeClass doesn't extend PDO

Typed arguments can be required or optional:

// required, only PDO (and sub-types) are valid
function connect(PDO $pdo) { }

// optional, only PDO (and sub-types) and 
// NULL (can be omitted) are valid
function connect(PDO $pdo = null) { }

Untyped arguments allow for flexibility through explicit conditions:

// accepts any argument, checks for PDO in body
function connect($pdo)
{
    if ($pdo instanceof PDO) {
        // ...
    }
}

// accepts any argument, checks for non-PDO in body
function connect($pdo)
{
    if (!($pdo instanceof PDO)) {
        // ...
    }
}

// accepts any argument, checks for method existance
function connect($pdo)
{
    if (method_exists($pdo, 'query')) {
        // ...
    }
}

As for the latter (using method_exists), I’m a bit mixed in my opinion. People coming from Ruby would find it familiar to respond_to?, for better or for worse. I’d personally write an interface and perform a normal type-hint against that:

interface QueryableInterface
{ 
    function query();
}

class MyPDO extends PDO implements QueryableInterface { }

function connect(QueryableInterface $queryable) { }

However, that’s not always feasible; in this example, PDO objects are not valid parameters as the base type doesn’t implement QueryableInterface.

It’s also worth mentioning that values have types, not variables, in PHP. This is important because null will fail an instanceof check.

$object = new Object();
$object = null;
if ($object instanceof Object) {
    // never run because $object is simply null
}

The value loses it’s type when it becomes null, a lack of type.

More Related Contents:

  1. Writing PHP functions that has many parameters/modifiers [closed]
  2. What is the difference between public, private, and protected?
  3. Use global variables in a class
  4. Getter and Setter? [closed]
  5. Can I extend a class using more than 1 class in PHP?
  6. mysqli_query() expects parameter 1 to be mysqli, object given
  7. When to use static vs instantiated classes
  8. mysql_fetch_array, mysql_fetch_assoc, mysql_fetch_object
  9. declare property as object?
  10. Can you create instance properties dynamically in PHP?
  11. Pre-declare all private/local variables?
  12. In PHP, can you instantiate an object and call a method on the same line?
  13. Understanding IoC Containers and Dependency Injection
  14. What is an abstract class in PHP?
  15. What are the advantages of using getters and setters instead of functions or simply public fields in PHP? [closed]
  16. Creating anonymous objects in php
  17. Magic __get getter for static properties in PHP
  18. What does the syntax ‘%s’ and ‘%d’ mean as shorthand for calling a variable?
  19. Is it possible to declare a method static and nonstatic in PHP?
  20. How to implement a decorator in PHP?
  21. Get all defined classes of a parent class in php
  22. Why does PHP allow “incompatible” constructors?
  23. Unresolvable dependency resolving [Parameter #0 [ $name ]]
  24. dynamic class names in php
  25. Call parent constructor before child constructor in PHP
  26. PHP’s function to list all objects’s properties and methods
  27. Passing variable from controller to view in CodeIgniter
  28. Is Multiple Inheritance allowed at class level in PHP?
  29. Method Chains PHP OOP
  30. PHP – Implement logging mechanism to file in several classes

Leave a Comment