[FEAT-596] Add multiple tag filter support #2105
Conversation
- Add the ability to provide a comma-separated list of tags that will return a list of sites that have ANY tag in the list. - Add an additional --tags options which takes a comma-separated list of tags, but requires ALL tags to match. - Now supports NO tags and will return only sites with no tags if the tag option value is empty.
| if (!is_null($tags = $options['tags'])) { | ||
| $this->sites->filterByTags($tags); | ||
| } |
There was a problem hiding this comment.
tag and tags probably shouldn't be used together, unless it's used in an and/or combination? Maybe there is a use for it.
kyletaylored
changed the title
- Add the ability to provide a comma-separated list of tags that will return a list of sites that have ANY tag in the list. - Add an additional --tags options which takes a comma-separated list of tags, but requires ALL tags to match. - Now supports NO tags and will return only sites with no tags if the tag option value is empty.
…d/terminus into feature/add-multitag-support
|
Sorry, that we're just now getting to this, but we haven't really had anyone working on Terminus in a while. I'll try to rebase around the changes we're including in v3.0 and and see if I can tease out just your tag changes. Gimme a day or so to work out the diff. |
|
Note also that the underlying API that Terminus uses does not report all tags, so this PR will not behave correctly in all circumstances. |
|
@greg-1-anderson What is the underlying API that is used, and do you have recommendations on how to address those? Or just pointing out the potential issue as a heads up? |
|
@greg-1-anderson @stovak Would it be possible to revisit this PR? Getting the right tag data from the platform API should be a separate issue, but in this case we're just applying the correct logic to the data that is available. // cc @danny2p |
|
Terminus 2 is EOL now so closing this PR. We'll get this merged into Terminus 3 soon |
--tagthat will return a list of sites that have ANY tag in the list. (fixes Support for Multiple Values for TAG? #1790)--tagsoption which takes a comma-separated list of tags, but requires ALL tags to match.The summary of this PR is extending the functionality of the existing
--tagoption to support multiple tags as a comma-separated string, in addition to adding a--tagsoption which is more explicit. These also support single tag values as to not alter the previous behavior.--tagwill return sites matching ANY tag--tagswill return sites that match ALL tags--tag "")I added 3 methods to the
TerminusCollectionin addition to the binaryhas()method:containsAny- if any provided ID matchescontainsAll- if all provided IDs matchcontainsNone- Match if an empty ID was provided with sites with no IDWhat about
--filter?While the
--filteroption can work, it is more restrictive in terms of both functionality and results. The tag field is parsed as a single, combined string, which causes unexpected results.Single tag (
--filter "tags=tagA")This will only return a list of sites that have only this one tag. If the site has other tags, this fails.
More than one tag (
--filter "tags=tagA||tags=tagB")Similar to a single tag, only shows a list of sites if they solely contain each tag, and it disregards other tags.
More than one tag, but listed alphabetically (
--filter "tags=tagA,tagB")Will only list sites that have both tags (none others), and they must be listed in alphabetical order. If you were switch the order of the tags (tagB,tagA), then you will get no results.