3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2015
36 * This class contains all contact related functions that are called using AJAX (jQuery)
38 class CRM_Contact_Page_AJAX
{
40 * When a user chooses a username, CHECK_USERNAME_TTL
41 * is the time window in which they can check usernames
42 * (without reloading the overall form).
44 const CHECK_USERNAME_TTL
= 10800; // 3hr; 3*60*60
46 const AUTOCOMPLETE_TTL
= 21600; // 6hr; 6*60*60
49 * Ajax callback for custom fields of type ContactReference
51 * Todo: Migrate contact reference fields to use EntityRef
53 public static function contactReference() {
54 $name = CRM_Utils_Array
::value('term', $_GET);
55 $name = CRM_Utils_Type
::escape($name, 'String');
56 $cfID = CRM_Utils_Type
::escape($_GET['id'], 'Positive');
58 // check that this is a valid, active custom field of Contact Reference type
59 $params = array('id' => $cfID);
60 $returnProperties = array('filter', 'data_type', 'is_active');
62 CRM_Core_DAO
::commonRetrieve('CRM_Core_DAO_CustomField', $params, $cf, $returnProperties);
63 if (!$cf['id'] ||
!$cf['is_active'] ||
$cf['data_type'] != 'ContactReference') {
64 CRM_Utils_System
::civiExit('error');
67 if (!empty($cf['filter'])) {
68 $filterParams = array();
69 parse_str($cf['filter'], $filterParams);
71 $action = CRM_Utils_Array
::value('action', $filterParams);
73 if (!empty($action) &&
74 !in_array($action, array('get', 'lookup'))
76 CRM_Utils_System
::civiExit('error');
80 $list = array_keys(CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
81 'contact_reference_options'
84 $return = array_unique(array_merge(array('sort_name'), $list));
86 $limit = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'search_autocomplete_count', NULL, 10);
88 $params = array('offset' => 0, 'rowCount' => $limit, 'version' => 3);
89 foreach ($return as $fld) {
90 $params["return.{$fld}"] = 1;
93 if (!empty($action)) {
109 foreach ($_GET as $param => $val) {
111 in_array($param, $excludeGet) ||
112 strpos($param, 'return.') !== FALSE ||
113 strpos($param, 'api.') !== FALSE
117 $params[$param] = $val;
122 $params['sort_name'] = $name;
125 $params['sort'] = 'sort_name';
127 // tell api to skip permission chk. dgg
128 $params['check_permissions'] = 0;
130 // add filter variable to params
131 if (!empty($filterParams)) {
132 $params = array_merge($params, $filterParams);
135 $contact = civicrm_api('Contact', 'Get', $params);
137 if (!empty($contact['is_error'])) {
138 CRM_Utils_System
::civiExit('error');
141 $contactList = array();
142 foreach ($contact['values'] as $value) {
144 foreach ($return as $fld) {
145 if (!empty($value[$fld])) {
146 $view[] = $value[$fld];
149 $contactList[] = array('id' => $value['id'], 'text' => implode(' :: ', $view));
152 CRM_Utils_JSON
::output($contactList);
156 * Fetch PCP ID by PCP Supporter sort_name, also displays PCP title and associated Contribution Page title
158 public static function getPCPList() {
159 $name = CRM_Utils_Array
::value('term', $_GET);
160 $name = CRM_Utils_Type
::escape($name, 'String');
161 $limit = $max = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'search_autocomplete_count', NULL, 10);
163 $where = ' AND pcp.page_id = cp.id AND pcp.contact_id = cc.id';
165 $config = CRM_Core_Config
::singleton();
166 if ($config->includeWildCardInName
) {
167 $strSearch = "%$name%";
170 $strSearch = "$name%";
172 $includeEmailFrom = $includeNickName = '';
173 if ($config->includeNickNameInName
) {
174 $includeNickName = " OR nick_name LIKE '$strSearch'";
176 if ($config->includeEmailInName
) {
177 $includeEmailFrom = "LEFT JOIN civicrm_email eml ON ( cc.id = eml.contact_id AND eml.is_primary = 1 )";
178 $whereClause = " WHERE ( email LIKE '$strSearch' OR sort_name LIKE '$strSearch' $includeNickName ) {$where} ";
181 $whereClause = " WHERE ( sort_name LIKE '$strSearch' $includeNickName ) {$where} ";
184 $offset = $count = 0;
185 if (!empty($_GET['page_num'])) {
186 $page = (int) $_GET['page_num'];
187 $offset = $limit * ($page - 1);
191 $select = 'cc.sort_name, pcp.title, cp.title';
195 SELECT pcp.id as id, CONCAT_WS( ' :: ', {$select} ) as data, sort_name
196 FROM civicrm_pcp pcp, civicrm_contribution_page cp, civicrm_contact cc
198 {$whereClause} AND pcp.page_type = 'contribute'
200 SELECT pcp.id as id, CONCAT_WS( ' :: ', {$select} ) as data, sort_name
201 FROM civicrm_pcp pcp, civicrm_event cp, civicrm_contact cc
203 {$whereClause} AND pcp.page_type = 'event'
206 LIMIT $offset, $limit
209 $dao = CRM_Core_DAO
::executeQuery($query);
210 $output = array('results' => array(), 'more' => FALSE);
211 while ($dao->fetch()) {
212 if (++
$count > $max) {
213 $output['more'] = TRUE;
216 $output['results'][] = array('id' => $dao->id
, 'text' => $dao->data
);
219 CRM_Utils_JSON
::output($output);
222 public static function relationship() {
223 $relType = CRM_Utils_Request
::retrieve('rel_type', 'Positive', CRM_Core_DAO
::$_nullObject, TRUE);
224 $relContactID = CRM_Utils_Request
::retrieve('rel_contact', 'Positive', CRM_Core_DAO
::$_nullObject, TRUE);
225 $relationshipID = CRM_Utils_Array
::value('rel_id', $_REQUEST); // this used only to determine add or update mode
226 $caseID = CRM_Utils_Request
::retrieve('case_id', 'Positive', CRM_Core_DAO
::$_nullObject, TRUE);
228 // check if there are multiple clients for this case, if so then we need create
229 // relationship and also activities for each contacts
231 // get case client list
232 $clientList = CRM_Case_BAO_Case
::getCaseClients($caseID);
234 $ret = array('is_error' => 0);
236 foreach ($clientList as $sourceContactID) {
237 $relationParams = array(
238 'relationship_type_id' => $relType . '_a_b',
239 'contact_check' => array($relContactID => 1),
241 'case_id' => $caseID,
242 'start_date' => date("Ymd"),
245 $relationIds = array('contact' => $sourceContactID);
247 // check if we are editing/updating existing relationship
248 if ($relationshipID && $relationshipID != 'null') {
249 // here we need to retrieve appropriate relationshipID based on client id and relationship type id
250 $caseRelationships = new CRM_Contact_DAO_Relationship();
251 $caseRelationships->case_id
= $caseID;
252 $caseRelationships->relationship_type_id
= $relType;
253 $caseRelationships->contact_id_a
= $sourceContactID;
254 $caseRelationships->find();
256 while ($caseRelationships->fetch()) {
257 $relationIds['relationship'] = $caseRelationships->id
;
258 $relationIds['contactTarget'] = $relContactID;
260 $caseRelationships->free();
263 // create new or update existing relationship
264 $return = CRM_Contact_BAO_Relationship
::legacyCreateMultiple($relationParams, $relationIds);
266 if (!empty($return[4][0])) {
267 $relationshipID = $return[4][0];
269 //create an activity for case role assignment.CRM-4480
270 CRM_Case_BAO_Case
::createCaseRoleActivity($caseID, $relationshipID, $relContactID);
275 'error_message' => ts('The relationship type definition for the case role is not valid for the client and / or staff contact types. You can review and edit relationship types at <a href="%1">Administer >> Option Lists >> Relationship Types</a>.',
276 array(1 => CRM_Utils_System
::url('civicrm/admin/reltype', 'reset=1'))),
281 CRM_Utils_JSON
::output($ret);
285 * Fetch the custom field help.
287 public static function customField() {
288 $fieldId = CRM_Utils_Type
::escape($_REQUEST['id'], 'Integer');
289 $params = array('id' => $fieldId);
290 $returnProperties = array('help_pre', 'help_post');
293 CRM_Core_DAO
::commonRetrieve('CRM_Core_DAO_CustomField', $params, $values, $returnProperties);
294 CRM_Utils_JSON
::output($values);
297 public static function groupTree() {
298 CRM_Utils_System
::setHttpHeader('Content-Type', 'application/json');
299 $gids = CRM_Utils_Type
::escape($_GET['gids'], 'String');
300 echo CRM_Contact_BAO_GroupNestingCache
::json($gids);
301 CRM_Utils_System
::civiExit();
305 * Delete custom value.
307 public static function deleteCustomValue() {
308 CRM_Utils_System
::setHttpHeader('Content-Type', 'text/plain');
309 $customValueID = CRM_Utils_Type
::escape($_REQUEST['valueID'], 'Positive');
310 $customGroupID = CRM_Utils_Type
::escape($_REQUEST['groupID'], 'Positive');
312 CRM_Core_BAO_CustomValue
::deleteCustomValue($customValueID, $customGroupID);
313 $contactId = CRM_Utils_Array
::value('contactId', $_REQUEST);
315 echo CRM_Contact_BAO_Contact
::getCountComponent('custom_' . $_REQUEST['groupID'], $contactId);
318 // reset the group contact cache for this group
319 CRM_Contact_BAO_GroupContactCache
::remove();
320 CRM_Utils_System
::civiExit();
324 * check the CMS username.
326 static public function checkUserName() {
327 $signer = new CRM_Utils_Signer(CRM_Core_Key
::privateKey(), array('for', 'ts'));
329 CRM_Utils_Time
::getTimeRaw() > $_REQUEST['ts'] + self
::CHECK_USERNAME_TTL
330 ||
$_REQUEST['for'] != 'civicrm/ajax/cmsuser'
331 ||
!$signer->validate($_REQUEST['sig'], $_REQUEST)
333 $user = array('name' => 'error');
334 CRM_Utils_JSON
::output($user);
337 $config = CRM_Core_Config
::singleton();
338 $username = trim($_REQUEST['cms_name']);
340 $params = array('name' => $username);
343 $config->userSystem
->checkUserNameEmailExists($params, $errors);
345 if (isset($errors['cms_name']) ||
isset($errors['name'])) {
346 //user name is not available
347 $user = array('name' => 'no');
348 CRM_Utils_JSON
::output($user);
351 //user name is available
352 $user = array('name' => 'yes');
353 CRM_Utils_JSON
::output($user);
356 // Not reachable: JSON::output() above exits.
357 CRM_Utils_System
::civiExit();
361 * Function to get email address of a contact.
363 public static function getContactEmail() {
364 if (!empty($_REQUEST['contact_id'])) {
365 $contactID = CRM_Utils_Type
::escape($_REQUEST['contact_id'], 'Positive');
366 if (!CRM_Contact_BAO_Contact_Permission
::allow($contactID, CRM_Core_Permission
::EDIT
)) {
371 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($contactID);
373 CRM_Utils_System
::setHttpHeader('Content-Type', 'text/plain');
379 $noemail = CRM_Utils_Array
::value('noemail', $_GET);
381 $name = CRM_Utils_Array
::value('name', $_GET);
383 $name = CRM_Utils_Type
::escape($name, 'String');
385 $queryString = " cc.sort_name LIKE '%$name%'";
388 $queryString = " ( cc.sort_name LIKE '%$name%' OR ce.email LIKE '%$name%' ) ";
392 $cid = CRM_Utils_Array
::value('cid', $_GET);
394 //check cid for integer
395 $contIDS = explode(',', $cid);
396 foreach ($contIDS as $contID) {
397 CRM_Utils_Type
::escape($contID, 'Integer');
399 $queryString = " cc.id IN ( $cid )";
404 $offset = CRM_Utils_Array
::value('offset', $_GET, 0);
405 $rowCount = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'search_autocomplete_count', NULL, 10);
407 $offset = CRM_Utils_Type
::escape($offset, 'Int');
409 // add acl clause here
410 list($aclFrom, $aclWhere) = CRM_Contact_BAO_Contact_Permission
::cacheClause('cc');
412 $aclWhere = " AND $aclWhere";
416 SELECT sort_name name, cc.id
417 FROM civicrm_contact cc
419 WHERE cc.is_deceased = 0 AND {$queryString}
421 LIMIT {$offset}, {$rowCount}
424 // send query to hook to be modified if needed
425 CRM_Utils_Hook
::contactListQuery($query,
427 CRM_Utils_Array
::value('context', $_GET),
428 CRM_Utils_Array
::value('cid', $_GET)
431 $dao = CRM_Core_DAO
::executeQuery($query);
432 while ($dao->fetch()) {
435 'text' => $dao->name
,
441 SELECT sort_name name, ce.email, cc.id
442 FROM civicrm_email ce INNER JOIN civicrm_contact cc ON cc.id = ce.contact_id
444 WHERE ce.on_hold = 0 AND cc.is_deceased = 0 AND cc.do_not_email = 0 AND {$queryString}
446 LIMIT {$offset}, {$rowCount}
449 // send query to hook to be modified if needed
450 CRM_Utils_Hook
::contactListQuery($query,
452 CRM_Utils_Array
::value('context', $_GET),
453 CRM_Utils_Array
::value('cid', $_GET)
456 $dao = CRM_Core_DAO
::executeQuery($query);
458 while ($dao->fetch()) {
461 'text' => '"' . $dao->name
. '" <' . $dao->email
. '>',
462 'id' => (CRM_Utils_Array
::value('id', $_GET)) ?
"{$dao->id}::{$dao->email}" : '"' . $dao->name
. '" <' . $dao->email
. '>',
467 CRM_Utils_JSON
::output($result);
471 CRM_Utils_System
::civiExit();
474 public static function getContactPhone() {
477 //check for mobile type
478 $phoneTypes = CRM_Core_OptionGroup
::values('phone_type', TRUE, FALSE, FALSE, NULL, 'name');
479 $mobileType = CRM_Utils_Array
::value('Mobile', $phoneTypes);
481 $name = CRM_Utils_Array
::value('name', $_GET);
483 $name = CRM_Utils_Type
::escape($name, 'String');
484 $queryString = " ( cc.sort_name LIKE '%$name%' OR cp.phone LIKE '%$name%' ) ";
487 $cid = CRM_Utils_Array
::value('cid', $_GET);
489 //check cid for integer
490 $contIDS = explode(',', $cid);
491 foreach ($contIDS as $contID) {
492 CRM_Utils_Type
::escape($contID, 'Integer');
494 $queryString = " cc.id IN ( $cid )";
499 $offset = CRM_Utils_Array
::value('offset', $_GET, 0);
500 $rowCount = CRM_Utils_Array
::value('rowcount', $_GET, 20);
502 $offset = CRM_Utils_Type
::escape($offset, 'Int');
503 $rowCount = CRM_Utils_Type
::escape($rowCount, 'Int');
505 // add acl clause here
506 list($aclFrom, $aclWhere) = CRM_Contact_BAO_Contact_Permission
::cacheClause('cc');
508 $aclWhere = " AND $aclWhere";
512 SELECT sort_name name, cp.phone, cc.id
513 FROM civicrm_phone cp INNER JOIN civicrm_contact cc ON cc.id = cp.contact_id
515 WHERE cc.is_deceased = 0 AND cc.do_not_sms = 0 AND cp.phone_type_id = {$mobileType} AND {$queryString}
517 LIMIT {$offset}, {$rowCount}
520 // send query to hook to be modified if needed
521 CRM_Utils_Hook
::contactListQuery($query,
523 CRM_Utils_Array
::value('context', $_GET),
524 CRM_Utils_Array
::value('cid', $_GET)
527 $dao = CRM_Core_DAO
::executeQuery($query);
529 while ($dao->fetch()) {
531 'text' => '"' . $dao->name
. '" (' . $dao->phone
. ')',
532 'id' => (CRM_Utils_Array
::value('id', $_GET)) ?
"{$dao->id}::{$dao->phone}" : '"' . $dao->name
. '" <' . $dao->phone
. '>',
538 CRM_Utils_JSON
::output($result);
540 CRM_Utils_System
::civiExit();
544 public static function buildSubTypes() {
545 $parent = CRM_Utils_Array
::value('parentId', $_REQUEST);
549 $contactType = 'Individual';
553 $contactType = 'Household';
557 $contactType = 'Organization';
561 $subTypes = CRM_Contact_BAO_ContactType
::subTypePairs($contactType, FALSE, NULL);
563 CRM_Utils_JSON
::output($subTypes);
566 public static function buildDedupeRules() {
567 $parent = CRM_Utils_Array
::value('parentId', $_REQUEST);
571 $contactType = 'Individual';
575 $contactType = 'Household';
579 $contactType = 'Organization';
583 $dedupeRules = CRM_Dedupe_BAO_RuleGroup
::getByType($contactType);
585 CRM_Utils_JSON
::output($dedupeRules);
589 * Function used for CiviCRM dashboard operations.
591 public static function dashboard() {
592 $operation = CRM_Utils_Type
::escape($_REQUEST['op'], 'String');
594 switch ($operation) {
595 case 'get_widgets_by_column':
596 // This would normally be coming from either the database (this user's settings) or a default/initial dashboard configuration.
597 // get contact id of logged in user
599 $dashlets = CRM_Core_BAO_Dashboard
::getContactDashlets();
603 $dashletID = CRM_Utils_Type
::escape($_GET['id'], 'Positive');
605 $dashlets = CRM_Core_BAO_Dashboard
::getDashletInfo($dashletID);
609 CRM_Core_BAO_Dashboard
::saveDashletChanges($_REQUEST['columns']);
610 CRM_Utils_System
::civiExit();
611 case 'delete_dashlet':
612 $dashletID = CRM_Utils_Type
::escape($_REQUEST['dashlet_id'], 'Positive');
613 CRM_Core_BAO_Dashboard
::deleteDashlet($dashletID);
614 CRM_Utils_System
::civiExit();
617 CRM_Utils_JSON
::output($dashlets);
621 * Retrieve signature based on email id.
623 public static function getSignature() {
624 $emailID = CRM_Utils_Type
::escape($_REQUEST['emailID'], 'Positive');
625 $query = "SELECT signature_text, signature_html FROM civicrm_email WHERE id = {$emailID}";
626 $dao = CRM_Core_DAO
::executeQuery($query);
628 $signatures = array();
629 while ($dao->fetch()) {
631 'signature_text' => $dao->signature_text
,
632 'signature_html' => $dao->signature_html
,
636 CRM_Utils_JSON
::output($signatures);
642 public static function processDupes() {
643 $oper = CRM_Utils_Type
::escape($_REQUEST['op'], 'String');
644 $cid = CRM_Utils_Type
::escape($_REQUEST['cid'], 'Positive');
645 $oid = CRM_Utils_Type
::escape($_REQUEST['oid'], 'Positive');
647 if (!$oper ||
!$cid ||
!$oid) {
651 $exception = new CRM_Dedupe_DAO_Exception();
652 $exception->contact_id1
= $cid;
653 $exception->contact_id2
= $oid;
654 //make sure contact2 > contact1.
656 $exception->contact_id1
= $oid;
657 $exception->contact_id2
= $cid;
659 $exception->find(TRUE);
661 if ($oper == 'dupe-nondupe') {
662 $status = $exception->save();
664 if ($oper == 'nondupe-dupe') {
665 $status = $exception->delete();
668 CRM_Utils_JSON
::output(array('status' => ($status) ?
$oper : $status));
671 public static function getDedupes() {
673 $sEcho = CRM_Utils_Type
::escape($_REQUEST['sEcho'], 'Integer');
674 $offset = isset($_REQUEST['iDisplayStart']) ? CRM_Utils_Type
::escape($_REQUEST['iDisplayStart'], 'Integer') : 0;
675 $rowCount = isset($_REQUEST['iDisplayLength']) ? CRM_Utils_Type
::escape($_REQUEST['iDisplayLength'], 'Integer') : 25;
677 $sortOrder = isset($_REQUEST['sSortDir_0']) ? CRM_Utils_Type
::escape($_REQUEST['sSortDir_0'], 'String') : 'asc';
679 $gid = isset($_REQUEST['gid']) ? CRM_Utils_Type
::escape($_REQUEST['gid'], 'Integer') : 0;
680 $rgid = isset($_REQUEST['rgid']) ? CRM_Utils_Type
::escape($_REQUEST['rgid'], 'Integer') : 0;
683 $contactType = CRM_Core_DAO
::getFieldValue('CRM_Dedupe_DAO_RuleGroup', $rgid, 'contact_type');
686 $cacheKeyString = "merge {$contactType}_{$rgid}_{$gid}";
687 $searchRows = array();
688 $selectorElements = array('src', 'dst', 'weight', 'actions');
690 $join = "LEFT JOIN civicrm_dedupe_exception de ON ( pn.entity_id1 = de.contact_id1 AND
691 pn.entity_id2 = de.contact_id2 )";
692 $where = "de.id IS NULL";
694 $iFilteredTotal = $iTotal = CRM_Core_BAO_PrevNextCache
::getCount($cacheKeyString, $join, $where);
695 $mainContacts = CRM_Core_BAO_PrevNextCache
::retrieve($cacheKeyString, $join, $where, $offset, $rowCount);
697 foreach ($mainContacts as $mainId => $main) {
698 $searchRows[$mainId]['src'] = CRM_Utils_System
::href($main['srcName'], 'civicrm/contact/view', "reset=1&cid={$main['srcID']}");
699 $searchRows[$mainId]['dst'] = CRM_Utils_System
::href($main['dstName'], 'civicrm/contact/view', "reset=1&cid={$main['dstID']}");
700 $searchRows[$mainId]['weight'] = CRM_Utils_Array
::value('weight', $main);
702 if (!empty($main['canMerge'])) {
703 $mergeParams = "reset=1&cid={$main['srcID']}&oid={$main['dstID']}&action=update&rgid={$rgid}";
705 $mergeParams .= "&gid={$gid}";
708 $searchRows[$mainId]['actions'] = '<a class="action-item crm-hover-button" href="' . CRM_Utils_System
::url('civicrm/contact/merge', $mergeParams) . '">' . ts('merge') . '</a>';
709 $searchRows[$mainId]['actions'] .= "<a class='action-item crm-hover-button crm-notDuplicate' href='#' onClick=\"processDupes( {$main['srcID']}, {$main['dstID']}, 'dupe-nondupe', 'dupe-listing'); return false;\">" . ts('not a duplicate') . "</a>";
712 $searchRows[$mainId]['actions'] = '<em>' . ts('Insufficient access rights - cannot merge') . '</em>';
716 CRM_Utils_System
::setHttpHeader('Content-Type', 'application/json');
717 echo CRM_Utils_JSON
::encodeDataTableSelector($searchRows, $sEcho, $iTotal, $iFilteredTotal, $selectorElements);
719 CRM_Utils_System
::civiExit();
723 * Retrieve a PDF Page Format for the PDF Letter form.
725 public function pdfFormat() {
726 $formatId = CRM_Utils_Type
::escape($_REQUEST['formatId'], 'Integer');
728 $pdfFormat = CRM_Core_BAO_PdfFormat
::getById($formatId);
730 CRM_Utils_JSON
::output($pdfFormat);
734 * Retrieve Paper Size dimensions.
736 public static function paperSize() {
737 $paperSizeName = CRM_Utils_Type
::escape($_REQUEST['paperSizeName'], 'String');
739 $paperSize = CRM_Core_BAO_PaperSize
::getByName($paperSizeName);
741 CRM_Utils_JSON
::output($paperSize);
745 * Used to store selected contacts across multiple pages in advanced search.
747 public static function selectUnselectContacts() {
748 $name = CRM_Utils_Array
::value('name', $_REQUEST);
749 $cacheKey = CRM_Utils_Array
::value('qfKey', $_REQUEST);
750 $state = CRM_Utils_Array
::value('state', $_REQUEST, 'checked');
751 $variableType = CRM_Utils_Array
::value('variableType', $_REQUEST, 'single');
753 $actionToPerform = CRM_Utils_Array
::value('action', $_REQUEST, 'select');
755 if ($variableType == 'multiple') {
756 // action post value only works with multiple type variable
758 //multiple names like mark_x_1-mark_x_2 where 1,2 are cids
759 $elements = explode('-', $name);
760 foreach ($elements as $key => $element) {
761 $elements[$key] = self
::_convertToId($element);
763 CRM_Core_BAO_PrevNextCache
::markSelection($cacheKey, $actionToPerform, $elements);
766 CRM_Core_BAO_PrevNextCache
::markSelection($cacheKey, $actionToPerform);
769 elseif ($variableType == 'single') {
770 $cId = self
::_convertToId($name);
771 $action = ($state == 'checked') ?
'select' : 'unselect';
772 CRM_Core_BAO_PrevNextCache
::markSelection($cacheKey, $action, $cId);
774 $contactIds = CRM_Core_BAO_PrevNextCache
::getSelection($cacheKey);
775 $countSelectionCids = count($contactIds[$cacheKey]);
777 $arrRet = array('getCount' => $countSelectionCids);
778 CRM_Utils_JSON
::output($arrRet);
782 * @param string $name
786 public static function _convertToId($name) {
787 if (substr($name, 0, CRM_Core_Form
::CB_PREFIX_LEN
) == CRM_Core_Form
::CB_PREFIX
) {
788 $cId = substr($name, CRM_Core_Form
::CB_PREFIX_LEN
);
793 public static function getAddressDisplay() {
794 $contactId = CRM_Utils_Array
::value('contact_id', $_REQUEST);
796 $addressVal["error_message"] = "no contact id found";
799 $entityBlock = array(
800 'contact_id' => $contactId,
801 'entity_id' => $contactId,
803 $addressVal = CRM_Core_BAO_Address
::getValues($entityBlock);
806 CRM_Utils_JSON
::output($addressVal);
810 * Retrieve contact relationships.
812 public static function getContactRelationships() {
813 $contactID = CRM_Utils_Type
::escape($_GET['cid'], 'Integer');
814 $context = CRM_Utils_Type
::escape($_GET['context'], 'String');
815 $relationship_type_id = CRM_Utils_Type
::escape(CRM_Utils_Array
::value('relationship_type_id', $_GET), 'Integer', FALSE);
817 if (!CRM_Contact_BAO_Contact_Permission
::allow($contactID)) {
818 return CRM_Utils_System
::permissionDenied();
821 $sortMapper = array();
822 foreach ($_GET['columns'] as $key => $value) {
823 $sortMapper[$key] = $value['data'];
826 $offset = isset($_GET['start']) ? CRM_Utils_Type
::escape($_GET['start'], 'Integer') : 0;
827 $rowCount = isset($_GET['length']) ? CRM_Utils_Type
::escape($_GET['length'], 'Integer') : 25;
828 $sort = isset($_GET['order'][0]['column']) ? CRM_Utils_Array
::value(CRM_Utils_Type
::escape($_GET['order'][0]['column'], 'Integer'), $sortMapper) : NULL;
829 $sortOrder = isset($_GET['order'][0]['dir']) ? CRM_Utils_Type
::escape($_GET['order'][0]['dir'], 'String') : 'asc';
832 if ($sort && $sortOrder) {
833 $params['sortBy'] = $sort . ' ' . $sortOrder;
836 $params['page'] = ($offset / $rowCount) +
1;
837 $params['rp'] = $rowCount;
839 $params['contact_id'] = $contactID;
840 $params['context'] = $context;
841 if ($relationship_type_id) {
842 $params['relationship_type_id'] = $relationship_type_id;
845 // get the contact relationships
846 $relationships = CRM_Contact_BAO_Relationship
::getContactRelationshipSelector($params);
848 CRM_Utils_JSON
::output($relationships);