GetObjectTypes::from()
Since v1.3.0
Description
GetObjectTypes::from()
returns a list of all strict PHP types for a given PHP object. The list is ordered with the most specific match first.
use GanbaroDigital\MissingBits\TypeInspectors\GetObjectTypes;
public static array GetObjectTypes::from(object $item);
Parameters
The input parameters are:
object $item
- the item to examine
Return Value
GetObjectTypes::from()
returns an array.
- If
$item
is not an object, an empty list[]
is returned - We return a list of
$item
's' class, the class's parents, and all interfaces it implements (directly or otherwise) - We detect if
$item
is invokeable - We detect if
$item
supports automatic conversion to a string
The resulting list is a complete list of strict types where it is safe to use $item
.
In PHP 7.0, object
is not valid type declaration. That's why GetObjectTypes::from()
does not include object
in the returned list.
Example Return Values
Here's a list of examples of accepted input values:
var_dump(GetObjectTypes::from(function(){}));
// outputs
//
// array(2) {
// ["Closure"]=>
// string(7) "Closure"
// ["callable"]=>
// string(8) "callable"
// }
var_dump(GetObjectTypes::from(new ArrayObject));
// outputs
//
// array(6) {
// ["ArrayObject"]=>
// string(11) "ArrayObject"
// ["IteratorAggregate"]=>
// string(17) "IteratorAggregate"
// ["Traversable"]=>
// string(11) "Traversable"
// ["ArrayAccess"]=>
// string(11) "ArrayAccess"
// ["Serializable"]=>
// string(12) "Serializable"
// ["Countable"]=>
// string(9) "Countable"
// }
use GanbaroDigital\MissingBits\TypeInspectors\GetStrictTypes;
var_dump(GetObjectTypes::from(new GetStrictTypes));
// outputs
//
// array(2) {
// ["GanbaroDigital\MissingBits\TypeInspectors\GetStrictTypes"]=>
// string(56) "GanbaroDigital\MissingBits\TypeInspectors\GetStrictTypes"
// ["callable"]=>
// string(8) "callable"
// }
var_dump(GetObjectTypes::from((object)[]));
// outputs
//
// array(1) {
// ["stdClass"]=>
// string(8) "stdClass"
// }
var_dump(GetObjectTypes::from(new Exception(__FILE__)));
// outputs
//
// array(3) {
// ["Exception"]=>
// string(9) "Exception"
// ["Throwable"]=>
// string(9) "Throwable"
// ["string"]=>
// string(6) "string"
// }
Here's a list of examples of ingored input values:
var_dump(GetObjectTypes::from(null));
// outputs
//
// array(0) {
// }
var_dump(GetObjectTypes::from([1,2,3]));
// outputs
//
// array(0) {
// }
use GanbaroDigital\MissingBits\TypeInspectors\GetStrictTypes;
var_dump(GetObjectTypes::from([GetStrictTypes::class, "from"]));
// outputs
//
// array(0) {
// }
var_dump(GetObjectTypes::from(true));
// outputs
//
// array(0) {
// }
var_dump(GetObjectTypes::from(false));
// outputs
//
// array(0) {
// }
var_dump(GetObjectTypes::from(0.0));
// outputs
//
// array(0) {
// }
var_dump(GetObjectTypes::from(3.1415927));
// outputs
//
// array(0) {
// }
var_dump(GetObjectTypes::from(0));
// outputs
//
// array(0) {
// }
var_dump(GetObjectTypes::from(100));
// outputs
//
// array(0) {
// }
var_dump(GetObjectTypes::from(-100));
// outputs
//
// array(0) {
// }
var_dump(GetObjectTypes::from(STDIN));
// outputs
//
// array(0) {
// }
var_dump(GetObjectTypes::from("true"));
// outputs
//
// array(0) {
// }
var_dump(GetObjectTypes::from("false"));
// outputs
//
// array(0) {
// }
var_dump(GetObjectTypes::from("0.0"));
// outputs
//
// array(0) {
// }
var_dump(GetObjectTypes::from("3.1415927"));
// outputs
//
// array(0) {
// }
var_dump(GetObjectTypes::from("0"));
// outputs
//
// array(0) {
// }
var_dump(GetObjectTypes::from("100"));
// outputs
//
// array(0) {
// }
var_dump(GetObjectTypes::from("hello, world!"));
// outputs
//
// array(0) {
// }
var_dump(GetObjectTypes::from(ArrayObject::class));
// outputs
//
// array(0) {
// }
var_dump(GetObjectTypes::from(Traversable::class));
// outputs
//
// array(0) {
// }
Throws
GetObjectTypes::from()
does not throw any exceptions.
Works With
GetObjectTypes::from()
is supported on these versions of PHP:
PHP Version | Works? |
---|---|
5.5 | Yes |
5.6 | Yes |
7.0 | Yes |
HHVM | Yes |