Cleanup api3 DashboardContact

[civicrm-core.git] / api / v3 / DashboardContact.php

diff --git a/api/v3/DashboardContact.php b/api/v3/DashboardContact.php
index 2c84ebed8b52d7fc1f81d5482eb9407cef3d2224..1467d24f226247d959a5145c8dec3c302b7f693b 100644 (file)
--- a/api/v3/DashboardContact.php
+++ b/api/v3/DashboardContact.php
@@ -1,27 +1,11 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 5                                                  |
- +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2019                                |
- +--------------------------------------------------------------------+
- | This file is a part of CiviCRM.                                    |
- |                                                                    |
- | CiviCRM is free software; you can copy, modify, and distribute it  |
- | under the terms of the GNU Affero General Public License           |
- | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
- |                                                                    |
- | CiviCRM is distributed in the hope that it will be useful, but     |
- | WITHOUT ANY WARRANTY; without even the implied warranty of         |
- | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
- | See the GNU Affero General Public License for more details.        |
+ | Copyright CiviCRM LLC. All rights reserved.                        |
  |                                                                    |
- | You should have received a copy of the GNU Affero General Public   |
- | License and the CiviCRM Licensing Exception along                  |
- | with this program; if not, contact CiviCRM LLC                     |
- | at info[AT]civicrm[DOT]org. If you have questions about the        |
- | GNU Affero General Public License or the licensing of CiviCRM,     |
- | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+ | This work is published under the GNU AGPLv3 license with some      |
+ | permitted exceptions and without any warranty. For full license    |
+ | and copyright information, see https://civicrm.org/licensing       |
  +--------------------------------------------------------------------+
  */
 
@@ -39,14 +23,6 @@
  * @return array
  */
 function civicrm_api3_dashboard_contact_create($params) {
-  if (empty($params['id'])) {
-    civicrm_api3_verify_one_mandatory($params,
-      NULL,
-      [
-        'dashboard_id',
-      ]
-    );
-  }
   $errors = _civicrm_api3_dashboard_contact_check_params($params);
   if ($errors !== NULL) {
     return $errors;
@@ -71,11 +47,11 @@ function civicrm_api3_dashboard_contact_get($params) {
  *
  * The metadata is used for setting defaults, documentation & validation.
  *
- * @param array $params
- *   Array of parameters determined by getfields.
+ * @param array $fields
+ *   Array of fields determined by getfields.
  */
-function _civicrm_api3_dashboard_contact_create_spec(&$params) {
-  unset($params['version']);
+function _civicrm_api3_dashboard_contact_create_spec(&$fields) {
+  $fields['dashboard_id']['api.required'] = TRUE;
 }
 
 /**
@@ -87,10 +63,9 @@ function _civicrm_api3_dashboard_contact_create_spec(&$params) {
  * @return array|null
  */
 function _civicrm_api3_dashboard_contact_check_params(&$params) {
-  $dashboard_id = CRM_Utils_Array::value('dashboard_id', $params);
-  if ($dashboard_id) {
-    $allDashlets = CRM_Core_BAO_Dashboard::getDashlets(TRUE, CRM_Utils_Array::value('check_permissions', $params, 0));
-    if (!isset($allDashlets[$dashboard_id])) {
+  if (!empty($params['dashboard_id'])) {
+    $allDashlets = CRM_Core_BAO_Dashboard::getDashlets(TRUE, $params['check_permissions'] ?? FALSE);
+    if (!isset($allDashlets[$params['dashboard_id']])) {
       return civicrm_api3_create_error('Invalid or inaccessible dashboard ID');
     }
   }
@@ -100,9 +75,6 @@ function _civicrm_api3_dashboard_contact_check_params(&$params) {
 /**
  * Delete an existing dashboard-contact.
  *
- * This method is used to delete any existing dashboard-board. the id of the dashboard-contact
- * is required field in $params array
- *
  * @param array $params
  *
  * @return array