Implement the possibility to search for null in backend grids

[digitalpianism]

Description (*)

This modification will let users search for NULL entries in the backend grids.

Related Pull Requests

Fixed Issues (if relevant)

1. Fixes Possibility to search for null in backend grids #1189

Manual testing scenarios (*)

1. Access a backend grid where an entry has a NULL value
2. Filter the grid searching for NULL in the column input
3. Enjoy the result

Questions or comments

Contribution checklist (*)

• Pull request has a meaningful description of its purpose
• All commits are accompanied by meaningful commit messages
• All automated tests passed successfully (all builds are green)

[luigifab]

I tried but it does not work on our websites, I did that:

$filtered = array_map(static function ($value) {
    return is_object($value) ? $value->__toString() : $value;
}, is_array($cond) ? array_values($cond) : [$cond]);
if (in_array('\'%NULL%\'', $filtered, true) || in_array('NULL', $filtered, true)) {
    $this->getCollection()->addFieldToFilter($field, ['null' => true]);
} else {
    $this->getCollection()->addFieldToFilter($field, $cond);
}

In my test, $cond contains Zend_Db_Expr.
It contains also a int when filter reviews in backend (type customer).

[luigifab]

I still using my version, but not really used because I forgot that now I can search with NULL :)

[fballiano]

@luigifab should we push your version to this PR?

[luigifab]

Why not.

[fballiano]

done, hope correctly :-)

[addison74]

This one is failing again with PHPStan.

[luigifab]

PHPStan is wrong! Where is the support? 😸

[addison74]

This PR is useful only when there are no data on a column of a Backend grid. I can get this information by one click on column title. Of course is a difference between a sort and a filtering action. It is easier to do mass-actions with filtered information (Select All).

[kiatng]

Tested and worked. @tobihille Thanks for the bump.

[fballiano]

somebody understands what phpstan is complaining about?

[kiatng]

@fballiano It's caused by the docblock here:

magento-lts/app/code/core/Mage/Adminhtml/Block/Widget/Grid.php

Lines 286 to 294 in fb601b0

	/**
	* get collection object
	*
	* @return Varien_Data_Collection
	*/
	public function getCollection()
	{
	return $this->_collection;
	}

It should be

     * @return Varien_Data_Collection_Db

But I am not sure what should be done to fix that in this PR.

[edit] Also

magento-lts/app/code/core/Mage/Adminhtml/Block/Widget/Grid.php

Line 278 in fb601b0

* @param Varien_Data_Collection $collection

[sreichel]

It should be

     * @return Varien_Data_Collection_Db

This would work, but not sure if its a good idea ... will check tomorrow

• * @param Varien_Data_Collection|Varien_Data_Collection_Db $collection
• * @return Varien_Data_Collection|Varien_Data_Collection_Db

[fballiano]

@sreichel did you have time to check this?

[sreichel]

Yes, fix phpstan-baseline.neon ... change count 1 to 2 for now. Its just a workaround, but removing this supressed errors is what i frequently do ... it will be fixed later ....

		-
			message: "#^Call to an undefined method Varien_Data_Collection\\:\\:addFieldToFilter\\(\\)\\.$#"
			count: 1
			path: ../app/code/core/Mage/Adminhtml/Block/Widget/Grid.php

[sreichel]

@digitalpianism i'm also confused. 47e461c was okay. All checks passed. I've reverted this change.

[sreichel]

Problem found: 2214b17 reverted all changes. I'll fix this in the evening ... (reapply fix)

[kiatng]

My bad, sorry about that. Please let me know what I did wrongly.

[sreichel]

@kiatng i dont know. I guess you just used the "Update branch" button.

[fballiano]

test on customer grid, works

[fballiano]

(but we should add something to the README)

[sreichel]

(but we should add something to the README)

You successfully tested it, its your job :P

[fballiano]

(but we should add something to the README)

You successfully tested it, its your job :P

fair enough 🤣

[github-actions]

Unit Test Results

1 files  ±0  1 suites  ±0   0s ⏱️ ±0s
0 tests ±0  0 ✔️ ±0  0 💤 ±0  0 ❌ ±0 
7 runs  ±0  5 ✔️ ±0  2 💤 ±0  0 ❌ ±0 

Results for commit 537e68e. ± Comparison against base commit 988e9ff.

[luigifab]

The committed version is wrong if I remember correctly (not tested again).

We need: is_array($cond) ? array_values($cond) : [$cond]
because $cond is also a int when we filter reviews in backend on type customer.

[kiatng]

I have this in production (I needed this exact feature). I have searched for NULL, int ranges, string, and date ranges. All work correctly. Can you provide a test case where it fails?

[kiatng]

because $cond is also a int when we filter reviews in backend on type customer

I cannot test the above because I do not have customer reviews.

But filtering for store_id in order grid and customer_group in customer grid work fine.

[kiatng]

Looking at the code:

magento-lts/app/code/core/Mage/Adminhtml/Block/Widget/Grid.php

Lines 499 to 503 in 712a3ee

	$cond = $column->getFilter()->getCondition();
	if ($field && $cond !== null) {
	$filtered = array_map(static function ($value) {
	return is_object($value) ? $value->__toString() : $value;
	}, array_values($cond));

If $cond is of type int or not an array, then it will throw on line 503

Warning: array_values() expects parameter 1 to be array

When searching for all the function getCondition() in folder https://github.com/OpenMage/magento-lts/tree/1.9.4.x/app/code/core/Mage/Adminhtml/Block/Widget/Grid/Column/Filter

The function return either null or array as far as I can see, except for

magento-lts/app/code/core/Mage/Adminhtml/Block/Widget/Grid/Column/Filter/Checkbox.php

Lines 53 to 65 in 712a3ee

	public function getCondition()
	{
	if ($this->getValue()) {
	return $this->getColumn()->getValue();
	}
	else {
	return [
	['neq'=>$this->getColumn()->getValue()],
	['is'=>new Zend_Db_Expr('NULL')]
	];
	}
	//return array('like'=>'%'.$this->getValue().'%');
	}

and Radio.php, which can return string|null|array.

But I have not seen a grid column that uses checkbox or radio (checkboxes in massaction doesn't count). So what do we do?

[sreichel]

I cannot test the above because I do not have customer reviews.

Tested with sample data and @luigifab is right. PR incoming.

[sreichel]

If $cond is of type int or not an array, then it will throw on line 503

Warning: array_values() expects parameter 1 to be array

This is what happens on customer review page + filter. :)

[kiatng]

I overlooked that it is possible to define your own filter:

magento-lts/app/code/core/Mage/Adminhtml/Block/Review/Grid.php

Lines 147 to 153 in 5d9036e

	$this->addColumn('type', [
	'header' => Mage::helper('review')->__('Type'),
	'type' => 'select',
	'index' => 'type',
	'filter' => 'adminhtml/review_grid_filter_type',
	'renderer' => 'adminhtml/review_grid_renderer_type'
	]);

And it returns int:

magento-lts/app/code/core/Mage/Adminhtml/Block/Review/Grid/Filter/Type.php

Lines 41 to 51 in 5d9036e

	public function getCondition()
	{
	if ($this->getValue() == 1) {
	return 1;
	} elseif ($this->getValue() == 2) {
	return 2;
	} else {
	return 3;
	}
	}
	}

[sreichel]

Maybe this could have been easier with correct phpdocs .... I'm working on this :)