Implement the possibility to search for null in backend grids #1203

digitalpianism · 2020-09-08T15:23:57Z

Description (*)

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

Related Pull Requests

Fixed Issues (if relevant)

Fixes Possibility to search for null in backend grids #1189

Manual testing scenarios (*)

Access a backend grid where an entry has a NULL value
Filter the grid searching for NULL in the column input
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 · 2021-12-07T09:15:53Z

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 · 2022-05-26T18:54:33Z

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

fballiano · 2022-06-08T13:04:55Z

@luigifab should we push your version to this PR?

luigifab · 2022-06-08T17:06:14Z

Why not.

fballiano · 2022-06-08T22:26:25Z

done, hope correctly :-)

ADDISON74 · 2022-06-09T16:13:50Z

This one is failing again with PHPStan.

luigifab · 2022-06-09T16:17:53Z

PHPStan is wrong! Where is the support? 😸

ADDISON74 · 2022-06-09T16:18:20Z

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 · 2022-08-20T15:28:42Z

somebody understands what phpstan is complaining about?

kiatng · 2022-08-21T01:51:07Z

@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 · 2022-08-21T03:12:32Z

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 · 2022-08-23T20:33:44Z

@sreichel did you have time to check this?

sreichel · 2022-08-23T21:09:39Z

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 · 2022-08-30T15:18:38Z

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

sreichel · 2022-08-30T15:27:49Z

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

kiatng · 2022-08-30T15:46:02Z

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

sreichel · 2022-08-30T15:50:35Z

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

fballiano

test on customer grid, works

fballiano · 2022-08-30T23:02:59Z

(but we should add something to the README)

sreichel · 2022-08-30T23:09:37Z

(but we should add something to the README)

You successfully tested it, its your job :P

fballiano · 2022-08-30T23:16:50Z

(but we should add something to the README)

You successfully tested it, its your job :P

fair enough 🤣

github-actions · 2022-08-31T07:28:09Z

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.

…ge#1203) * implement OpenMage#1189 * Updated the code from luigifab comments * Fixed baseline * Fixed phpstan-baseline.neon * Fixed PR * Update README.md Co-authored-by: Fabrizio Balliano <fabrizio.balliano@gmail.com> Co-authored-by: Ng Kiat Siong <kiatsiong.ng@gmail.com> Co-authored-by: sv3n <github-sr@hotmail.com>

luigifab · 2022-09-01T09:51:30Z

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 · 2022-09-01T10:25:10Z

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 · 2022-09-01T11:09:35Z

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 · 2022-09-01T11:41:49Z

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 · 2022-09-01T22:21:10Z

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

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

sreichel · 2022-09-01T22:47:29Z

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 · 2022-09-02T00:05:25Z

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 · 2022-09-02T00:07:24Z

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

github-actions bot added the Component: Adminhtml Relates to Mage_Adminhtml label Sep 8, 2020

luigifab previously approved these changes Jun 9, 2022

View reviewed changes

tobihille previously approved these changes Aug 20, 2022

View reviewed changes

kiatng previously approved these changes Aug 20, 2022

View reviewed changes

fballiano dismissed stale reviews from kiatng, tobihille, and luigifab via 59a23ed August 23, 2022 21:35

github-actions bot added environment phpstan labels Aug 23, 2022

digitalpianism and others added 3 commits August 23, 2022 22:36

implement OpenMage#1189

dafa2ba

Updated the code from luigifab comments

58c3ae8

Fixed baseline

47e461c

fballiano force-pushed the fix-1189 branch from 59a23ed to 47e461c Compare August 23, 2022 21:36

Merge branch '1.9.4.x' into fix-1189

567da9b

kiatng previously approved these changes Aug 24, 2022

View reviewed changes

Merge branch '1.9.4.x' into fix-1189

2214b17

kiatng dismissed their stale review via 2214b17 August 29, 2022 12:59

Fixed PR

4836ae3

github-actions bot added Component: Adminhtml Relates to Mage_Adminhtml phpstan labels Aug 30, 2022

fballiano previously approved these changes Aug 30, 2022

View reviewed changes

fballiano added 2 commits August 31, 2022 00:17

Merge branch '1.9.4.x' into fix-1189

b385dbb

Update README.md

437b359

fballiano dismissed their stale review via 437b359 August 30, 2022 23:19

github-actions bot added the documentation label Aug 30, 2022

fballiano approved these changes Aug 30, 2022

View reviewed changes

kiatng approved these changes Aug 31, 2022

View reviewed changes

sreichel merged commit 537e68e into OpenMage:1.9.4.x Aug 31, 2022

This comment has been minimized.

Sign in to view

elidrissidev mentioned this pull request Apr 3, 2023

TypeError: Unsupported operand types: int * string #3135

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement the possibility to search for null in backend grids #1203

Implement the possibility to search for null in backend grids #1203

digitalpianism commented Sep 8, 2020

luigifab commented Dec 7, 2021 •

edited

Loading

luigifab commented May 26, 2022

fballiano commented Jun 8, 2022

luigifab commented Jun 8, 2022

fballiano commented Jun 8, 2022

ADDISON74 commented Jun 9, 2022

luigifab commented Jun 9, 2022

ADDISON74 commented Jun 9, 2022

kiatng left a comment

fballiano commented Aug 20, 2022

kiatng commented Aug 21, 2022 •

edited

Loading

sreichel commented Aug 21, 2022

fballiano commented Aug 23, 2022

sreichel commented Aug 23, 2022

sreichel commented Aug 30, 2022

sreichel commented Aug 30, 2022

kiatng commented Aug 30, 2022

sreichel commented Aug 30, 2022

fballiano left a comment

fballiano commented Aug 30, 2022

sreichel commented Aug 30, 2022

fballiano commented Aug 30, 2022

This comment has been minimized.

github-actions bot commented Aug 31, 2022

luigifab commented Sep 1, 2022

kiatng commented Sep 1, 2022 •

edited

Loading

kiatng commented Sep 1, 2022

kiatng commented Sep 1, 2022 •

edited

Loading

sreichel commented Sep 1, 2022

sreichel commented Sep 1, 2022

kiatng commented Sep 2, 2022

sreichel commented Sep 2, 2022

Implement the possibility to search for null in backend grids #1203

Implement the possibility to search for null in backend grids #1203

Conversation

digitalpianism commented Sep 8, 2020

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Questions or comments

Contribution checklist (*)

luigifab commented Dec 7, 2021 • edited Loading

luigifab commented May 26, 2022

fballiano commented Jun 8, 2022

luigifab commented Jun 8, 2022

fballiano commented Jun 8, 2022

ADDISON74 commented Jun 9, 2022

luigifab commented Jun 9, 2022

ADDISON74 commented Jun 9, 2022

kiatng left a comment

Choose a reason for hiding this comment

fballiano commented Aug 20, 2022

kiatng commented Aug 21, 2022 • edited Loading

sreichel commented Aug 21, 2022

fballiano commented Aug 23, 2022

sreichel commented Aug 23, 2022

sreichel commented Aug 30, 2022

sreichel commented Aug 30, 2022

kiatng commented Aug 30, 2022

sreichel commented Aug 30, 2022

fballiano left a comment

Choose a reason for hiding this comment

fballiano commented Aug 30, 2022

sreichel commented Aug 30, 2022

fballiano commented Aug 30, 2022

This comment has been minimized.

github-actions bot commented Aug 31, 2022

Unit Test Results

luigifab commented Sep 1, 2022

kiatng commented Sep 1, 2022 • edited Loading

kiatng commented Sep 1, 2022

kiatng commented Sep 1, 2022 • edited Loading

sreichel commented Sep 1, 2022

sreichel commented Sep 1, 2022

kiatng commented Sep 2, 2022

sreichel commented Sep 2, 2022

luigifab commented Dec 7, 2021 •

edited

Loading

kiatng commented Aug 21, 2022 •

edited

Loading

kiatng commented Sep 1, 2022 •

edited

Loading

kiatng commented Sep 1, 2022 •

edited

Loading