CRM/Group/Page/AJAX.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  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 = $_REQUEST;
  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       $sortMapper = array(
  57         0 => 'groups.title',
  58         1 => 'count',
  59         2 => 'createdBy.sort_name',
  60         3 => '',
  61         4 => 'groups.group_type',
  62         5 => 'groups.visibility',
  63       );
  64
  65       $sEcho = CRM_Utils_Type::escape($_REQUEST['sEcho'], 'Integer');
  66       $offset = isset($_REQUEST['iDisplayStart']) ? CRM_Utils_Type::escape($_REQUEST['iDisplayStart'], 'Integer') : 0;
  67       $rowCount = isset($_REQUEST['iDisplayLength']) ? CRM_Utils_Type::escape($_REQUEST['iDisplayLength'], 'Integer') : 25;
  68       $sort = isset($_REQUEST['iSortCol_0']) ? CRM_Utils_Array::value(CRM_Utils_Type::escape($_REQUEST['iSortCol_0'], 'Integer'), $sortMapper) : NULL;
  69       $sortOrder = isset($_REQUEST['sSortDir_0']) ? CRM_Utils_Type::escape($_REQUEST['sSortDir_0'], 'String') : 'asc';
  70
  71       if ($sort && $sortOrder) {
  72         $params['sortBy'] = $sort . ' ' . $sortOrder;
  73       }
  74
  75       $params['page'] = ($offset / $rowCount) + 1;
  76       $params['rp'] = $rowCount;
  77
  78       // get group list
  79       $groups = CRM_Contact_BAO_Group::getGroupListSelector($params);
  80
  81       // if no groups found with parent-child hierarchy and logged in user say can view child groups only (an ACL case),
  82       // go ahead with flat hierarchy, CRM-12225
  83       if (empty($groups)) {
  84         $groupsAccessible = CRM_Core_PseudoConstant::group();
  85         $parentsOnly = CRM_Utils_Array::value('parentsOnly', $params);
  86         if (!empty($groupsAccessible) && $parentsOnly) {
  87           // recompute group list with flat hierarchy
  88           $params['parentsOnly'] = 0;
  89           $groups = CRM_Contact_BAO_Group::getGroupListSelector($params);
  90         }
  91       }
  92
  93       $iFilteredTotal = $iTotal = $params['total'];
  94       $selectorElements = array(
  95         'group_name',
  96         'count',
  97         'created_by',
  98         'group_description',
  99         'group_type',
 100         'visibility',
 101         'org_info',
 102         'links',
 103         'class',
 104       );
 105
 106       if (empty($params['showOrgInfo'])) {
 107         unset($selectorElements[6]);
 108       }
 109       //add setting so this can be tested by unit test
 110       //@todo - ideally the portion of this that retrieves the groups should be extracted into a function separate
 111       // from the one which deals with web inputs & outputs so we have a properly testable & re-usable function
 112       if (!empty($params['is_unit_test'])) {
 113         return array($groups, $iFilteredTotal);
 114       }
 115       header('Content-Type: application/json');
 116       echo CRM_Utils_JSON::encodeDataTableSelector($groups, $sEcho, $iTotal, $iFilteredTotal, $selectorElements);
 117       CRM_Utils_System::civiExit();
 118     }
 119   }
 120
 121 }