Commit | Line | Data |
---|---|---|
607f4c2d RT |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
81621fee | 4 | | CiviCRM version 4.7 | |
607f4c2d | 5 | +--------------------------------------------------------------------+ |
1f4ea726 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
607f4c2d RT |
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 | * This api exposes CiviCRM Payment Token records. | |
30 | * | |
31 | * @note Contribute component must be enabled. | |
32 | * | |
33 | * @package CiviCRM_APIv3 | |
34 | */ | |
35 | ||
36 | /** | |
37 | * Create/update Payment Token. | |
38 | * | |
39 | * This API is used to create new campaign or update any of the existing | |
40 | * In case of updating existing campaign, id of that particular campaign must | |
41 | * be in $params array. | |
42 | * | |
43 | * @param array $params | |
44 | * | |
45 | * @return array | |
46 | */ | |
47 | function civicrm_api3_payment_token_create($params) { | |
48 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'PaymentToken'); | |
49 | } | |
50 | ||
51 | /** | |
52 | * Adjust Metadata for Create action. | |
53 | * | |
54 | * The metadata is used for setting defaults, documentation & validation. | |
55 | * | |
56 | * @param array $params | |
57 | * Array of parameters determined by getfields. | |
58 | */ | |
59 | function _civicrm_api3_payment_token_create_spec(&$params) { | |
60 | $params['token']['api.required'] = 1; | |
61 | $params['contact_id']['api.required'] = 1; | |
62 | $params['payment_processor_id']['api.required'] = 1; | |
63 | $params['created_id']['api.default'] = 'user_contact_id'; | |
64 | $params['created_date']['api.default'] = 'now'; | |
65 | } | |
66 | ||
67 | /** | |
68 | * Returns array of campaigns matching a set of one or more properties. | |
69 | * | |
70 | * @param array $params | |
71 | * Array per getfields | |
72 | * | |
73 | * @return array | |
74 | * Array of matching campaigns | |
75 | */ | |
76 | function civicrm_api3_payment_token_get($params) { | |
77 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'PaymentToken'); | |
78 | } | |
79 | ||
80 | /** | |
81 | * Delete an existing payment token. | |
82 | * | |
83 | * This method is used to delete any existing payment token. | |
84 | * Id of the payment token to be deleted is required field in $params array | |
85 | * | |
86 | * @param array $params | |
87 | * array containing id of the group to be deleted | |
88 | * | |
89 | * @return array | |
90 | */ | |
91 | function civicrm_api3_payment_token_delete($params) { | |
92 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
93 | } |