Is there a good way to inspect objects whose type is derived from the EntityDrupalWrapper class?

Question

I'm sure this question applies to other complex object types, but EntityDrupalWrapper is the one I'm currently working with. This is the type of object returned by entity_metadata_wrapper() (and probably others).

When using code like the following:

$order_wrapper = entity_metadata_wrapper('commerce_order', $order_object);
dpm($order_wrapper);

the output from Devel is none too helpful:

It doesn't show what you'd expect to see for a call to dpm() with, for example, a stdClass object.

A similar call to dvm() does print the object, but in a manner I'm not familiar with, and it's not very readable.

I've tried debug() and it produces a PHP user notice that looks something like this:

Incidentally the HTML output contained in that warning is the same output that dvm() prints to the screen.

How can I inspect these types of objects (preferably with Krumo), so I can see what properties are available? Or am I stuck using dvm()?

Answer 1

Use dpm($wrapper->getPropertyInfo());

It's in the docs.

Answer 2

I had been playing with EntityDrupalWrapper objects. debug() usually returns the output that may have prepared by __toString()

I iterated EntityDrupalWrapper object using foreach and it helped to list down the name of properties.

foreach($order_wrapper as $name => $obj){
  debug($name);
  debug(get_class($obj)); //EntityValueWrapper
}

Here $obj is an object of type EntityValueWrapper

$obj can be read by $obj->value() and can be write by $obj->set('value');

EDIT:

If you have created your wrapper without passing second param
i.e. entity_metadata_wrapper('commerce_order');
then set and value methods will throw exception as they are not implemented.

Answer 3

I wound up writing my own little widget to unroll the wrapper:

function _wrapper_debug($w) {
  $values = array();
  foreach ($w->getPropertyInfo() as $key => $val) {
    $values[$key] = $w->$key->value();
  }
  return $values;
}

dpm(_wrapper_debug($some_object_wrapper));

Hope someone finds it useful.

Answer 4

The Inspect module provides a nice structural view of the data you want to debug.

Get instructive and well formatted variable dumps, deep stack traces, and execution time profiles - to database log (Reports / Recent log messages), to file or to screen.

Answer 5

If you want to inspect the original object that is "powering" the wrapper, try:

dpm($wrapper->raw())

This works well for me.

Answer 6

There is a devel patch the enables Krumo to show all private and protected properties.

Here is the thread on drupal.org

I've found this patch very helpful.

Answer 7

Use the drupal cli

$ drupal debug:entity
// Displays current events