__debugInfo() for $input is empty

[adrianbj]

Short description of the issue

__debugInfo() for $input is empty

Expected behavior

It should return an array of the data

Actual behavior

It's blank - print_r($input->post) looks like this:

ProcessWire\WireInputData Object ( )

whereas print_r($_POST) looks like this:

Array ( [messageId] => 1455 [allOrGroups] => single [singleUser] => ,1100 [testFromNumber] => [groups] => )

[ryancramerdesign]

You are right that __debugInfo() in $input is useless at present. Though ProcessWire's WireInput class also isn't going to behave like $_POST because it doesn't actually store the input data (that's the job of WireInputData objects). Plus it works on-demand, so it doesn't create any WireInputData objects unless/until you ask for one from $input. Does this one below, if pasted into WireInput.php, provide what you need?

	public function __debugInfo() {
		$info = parent::__debugInfo();
		$info['get'] = $this->getVars ? $this->getVars->getArray() : null;
		$info['post'] = $this->postVars ? $this->postVars->getArray() : null;
		$info['cookie'] = $this->cookieVars ? $this->cookieVars->getArray() : null;
		$info['whitelist'] = $this->whitelist ? $this->whitelist->getArray() : null;
		$info['urlSegments'] = $this->urlSegments;
		$info['pageNum'] = $this->pageNum;
		return $info;
	}

If so, I can add to our WireInput class. If not, let me know what you'd suggest.

[ryancramerdesign]

Here's an alternative that bypasses the on-demand nature of WireInput and makes the debugInfo() load all the input data (not sure if this is a good thing for it to do, but might be more useful in debug data):

	public function __debugInfo() {
		$info = parent::__debugInfo();
		$info['get'] = $this->get();
		$info['post'] = $this->post();
		$info['cookie'] = $this->cookie();
		$info['whitelist'] = $this->whitelist();
		$info['urlSegments'] = $this->urlSegments;
		$info['pageNum'] = $this->pageNum;
		return $info;
	}

[adrianbj]

Hi @ryancramerdesign - the first one works well:

But the second doesn't seem to do anything useful. They're all empty objects:

[ryancramerdesign]

Sounds good, I'll add the first one. I forgot the getArray() calls on the second one. It should be this:

	public function __debugInfo() {
		$info = parent::__debugInfo();
		$info['get'] = $this->get()->getArray();
		$info['post'] = $this->post()->getArray();
		$info['cookie'] = $this->cookie()->getArray();
		$info['whitelist'] = $this->whitelist()->getArray();
		$info['urlSegments'] = $this->urlSegments;
		$info['pageNum'] = $this->pageNum;
		return $info;
	}

[adrianbj]

I forgot the getArray() calls on the second one. It should be this:

Right - so of course now the second one works as expected. I honestly don't know at this point whether 2 has any advantages over 1 so I'll leave it to you, but maybe I'll experiment with 2 down the road if 1 isn't working as expected.

[adrianbj]

Thanks for adding this Ryan!

[ethanbeyer]

This is awesome - something I've wanted for a while now, too!

[adrianbj]

This is awesome - something I've wanted for a while now, too!

I expect there are other PW objects that don't have __debugInfo defined, so please report them if you come across them. It's especially obvious to me now that Tracy uses this method as the default dump.

[ethanbeyer]

Pretty sure Pagefiles is missing it too. I ran into this with at least three different classes earlier this week, I just don't recall what the other two were right now. Will report back if I discover any others.

[adrianbj]

@ryancramerdesign - do you mind if I reopen this so that we can add to it for other objects that need their own debugInfo method?