Commit | Line | Data |
---|---|---|
b025fef8 | 1 | <?php |
2 | ||
3 | /* | |
4 | * +--------------------------------------------------------------------+ | |
fee14197 | 5 | * | CiviCRM version 5 | |
b025fef8 | 6 | * +--------------------------------------------------------------------+ |
6b83d5bd | 7 | * | Copyright CiviCRM LLC (c) 2004-2019 | |
b025fef8 | 8 | * +--------------------------------------------------------------------+ |
71cd91c8 SL |
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 | | |
b025fef8 | 26 | * +--------------------------------------------------------------------+ |
27 | */ | |
28 | ||
29 | /** | |
30 | * This api exposes CiviCRM PCP records. | |
31 | * | |
32 | * | |
33 | * @package CiviCRM_APIv3 | |
34 | */ | |
7c31ae57 | 35 | |
b025fef8 | 36 | /** |
37 | * Create or update a survey. | |
38 | * | |
39 | * @param array $params | |
40 | * Array per getfields metadata. | |
efc37755 | 41 | * |
b025fef8 | 42 | * @return array api result array |
43 | */ | |
44 | function civicrm_api3_pcp_create($params) { | |
efc37755 | 45 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Pcp'); |
b025fef8 | 46 | } |
47 | ||
48 | /** | |
49 | * Adjust Metadata for Create action. | |
50 | * | |
51 | * The metadata is used for setting defaults, documentation & validation. | |
52 | * | |
53 | * @param array $params | |
54 | * Array of parameters determined by getfields. | |
55 | */ | |
56 | function _civicrm_api3_pcp_create_spec(&$params) { | |
57 | $params['title']['api.required'] = 1; | |
58 | $params['contact_id']['api.required'] = 1; | |
59 | $params['page_id']['api.required'] = 1; | |
60 | $params['pcp_block_id']['api.required'] = 1; | |
61 | } | |
62 | ||
63 | /** | |
64 | * Returns array of pcps matching a set of one or more properties. | |
65 | * | |
66 | * @param array $params | |
67 | * Array per getfields | |
efc37755 | 68 | * |
b025fef8 | 69 | * @return array Array of matching pcps |
70 | */ | |
71 | function civicrm_api3_pcp_get($params) { | |
efc37755 | 72 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Pcp'); |
b025fef8 | 73 | } |
74 | ||
75 | /** | |
76 | * Delete an existing PCP. | |
77 | * | |
78 | * This method is used to delete any existing PCP given its id. | |
79 | * | |
80 | * @param array $params | |
81 | * [id] | |
efc37755 | 82 | * |
b025fef8 | 83 | * @return array api result array |
84 | */ | |
85 | function civicrm_api3_pcp_delete($params) { | |
efc37755 | 86 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
87 | } |