<?php
-
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.5 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
* {@getfields batch_create}
* @example BatchCreate.php
*
- * @param $params
+ * @param array $params
*
- * @return array of newly created batch property values.
- * @access public
+ * @return array
+ * Array of newly created batch property values.
*/
function civicrm_api3_batch_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
* Adjust Metadata for Create action
*
* The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ * Array or parameters determined by getfields.
*/
function _civicrm_api3_batch_create_spec(&$params) {
//@todo - the entity table field looks like it is not actually required & should probably be removed (or a description added if
// it is actually required)
$params['entity_table']['api.default'] = "civicrm_batch";
$params['entity_table']['type'] = CRM_Utils_Type::T_STRING;
+ $params['entity_table']['title'] = 'Batch Entity Table - remove?';
$params['modified_date']['api.default'] = "now";
$params['status_id']['api.required'] = 1;
* {@getfields batch_get}
* @example BatchCreate.php
*
- * @param $params
+ * @param array $params
*
- * @return array of retrieved batch property values.
- * @access public
+ * @return array
+ * Array of retrieved batch property values.
*/
function civicrm_api3_batch_get($params) {
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
* {@getfields batch_delete}
* @example BatchCreate.php
*
- * @param $params
+ * @param array $params
*
- * @return array of deleted values.
- * @access public
+ * @return array
+ * Array of deleted values.
*/
function civicrm_api3_batch_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);