Merge pull request #14981 from eileenmcnaughton/load_extract
[civicrm-core.git] / api / v3 / Generic / Validate.php
CommitLineData
b7c239b6
SB
1<?php
2/*
3 +--------------------------------------------------------------------+
fee14197 4 | CiviCRM version 5 |
b7c239b6 5 +--------------------------------------------------------------------+
6b83d5bd 6 | Copyright CiviCRM LLC (c) 2004-2019 |
b7c239b6
SB
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 * @package CiviCRM_APIv3
30 */
31
32/**
33 * Provide meta-data for this api.
34 *
35 * @param array $params
36 */
37function _civicrm_api3_generic_validate_spec(&$params) {
38 $params['action']['api.required'] = TRUE;
6e4339c4 39 $params['action']['title'] = ts('API Action');
b7c239b6
SB
40}
41
42/**
43 * Generic api wrapper used for validation of entity-action pair.
44 *
45 * @param array $apiRequest
46 *
47 * @return mixed
48 */
49function civicrm_api3_generic_validate($apiRequest) {
969ca694 50 $errors = _civicrm_api3_validate($apiRequest['entity'], $apiRequest['params']['action'], $apiRequest['params']);
b7c239b6
SB
51
52 return civicrm_api3_create_success($errors, $apiRequest['params'], $apiRequest['entity'], 'validate');
53}