| 1 | <?php |
| 2 | |
| 3 | /* |
| 4 | +--------------------------------------------------------------------+ |
| 5 | | CiviCRM version 4.5 | |
| 6 | +--------------------------------------------------------------------+ |
| 7 | | Copyright CiviCRM LLC (c) 2004-2014 | |
| 8 | +--------------------------------------------------------------------+ |
| 9 | | This file is a part of CiviCRM. | |
| 10 | | | |
| 11 | | CiviCRM is free software; you can copy, modify, and distribute it | |
| 12 | | under the terms of the GNU Affero General Public License | |
| 13 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | |
| 14 | | | |
| 15 | | CiviCRM is distributed in the hope that it will be useful, but | |
| 16 | | WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 17 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | |
| 18 | | See the GNU Affero General Public License for more details. | |
| 19 | | | |
| 20 | | You should have received a copy of the GNU Affero General Public | |
| 21 | | License and the CiviCRM Licensing Exception along | |
| 22 | | with this program; if not, contact CiviCRM LLC | |
| 23 | | at info[AT]civicrm[DOT]org. If you have questions about the | |
| 24 | | GNU Affero General Public License or the licensing of CiviCRM, | |
| 25 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | |
| 26 | +--------------------------------------------------------------------+ |
| 27 | */ |
| 28 | |
| 29 | /** |
| 30 | * File for the CiviCRM APIv3 for Dashboard Contact |
| 31 | * |
| 32 | * @package CiviCRM_APIv3 |
| 33 | * @subpackage API_ActionSchedule |
| 34 | * |
| 35 | * @copyright CiviCRM LLC (c) 2004-2014 |
| 36 | * |
| 37 | */ |
| 38 | |
| 39 | /** |
| 40 | * Creates/Updates a new Dashboard Contact Entry |
| 41 | * |
| 42 | * @param array $params |
| 43 | * |
| 44 | * @return array |
| 45 | * |
| 46 | */ |
| 47 | function civicrm_api3_dashboard_contact_create($params) { |
| 48 | if (empty($params['id'])) { |
| 49 | civicrm_api3_verify_one_mandatory($params, |
| 50 | NULL, |
| 51 | array( |
| 52 | 'dashboard_id', |
| 53 | ) |
| 54 | ); |
| 55 | } |
| 56 | $errors = _civicrm_api3_dashboard_contact_check_params($params); |
| 57 | if ($errors !== NULL) { |
| 58 | return $errors; |
| 59 | } |
| 60 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
| 61 | } |
| 62 | |
| 63 | /** |
| 64 | * Gets a CiviCRM Dashlets of Contacts according to parameters |
| 65 | * |
| 66 | * @param array $params Associative array of property name/value |
| 67 | * pairs for the activity. |
| 68 | * |
| 69 | * @return array |
| 70 | * |
| 71 | */ |
| 72 | function civicrm_api3_dashboard_contact_get($params) { |
| 73 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
| 74 | } |
| 75 | |
| 76 | /** |
| 77 | * Adjust Metadata for Create action |
| 78 | * |
| 79 | * The metadata is used for setting defaults, documentation & validation |
| 80 | * @param array $params array or parameters determined by getfields |
| 81 | */ |
| 82 | function _civicrm_api3_dashboard_contact_create_spec(&$params) { |
| 83 | unset($params['version']); |
| 84 | } |
| 85 | |
| 86 | function _civicrm_api3_dashboard_contact_check_params(&$params) { |
| 87 | $dashboard_id = CRM_Utils_Array::value('dashboard_id', $params); |
| 88 | if ($dashboard_id) { |
| 89 | $allDashlets = CRM_Core_BAO_Dashboard::getDashlets(TRUE, CRM_Utils_Array::value('check_permissions', $params, 0)); |
| 90 | if (!isset($allDashlets[$dashboard_id])) { |
| 91 | return civicrm_api3_create_error('Invalid or inaccessible dashboard ID'); |
| 92 | } |
| 93 | } |
| 94 | return NULL; |
| 95 | } |
| 96 | |
| 97 | /** |
| 98 | * Delete an existing dashboard-contact |
| 99 | * |
| 100 | * This method is used to delete any existing dashboard-board. the id of the dashboard-contact |
| 101 | * is required field in $params array |
| 102 | * |
| 103 | * {@getfields dashboard_contact_delete} |
| 104 | * @access public |
| 105 | */ |
| 106 | function civicrm_api3_dashboard_contact_delete($params) { |
| 107 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
| 108 | } |