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