projects / civicrm-core.git / blame
| Commit | Line | Data |
|---|---|---|
| 6a488035 TO |
1 | <?php |
| 2 | /* | |
| 3 | /* | |
| 4 | +--------------------------------------------------------------------+ | |
| 731a0992 | 5 | | CiviCRM version 4.5 | |
| 6a488035 | 6 | +--------------------------------------------------------------------+ |
| 731a0992 | 7 | | Copyright CiviCRM LLC (c) 2004-2014 | |
| 6a488035 TO |
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 | /** | |
| 31 | * File for the CiviCRM APIv3 group functions | |
| 32 | * | |
| 33 | * @package CiviCRM_APIv3 | |
| 34 | * @subpackage API_ContributionPage | |
| 35 | * @copyright CiviCRM LLC (c) 20042012 | |
| 36 | */ | |
| 37 | ||
| 38 | /** | |
| 39 | * Create or update a contribution_page | |
| 40 | * | |
| 41 | * @param array $params Associative array of property | |
| 42 | * name/value pairs to insert in new 'contribution_page' | |
| 43 | * @example ContributionPageCreate.php Std Create example | |
| 44 | * | |
| 45 | * @return array api result array | |
| 46 | * {@getfields contribution_page_create} | |
| 47 | * @access public | |
| 48 | */ | |
| 49 | function civicrm_api3_contribution_page_create($params) { | |
| 50 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
| 51 | } | |
| 11e09c59 TO |
52 | |
| 53 | /** | |
| 6a488035 TO |
54 | * Adjust Metadata for Create action |
| 55 | * | |
| 56 | * The metadata is used for setting defaults, documentation & validation | |
| 57 | * @param array $params array or parameters determined by getfields | |
| 58 | */ | |
| 59 | function _civicrm_api3_contribution_page_create_spec(&$params) { | |
| 60 | $params['financial_type_id']['api.required'] = 1; | |
| 16c0ec8d | 61 | $params['payment_processor']['api.aliases'] = array('payment_processor_id'); |
| 6a488035 TO |
62 | } |
| 63 | ||
| 64 | /** | |
| 65 | * Returns array of contribution_pages matching a set of one or more group properties | |
| 66 | * | |
| 5785931e | 67 | * @param array $params Array of one or more valid property_name=>value pairs. |
| 6a488035 | 68 | * |
| 5785931e | 69 | * @return array API Result array Array of matching contribution_pages |
| 6a488035 TO |
70 | * {@getfields contribution_page_get} |
| 71 | * @access public | |
| 72 | */ | |
| 73 | function civicrm_api3_contribution_page_get($params) { | |
| 74 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
| 75 | } | |
| 76 | ||
| 77 | /** | |
| 78 | * delete an existing contribution_page | |
| 79 | * | |
| 80 | * This method is used to delete any existing contribution_page. id of the group | |
| 81 | * to be deleted is required field in $params array | |
| 82 | * | |
| 83 | * @param array $params (reference) array containing id of the group | |
| 84 | * to be deleted | |
| 85 | * | |
| 86 | * @return array (referance) returns flag true if successfull, error | |
| 87 | * message otherwise | |
| 88 | * {@getfields contribution_page_delete} | |
| 89 | * @access public | |
| 90 | */ | |
| 91 | function civicrm_api3_contribution_page_delete($params) { | |
| 92 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
| 93 | } |