Multiple choice options for selectable fields on custom reports #13482

akemidx · 2023-08-16T21:00:44Z

When running custom reports, users can now select multiple options from available choices in their DB.

Fields for multi select are:

Company
Location
Default Location
Department
Supplier
Model
Manufacturer
Category
Status

Type of Change:

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

How Has This Been Tested?

Tested locally in test instance

Test Configuration:
PHP version: php8.0
Snipe-IT dev instance

Checklist:

I have read the Contributing documentation available here: https://snipe-it.readme.io/docs/contributing-overview
I have formatted this PR according to the project guidelines: https://snipe-it.readme.io/docs/contributing-overview#pull-request-guidelines
My code follows the style guidelines of this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes

…electing the placeholder value in some circumstances

what-the-diff · 2023-08-16T21:01:14Z

PR Summary

Restructured Default Selection Options
The default selection options have been removed from several system components. This alteration has been made in the category, company, department, location, manufacturer, model, status, and supplier select interfaces. The change ensures a more streamlined selection process within these mentioned facets.
Enhanced Multi-Select Features in Custom Interface
There's also been an enhancement to the custom interface. The department-select and manufacturer-select now permit multiple selections. This broadens the versatility of the interface, allowing for a more varied form of data selection.

resources/views/partials/forms/edit/category-select.blade.php

snipe · 2023-08-16T21:12:20Z

Please outline in a little more detail how this was tested, specifically in ways where the files changed are used in areas outside of the custom report, which use cases you explored, etc.

akemidx · 2023-08-16T21:42:43Z

Please outline in a little more detail how this was tested, specifically in ways where the files changed are used in areas outside of the custom report, which use cases you explored, etc.

of course. wasn't sure what else to say, so I'll update the description.

snipe

I think we can compact a lot of this code down to just use a ternary statement, the same way as we do in the location-select.blade.php

snipe-it/resources/views/partials/forms/edit/location-select.blade.php

Line 6 in faa865f

    
           <select class="js-data-ajax" data-endpoint="locations" data-placeholder="{{ trans('general.select_location') }}" name="{{ $fieldname }}" style="width: 100%" id="{{ $fieldname }}_location_select" aria-label="{{ $fieldname }}" {!!  ((isset($item)) && (Helper::checkIfRequired($item, $fieldname))) ? ' data-validation="required" required' : '' !!}{{ (isset($multiple) && ($multiple=='true')) ? " multiple='multiple'" : '' }}>

akemidx · 2023-09-05T19:07:42Z

did you quote which I need to change, or an example of what other stuff should be changed to be like?

snipe · 2023-09-05T19:08:22Z

The link in my post above shows an example of the ternary

akemidx · 2023-09-07T21:23:11Z

So, I left the code the way it was, and we added the isset, and then tinkered with the company select blade. This is explicitly to fix the bug I discovered where a user could x out of their chosen options in each field, and then submit the placeholder, creating a blank report.

in this screenshot, even if a user selects another valid option, the placeholder can still seen as a valid value to filter with.

akemidx · 2023-10-25T19:02:32Z

@snipe This is finished and ready for review.

I tested a few of our create and edit pages for our different top level models and was able to confirm they only allow the selection of one choice in the fields I made available to be a multiple choice on the custom reports.

Since I had used the isset(multiple), I believe this will work, and ONLY in spots in the code where we explicitly state "multiple" will be the fields where you can choose multiple options. The custom reports blade was the only spot i changed to allow multiple choices.

Custom reports -> multiple is set -> multiple choice allowed
asset creation page (for example) -> multiple not set -> only single choice allowed.

uberbrady

This looks excellent - very nice work! If I'm reading it right - and I'm not sure that I am - it looks to me like the <option> tags look the same whether something is multiple or not. If so, can we squish those up into just one <option> tag value? e.g. I don't think we need the if($multiple) or if(!$multiple) branches - they look identical to me. Another thing - which might be completely fine, mind you - is that I don't see any changes to the controller to accept arrays - does that already 'automagically' work? If so that's great! Once we can get those if($multiple)/if!($multiple) branches squished together (assuming they can be squished together), I think we'll be good to go!

akemidx · 2023-12-07T23:07:54Z

@uberbrady I will go back and test on Monday. I believe that when I originally made the PR, the reason for the way it is now, is to fix a bug in the fields you can select. #13482 (comment) <--example here

This was causing a situation where a report could end up empty.

uberbrady

I think a couple of those drop-downs got their contents flipped around - to Category from various things like Company, Location, Department - once we can get those back to where they should be (or if you can explain what I'm misunderstanding!) I think we should be in good shape.

uberbrady · 2024-01-04T18:31:51Z

resources/views/partials/forms/edit/company-select.blade.php

+                    @if($multiple)
+                        @if($company_id = old($fieldname, (isset($item)) ? $item->{$fieldname} : ''))
+                            <option value="{{ $company_id }}" selected="selected" role="option" aria-selected="true"  role="option">
+                                {{ (\App\Models\Category::find($company_id)) ? \App\Models\Category::find($company_id)->name : '' }}


Hrm, we sure we want 'Category' here? Shouldn't that be Company?

uberbrady · 2024-01-04T18:32:03Z

resources/views/partials/forms/edit/company-select.blade.php

+                    @if(!$multiple)
+                        @if($company_id = old($fieldname, (isset($item)) ? $item->{$fieldname} : ''))
+                            <option value="{{ $company_id }}" selected="selected" role="option" aria-selected="true"  role="option">
+                                {{ (\App\Models\Category::find($company_id)) ? \App\Models\Category::find($company_id)->name : '' }}


uberbrady · 2024-01-04T18:32:38Z

resources/views/partials/forms/edit/company-select.blade.php

+                    @if($multiple ?? '')
+                        @if($company_id = old($fieldname, (isset($item)) ? $item->{$fieldname} : ''))
+                            <option value="{{ $company_id }}" selected="selected" aria-selected="true">
+                                {{ (\App\Models\Category::find($company_id)) ? \App\Models\Category::find($company_id)->name : '' }}


Maybe this too?

uberbrady · 2024-01-04T18:32:46Z

resources/views/partials/forms/edit/company-select.blade.php

+                    @if(!$multiple ?? '')
+                        @if($company_id = old($fieldname, (isset($item)) ? $item->{$fieldname} : ''))
+                            <option value="{{ $company_id }}" selected="selected">
+                                {{ (\App\Models\Category::find($company_id)) ? \App\Models\Category::find($company_id)->name : '' }}


uberbrady · 2024-01-04T18:33:14Z

resources/views/partials/forms/edit/department-select.blade.php

+                @if($multiple)
+                    @if($department_id = old($fieldname, (isset($item)) ? $item->{$fieldname} : ''))
+                        <option value="{{ $department_id }}" selected="selected" role="option" aria-selected="true"  role="option">
+                            {{ (\App\Models\Category::find($department_id)) ? \App\Models\Category::find($cdepartment_id)->name : '' }}


Department->Category here as well? Or maybe I'm missing something.

uberbrady · 2024-01-04T18:33:48Z

resources/views/partials/forms/edit/location-select.blade.php

+                @if($multiple)
+                    @if($location_id = old($fieldname, (isset($item)) ? $item->{$fieldname} : ''))
+                        <option value="{{ $location_id }}" selected="selected" role="option" aria-selected="true"  role="option">
+                            {{ (\App\Models\Category::find($location_id)) ? \App\Models\Category::find($location_id)->name : '' }}


Similar here?

uberbrady · 2024-01-04T18:34:18Z

resources/views/partials/forms/edit/location-select.blade.php

+                @if(!$multiple)
+                    @if($location_id = old($fieldname, (isset($item)) ? $item->{$fieldname} : ''))
+                        <option value="{{ $location_id }}" selected="selected" role="option" aria-selected="true"  role="option">
+                            {{ (\App\Models\Category::find($location_id)) ? \App\Models\Category::find($location_id)->name : '' }}


Maybe also here? (Locations)

akemidx · 2024-01-04T20:51:48Z

@uberbrady I adjusted those. It seems that some of the multi searches were working even with those erroneously being "Category" instead of their proper paths.

The code is built to bypass the "blank search" bug I found. But as of right now, the three choices I made newly multi searchable, are not working. so that's Department, Manufacturer, and Company

Currently, it is only returning the FIRST choice in the multi select, and I'm not sure why right now. Need to do some more testing and see what is different between the ones that work, and the ones that don't.

I'll update if I can figure out a fix. Worst case I will make a new PR that is specifically fixing that bug.

multi choice on reports. includes fixes on select blades to prevent s…

c78ffd7

…electing the placeholder value in some circumstances

akemidx requested a review from snipe as a code owner August 16, 2023 21:00

probot-autolabeler bot added the frontend label Aug 16, 2023

snipe reviewed Aug 16, 2023

View reviewed changes

resources/views/partials/forms/edit/category-select.blade.php Show resolved Hide resolved

multiselect. handling both multi and single choice possibilities

2d4f51b

snipe requested changes Sep 5, 2023

View reviewed changes

akemidx added 2 commits September 6, 2023 19:42

handle 500s if multiple is NOT set

2de65f9

fixing 500s on create blades

b000f8a

snipe requested a review from uberbrady October 25, 2023 19:44

push

419fa10

probot-autolabeler bot added the backend label Oct 30, 2023

uberbrady requested changes Dec 7, 2023

View reviewed changes

uberbrady requested changes Jan 4, 2024

View reviewed changes

requested changes | WIP

f47a896

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Multiple choice options for selectable fields on custom reports #13482

Multiple choice options for selectable fields on custom reports #13482

akemidx commented Aug 16, 2023

what-the-diff bot commented Aug 16, 2023

snipe commented Aug 16, 2023

akemidx commented Aug 16, 2023

snipe left a comment •

edited

akemidx commented Sep 5, 2023

snipe commented Sep 5, 2023

akemidx commented Sep 7, 2023

akemidx commented Oct 25, 2023

uberbrady left a comment

akemidx commented Dec 7, 2023 •

edited

uberbrady left a comment

uberbrady Jan 4, 2024

uberbrady Jan 4, 2024

uberbrady Jan 4, 2024

uberbrady Jan 4, 2024

uberbrady Jan 4, 2024

uberbrady Jan 4, 2024

uberbrady Jan 4, 2024

akemidx commented Jan 4, 2024

Multiple choice options for selectable fields on custom reports #13482

Are you sure you want to change the base?

Multiple choice options for selectable fields on custom reports #13482

Conversation

akemidx commented Aug 16, 2023

Type of Change:

How Has This Been Tested?

Checklist:

what-the-diff bot commented Aug 16, 2023

PR Summary

snipe commented Aug 16, 2023

akemidx commented Aug 16, 2023

snipe left a comment • edited

Choose a reason for hiding this comment

akemidx commented Sep 5, 2023

snipe commented Sep 5, 2023

akemidx commented Sep 7, 2023

akemidx commented Oct 25, 2023

uberbrady left a comment

Choose a reason for hiding this comment

akemidx commented Dec 7, 2023 • edited

uberbrady left a comment

Choose a reason for hiding this comment

uberbrady Jan 4, 2024

Choose a reason for hiding this comment

uberbrady Jan 4, 2024

Choose a reason for hiding this comment

uberbrady Jan 4, 2024

Choose a reason for hiding this comment

uberbrady Jan 4, 2024

Choose a reason for hiding this comment

uberbrady Jan 4, 2024

Choose a reason for hiding this comment

uberbrady Jan 4, 2024

Choose a reason for hiding this comment

uberbrady Jan 4, 2024

Choose a reason for hiding this comment

akemidx commented Jan 4, 2024

snipe left a comment •

edited

akemidx commented Dec 7, 2023 •

edited