SproutCMS

This is the code documentation for the SproutCMS project

source of /sprout/Helpers/TreenodeIdsMatcher.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 which has an id of one of the ids in the list
  22. **/
  23. class TreenodeIdsMatcher implements TreenodeMatcher
  24. {
  25. private $ids = array();
  26.  
  27.  
  28. /**
  29.   * Constructor
  30.   **/
  31. public function __construct(array $ids)
  32. {
  33. $this->ids = $ids;
  34. }
  35.  
  36.  
  37. /**
  38.   * Does the match
  39.   *
  40.   * @param TreeNode $node The treenode to do matching against
  41.   * @return True if the node matches, false otherwise
  42.   **/
  43. public function match($node)
  44. {
  45. if (in_array($node['id'], $this->ids)) return true;
  46. return false;
  47. }
  48.  
  49. /**
  50.   * Returns true if the children of the specified node should be searched, false otherwise.
  51.   *
  52.   * @param TreeNode $node The treenode which is about to be descended into
  53.   * @return True descending should proceed, false otherwise
  54.   **/
  55. public function descend($node)
  56. {
  57. return true;
  58. }
  59.  
  60. /**
  61.   * Called after children have been processed
  62.   *
  63.   * @param TreeNode $node The treenode which has just ascended.
  64.   **/
  65. public function ascend ($node) {}
  66. }
  67.  
  68.  
  69.