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   public static function getGroupList() {
  40     $params = $_REQUEST;
  41
  42     if (isset($params['parent_id'])) {
  43       // requesting child groups for a given parent
  44       $params['page'] = 1;
  45       $params['rp']   = 0;
  46       $groups = CRM_Contact_BAO_Group::getGroupListSelector($params);
  47
  48       CRM_Utils_JSON::output($groups);
  49     }
  50     else {
  51       $sortMapper = array(
  52         0 => 'groups.title',
  53       1 => 'count',
  54       2 => 'createdBy.sort_name',
  55       3 => '',
  56         4 => 'groups.group_type',
  57       5 => 'groups.visibility',
  58       );
  59
  60       $sEcho     = CRM_Utils_Type::escape($_REQUEST['sEcho'], 'Integer');
  61       $offset    = isset($_REQUEST['iDisplayStart']) ? CRM_Utils_Type::escape($_REQUEST['iDisplayStart'], 'Integer') : 0;
  62       $rowCount  = isset($_REQUEST['iDisplayLength']) ? CRM_Utils_Type::escape($_REQUEST['iDisplayLength'], 'Integer') : 25;
  63       $sort      = isset($_REQUEST['iSortCol_0']) ? CRM_Utils_Array::value(CRM_Utils_Type::escape($_REQUEST['iSortCol_0'], 'Integer'), $sortMapper) : NULL;
  64       $sortOrder = isset($_REQUEST['sSortDir_0']) ? CRM_Utils_Type::escape($_REQUEST['sSortDir_0'], 'String') : 'asc';
  65
  66       if ($sort && $sortOrder) {
  67         $params['sortBy'] = $sort . ' ' . $sortOrder;
  68       }
  69
  70       $params['page'] = ($offset / $rowCount) + 1;
  71       $params['rp'] = $rowCount;
  72
  73       // get group list
  74       $groups = CRM_Contact_BAO_Group::getGroupListSelector($params);
  75
  76       // if no groups found with parent-child hierarchy and logged in user say can view child groups only (an ACL case),
  77       // go ahead with flat hierarchy, CRM-12225
  78       if (empty($groups)) {
  79         $groupsAccessible = CRM_Core_PseudoConstant::group();
  80         $parentsOnly      = CRM_Utils_Array::value('parentsOnly', $params);
  81         if (!empty($groupsAccessible) && $parentsOnly) {
  82           // recompute group list with flat hierarchy
  83           $params['parentsOnly'] = 0;
  84           $groups = CRM_Contact_BAO_Group::getGroupListSelector($params);
  85         }
  86       }
  87
  88       $iFilteredTotal = $iTotal = $params['total'];
  89       $selectorElements = array(
  90         'group_name', 'count', 'created_by', 'group_description',
  91         'group_type', 'visibility', 'org_info', 'links', 'class',
  92       );
  93
  94       if (empty($params['showOrgInfo'])) {
  95         unset($selectorElements[6]);
  96       }
  97       //add setting so this can be tested by unit test
  98       //@todo - ideally the portion of this that retrieves the groups should be extracted into a function separate
  99       // from the one which deals with web inputs & outputs so we have a properly testable & re-usable function
 100       if (!empty($params['is_unit_test'])) {
 101         return array($groups, $iFilteredTotal);
 102       }
 103       echo CRM_Utils_JSON::encodeDataTableSelector($groups, $sEcho, $iTotal, $iFilteredTotal, $selectorElements);
 104       CRM_Utils_System::civiExit();
 105     }
 106   }
 107 }