CRM/Group/Page/AJAX.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  *
  33  */
  34
  35 /**
  36  * This class contains the functions that are called using AJAX (jQuery)
  37  */
  38 class CRM_Group_Page_AJAX {
  39
  40   /**
  41    * Get list of groups.
  42    */
  43   public static function getGroupList() {
  44     $params = $_GET;
  45     if (isset($params['parent_id'])) {
  46       // requesting child groups for a given parent
  47       $params['page'] = 1;
  48       $params['rp'] = 0;
  49       $groups = CRM_Contact_BAO_Group::getGroupListSelector($params);
  50     }
  51     else {
  52       $requiredParams = [];
  53       $optionalParams = [
  54         'title' => 'String',
  55         'created_by' => 'String',
  56         'group_type' => 'String',
  57         'visibility' => 'String',
  58         'component_mode' => 'String',
  59         'status' => 'Integer',
  60         'parentsOnly' => 'Integer',
  61         'showOrgInfo' => 'Boolean',
  62         // Ignore 'parent_id' as that case is handled above
  63       ];
  64       $params = CRM_Core_Page_AJAX::defaultSortAndPagerParams();
  65       $params += CRM_Core_Page_AJAX::validateParams($requiredParams, $optionalParams);
  66
  67       // get group list
  68       $groups = CRM_Contact_BAO_Group::getGroupListSelector($params);
  69
  70       // if no groups found with parent-child hierarchy and logged in user say can view child groups only (an ACL case),
  71       // go ahead with flat hierarchy, CRM-12225
  72       if (empty($groups)) {
  73         $groupsAccessible = CRM_Core_PseudoConstant::group();
  74         $parentsOnly = CRM_Utils_Array::value('parentsOnly', $params);
  75         if (!empty($groupsAccessible) && $parentsOnly) {
  76           // recompute group list with flat hierarchy
  77           $params['parentsOnly'] = 0;
  78           $groups = CRM_Contact_BAO_Group::getGroupListSelector($params);
  79         }
  80       }
  81     }
  82
  83     if (!empty($_GET['is_unit_test'])) {
  84       return $groups;
  85     }
  86
  87     CRM_Utils_JSON::output($groups);
  88   }
  89
  90 }