projects
/
civicrm-core.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (from parent 1:
d1b0d05
)
more api comment fixes
author
Eileen McNaughton
<eileen@fuzion.co.nz>
Mon, 2 Feb 2015 08:11:17 +0000
(21:11 +1300)
committer
Eileen McNaughton
<eileen@fuzion.co.nz>
Tue, 3 Feb 2015 00:57:34 +0000
(13:57 +1300)
37 files changed:
api/Exception.php
patch
|
blob
|
blame
|
history
api/api.php
patch
|
blob
|
blame
|
history
api/class.api.php
patch
|
blob
|
blame
|
history
api/v3/ActionSchedule.php
patch
|
blob
|
blame
|
history
api/v3/ActivityContact.php
patch
|
blob
|
blame
|
history
api/v3/Attachment.php
patch
|
blob
|
blame
|
history
api/v3/CaseType.php
patch
|
blob
|
blame
|
history
api/v3/Constant.php
patch
|
blob
|
blame
|
history
api/v3/Contact.php
patch
|
blob
|
blame
|
history
api/v3/Contribution.php
patch
|
blob
|
blame
|
history
api/v3/ContributionPage.php
patch
|
blob
|
blame
|
history
api/v3/CustomValue.php
patch
|
blob
|
blame
|
history
api/v3/Dashboard.php
patch
|
blob
|
blame
|
history
api/v3/DashboardContact.php
patch
|
blob
|
blame
|
history
api/v3/Extension.php
patch
|
blob
|
blame
|
history
api/v3/Generic.php
patch
|
blob
|
blame
|
history
api/v3/GroupContact.php
patch
|
blob
|
blame
|
history
api/v3/GroupOrganization.php
patch
|
blob
|
blame
|
history
api/v3/LineItem.php
patch
|
blob
|
blame
|
history
api/v3/Mailing.php
patch
|
blob
|
blame
|
history
api/v3/MailingAB.php
patch
|
blob
|
blame
|
history
api/v3/MailingComponent.php
patch
|
blob
|
blame
|
history
api/v3/MailingEventQueue.php
patch
|
blob
|
blame
|
history
api/v3/MailingGroup.php
patch
|
blob
|
blame
|
history
api/v3/Membership.php
patch
|
blob
|
blame
|
history
api/v3/MembershipStatus.php
patch
|
blob
|
blame
|
history
api/v3/MessageTemplate.php
patch
|
blob
|
blame
|
history
api/v3/ParticipantPayment.php
patch
|
blob
|
blame
|
history
api/v3/Profile.php
patch
|
blob
|
blame
|
history
api/v3/Relationship.php
patch
|
blob
|
blame
|
history
api/v3/RelationshipType.php
patch
|
blob
|
blame
|
history
api/v3/ReportInstance.php
patch
|
blob
|
blame
|
history
api/v3/ReportTemplate.php
patch
|
blob
|
blame
|
history
api/v3/Setting.php
patch
|
blob
|
blame
|
history
api/v3/SurveyRespondant.php
patch
|
blob
|
blame
|
history
api/v3/UFGroup.php
patch
|
blob
|
blame
|
history
api/v3/Website.php
patch
|
blob
|
blame
|
history
diff --git
a/api/Exception.php
b/api/Exception.php
index 517755bae69980d075cf85b1bcb70c42aaaf3202..2bb9dcdd76fb9c2d10f78e1707e2ba19286a818d 100644
(file)
--- a/
api/Exception.php
+++ b/
api/Exception.php
@@
-60,6
+60,8
@@
class API_Exception extends Exception {
}
/**
}
/**
+ * Get extra parameters.
+ *
* @return array
*/
public function getExtraParams() {
* @return array
*/
public function getExtraParams() {
@@
-67,6
+69,8
@@
class API_Exception extends Exception {
}
/**
}
/**
+ * Get error codes.
+ *
* @return array
*/
public function getErrorCodes() {
* @return array
*/
public function getErrorCodes() {
@@
-89,6
+93,8
@@
class CiviCRM_API3_Exception extends Exception {
private $extraParams = array();
/**
private $extraParams = array();
/**
+ * Class constructor.
+ *
* @param string $message
* The human friendly error message.
* @param mixed $error_code
* @param string $message
* The human friendly error message.
* @param mixed $error_code
@@
-125,6
+131,8
@@
class CiviCRM_API3_Exception extends Exception {
}
/**
}
/**
+ * Get extra parameters.
+ *
* @return array
*/
public function getExtraParams() {
* @return array
*/
public function getExtraParams() {
diff --git
a/api/api.php
b/api/api.php
index c9b5fbe564dc912928f541d4b0d6e36d8f3be95b..6c263513e871deca72176ac02f4b600bda8b387c 100644
(file)
--- a/
api/api.php
+++ b/
api/api.php
@@
-53,7
+53,9
@@
function civicrm_api3($entity, $action, $params = array()) {
}
/**
}
/**
- * Call getfields from api wrapper. This function ensures that settings that
+ * Call getfields from api wrapper.
+ *
+ * This function ensures that settings that
* could alter getfields output (e.g. action for all api & profile_id for
* profile api ) are consistently passed in.
*
* could alter getfields output (e.g. action for all api & profile_id for
* profile api ) are consistently passed in.
*
@@
-64,6
+66,7
@@
function civicrm_api3($entity, $action, $params = array()) {
* @todo other output modifiers include contact_type
*
* @param array $apiRequest
* @todo other output modifiers include contact_type
*
* @param array $apiRequest
+ *
* @return array
* getfields output
*/
* @return array
* getfields output
*/
@@
-165,11
+168,12
@@
function _civicrm_api_replace_variables(&$params, &$parentResult, $separator = '
}
/**
}
/**
- * Convert possibly camel name to underscore separated entity name
+ * Convert possibly camel name to underscore separated entity name
.
*
* @param string $entity
* Entity name in various formats e.g. Contribution, contribution,
* OptionValue, option_value, UFJoin, uf_join.
*
* @param string $entity
* Entity name in various formats e.g. Contribution, contribution,
* OptionValue, option_value, UFJoin, uf_join.
+ *
* @return string
* Entity name in underscore separated format.
*
* @return string
* Entity name in underscore separated format.
*
@@
-190,9
+194,11
@@
function _civicrm_api_get_entity_name_from_camel($entity) {
}
/**
}
/**
- * Having a DAO object find the entity name
+ * Having a DAO object find the entity name.
+ *
* @param object $bao
* DAO being passed in.
* @param object $bao
* DAO being passed in.
+ *
* @return string
*/
function _civicrm_api_get_entity_name_from_dao($bao) {
* @return string
*/
function _civicrm_api_get_entity_name_from_dao($bao) {
diff --git
a/api/class.api.php
b/api/class.api.php
index 119b7c1f3d3cf95c36cacf15a150d21ede248077..7a5f72cdec04c95a304e4a94ea056d892d2cf0ee 100644
(file)
--- a/
api/class.api.php
+++ b/
api/class.api.php
@@
-79,6
+79,8
@@
class civicrm_api3 {
/**
class civicrm_api3 {
/**
+ * Class constructor.
+ *
* @param array $config API configuration.
*/
public function __construct($config = NULL) {
* @param array $config API configuration.
*/
public function __construct($config = NULL) {
@@
-126,6
+128,8
@@
class civicrm_api3 {
}
/**
}
/**
+ * Convert to string.
+ *
* @return string
*/
public function __toString() {
* @return string
*/
public function __toString() {
@@
-133,9
+137,11
@@
class civicrm_api3 {
}
/**
}
/**
- * Perform action
+ * Perform action.
+ *
* @param $action
* @param $params
* @param $action
* @param $params
+ *
* @return bool
*/
public function __call($action, $params) {
* @return bool
*/
public function __call($action, $params) {
@@
-149,7
+155,8
@@
class civicrm_api3 {
}
/**
}
/**
- * As of PHP 5.3.0
+ * As of PHP 5.3.0.
+ *
* @param $name
* @param $arguments
*/
* @param $name
* @param $arguments
*/
@@
-159,10
+166,12
@@
class civicrm_api3 {
}
/**
}
/**
- * Call via rest
+ * Call via rest.
+ *
* @param $entity
* @param $action
* @param array $params
* @param $entity
* @param $action
* @param array $params
+ *
* @return \stdClass
*/
public function remoteCall($entity, $action, $params = array()) {
* @return \stdClass
*/
public function remoteCall($entity, $action, $params = array()) {
@@
-208,6
+217,8
@@
class civicrm_api3 {
}
/**
}
/**
+ * Call api function.
+ *
* @param $entity
* @param string $action
* @param array $params
* @param $entity
* @param string $action
* @param array $params
@@
-296,6
+307,8
@@
class civicrm_api3 {
}
/**
}
/**
+ * Is this an error.
+ *
* @return bool
*/
public function is_error() {
* @return bool
*/
public function is_error() {
@@
-306,6
+319,7
@@
class civicrm_api3 {
* Check if var is set.
*
* @param string $name
* Check if var is set.
*
* @param string $name
+ *
* @return bool
*/
public function is_set($name) {
* @return bool
*/
public function is_set($name) {
@@
-316,6
+330,7
@@
class civicrm_api3 {
* Get object.
*
* @param string $name
* Get object.
*
* @param string $name
+ *
* @return $this
*/
public function __get($name) {
* @return $this
*/
public function __get($name) {
diff --git
a/api/v3/ActionSchedule.php
b/api/v3/ActionSchedule.php
index 6fcd9cb1a54a8738cc8128716bbfeb338ff5466e..ed0c42605cede441acaa9ddf4c7e50cef18d5ac1 100644
(file)
--- a/
api/v3/ActionSchedule.php
+++ b/
api/v3/ActionSchedule.php
@@
-72,7
+72,6
@@
function civicrm_api3_action_schedule_create($params) {
function _civicrm_api3_action_schedule_create_spec(&$params) {
$params['title']['api.required'] = TRUE;
$params['mapping_id']['api.required'] = TRUE;
function _civicrm_api3_action_schedule_create_spec(&$params) {
$params['title']['api.required'] = TRUE;
$params['mapping_id']['api.required'] = TRUE;
- // $params['entity_status']['api.required'] = TRUE;
$params['entity_value']['api.required'] = TRUE;
}
$params['entity_value']['api.required'] = TRUE;
}
diff --git
a/api/v3/ActivityContact.php
b/api/v3/ActivityContact.php
index c4aecb6cb6eb1b29ee166bffa9423832ee017b2b..d9220ac8ca67aeff0cddb8d65636078eccf9b34a 100644
(file)
--- a/
api/v3/ActivityContact.php
+++ b/
api/v3/ActivityContact.php
@@
-36,7
+36,7
@@
*/
/**
*/
/**
- *
Add a record relating a contact with an activity.
+ * Add a record relating a contact with an activity.
*
* @param array $params
*
*
* @param array $params
*
@@
-61,7
+61,7
@@
function _civicrm_api3_activity_contact_create_spec(&$params) {
}
/**
}
/**
- * Delete
s an existing ActivityContact record
+ * Delete
an existing ActivityContact record.
*
* @param array $params
*
*
* @param array $params
*
diff --git
a/api/v3/Attachment.php
b/api/v3/Attachment.php
index 829235fde6ab492500c03a8368f0cf8a519e5109..455fd96517e2ccbf1368a895333360b3176668cd 100644
(file)
--- a/
api/v3/Attachment.php
+++ b/
api/v3/Attachment.php
@@
-66,7
+66,6
@@
* @subpackage API_Attachment
* @copyright CiviCRM LLC (c) 2004-2014
* $Id: $
* @subpackage API_Attachment
* @copyright CiviCRM LLC (c) 2004-2014
* $Id: $
- *
*/
/**
*/
/**
@@
-163,7
+162,10
@@
function _civicrm_api3_attachment_get_spec(&$spec) {
}
/**
}
/**
+ * Get attachment.
+ *
* @param array $params
* @param array $params
+ *
* @return array
* per APIv3
* @throws API_Exception validation errors
* @return array
* per APIv3
* @throws API_Exception validation errors
@@
-308,7
+310,8
@@
function __civicrm_api3_attachment_find($params, $id, $file, $entityFile, $isTru
*
* @param array $params
*
*
* @param array $params
*
- * @return array (0 => int $id, 1 => array $file, 2 => array $entityFile, 3 => string $name, 4 => string $content,
+ * @return array
+ * (0 => int $id, 1 => array $file, 2 => array $entityFile, 3 => string $name, 4 => string $content,
* 5 => string $moveFile, 6 => $isTrusted, 7 => bool $returnContent)
* - array $file: whitelisted fields that can pass through directly to civicrm_file
* - array $entityFile: whitelisted fields that can pass through directly to civicrm_entity_file
* 5 => string $moveFile, 6 => $isTrusted, 7 => bool $returnContent)
* - array $file: whitelisted fields that can pass through directly to civicrm_file
* - array $entityFile: whitelisted fields that can pass through directly to civicrm_entity_file
diff --git
a/api/v3/CaseType.php
b/api/v3/CaseType.php
index dfdf62d0922ed86a0d1e439d22afa1b1d5fc3c05..90f8e1b7ebf031b973494613c3d17c2e1164380e 100644
(file)
--- a/
api/v3/CaseType.php
+++ b/
api/v3/CaseType.php
@@
-43,7
+43,6
@@
* @throws API_Exception
* @return array
* API result array
* @throws API_Exception
* @return array
* API result array
- *
*/
function civicrm_api3_case_type_create($params) {
civicrm_api3_verify_mandatory($params, _civicrm_api3_get_DAO(__FUNCTION__));
*/
function civicrm_api3_case_type_create($params) {
civicrm_api3_verify_mandatory($params, _civicrm_api3_get_DAO(__FUNCTION__));
diff --git
a/api/v3/Constant.php
b/api/v3/Constant.php
index ac42c16533b6d87845e9d2d7f5ebd3d9ed0a9dc3..1b7363e4b01e811f91d847472f21ebcf4897f0de 100644
(file)
--- a/
api/v3/Constant.php
+++ b/
api/v3/Constant.php
@@
-36,6
+36,8
@@
*/
/**
*/
/**
+ * Declare deprecated api entity.
+ *
* @deprecated api notice
* @return string
* to indicate this entire api entity is deprecated
* @deprecated api notice
* @return string
* to indicate this entire api entity is deprecated
@@
-45,6
+47,8
@@
function _civicrm_api3_constant_deprecation() {
}
/**
}
/**
+ * Get constant values (deprecated).
+ *
* @deprecated as of CiviCRM 4.4.
* It's recommended to use the api getoptions action instead
*
* @deprecated as of CiviCRM 4.4.
* It's recommended to use the api getoptions action instead
*
@@
-136,6
+140,8
@@
function civicrm_api3_constant_get($params) {
}
/**
}
/**
+ * Adjust metadata for constant get action.
+ *
* @param array $params
*/
function _civicrm_api3_constant_get_spec(&$params) {
* @param array $params
*/
function _civicrm_api3_constant_get_spec(&$params) {
diff --git
a/api/v3/Contact.php
b/api/v3/Contact.php
index 38b7b31ad5d09815bab17a78fe0517ca27cc3ac3..5d97e5362a4ee3f06a12f9c08de1eedf341a7999 100644
(file)
--- a/
api/v3/Contact.php
+++ b/
api/v3/Contact.php
@@
-1006,7
+1006,13
@@
function _civicrm_api3_contact_getlist_params(&$request) {
function _civicrm_api3_contact_getlist_output($result, $request) {
$output = array();
if (!empty($result['values'])) {
function _civicrm_api3_contact_getlist_output($result, $request) {
$output = array();
if (!empty($result['values'])) {
- $addressFields = array_intersect(array('street_address', 'city', 'state_province', 'country'), $request['params']['return']);
+ $addressFields = array_intersect(array(
+ 'street_address',
+ 'city',
+ 'state_province',
+ 'country',
+ ),
+ $request['params']['return']);
foreach ($result['values'] as $row) {
$data = array(
'id' => $row[$request['id_field']],
foreach ($result['values'] as $row) {
$data = array(
'id' => $row[$request['id_field']],
diff --git
a/api/v3/Contribution.php
b/api/v3/Contribution.php
index 8b65f55ceacde4a4f7be14a3a2ae80a2286ac833..5c696661f583e983a27a22cbc18ba42e2e1c052f 100644
(file)
--- a/
api/v3/Contribution.php
+++ b/
api/v3/Contribution.php
@@
-148,6
+148,7
@@
function _civicrm_api3_contribution_create_spec(&$params) {
* 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.
* 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_contribution_create_legacy_support_45(&$params) {
* @param array $params
*/
function _civicrm_api3_contribution_create_legacy_support_45(&$params) {
@@
-230,6
+231,7
@@
function civicrm_api3_contribution_get($params) {
*
* As of v4.4 we support multiple soft credit, so now contribution returns array with 'soft_credit' as key
* but we still return first soft credit as a part of contribution array
*
* As of v4.4 we support multiple soft credit, so now contribution returns array with 'soft_credit' as key
* but we still return first soft credit as a part of contribution array
+ *
* @param $contribution
*/
function _civicrm_api3_format_soft_credit(&$contribution) {
* @param $contribution
*/
function _civicrm_api3_format_soft_credit(&$contribution) {
diff --git
a/api/v3/ContributionPage.php
b/api/v3/ContributionPage.php
index a2ac132a9d19c1359280697b1fecaa0948aa4145..5c68330cb520809a88ea15b6362dc39117c24c7f 100644
(file)
--- a/
api/v3/ContributionPage.php
+++ b/
api/v3/ContributionPage.php
@@
-94,7
+94,7
@@
function civicrm_api3_contribution_page_delete($params) {
}
/**
}
/**
- *
Submit a contribution_page.
+ * Submit a contribution_page.
*
* @param array $params
* Array per getfields metadata.
*
* @param array $params
* Array per getfields metadata.
diff --git
a/api/v3/CustomValue.php
b/api/v3/CustomValue.php
index 66a5dfb84cd5a371f03efa6e843428a011f9e60f..748bbde23b97ba2c765ed20dceb306e5aa10dd52 100644
(file)
--- a/
api/v3/CustomValue.php
+++ b/
api/v3/CustomValue.php
@@
-64,7
+64,6
@@
* @throws Exception
* @return array
* ['values' => TRUE] or ['is_error' => 1, 'error_message' => 'what went wrong']
* @throws Exception
* @return array
* ['values' => TRUE] or ['is_error' => 1, 'error_message' => 'what went wrong']
- *
*/
function civicrm_api3_custom_value_create($params) {
// @todo it's not clear where the entity_table is used as CRM_Core_BAO_CustomValueTable::setValues($create)
*/
function civicrm_api3_custom_value_create($params) {
// @todo it's not clear where the entity_table is used as CRM_Core_BAO_CustomValueTable::setValues($create)
@@
-226,7
+225,7
@@
function civicrm_api3_custom_value_get($params) {
}
/**
}
/**
- * Adjust Metadata for Get action
+ * Adjust Metadata for Get action
.
*
* The metadata is used for setting defaults, documentation & validation.
*
*
* The metadata is used for setting defaults, documentation & validation.
*
diff --git
a/api/v3/Dashboard.php
b/api/v3/Dashboard.php
index af73c3aac4a54d4579e1dc6fba30295e583967f1..706d28e77f02369ad5f15a313f6e834606ddd046 100644
(file)
--- a/
api/v3/Dashboard.php
+++ b/
api/v3/Dashboard.php
@@
-34,7
+34,6
@@
* @subpackage API_Activity
* @copyright CiviCRM LLC (c) 2004-2014
* @version $Id: Activity.php 30486 2010-11-02 16:12:09Z shot $
* @subpackage API_Activity
* @copyright CiviCRM LLC (c) 2004-2014
* @version $Id: Activity.php 30486 2010-11-02 16:12:09Z shot $
- *
*/
*/
diff --git
a/api/v3/DashboardContact.php
b/api/v3/DashboardContact.php
index 53bef6a33aebcf97b441ae62ef66838aaf422e1f..294930046b2aaf41058c0277e9179f291258d6e2 100644
(file)
--- a/
api/v3/DashboardContact.php
+++ b/
api/v3/DashboardContact.php
@@
-101,12
+101,13
@@
function _civicrm_api3_dashboard_contact_check_params(&$params) {
}
/**
}
/**
- * Delete an existing dashboard-contact
+ * Delete an existing dashboard-contact
.
*
* This method is used to delete any existing dashboard-board. the id of the dashboard-contact
* is required field in $params array
*
* @param array $params
*
* This method is used to delete any existing dashboard-board. the id of the dashboard-contact
* is required field in $params array
*
* @param array $params
+ *
* @return array
* @throws \API_Exception
*/
* @return array
* @throws \API_Exception
*/
diff --git
a/api/v3/Extension.php
b/api/v3/Extension.php
index 7ca3d97a0db32b38f91d498ec7391b2d7c391f68..2bbd45af13cca4e73787d38bad017e3fd6922371 100644
(file)
--- a/
api/v3/Extension.php
+++ b/
api/v3/Extension.php
@@
-36,11
+36,10
@@
define('API_V3_EXTENSION_DELIMITER', ',');
*
* @copyright CiviCRM LLC (c) 2004-2014
* @version $Id$
*
* @copyright CiviCRM LLC (c) 2004-2014
* @version $Id$
- *
*/
/**
*/
/**
- * Install an extension
+ * Install an extension
.
*
* @param array $params
* Input parameters.
*
* @param array $params
* Input parameters.
@@
-98,7
+97,7
@@
function civicrm_api3_extension_upgrade() {
}
/**
}
/**
- * Enable an extension
+ * Enable an extension
.
*
* @param array $params
* Input parameters.
*
* @param array $params
* Input parameters.
@@
-142,7
+141,7
@@
function civicrm_api3_extension_disable($params) {
}
/**
}
/**
- * Uninstall an extension
,
+ * Uninstall an extension
.
*
* @param array $params
* Input parameters.
*
* @param array $params
* Input parameters.
@@
-166,7
+165,7
@@
function civicrm_api3_extension_uninstall($params) {
}
/**
}
/**
- * Download and install an extension
+ * Download and install an extension
.
*
* @param array $params
* Input parameters.
*
* @param array $params
* Input parameters.
@@
-217,7
+216,7
@@
function civicrm_api3_extension_download($params) {
}
/**
}
/**
- * Download and install an extension
+ * Download and install an extension
.
*
* @param array $params
* Input parameters.
*
* @param array $params
* Input parameters.
@@
-226,8
+225,6
@@
function civicrm_api3_extension_download($params) {
*
* @return array
* API result
*
* @return array
* API result
- * @example ExtensionRefresh.php
- *
*/
function civicrm_api3_extension_refresh($params) {
$defaults = array('local' => TRUE, 'remote' => TRUE);
*/
function civicrm_api3_extension_refresh($params) {
$defaults = array('local' => TRUE, 'remote' => TRUE);
diff --git
a/api/v3/Generic.php
b/api/v3/Generic.php
index a19e1a9ff639196877d47c39f67c6edda270730a..daf416e65c134ed99141a8f14a8fa84e2ef26d73 100644
(file)
--- a/
api/v3/Generic.php
+++ b/
api/v3/Generic.php
@@
-312,6
+312,8
@@
function civicrm_api3_generic_getoptions($apiRequest) {
}
/**
}
/**
+ * Get metadata.
+ *
* Function fills the 'options' array on the metadata returned by getfields if
* 1) the param option 'get_options' is defined - e.g. $params['options']['get_options'] => array('custom_1)
* (this is passed in as the $fieldsToResolve array)
* Function fills the 'options' array on the metadata returned by getfields if
* 1) the param option 'get_options' is defined - e.g. $params['options']['get_options'] => array('custom_1)
* (this is passed in as the $fieldsToResolve array)
diff --git
a/api/v3/GroupContact.php
b/api/v3/GroupContact.php
index bb90583b84cf6e2db778a447d0a9368a08d2d98b..2fcd3400af51e97e824d5503b3af1be3a45c0bf3 100644
(file)
--- a/
api/v3/GroupContact.php
+++ b/
api/v3/GroupContact.php
@@
-136,7
+136,8
@@
function civicrm_api3_group_contact_delete($params) {
}
/**
}
/**
- * modify metadata
+ * Adjust metadata.
+ *
* @param array $params
*/
function _civicrm_api3_group_contact_delete_spec(&$params) {
* @param array $params
*/
function _civicrm_api3_group_contact_delete_spec(&$params) {
@@
-158,6
+159,7
@@
function civicrm_api3_group_contact_pending($params) {
}
/**
}
/**
+ * Group contact helper function.
*
* @param array $params
* @param string $op
*
* @param array $params
* @param string $op
@@
-227,8
+229,12
@@
function _civicrm_api3_group_contact_common($params, $op = 'Added') {
}
/**
}
/**
+ * Update group contact status.
+ *
* @deprecated - this should be part of create but need to know we aren't missing something
* @deprecated - this should be part of create but need to know we aren't missing something
+ *
* @param array $params
* @param array $params
+ *
* @return bool
* @throws \API_Exception
*/
* @return bool
* @throws \API_Exception
*/
@@
-248,6
+254,8
@@
function civicrm_api3_group_contact_update_status($params) {
}
/**
}
/**
+ * Deprecated function notices.
+ *
* @deprecated api notice
* @return array
* Array of deprecated actions
* @deprecated api notice
* @return array
* Array of deprecated actions
diff --git
a/api/v3/GroupOrganization.php
b/api/v3/GroupOrganization.php
index 7286dde3624aae9bc7c01705bd799ce77acb80a5..451eefe30073f404155188859baf1939813a6d34 100644
(file)
--- a/
api/v3/GroupOrganization.php
+++ b/
api/v3/GroupOrganization.php
@@
-56,7
+56,6
@@
function civicrm_api3_group_organization_get($params) {
* Array.
*
* @return array
* Array.
*
* @return array
- *
*/
function civicrm_api3_group_organization_create($params) {
*/
function civicrm_api3_group_organization_create($params) {
diff --git
a/api/v3/LineItem.php
b/api/v3/LineItem.php
index 4d7732ea97c9452037017b1c049ff536dbe6b95b..c44c4e1ab5572fa7e5943a79d89f70774013b649 100644
(file)
--- a/
api/v3/LineItem.php
+++ b/
api/v3/LineItem.php
@@
-38,9
+38,7
@@
* Create or update a line_item.
*
* @param array $params
* Create or update a line_item.
*
* @param array $params
- * Associative array of property.
- * name/value pairs to insert in new 'line_item'
- * @example LineItemCreate.php Std Create example
+ * Array of property name/value pairs to insert in new 'line_item'
*
* @return array
* api result array
*
* @return array
* api result array
diff --git
a/api/v3/Mailing.php
b/api/v3/Mailing.php
index 3d159ec4f6ea0adb00b389545f02f7e1194eff62..7e36d2a7cb386fe0033cc6a6be885f6745ae0b39 100755
(executable)
--- a/
api/v3/Mailing.php
+++ b/
api/v3/Mailing.php
@@
-171,11
+171,11
@@
function civicrm_api3_mailing_submit($params) {
$updateParams = array();
$updateParams['id'] = $params['id'];
$updateParams = array();
$updateParams['id'] = $params['id'];
- //
the BAO will autocreate the job
- $updateParams['api.mailing_job.create'] = 0;
// note: exact match to API default
+ //
The BAO will auto-create the job - note: exact match to API default.
+ $updateParams['api.mailing_job.create'] = 0;
- //
n
ote: we'll pass along scheduling/approval fields, but they may get ignored
- // if we don't have permission
+ //
N
ote: we'll pass along scheduling/approval fields, but they may get ignored
+ // if we don't have permission
.
if (isset($params['scheduled_date'])) {
$updateParams['scheduled_date'] = $params['scheduled_date'];
$updateParams['scheduled_id'] = CRM_Core_Session::getLoggedInContactID();
if (isset($params['scheduled_date'])) {
$updateParams['scheduled_date'] = $params['scheduled_date'];
$updateParams['scheduled_id'] = CRM_Core_Session::getLoggedInContactID();
diff --git
a/api/v3/MailingAB.php
b/api/v3/MailingAB.php
index 5849011d49dd29f30cee3274eadfbdaddfda2163..8685246a110a27da077123c78adce0bfcec4f559 100755
(executable)
--- a/
api/v3/MailingAB.php
+++ b/
api/v3/MailingAB.php
@@
-63,6
+63,7
@@
function civicrm_api3_mailing_a_b_delete($params) {
* Handle a get event.
*
* @param array $params
* Handle a get event.
*
* @param array $params
+ *
* @return array
*/
function civicrm_api3_mailing_a_b_get($params) {
* @return array
*/
function civicrm_api3_mailing_a_b_get($params) {
diff --git
a/api/v3/MailingComponent.php
b/api/v3/MailingComponent.php
index cf4184226e861085f636bc4c4efee6d9c4a64dfe..6e8744a477708bcd067f6186b42dff35942e1201 100644
(file)
--- a/
api/v3/MailingComponent.php
+++ b/
api/v3/MailingComponent.php
@@
-34,6
+34,7
@@
/**
* Save a mailing_component.
/**
* Save a mailing_component.
+ *
* @param array $params
*
* @throws API_Exception
* @param array $params
*
* @throws API_Exception
diff --git
a/api/v3/MailingEventQueue.php
b/api/v3/MailingEventQueue.php
index a0f56e1edb64b43978380f6ea1fbeb0f8a10fa02..ac3bb377fe7acf66c49c00566c29d3eee17e21c9 100644
(file)
--- a/
api/v3/MailingEventQueue.php
+++ b/
api/v3/MailingEventQueue.php
@@
-60,6
+60,7
@@
function civicrm_api3_mailing_event_queue_create($params) {
* Get mailing event queue record.
*
* @param array $params
* Get mailing event queue record.
*
* @param array $params
+ *
* @return array
*/
function civicrm_api3_mailing_event_queue_get($params) {
* @return array
*/
function civicrm_api3_mailing_event_queue_get($params) {
diff --git
a/api/v3/MailingGroup.php
b/api/v3/MailingGroup.php
index eacb3b169c3f0021ea04be5b62ed100862072b01..51f64bb4ae1f67915666dd590209efc43fe6f2b8 100644
(file)
--- a/
api/v3/MailingGroup.php
+++ b/
api/v3/MailingGroup.php
@@
-87,7
+87,8
@@
function civicrm_api3_mailing_group_event_resubscribe($params) {
}
/**
}
/**
- * Handle a subscription event
+ * Handle a subscription event.
+ *
* @deprecated
*
* @param array $params
* @deprecated
*
* @param array $params
@@
-99,7
+100,10
@@
function civicrm_api3_mailing_group_event_subscribe($params) {
}
/**
}
/**
+ * Create mailing group.
+ *
* @param array $params
* @param array $params
+ *
* @return array
* @throws \API_Exception
*/
* @return array
* @throws \API_Exception
*/
@@
-108,6
+112,8
@@
function civicrm_api3_mailing_group_create($params) {
}
/**
}
/**
+ * Get mailing group.
+ *
* @param array $params
*
* @return array
* @param array $params
*
* @return array
@@
-129,6
+135,8
@@
function civicrm_api3_mailing_group_delete($params) {
}
/**
}
/**
+ * Get metadata for mailing group functions.
+ *
* @param array $params
*
* @return array
* @param array $params
*
* @return array
diff --git
a/api/v3/Membership.php
b/api/v3/Membership.php
index 0c7621a1d243af4de46f48c8709c755909e356e8..7abd85e6ad9b261c8044ff0acb1e7185928deae7 100644
(file)
--- a/
api/v3/Membership.php
+++ b/
api/v3/Membership.php
@@
-50,7
+50,7
@@
function civicrm_api3_membership_delete($params) {
}
/**
}
/**
- * Create a Contact Membership
+ * Create a Contact Membership
.
*
* This API is used for creating a Membership for a contact.
* Required parameters : membership_type_id and status_id.
*
* This API is used for creating a Membership for a contact.
* Required parameters : membership_type_id and status_id.
@@
-162,7
+162,7
@@
function _civicrm_api3_membership_create_spec(&$params) {
);
}
/**
);
}
/**
- * Adjust Metadata for Get action
+ * Adjust Metadata for Get action
.
*
* The metadata is used for setting defaults, documentation & validation.
*
*
* The metadata is used for setting defaults, documentation & validation.
*
@@
-221,6
+221,8
@@
function civicrm_api3_membership_get($params) {
}
/**
}
/**
+ * Perform api v2 custom behaviour.
+ *
* When we copied apiv3 from api v2 we brought across some custom behaviours - in the case of
* membership a complicated return array is constructed. The original
* behaviour made contact_id a required field. We still need to keep this for v3 when contact_id
* When we copied apiv3 from api v2 we brought across some custom behaviours - in the case of
* membership a complicated return array is constructed. The original
* behaviour made contact_id a required field. We still need to keep this for v3 when contact_id
diff --git
a/api/v3/MembershipStatus.php
b/api/v3/MembershipStatus.php
index 78f2d77becc6add70daec49dd6d831cdead482d6..3e8a7d2e7d4021f2a30066d48d52ad23e043fd5b 100644
(file)
--- a/
api/v3/MembershipStatus.php
+++ b/
api/v3/MembershipStatus.php
@@
-71,7
+71,8
@@
function civicrm_api3_membership_status_get($params) {
* Required parameters : id of a membership status
*
* @param array $params
* Required parameters : id of a membership status
*
* @param array $params
- * An associative array of name/value property values of civicrm_membership_status.
+ * Array of name/value property values of civicrm_membership_status.
+ *
* @deprecated - should just use create
*
* @return array
* @deprecated - should just use create
*
* @return array
diff --git
a/api/v3/MessageTemplate.php
b/api/v3/MessageTemplate.php
index c768645f510d59e8fcc0fa4511fa8d4dbe89bd69..1a330542c6d7cf4c334ba19472c7af55140f0855 100644
(file)
--- a/
api/v3/MessageTemplate.php
+++ b/
api/v3/MessageTemplate.php
@@
-60,6
+60,8
@@
function _civicrm_api3_message_template_create_spec(&$params) {
}
/**
}
/**
+ * Delete message template.
+ *
* @param array $params
*
* @return bool
* @param array $params
*
* @return bool
diff --git
a/api/v3/ParticipantPayment.php
b/api/v3/ParticipantPayment.php
index c2f36f5b281c606b8c1b8956252f8f3845b341b7..1720dfb13282344e2ce0e9fb95ba30af903c5905 100644
(file)
--- a/
api/v3/ParticipantPayment.php
+++ b/
api/v3/ParticipantPayment.php
@@
-36,7
+36,7
@@
*/
/**
*/
/**
- * Create a Event Participant Payment
+ * Create a Event Participant Payment
.
*
* This API is used for creating a Participant Payment of Event.
* Required parameters : participant_id, contribution_id.
*
* This API is used for creating a Participant Payment of Event.
* Required parameters : participant_id, contribution_id.
diff --git
a/api/v3/Profile.php
b/api/v3/Profile.php
index 4a3874d69b5f0e44fa32250c9ba3ee58900621d4..82269c5d8885389f5fedd26bd6c47abfe152d482 100644
(file)
--- a/
api/v3/Profile.php
+++ b/
api/v3/Profile.php
@@
-307,8
+307,10
@@
function _civicrm_api3_profile_translate_fieldnames_for_bao($fieldName) {
$fieldName = str_replace('url', 'URL', $fieldName);
return str_replace('primary', 'Primary', $fieldName);
}
$fieldName = str_replace('url', 'URL', $fieldName);
return str_replace('primary', 'Primary', $fieldName);
}
+
/**
/**
- * metadata for submit action
+ * Metadata for submit action.
+ *
* @param array $params
* @param array $apirequest
*/
* @param array $params
* @param array $apirequest
*/
@@
-345,8
+347,6
@@
function _civicrm_api3_profile_submit_spec(&$params, $apirequest) {
*
* @return array
* Updated Contact/ Activity object|CRM_Error
*
* @return array
* Updated Contact/ Activity object|CRM_Error
- *
- *
*/
function civicrm_api3_profile_set($params) {
return civicrm_api3('profile', 'submit', $params);
*/
function civicrm_api3_profile_set($params) {
return civicrm_api3('profile', 'submit', $params);
@@
-484,8
+484,9
@@
function _civicrm_api3_profile_getbillingpseudoprofile(&$params) {
}
/**
}
/**
- * Here we will build up getfields type data for all the fields in the profile. Because the integration with the
- * form layer in core is so hard-coded we are not going to attempt to re-use it
+ * Here we will build up getfields type data for all the fields in the profile.
+ *
+ * Because the integration with the form layer in core is so hard-coded we are not going to attempt to re-use it
* However, as this function is unit-tested & hence 'locked in' we can aspire to extract sharable
* code out of the form-layer over time.
*
* However, as this function is unit-tested & hence 'locked in' we can aspire to extract sharable
* code out of the form-layer over time.
*
diff --git
a/api/v3/Relationship.php
b/api/v3/Relationship.php
index d0903b3adb62f226ccf10ad7206a9a343d5e4e1d..9e0456e1764bf37c4f502bfb54d2b5644a559acb 100644
(file)
--- a/
api/v3/Relationship.php
+++ b/
api/v3/Relationship.php
@@
-71,7
+71,6
@@
function _civicrm_api3_relationship_create_spec(&$params) {
*
* @return array
* API Result Array
*
* @return array
* API Result Array
- *
*/
function civicrm_api3_relationship_delete($params) {
*/
function civicrm_api3_relationship_delete($params) {
diff --git
a/api/v3/RelationshipType.php
b/api/v3/RelationshipType.php
index 7e2eb908e89d4b7c2963d99d5a85812270e3847e..799292f7ba3e219e04e7f454ab2f07d159f30bc9 100644
(file)
--- a/
api/v3/RelationshipType.php
+++ b/
api/v3/RelationshipType.php
@@
-117,6
+117,7
@@
function civicrm_api3_relationship_type_delete($params) {
* @see _civicrm_api3_generic_getlist_defaults
*
* @param array $request
* @see _civicrm_api3_generic_getlist_defaults
*
* @param array $request
+ *
* @return array
*/
function _civicrm_api3_relationship_type_getlist_defaults($request) {
* @return array
*/
function _civicrm_api3_relationship_type_getlist_defaults($request) {
diff --git
a/api/v3/ReportInstance.php
b/api/v3/ReportInstance.php
index fa34ae958a84a605d167cd7604458c4f1df42c51..ebf7a44c9681a585ae7ac0c24d4da67e986e84a7 100644
(file)
--- a/
api/v3/ReportInstance.php
+++ b/
api/v3/ReportInstance.php
@@
-39,7
+39,7
@@
function _civicrm_api3_report_instance_create_spec(&$params) {
}
/**
}
/**
- * Deletes an existing ReportInstance
+ * Deletes an existing ReportInstance
.
*
* @param array $params
*
*
* @param array $params
*
diff --git
a/api/v3/ReportTemplate.php
b/api/v3/ReportTemplate.php
index 9f5c8eee635a82a50d3d2dd7dc8e7d31f6b770df..78707e8b35623382cf039a8e8ee4cf3b813b13bb 100644
(file)
--- a/
api/v3/ReportTemplate.php
+++ b/
api/v3/ReportTemplate.php
@@
-154,13
+154,10
@@
function civicrm_api3_report_template_getstatistics($params) {
return civicrm_api3_create_success($stats, $params, 'report_template', 'getstatistics', CRM_Core_DAO::$_nullObject, $metadata);
}
/**
return civicrm_api3_create_success($stats, $params, 'report_template', 'getstatistics', CRM_Core_DAO::$_nullObject, $metadata);
}
/**
- *
Retrieve rows from a report template
.
+ *
Adjust metadata for template getrows action
.
*
* @param array $params
* Input parameters.
*
* @param array $params
* Input parameters.
- *
- * @return void
- * details of found instances
*/
function _civicrm_api3_report_template_getrows_spec(&$params) {
$params['report_id'] = array(
*/
function _civicrm_api3_report_template_getrows_spec(&$params) {
$params['report_id'] = array(
diff --git
a/api/v3/Setting.php
b/api/v3/Setting.php
index 22c9e2c9261d9e6f494bb7a297d262ea2a648759..7bf30316c5379212f6c3c8b3f8a30492f222914a 100644
(file)
--- a/
api/v3/Setting.php
+++ b/
api/v3/Setting.php
@@
-166,7
+166,8
@@
function civicrm_api3_setting_revert(&$params) {
}
/**
}
/**
- * Alter metadata for getfields functions
+ * Alter metadata for getfields functions.
+ *
* @param array $params
*/
function _civicrm_api3_setting_revert_spec(&$params) {
* @param array $params
*/
function _civicrm_api3_setting_revert_spec(&$params) {
@@
-174,8
+175,8
@@
function _civicrm_api3_setting_revert_spec(&$params) {
$params['component_id'] = array('title' => 'id of relevant component');
$params['domain_id'] = array(
'api.default' => 'current_domain',
$params['component_id'] = array('title' => 'id of relevant component');
$params['domain_id'] = array(
'api.default' => 'current_domain',
- 'description' => 'Defaults may differ by domain - if you do not pass in a domain id this will default to the current domain
-
an array or "all" are acceptable values for multiple domains',
+ 'description' => 'Defaults may differ by domain - if you do not pass in a domain id this will default to the current domain
'
+
. '
an array or "all" are acceptable values for multiple domains',
'title' => 'Setting Domain',
);
}
'title' => 'Setting Domain',
);
}
@@
-219,7
+220,7
@@
function _civicrm_api3_setting_fill_spec(&$params) {
'api.default' => 'current_domain',
'title' => 'Setting Domain',
'description' => 'Defaults may differ by domain - if you do not pass in a domain id this will default to the '
'api.default' => 'current_domain',
'title' => 'Setting Domain',
'description' => 'Defaults may differ by domain - if you do not pass in a domain id this will default to the '
-
. 'current domain, an array or "all" are acceptable values for multiple domains',
+ . 'current domain, an array or "all" are acceptable values for multiple domains',
);
}
);
}
diff --git
a/api/v3/SurveyRespondant.php
b/api/v3/SurveyRespondant.php
index 591007c23acd0e7bf3fca90c6d6de15aaab652fc..82bc9d1bd0d6f8a519d3b95bebec01f6ee51b56c 100644
(file)
--- a/
api/v3/SurveyRespondant.php
+++ b/
api/v3/SurveyRespondant.php
@@
-44,7
+44,8
@@
function _civicrm_api3_survey_respondant_deprecation() {
}
/**
}
/**
- * Get the list of signatories
+ * Get the list of signatories.
+ *
* @deprecated - api currently not supported
*
* @param array $params
* @deprecated - api currently not supported
*
* @param array $params
@@
-79,7
+80,10
@@
function civicrm_api3_survey_respondant_get(&$params) {
}
/**
}
/**
+ * Count survey respondents.
+ *
* @deprecated - api currently not supported
* @deprecated - api currently not supported
+ *
* @param array $params
* @return array
*/
* @param array $params
* @return array
*/
diff --git
a/api/v3/UFGroup.php
b/api/v3/UFGroup.php
index 57a1e0bced90e7c31e7f9292a9876acec330e1f0..2ff2ac65dd11e87ea1d89c9f87c1a14f1f95eb76 100644
(file)
--- a/
api/v3/UFGroup.php
+++ b/
api/v3/UFGroup.php
@@
-45,9
+45,11
@@
function _civicrm_api3_uf_group_create_spec(&$params) {
$params['title']['api.required'] = 1;
$params['is_active']['api.default'] = 1;
$params['is_update_dupe']['api.default'] = 1;
$params['title']['api.required'] = 1;
$params['is_active']['api.default'] = 1;
$params['is_update_dupe']['api.default'] = 1;
- $params['created_id']['api.default'] = 'user_contact_id';//the current user
+ // Default to the logged in user.
+ $params['created_id']['api.default'] = 'user_contact_id';
$params['created_date']['api.default'] = 'now';
}
$params['created_date']['api.default'] = 'now';
}
+
/**
* Use this API to create a new group.
*
/**
* Use this API to create a new group.
*
diff --git
a/api/v3/Website.php
b/api/v3/Website.php
index 7cb54a9d87f01f79857d2aaceefd22cc68fcd991..ca4f07606c6459ec586b47c539c4a82004d9c1f3 100644
(file)
--- a/
api/v3/Website.php
+++ b/
api/v3/Website.php
@@
-69,6
+69,7
@@
function _civicrm_api3_website_create_spec(&$params) {
* Deletes an existing Website.
*
* @todo convert to using Basic delete - BAO function non standard
* Deletes an existing Website.
*
* @todo convert to using Basic delete - BAO function non standard
+ *
* @param array $params
*
* @return array
* @param array $params
*
* @return array