We launched new forums in March 2019—join us there. In a hurry for help with your website? Get Help Now!
MODX Community Forums Archive

Wayfinder IncludeDocs parameter is breaking the snippet?

    • 36552
    • 32 Posts
    djad33 Reply #1, 9 years, 5 months ago
    I'm quite stuck on an unexpected problem. I'm trying to use Wayfinder to generate a sitemap for a project. The output of the navigation items is as expected, but I need to include a number of documents in addition to the primary navigation elements.

    To do this, I have used the includeDocs parameter.

    [[Wayfinder? &startId=`0` &includeDocs=`17,18,19,20`]]

    When I do this, I get no output at all. Remove includeDocs and I get the standard nav (expected). Use the param and the output is completely empty.

    No idea what I'm doing wrong or what (if any) other setting must be defined in order to make this work.
    • chrischerrett Reply #2, 9 years, 5 months ago
      Looking at the code in Wayfinder, I'm not sure this property is used to include additional elements? It appears to me that this will limit the results to 17,18,19,20, if 17,18,19,20 appear in the original dataset.

      /* if set, limit results to specific resources */
if (!empty($this->_config['includeDocs'])) {
  $c->where(array('modResource.id:IN' => explode(',',$this->_config['includeDocs'])));
}


      Only those resources which are in both are returned. I might be wrong, as this was just a quick glance, but this would explain it.
      • Jako Reply #3, 9 years, 5 months ago
        Almost the same code in Evo.

        if ($this->_config['includeDocs']) {
	$menuWhere .= " AND sc.id IN ({$this->_config['includeDocs']})";
}


        Additional resources could not be added this way.

        Anyway, since you are using &startId=`0`, the resorces 17, 18, 19, 20 should be shown, but only if they are not hidden from the menu.
        • chrischerrett Reply #4, 9 years, 5 months ago
          Sorry, we're talking Evo. I wasn't paying attention to the thread group!
            • 36552
            • 32 Posts
            djad33 Reply #5, 9 years, 5 months ago
            Thanks for the input. IncludeDocs is a terrible name for this parameter.

            I ended up having to create a series of Wayfinder calls in order to display the elements desired.
            • Jako Reply #6, 9 years, 5 months ago
              Yes, the parameter name could be called better. To include additional resources (without checking if they are visible, published, deleted, allowed for the current user etc.) you could try to add
              &where=`1=1 OR sc.id IN (17,18,19,20)`

              to the snippet call. Untested.
                • 36552
                • 32 Posts
                djad33 Reply #7, 9 years, 5 months ago
                That's a good idea, Jako. Thanks! I'm already working from a modified version of Wayfinder. I made it capable of using resource children under different parents, so a section could appear under more than one parent category. Adding another parameter shouldn't be too big of a deal.
                  • 1061
                  • 81 Posts
                  alex_dutch Reply #8, 9 years, 4 months ago
                  Simple solution is used 
                  &excludeDocs=``
                  if nearby resources is not so much.
                  And maybe useful 
                  &ignoreHidden=`1`
                  to mark them in "Hide From Menus" [ed. note: alex_dutch last edited this post 9 years, 4 months ago.]