}
/**
- * Store multiple items in the setting table
+ * Store multiple items in the setting table.
*
* @param array $params
* (required) An api formatted array of keys and values.
- * @param null $domains
+ * @param array $domains Array of domains to get settings for. Default is the current domain
* @param $settingsToReturn
*
- * @domains array an array of domains to get settings for. Default is the current domain
- * @return void
+ * @return array
*/
public static function getItems(&$params, $domains = NULL, $settingsToReturn) {
$originalDomain = CRM_Core_Config::domainID();
* Whether to return the full content of the file.
* @param bool $isTrusted
* Whether the current request is trusted to perform file-specific operations.
+ *
* @return array
*/
function _civicrm_api3_attachment_format_result($fileDao, $entityFileDao, $returnContent, $isTrusted) {
}
/**
- * Returns array of campaigns matching a set of one or more group properties
+ * Returns array of campaigns matching a set of one or more group properties.
*
* @param array $params
* Array per getfields
}
/**
- * delete an existing campaign
+ * Delete an existing campaign.
*
* This method is used to delete any existing campaign. id of the group
* to be deleted is required field in $params array
}
/**
- * Deprecated. Use activity API instead
+ * Deprecated API.
+ *
+ * Use activity API instead.
*
* @param array $params
*
}
/**
+ * Declare deprecated api functions.
+ *
* @deprecated api notice
* @return array
* Array of deprecated actions
}
/**
+ * Declare deprecated api functions.
+ *
* @deprecated api notice
* @return array
* Array of deprecated actions
}
/**
- * Retrieve a set of contributions, given a set of input params
+ * Retrieve a set of contributions.
*
* @param array $params
- * (reference ) input parameters.
+ * Input parameters.
*
* @return array
* Array of contributions, if error an array with an error id and error message
*
* @copyright CiviCRM LLC (c) 2004-2014
* @version $Id: Event.php 30964 2010-11-29 09:41:54Z shot $
- *
*/
/**
- * Create a Event
- *
- * This API is used for creating a Event
+ * Create a Event.
*
* @param array $params
* Input parameters.
- * Allowed @params array keys are:
- * {@getfields event_create}
*
* @return array
* API result Array.
}
/**
- * Support for schema changes made in 4.2
+ * Support for schema changes made in 4.2.
+ *
* The main purpose of the API is to provide integrators a level of stability not provided by
* the core code or schema - this means we have to provide support for api calls (where possible)
* across schema changes.
+ *
* @param array $params
*/
function _civicrm_api3_event_create_legacy_support_42(&$params) {
}
/**
- * Adjust Metadata for Get action
+ * Adjust Metadata for Get action.
*
* The metadata is used for setting defaults, documentation & validation.
*
}
/**
- * Support for schema changes made in 4.2
+ * Support for schema changes made in 4.2.
+ *
* The main purpose of the API is to provide integrators a level of stability not provided by
* the core code or schema - this means we have to provide support for api calls (where possible)
* across schema changes.
- * @param $event
- * @param $event_id
+ *
+ * @param array $event
+ * @param int $event_id
*/
function _civicrm_api3_event_get_legacy_support_42(&$event, $event_id) {
if (!empty($event[$event_id]['payment_processor'])) {
}
/**
- * Deletes an existing event
+ * Delete an existing event.
*
- * This API is used for deleting a event
+ * This API is used for deleting a event.
*
* @param array $params
+ *
* @return array
*/
function civicrm_api3_event_delete($params) {
return CRM_Event_BAO_Event::del($params['id']) ? civicrm_api3_create_success() : civicrm_api3_create_error(ts('Error while deleting event'));
}
-/*
/**
- * add 'is_full' & 'available_seats' to the return array. (this might be better in the BAO)
+ * Add 'is_full' & 'available_seats' to the return array.
+ *
+ * (this might be better in the BAO)
* Default BAO function returns a string if full rather than a Bool - which is more appropriate to a form
*
* @param array $event
* Return array of the event.
* @param int $event_id
* Id of the event to be updated.
- *
- */
-/**
- * @param $event
- * @param int $event_id
*/
function _civicrm_api3_event_getisfull(&$event, $event_id) {
$eventFullResult = CRM_Event_BAO_Participant::eventFull($event_id, 1);
/**
+ * Get event list parameters.
+ *
* @see _civicrm_api3_generic_getlist_params
*
* @param array $request
}
/**
+ * Get event list output.
+ *
* @see _civicrm_api3_generic_getlist_output
*
* @param array $result
$data = array(
'id' => $row[$request['id_field']],
'label' => $row[$request['label_field']],
- 'description' => array(CRM_Core_Pseudoconstant::getLabel('CRM_Event_BAO_Event', 'event_type_id', $row['event_type_id'])),
+ 'description' => array(
+ CRM_Core_Pseudoconstant::getLabel(
+ 'CRM_Event_BAO_Event',
+ 'event_type_id',
+ $row['event_type_id']
+ ),
+ ),
);
if (!empty($row['start_date'])) {
$data['description'][0] .= ': ' . CRM_Utils_Date::customFormat($row['start_date']);
}
/**
- * Job to get mail and create activities
+ * Job to get mail and create activities.
*
* @param array $params
*
}
/**
- * Process participant statuses
+ * Process participant statuses.
*
* @param array $params
- * (reference ) input parameters.
+ * Input parameters.
*
* @return array
* array of properties, if error an array with an error id and error message
}
/**
+ * Get delivered mailing contacts.
+ *
* @param int $contactID
* @param $offset
* @param $limit
}
/**
- * Create or update a setting
+ * Create or update a setting.
*
* @param array $params
- * Associative array of setting.
- * name/value pairs + other vars as applicable - see getfields for more
- * @example SettingCreate.php Std Create example
+ * Parameters as per getfields.
*
* @return array
* api result array
- * {@getfields setting_create}
*/
function civicrm_api3_setting_create($params) {
$domains = _civicrm_api3_setting_getDomainArray($params);
}
/**
- * Returns array of settings matching input parameters
+ * Returns array of settings matching input parameters.
*
* @param array $params
- * Array of one or more valid.
- * property_name=>value pairs.
+ * Array of one or more valid property_name=>value pairs.
*
* @return array
* Array of matching settings
- * {@getfields setting_get}
*/
function civicrm_api3_setting_get($params) {
$domains = _civicrm_api3_setting_getDomainArray($params);
}
/**
- * Format array in result output styple
+ * Format array in result output style.
*
* @param array|int $values values generated by API operation (the result)
* @param array $params
projects / civicrm-core.git / commitdiff