CRM/Group/Page/AJAX.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  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    * Get list of groups.
  41    *
  42    * @return array
  43    */
  44   public static function getGroupList() {
  45     $params = $_GET;
  46
  47     if (isset($params['parent_id'])) {
  48       // requesting child groups for a given parent
  49       $params['page'] = 1;
  50       $params['rp'] = 0;
  51       $groups = CRM_Contact_BAO_Group::getGroupListSelector($params);
  52
  53       CRM_Utils_JSON::output($groups);
  54     }
  55     else {
  56
  57       $sortMapper = array();
  58       foreach ($_GET['columns'] as $key => $value) {
  59         $sortMapper[$key] = $value['data'];
  60       };
  61
  62       $offset = isset($_GET['start']) ? CRM_Utils_Type::escape($_GET['start'], 'Integer') : 0;
  63       $rowCount = isset($_GET['length']) ? CRM_Utils_Type::escape($_GET['length'], 'Integer') : 25;
  64       $sort = isset($_GET['order'][0]['column']) ? CRM_Utils_Array::value(CRM_Utils_Type::escape($_GET['order'][0]['column'], 'Integer'), $sortMapper) : NULL;
  65       $sortOrder = isset($_GET['order'][0]['dir']) ? CRM_Utils_Type::escape($_GET['order'][0]['dir'], 'String') : 'asc';
  66
  67       if ($sort && $sortOrder) {
  68         $params['sortBy'] = $sort . ' ' . $sortOrder;
  69       }
  70
  71       $params['page'] = ($offset / $rowCount) + 1;
  72       $params['rp'] = $rowCount;
  73
  74       // get group list
  75       $groups = CRM_Contact_BAO_Group::getGroupListSelector($params);
  76
  77       // if no groups found with parent-child hierarchy and logged in user say can view child groups only (an ACL case),
  78       // go ahead with flat hierarchy, CRM-12225
  79       if (empty($groups)) {
  80         $groupsAccessible = CRM_Core_PseudoConstant::group();
  81         $parentsOnly = CRM_Utils_Array::value('parentsOnly', $params);
  82         if (!empty($groupsAccessible) && $parentsOnly) {
  83           // recompute group list with flat hierarchy
  84           $params['parentsOnly'] = 0;
  85           $groups = CRM_Contact_BAO_Group::getGroupListSelector($params);
  86         }
  87       }
  88
  89       //add setting so this can be tested by unit test
  90       //@todo - ideally the portion of this that retrieves the groups should be extracted into a function separate
  91       // from the one which deals with web inputs & outputs so we have a properly testable & re-usable function
  92       if (!empty($params['is_unit_test'])) {
  93         return array($groups, $iFilteredTotal);
  94       }
  95       CRM_Utils_JSON::output($groups);
  96     }
  97   }
  98
  99 }