SproutCMS

This is the code documentation for the SproutCMS project

source of /sprout/Helpers/TreenodeInMenuMatcher.php

  1. <?php
  2. /*
  3.  * Copyright (C) 2017 Karmabunny Pty Ltd.
  4.  *
  5.  * This file is a part of SproutCMS.
  6.  *
  7.  * SproutCMS is free software: you can redistribute it and/or modify it under the terms
  8.  * of the GNU General Public License as published by the Free Software Foundation, either
  9.  * version 2 of the License, or (at your option) any later version.
  10.  *
  11.  * For more information, visit <http://getsproutcms.com>.
  12.  */
  13.  
  14. namespace Sprout\Helpers;
  15.  
  16. /**
  17. * @package Tree
  18. **/
  19.  
  20. /**
  21. * Matches a node which has a specific key matching a specific value
  22. **/
  23. class TreenodeInMenuMatcher implements TreenodeMatcher
  24. {
  25.  
  26. /**
  27.   * Does the match
  28.   *
  29.   * @param TreeNode $node The treenode to do matching against
  30.   * @return True if the node matches, false otherwise
  31.   **/
  32. public function match($node)
  33. {
  34. if (! UserPerms::checkPermissionsTree('pages', $node['id'])) return false;
  35. if ($node['show_in_nav']) return true;
  36. return false;
  37. }
  38.  
  39. /**
  40.   * Returns true if the children of the specified node should be searched, false otherwise.
  41.   *
  42.   * @param TreeNode $node The treenode which is about to be descended into
  43.   * @return True descending should proceed, false otherwise
  44.   **/
  45. public function descend($node)
  46. {
  47. return true;
  48. }
  49.  
  50. /**
  51.   * Called after children have been processed
  52.   *
  53.   * @param TreeNode $node The treenode which has just ascended.
  54.   **/
  55. public function ascend ($node) {}
  56. }
  57.  
  58.  
  59.