&parents parameter - For a more convenient way to specify the documents ids

Since Evo, with ditto, ajaxSearch, and some other snippets, to define a list of id (in order to restrict the area of list/search), we use the "classical" parameters &documents or &parents with &depth.

With getResources for Revo, we use always &parents and &depth. With &parents parameter, if you specify &parents=`28,42` you get #28 and all children of #28 (if #28 if a parent document), #42 and children of #42 (if #42 if a parent document).

But this specification is not efficient if I would like:

- Children of #28 but not the document #28 ? For this, I probably need to list ll the children id of #28. Not very convenient

- Document #28 and #36 with the first level of children. If I use depth = 0, I got 28, but not the children of #36. If I choose depth = 1 I get #36 but also the children of #28 >:(

- All the parents of #28 but not #28 nor documenbt #0 and document #1 ?

- All the children of the document #28 but not the children document of #36 which is a child of 28 and a parent of a subtree ? How could I exclude this document sub-tree ?



A solution could be to specify documents parameter like this: &documents=`comma separated list of prefixedId` avec prefixedId=[[ |+|-][ |c|p]id ]

With this specification:

- Children of #28 but not the document #28 ? &documents=`c28` => c for chidren (#28 excluded)

- Only #28 and #36 with the first child ? &documents=`28, 36, c36` => #28, #36, and children of #36

- All the parents of #28 but not 28 nor 0 or 1 ? &documents=`p28, -0, -1` => p for parents (#28 excluded),#0 and #1 excluded (- for excluded)

- All the children of #28 but not the children of #36 ? &documents=`c28, -c36` => children of #28 and children of #36 excluded (#36 included)


It could be interesting that all addons implement this general &documents parameter like this. Does it make sense or is it too complicated or sophisticated ?


Hereafter the code which implement for Revo this parameter[Edit] A snippet named GetIds is now available in the utilities section of the repository.

Some interesting ideas.

This isn’t exactly what you want, but it is in the getResources comments:



You can also include and exclude children in the front end by putting them in resource groups. If you put children in a protected resource group, getResources won’t show them.

Resources groups could be a solution, but this implied to defined a group each time before to use it.

With getResources, &resources parameter exclude the resources at the end of the list construction. Which is a bit different.


As I think that it could be usefull, I have proposed a snippet named GetIds (Utility section), which can be used to fill &resources for getResources or &documents for ditto. I hope It can help.


e.g: [[!getResources? &resources=`[[!GetIds? &ids=`18, c18, -c21, 34`]]` &limit=`100` &tpl=`blogPost`]]


Hereafter is the header of this snippet:


You could download the snippet from http://modxcms.com/extras/search.html?query=getIds

Very nice. I’m sure it will get a lot of use.

Once you have it the way you want it, you could package it up with PackMan and release it.

Thanks. Packaged and downloadable from http://modxcms.com/extras/search.html?query=getIds

I have done lot of tests with crazy ids like ’ ,z ,- ,cz ,c- ,-c ,-2 ,zzz ,zz+ ,zc+ ,+zc ,+cz ,c+3 ,+c3 ,p22 ,+22 ,+2, -22, 2, +222, -222, 222’
Hope all is correct

I agree with Bob, this should be a great snippet that man other developers could use and not have to handle that bit. Great job!

This sounds phenomenal, exactly what I need for Evo and AjaxSearch.
I wish there was an Evo version to help with excluding children resources of known parents from AjaxSearch results - https://forums.modx.com/thread/91767/exclude-children-of-known-parents-from-ajaxsearch-results

Quote from: nickf08 at Jun 28, 2014, 01:10 AM

This sounds phenomenal, exactly what I need for Evo and AjaxSearch.
I wish there was an Evo version to help with excluding children resources of known parents from AjaxSearch results - https://forums.modx.com/thread/91767/exclude-children-of-known-parents-from-ajaxsearch-results

No need for it! https://forums.modx.com/thread/91767/exclude-children-of-known-parents-from-ajaxsearch-results#dis-post-501735

My guess is that this is exactly why coroico (author of AjaxSearch) wanted this feature and wrote this snippet. [ed. note: mrhaw last edited this post 12 years, 3 months ago.]