Cleanup api3 DashboardContact
[civicrm-core.git] / api / v3 / DashboardContact.php
index fe1ceffc0b79b2f3854a5dcc1d62cba8b75a9360..1467d24f226247d959a5145c8dec3c302b7f693b 100644 (file)
  * @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;
@@ -55,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;
 }
 
 /**
@@ -71,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) {
+  if (!empty($params['dashboard_id'])) {
     $allDashlets = CRM_Core_BAO_Dashboard::getDashlets(TRUE, $params['check_permissions'] ?? FALSE);
-    if (!isset($allDashlets[$dashboard_id])) {
+    if (!isset($allDashlets[$params['dashboard_id']])) {
       return civicrm_api3_create_error('Invalid or inaccessible dashboard ID');
     }
   }
@@ -84,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