X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FPaymentProcessor.php;h=a9b28266e6e6942e63c9a70d126f2e3b3d7d5b20;hb=163e693ee26a91de8f31cc016abcd3fed35af617;hp=4bb89c729da60961a0b8d036e719838e39e2f1a6;hpb=ff7da3a6508d0a7059c6527216920b2efb896b93;p=civicrm-core.git diff --git a/api/v3/PaymentProcessor.php b/api/v3/PaymentProcessor.php index 4bb89c729d..a9b28266e6 100644 --- a/api/v3/PaymentProcessor.php +++ b/api/v3/PaymentProcessor.php @@ -26,35 +26,29 @@ */ /** - * File for the CiviCRM APIv3 PaymentProcessor functions + * This api exposes CiviCRM PaymentProcessor. * * @package CiviCRM_APIv3 - * @subpackage API_PaymentProcessor - * - * @copyright CiviCRM LLC (c) 2004-2014 */ /** - * Add/Update a PaymentProcessor - * - * Allowed @params array keys are: - * {@getfields payment_processor_create} + * Add/Update a PaymentProcessor. * * @param array $params * * @return array - * Array of newly created PaymentProcessor property values. */ function civicrm_api3_payment_processor_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); } /** - * Adjust Metadata for Create action + * Adjust Metadata for Create action. + * + * The metadata is used for setting defaults, documentation & validation. * - * The metadata is used for setting defaults, documentation & validation * @param array $params - * Array or parameters determined by getfields. + * Array of parameters determined by getfields. */ function _civicrm_api3_payment_processor_create_spec(&$params) { $params['payment_processor_type_id']['api.required'] = 1; @@ -63,10 +57,9 @@ function _civicrm_api3_payment_processor_create_spec(&$params) { } /** - * Deletes an existing PaymentProcessor + * Deletes an existing PaymentProcessor. * * @param array $params - * {@getfields payment_processor_delete} * * @return array * API result Array @@ -76,11 +69,10 @@ function civicrm_api3_payment_processor_delete($params) { } /** - * Retrieve one or more PaymentProcessor + * Retrieve one or more PaymentProcessor. * * @param array $params - * An associative array of name/value pairs. - * {@getfields payment_processor_get} + * Array of name/value pairs. * * @return array * details of found PaymentProcessor