X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FContact%2FBAO%2FGroupNesting.php;h=1a27086e77d0d79e9aca627cda4b926d2cb09324;hb=77c5b6193c63d17f0c16a20b4dd4aa3a0adf8d5b;hp=dc656cd9d7a417a9ee9948edd881d3e3e76cc9bb;hpb=e913987d303f2c51e60be23820fc8d1031e7eadd;p=civicrm-core.git

diff --git a/CRM/Contact/BAO/GroupNesting.php b/CRM/Contact/BAO/GroupNesting.php
index dc656cd9d7..1a27086e77 100644
--- a/CRM/Contact/BAO/GroupNesting.php
+++ b/CRM/Contact/BAO/GroupNesting.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright U.S. PIRG Education Fund (c) 2007                        |
  | Licensed to CiviCRM under the Academic Free License version 3.0.   |
@@ -50,9 +50,9 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
   private $_alreadyStyled = FALSE;
 
   /**
-   * class constructor
+   * Class constructor
    */
-  function __construct($styleLabels = FALSE, $styleIndent = "&nbsp;--&nbsp;") {
+  public function __construct($styleLabels = FALSE, $styleIndent = "&nbsp;--&nbsp;") {
     parent::__construct();
     $this->_styleLabels = $styleLabels;
     $this->_styleIndent = $styleIndent;
@@ -61,7 +61,7 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
   /**
    * @param $sortOrder
    */
-  function setSortOrder($sortOrder) {
+  public function setSortOrder($sortOrder) {
     switch ($sortOrder) {
       case 'ASC':
       case 'DESC':
@@ -79,14 +79,14 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
   /**
    * @return string
    */
-  function getSortOrder() {
+  public function getSortOrder() {
     return self::$_sortOrder;
   }
 
   /**
    * @return int
    */
-  function getCurrentNestingLevel() {
+  public function getCurrentNestingLevel() {
     return count($this->_parentStack);
   }
 
@@ -95,7 +95,7 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
    * which is the first group (according to _sortOrder) that
    * has no parent groups
    */
-  function rewind() {
+  public function rewind() {
     $this->_parentStack = array();
     // calling _getNextParentlessGroup w/ no arguments
     // makes it return the first parentless group
@@ -105,7 +105,7 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
     $this->_alreadyStyled = FALSE;
   }
 
-  function current() {
+  public function current() {
     if ($this->_styleLabels &&
       $this->valid() &&
       !$this->_alreadyStyled
@@ -127,7 +127,7 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
   /**
    * @return string
    */
-  function key() {
+  public function key() {
     $group = &$this->_current;
     $ids = array();
     foreach ($this->_parentStack as $parentGroup) {
@@ -144,7 +144,7 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
   /**
    * @return CRM_Contact_BAO_Group|null
    */
-  function next() {
+  public function next() {
     $currentGroup = &$this->_current;
     $childGroup = $this->_getNextChildGroup($currentGroup);
     if ($childGroup) {
@@ -178,7 +178,7 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
   /**
    * @return bool
    */
-  function valid() {
+  public function valid() {
     if ($this->_current) {
       return TRUE;
     }
@@ -192,7 +192,7 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
    *
    * @return CRM_Contact_BAO_Group|null
    */
-  function _getNextParentlessGroup(&$group = NULL) {
+  public function _getNextParentlessGroup(&$group = NULL) {
     $lastParentlessGroup = $this->_lastParentlessGroup;
     $nextGroup           = new CRM_Contact_BAO_Group();
     $nextGroup->order_by = 'title ' . self::$_sortOrder;
@@ -220,7 +220,7 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
    *
    * @return CRM_Contact_BAO_Group|null
    */
-  function _getNextChildGroup(&$parentGroup, &$group = NULL) {
+  public function _getNextChildGroup(&$parentGroup, &$group = NULL) {
     $children = self::getChildGroupIds($parentGroup->id);
     if (count($children) > 0) {
       // we have child groups, so get the first one based on _sortOrder
@@ -251,7 +251,7 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
    *
    * @return CRM_Contact_BAO_Group|null
    */
-  function _getNextSiblingGroup(&$group) {
+  public function _getNextSiblingGroup(&$group) {
     $parentGroup = end($this->_parentStack);
     if ($parentGroup) {
       $nextGroup = $this->_getNextChildGroup($parentGroup, $group);
@@ -277,17 +277,15 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
    * Adds a new child group identified by $childGroupId to the group
    * identified by $groupId
    *
-   * @param $parentID
-   * @param $childID
+   * @param int $parentID
+   *   Id of the group to add the child to.
+   * @param int $childID
+   *   Id of the new child group.
    *
-   * @internal param \The $groupId id of the group to add the child to
-   * @internal param \The $childGroupId id of the new child group
    *
-   * @return           void
-   *
-   * @access public
+   * @return void
    */
-  static function add($parentID, $childID) {
+  public static function add($parentID, $childID) {
     // TODO: Add checks here to make sure invalid nests can't be created
     $dao = new CRM_Contact_DAO_GroupNesting();
     $query = "REPLACE INTO civicrm_group_nesting (child_group_id, parent_group_id) VALUES ($childID,$parentID);";
@@ -299,14 +297,15 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
    * identified by $groupId; does not delete child group, just the
    * association between the two
    *
-   * @param            $parentID         The id of the group to remove the child from
-   * @param            $childID          The id of the child group being removed
+   * @param $parentID
+   *   The id of the group to remove the child from.
+   * @param $childID
+   *   The id of the child group being removed.
    *
    * @return           void
    *
-   * @access public
    */
-  static function remove($parentID, $childID) {
+  public static function remove($parentID, $childID) {
     $dao = new CRM_Contact_DAO_GroupNesting();
     $query = "DELETE FROM civicrm_group_nesting WHERE child_group_id = $childID AND parent_group_id = $parentID";
     $dao->query($query);
@@ -317,14 +316,13 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
    * identified by $groupId; does not delete child group, just the
    * association between the two
    *
-   * @param            $childID          The id of the child group being removed
+   * @param int $childID
+   *   The id of the child group being removed.
    *
-   * @internal param \The $parentID id of the group to remove the child from
    * @return           void
    *
-   * @access public
    */
-  static function removeAllParentForChild($childID) {
+  public static function removeAllParentForChild($childID) {
     $dao = new CRM_Contact_DAO_GroupNesting();
     $query = "DELETE FROM civicrm_group_nesting WHERE child_group_id = $childID";
     $dao->query($query);
@@ -334,14 +332,15 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
    * Returns true if the association between parent and child is present,
    * false otherwise.
    *
-   * @param            $parentID         The parent id of the association
-   * @param            $childID          The child id of the association
+   * @param $parentID
+   *   The parent id of the association.
+   * @param $childID
+   *   The child id of the association.
    *
    * @return           boolean           True if association is found, false otherwise.
    *
-   * @access public
    */
-  static function isParentChild($parentID, $childID) {
+  public static function isParentChild($parentID, $childID) {
     $dao = new CRM_Contact_DAO_GroupNesting();
     $query = "SELECT id FROM civicrm_group_nesting WHERE child_group_id = $childID AND parent_group_id = $parentID";
     $dao->query($query);
@@ -355,13 +354,13 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
    * Returns true if if the given groupId has 1 or more child groups,
    * false otherwise.
    *
-   * @param            $groupId               The id of the group to check for child groups
+   * @param $groupId
+   *   The id of the group to check for child groups.
    *
    * @return           boolean                True if 1 or more child groups are found, false otherwise.
    *
-   * @access public
    */
-  static function hasChildGroups($groupId) {
+  public static function hasChildGroups($groupId) {
     $dao = new CRM_Contact_DAO_GroupNesting();
     $query = "SELECT child_group_id FROM civicrm_group_nesting WHERE parent_group_id = $groupId LIMIT 1";
     //print $query . "\n<br><br>";
@@ -376,13 +375,13 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
    * Returns true if the given groupId has 1 or more parent groups,
    * false otherwise.
    *
-   * @param            $groupId               The id of the group to check for parent groups
+   * @param $groupId
+   *   The id of the group to check for parent groups.
    *
    * @return           boolean                True if 1 or more parent groups are found, false otherwise.
    *
-   * @access public
    */
-  static function hasParentGroups($groupId) {
+  public static function hasParentGroups($groupId) {
     $dao = new CRM_Contact_DAO_GroupNesting();
     $query = "SELECT parent_group_id FROM civicrm_group_nesting WHERE child_group_id = $groupId LIMIT 1";
     $dao->query($query);
@@ -396,14 +395,15 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
    * Returns true if checkGroupId is a parent of one of the groups in
    * groupIds, false otherwise.
    *
-   * @param            $groupIds              Array of group ids (or one group id) to serve as the starting point
-   * @param            $checkGroupId         The group id to check if it is a parent of the $groupIds group(s)
+   * @param $groupIds
+   *   Array of group ids (or one group id) to serve as the starting point.
+   * @param $checkGroupId
+   *   The group id to check if it is a parent of the $groupIds group(s).
    *
    * @return           boolean                True if $checkGroupId points to a group that is a parent of one of the $groupIds groups, false otherwise.
    *
-   * @access public
    */
-  static function isParentGroup($groupIds, $checkGroupId) {
+  public static function isParentGroup($groupIds, $checkGroupId) {
     if (!is_array($groupIds)) {
       $groupIds = array($groupIds);
     }
@@ -427,14 +427,15 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
    * Returns true if checkGroupId is a child of one of the groups in
    * groupIds, false otherwise.
    *
-   * @param            $groupIds              Array of group ids (or one group id) to serve as the starting point
-   * @param            $checkGroupId         The group id to check if it is a child of the $groupIds group(s)
+   * @param $groupIds
+   *   Array of group ids (or one group id) to serve as the starting point.
+   * @param $checkGroupId
+   *   The group id to check if it is a child of the $groupIds group(s).
    *
    * @return           boolean                True if $checkGroupId points to a group that is a child of one of the $groupIds groups, false otherwise.
    *
-   * @access public
    */
-  static function isChildGroup($groupIds, $checkGroupId) {
+  public static function isChildGroup($groupIds, $checkGroupId) {
 
     if (!is_array($groupIds)) {
       $groupIds = array($groupIds);
@@ -460,14 +461,15 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
    * Returns true if checkGroupId is an ancestor of one of the groups in
    * groupIds, false otherwise.
    *
-   * @param            $groupIds              Array of group ids (or one group id) to serve as the starting point
-   * @param            $checkGroupId         The group id to check if it is an ancestor of the $groupIds group(s)
+   * @param $groupIds
+   *   Array of group ids (or one group id) to serve as the starting point.
+   * @param $checkGroupId
+   *   The group id to check if it is an ancestor of the $groupIds group(s).
    *
    * @return           boolean                True if $checkGroupId points to a group that is an ancestor of one of the $groupIds groups, false otherwise.
    *
-   * @access public
    */
-  static function isAncestorGroup($groupIds, $checkGroupId) {
+  public static function isAncestorGroup($groupIds, $checkGroupId) {
     if (!is_array($groupIds)) {
       $groupIds = array($groupIds);
     }
@@ -500,14 +502,15 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
    * Returns true if checkGroupId is a descendent of one of the groups in
    * groupIds, false otherwise.
    *
-   * @param            $groupIds              Array of group ids (or one group id) to serve as the starting point
-   * @param            $checkGroupId         The group id to check if it is a descendent of the $groupIds group(s)
+   * @param $groupIds
+   *   Array of group ids (or one group id) to serve as the starting point.
+   * @param $checkGroupId
+   *   The group id to check if it is a descendent of the $groupIds group(s).
    *
    * @return           boolean                True if $checkGroupId points to a group that is a descendent of one of the $groupIds groups, false otherwise.
    *
-   * @access public
    */
-  static function isDescendentGroup($groupIds, $checkGroupId) {
+  public static function isDescendentGroup($groupIds, $checkGroupId) {
     if (!is_array($groupIds)) {
       $groupIds = array($groupIds);
     }
@@ -539,13 +542,14 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
   /**
    * Returns array of group ids of ancestor groups of the specified group.
    *
-   * @param             $groupIds             An array of valid group ids (passed by reference)
+   * @param $groupIds
+   *   An array of valid group ids (passed by reference).
    *
    * @param bool $includeSelf
    *
    * @return array $groupIdArray         List of groupIds that represent the requested group and its ancestors@access public
    */
-  static function getAncestorGroupIds($groupIds, $includeSelf = TRUE) {
+  public static function getAncestorGroupIds($groupIds, $includeSelf = TRUE) {
     if (!is_array($groupIds)) {
       $groupIds = array($groupIds);
     }
@@ -575,12 +579,13 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
   /**
    * Returns array of ancestor groups of the specified group.
    *
-   * @param             $groupIds     An array of valid group ids (passed by reference)
+   * @param $groupIds
+   *   An array of valid group ids (passed by reference).
    *
    * @param bool $includeSelf
    * @return \An $groupArray   List of ancestor groups@access public
    */
-  static function getAncestorGroups($groupIds, $includeSelf = TRUE) {
+  public static function getAncestorGroups($groupIds, $includeSelf = TRUE) {
     $groupIds = self::getAncestorGroupIds($groupIds, $includeSelf);
     $params['id'] = $groupIds;
     return CRM_Contact_BAO_Group::getGroups($params);
@@ -589,11 +594,12 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
   /**
    * Returns array of group ids of child groups of the specified group.
    *
-   * @param             $groupIds     An array of valid group ids (passed by reference)
+   * @param $groupIds
+   *   An array of valid group ids (passed by reference).
    *
    * @return array $groupIdArray List of groupIds that represent the requested group and its children@access public
    */
-  static function getChildGroupIds($groupIds) {
+  public static function getChildGroupIds($groupIds) {
     if (!is_array($groupIds)) {
       $groupIds = array($groupIds);
     }
@@ -610,11 +616,12 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
   /**
    * Returns array of group ids of parent groups of the specified group.
    *
-   * @param             $groupIds               An array of valid group ids (passed by reference)
+   * @param $groupIds
+   *   An array of valid group ids (passed by reference).
    *
    * @return array $groupIdArray         List of groupIds that represent the requested group and its parents@access public
    */
-  static function getParentGroupIds($groupIds) {
+  public static function getParentGroupIds($groupIds) {
     if (!is_array($groupIds)) {
       $groupIds = array($groupIds);
     }
@@ -631,12 +638,13 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
   /**
    * Returns array of group ids of descendent groups of the specified group.
    *
-   * @param             $groupIds               An array of valid group ids (passed by reference)
+   * @param $groupIds
+   *   An array of valid group ids (passed by reference).
    *
    * @param bool $includeSelf
    * @return array $groupIdArray         List of groupIds that represent the requested group and its descendents@access public
    */
-  static function getDescendentGroupIds($groupIds, $includeSelf = TRUE) {
+  public static function getDescendentGroupIds($groupIds, $includeSelf = TRUE) {
     if (!is_array($groupIds)) {
       $groupIds = array($groupIds);
     }
@@ -664,12 +672,13 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
   /**
    * Returns array of descendent groups of the specified group.
    *
-   * @param             $groupIds     An array of valid group ids (passed by reference)
+   * @param $groupIds
+   *   An array of valid group ids (passed by reference).
    *
    * @param bool $includeSelf
    * @return \An $groupArray   List of descendent groups@access public
    */
-  static function getDescendentGroups($groupIds, $includeSelf = TRUE) {
+  public static function getDescendentGroups($groupIds, $includeSelf = TRUE) {
     $groupIds = self::getDescendentGroupIds($groupIds, $includeSelf);
     $params['id'] = $groupIds;
     return CRM_Contact_BAO_Group::getGroups($params);
@@ -678,11 +687,12 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
   /**
    * Returns array of group ids of valid potential child groups of the specified group.
    *
-   * @param             $groupId              The group id to get valid potential children for
+   * @param $groupId
+   *   The group id to get valid potential children for.
    *
    * @return array $groupIdArray         List of groupIds that represent the valid potential children of the group@access public
    */
-  static function getPotentialChildGroupIds($groupId) {
+  public static function getPotentialChildGroupIds($groupId) {
     $groups = CRM_Contact_BAO_Group::getGroups();
     $potentialChildGroupIds = array();
     foreach ($groups as $group) {
@@ -699,12 +709,12 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
   }
 
   /**
-   * @param $contactId
-   * @param $parentGroupId
+   * @param int $contactId
+   * @param int $parentGroupId
    *
    * @return array
    */
-  static function getContainingGroups($contactId, $parentGroupId) {
+  public static function getContainingGroups($contactId, $parentGroupId) {
     $groups = CRM_Contact_BAO_Group::getGroups();
     $containingGroups = array();
     foreach ($groups as $group) {
@@ -719,4 +729,3 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
     return $containingGroups;
   }
 }
-