From 24a70b661b4cdd5798445955249a1de00ec9e835 Mon Sep 17 00:00:00 2001 From: Eileen McNaughton Date: Tue, 13 Jan 2015 12:26:04 +1300 Subject: [PATCH] remove some @access from phpdoc --- CRM/Activity/BAO/ICalendar.php | 1 - CRM/Activity/Selector/Activity.php | 1 - CRM/Activity/Selector/Search.php | 1 - CRM/Campaign/BAO/Campaign.php | 1 - CRM/Campaign/BAO/Petition.php | 1 - CRM/Campaign/Selector/Search.php | 1 - CRM/Case/BAO/Case.php | 1 - CRM/Case/Selector/Search.php | 1 - CRM/Contact/BAO/GroupOrganization.php | 1 - CRM/Contact/BAO/Query.php | 1 - CRM/Contact/BAO/Relationship.php | 1 - CRM/Contact/Form/Domain.php | 1 - CRM/Contact/Selector/Custom.php | 1 - CRM/Contribute/BAO/Contribution.php | 1 - CRM/Contribute/Selector/Search.php | 1 - api/api.php | 1 - api/v3/Acl.php | 6 ------ api/v3/AclRole.php | 3 --- api/v3/ActionSchedule.php | 1 - api/v3/ActivityContact.php | 3 --- api/v3/ActivityType.php | 9 --------- api/v3/Address.php | 3 --- api/v3/Attachment.php | 4 +++- api/v3/Batch.php | 3 --- api/v3/Campaign.php | 2 -- api/v3/Case.php | 2 -- api/v3/CaseType.php | 2 -- api/v3/Contact.php | 1 - api/v3/RelationshipType.php | 1 - api/v3/ReportInstance.php | 3 --- api/v3/ReportTemplate.php | 5 ----- api/v3/Setting.php | 3 --- api/v3/SmsProvider.php | 3 --- api/v3/Survey.php | 3 --- api/v3/System.php | 3 ++- api/v3/Tag.php | 3 --- api/v3/UFField.php | 1 - api/v3/UFGroup.php | 2 -- api/v3/UFMatch.php | 2 -- api/v3/Website.php | 1 - api/v3/WordReplacement.php | 1 - api/v3/utils.php | 6 +----- 42 files changed, 6 insertions(+), 86 deletions(-) diff --git a/CRM/Activity/BAO/ICalendar.php b/CRM/Activity/BAO/ICalendar.php index 582a322013..7cb7ed51af 100644 --- a/CRM/Activity/BAO/ICalendar.php +++ b/CRM/Activity/BAO/ICalendar.php @@ -51,7 +51,6 @@ class CRM_Activity_BAO_ICalendar { * Reference to an activity object. * * @return \CRM_Activity_BAO_ICalendar - * @access public */ public function __construct(&$act) { $this->activity = $act; diff --git a/CRM/Activity/Selector/Activity.php b/CRM/Activity/Selector/Activity.php index 217d3e1471..4187319007 100644 --- a/CRM/Activity/Selector/Activity.php +++ b/CRM/Activity/Selector/Activity.php @@ -74,7 +74,6 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C * @param null $activityTypeIDs * * @return \CRM_Activity_Selector_Activity - * @access public */ function __construct( $contactId, diff --git a/CRM/Activity/Selector/Search.php b/CRM/Activity/Selector/Search.php index ade1404e27..082b835b08 100644 --- a/CRM/Activity/Selector/Search.php +++ b/CRM/Activity/Selector/Search.php @@ -152,7 +152,6 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM * @param null $compContext * * @return \CRM_Activity_Selector_Search - * @access public */ function __construct( &$queryParams, diff --git a/CRM/Campaign/BAO/Campaign.php b/CRM/Campaign/BAO/Campaign.php index e9ab3a0e34..940a04e6df 100644 --- a/CRM/Campaign/BAO/Campaign.php +++ b/CRM/Campaign/BAO/Campaign.php @@ -154,7 +154,6 @@ class CRM_Campaign_BAO_Campaign extends CRM_Campaign_DAO_Campaign { * * @return mixed * $campaigns a set of campaigns. - * @access public */ public static function getCampaigns( $includeId = NULL, diff --git a/CRM/Campaign/BAO/Petition.php b/CRM/Campaign/BAO/Petition.php index 8258970aa4..30136a430e 100644 --- a/CRM/Campaign/BAO/Petition.php +++ b/CRM/Campaign/BAO/Petition.php @@ -536,7 +536,6 @@ AND tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )"; * * @throws Exception * @return void - * @access public */ public static function sendEmail($params, $sendEmailMode) { diff --git a/CRM/Campaign/Selector/Search.php b/CRM/Campaign/Selector/Search.php index d246c2e9b4..6928b2c23b 100755 --- a/CRM/Campaign/Selector/Search.php +++ b/CRM/Campaign/Selector/Search.php @@ -144,7 +144,6 @@ class CRM_Campaign_Selector_Search extends CRM_Core_Selector_Base implements CRM * @param string $context * * @return \CRM_Campaign_Selector_Search - * @access public */ function __construct( &$queryParams, diff --git a/CRM/Case/BAO/Case.php b/CRM/Case/BAO/Case.php index fade780f00..c51b099203 100644 --- a/CRM/Case/BAO/Case.php +++ b/CRM/Case/BAO/Case.php @@ -1587,7 +1587,6 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c * * @return array|void * $activity object of newly creted activity via email - * @access public */ public static function recordActivityViaEmail($file) { if (!file_exists($file) || diff --git a/CRM/Case/Selector/Search.php b/CRM/Case/Selector/Search.php index 611107dc40..2320e1ff21 100644 --- a/CRM/Case/Selector/Search.php +++ b/CRM/Case/Selector/Search.php @@ -140,7 +140,6 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { * @param string $context * * @return \CRM_Case_Selector_Search - * @access public */ function __construct( &$queryParams, diff --git a/CRM/Contact/BAO/GroupOrganization.php b/CRM/Contact/BAO/GroupOrganization.php index 8da6664c57..9315b543c6 100644 --- a/CRM/Contact/BAO/GroupOrganization.php +++ b/CRM/Contact/BAO/GroupOrganization.php @@ -143,7 +143,6 @@ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganizatio * * @return int|null * no of deleted group organization on success, false otherwise - * @access public */ public static function deleteGroupOrganization($groupOrganizationID) { $results = NULL; diff --git a/CRM/Contact/BAO/Query.php b/CRM/Contact/BAO/Query.php index 5fd747d830..c5b9ba0f62 100644 --- a/CRM/Contact/BAO/Query.php +++ b/CRM/Contact/BAO/Query.php @@ -408,7 +408,6 @@ class CRM_Contact_BAO_Query { * @param string $operator * * @return \CRM_Contact_BAO_Query - * @access public */ function __construct( $params = NULL, $returnProperties = NULL, $fields = NULL, diff --git a/CRM/Contact/BAO/Relationship.php b/CRM/Contact/BAO/Relationship.php index 6dd71afc8a..fd6fe90647 100644 --- a/CRM/Contact/BAO/Relationship.php +++ b/CRM/Contact/BAO/Relationship.php @@ -712,7 +712,6 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { * This is contact id for adding relationship. * * @return string - * @access public */ public static function checkValidRelationship($params, $ids, $contactId) { $errors = ''; diff --git a/CRM/Contact/Form/Domain.php b/CRM/Contact/Form/Domain.php index dbb1c5a02a..22328fb9db 100644 --- a/CRM/Contact/Form/Domain.php +++ b/CRM/Contact/Form/Domain.php @@ -97,7 +97,6 @@ class CRM_Contact_Form_Domain extends CRM_Core_Form { * @return array * reference to the array of default values * - * @access public */ public function setDefaultValues() { $defaults = array(); diff --git a/CRM/Contact/Selector/Custom.php b/CRM/Contact/Selector/Custom.php index 5f5fde7b5f..b0a8cf111e 100644 --- a/CRM/Contact/Selector/Custom.php +++ b/CRM/Contact/Selector/Custom.php @@ -116,7 +116,6 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector { * @param null $contextMenu * * @return \CRM_Contact_Selector_Custom - * @access public */ function __construct( $customSearchClass, diff --git a/CRM/Contribute/BAO/Contribution.php b/CRM/Contribute/BAO/Contribution.php index 41b9b61890..2a7df6cb53 100644 --- a/CRM/Contribute/BAO/Contribution.php +++ b/CRM/Contribute/BAO/Contribution.php @@ -770,7 +770,6 @@ INNER JOIN civicrm_contact contact ON ( contact.id = civicrm_contribution.conta * * @return mixed|null * $results no of deleted Contribution on success, false otherwise - * @access public */ public static function deleteContribution($id) { CRM_Utils_Hook::pre('delete', 'Contribution', $id, CRM_Core_DAO::$_nullArray); diff --git a/CRM/Contribute/Selector/Search.php b/CRM/Contribute/Selector/Search.php index e409697f61..3da2901603 100644 --- a/CRM/Contribute/Selector/Search.php +++ b/CRM/Contribute/Selector/Search.php @@ -162,7 +162,6 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C * @param null $compContext * * @return \CRM_Contribute_Selector_Search - * @access public */ function __construct( &$queryParams, diff --git a/api/api.php b/api/api.php index 1c8f3671f3..3d526247ec 100644 --- a/api/api.php +++ b/api/api.php @@ -91,7 +91,6 @@ function _civicrm_api3_api_getfields(&$apiRequest) { * * @return boolean * true if error, false otherwise - * @access public */ function civicrm_error($result) { if (is_array($result)) { diff --git a/api/v3/Acl.php b/api/v3/Acl.php index f6eadc717d..6998d3982f 100644 --- a/api/v3/Acl.php +++ b/api/v3/Acl.php @@ -36,7 +36,6 @@ /** * Save an acl * - * Allowed @params array keys are: * {@getfields acl_create} * @example aclCreate.php * @@ -44,7 +43,6 @@ * * @return array * Array of newly created acl property values. - * @access public */ function civicrm_api3_acl_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -53,7 +51,6 @@ function civicrm_api3_acl_create($params) { /** * Get an acl * - * Allowed @params array keys are: * {@getfields acl_get} * @example aclCreate.php * @@ -61,7 +58,6 @@ function civicrm_api3_acl_create($params) { * * @return array * Array of retrieved acl property values. - * @access public */ function civicrm_api3_acl_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -70,7 +66,6 @@ function civicrm_api3_acl_get($params) { /** * Delete an acl * - * Allowed @params array keys are: * {@getfields acl_delete} * @example aclCreate.php * @@ -78,7 +73,6 @@ function civicrm_api3_acl_get($params) { * * @return array * Array of deleted values. - * @access public */ function civicrm_api3_acl_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/AclRole.php b/api/v3/AclRole.php index dd32d5c51d..2679869717 100644 --- a/api/v3/AclRole.php +++ b/api/v3/AclRole.php @@ -44,7 +44,6 @@ * * @return array * Array of newly created acl_role property values. - * @access public */ function civicrm_api3_acl_role_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -61,7 +60,6 @@ function civicrm_api3_acl_role_create($params) { * * @return array * Array of retrieved acl_role property values. - * @access public */ function civicrm_api3_acl_role_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -78,7 +76,6 @@ function civicrm_api3_acl_role_get($params) { * * @return array * Array of deleted values. - * @access public */ function civicrm_api3_acl_role_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/ActionSchedule.php b/api/v3/ActionSchedule.php index 7779358393..bd4899699f 100644 --- a/api/v3/ActionSchedule.php +++ b/api/v3/ActionSchedule.php @@ -87,7 +87,6 @@ function _civicrm_api3_action_schedule_create_spec(&$params) { * @return array * API result array * - * @access public */ function civicrm_api3_action_schedule_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/ActivityContact.php b/api/v3/ActivityContact.php index 9d8a3abd80..fe3d3899c3 100644 --- a/api/v3/ActivityContact.php +++ b/api/v3/ActivityContact.php @@ -46,7 +46,6 @@ * * @return array * Array of newly created activity contact records. - * @access public */ function civicrm_api3_activity_contact_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -73,7 +72,6 @@ function _civicrm_api3_activity_contact_create_spec(&$params) { * Api Result * * @example ActivityContact.php - * @access public */ function civicrm_api3_activity_contact_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -90,7 +88,6 @@ function civicrm_api3_activity_contact_delete($params) { * @return array * details of found tags else error * - * @access public */ function civicrm_api3_activity_contact_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/ActivityType.php b/api/v3/ActivityType.php index a139f3b253..52158cfa0b 100644 --- a/api/v3/ActivityType.php +++ b/api/v3/ActivityType.php @@ -52,9 +52,6 @@ function _civicrm_api3_activity_type_deprecation() { * * @return array * activity types keyed by id - * @access public - * - * @example ActivityTypeGet.php * @deprecated - use getoptions */ function civicrm_api3_activity_type_get($params) { @@ -67,14 +64,10 @@ function civicrm_api3_activity_type_get($params) { * create activity type ( * * @param array $params - * Associated array of fields. - * $params['option_value_id'] is required for updation of activity type * * @return array * created / updated activity type * - * @access public - * * @deprecated - use option_value create */ function civicrm_api3_activity_type_create($params) { @@ -115,8 +108,6 @@ function _civicrm_api3_activity_type_create_spec(&$params) { * @return array * API result array * - * @access public - * * @deprecated - we will introduce OptionValue Delete- plse consider helping with this if not done */ function civicrm_api3_activity_type_delete($params) { diff --git a/api/v3/Address.php b/api/v3/Address.php index 7a045fd3e4..f1f9185682 100644 --- a/api/v3/Address.php +++ b/api/v3/Address.php @@ -46,7 +46,6 @@ * * @return array * Array of newly created tag property values. - * @access public */ function civicrm_api3_address_create(&$params) { /** @@ -133,7 +132,6 @@ function _civicrm_api3_address_get_spec(&$params) { * * @return array * api result array - * @access public */ function civicrm_api3_address_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -152,7 +150,6 @@ function civicrm_api3_address_delete($params) { * @return array * details of found addresses else error * {@getfields address_get} - * @access public */ function civicrm_api3_address_get(&$params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Address'); diff --git a/api/v3/Attachment.php b/api/v3/Attachment.php index 2b22752b0f..85e6cbb167 100644 --- a/api/v3/Attachment.php +++ b/api/v3/Attachment.php @@ -90,7 +90,6 @@ function _civicrm_api3_attachment_create_spec(&$spec) { * @param array $params * @return array * Array of newly created file property values. - * @access public * @throws API_Exception validation errors */ function civicrm_api3_attachment_create($params) { @@ -179,6 +178,9 @@ function civicrm_api3_attachment_get($params) { return civicrm_api3_create_success($result, $params, 'Attachment', 'create'); } +/** + * @param $spec + */ function _civicrm_api3_attachment_delete_spec(&$spec) { unset($spec['id']['api.required']); $entityFileFields = CRM_Core_DAO_EntityFile::fields(); diff --git a/api/v3/Batch.php b/api/v3/Batch.php index ae9e2a91de..5c52f3a559 100644 --- a/api/v3/Batch.php +++ b/api/v3/Batch.php @@ -44,7 +44,6 @@ * * @return array * Array of newly created batch property values. - * @access public */ function civicrm_api3_batch_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -81,7 +80,6 @@ function _civicrm_api3_batch_create_spec(&$params) { * * @return array * Array of retrieved batch property values. - * @access public */ function civicrm_api3_batch_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -98,7 +96,6 @@ function civicrm_api3_batch_get($params) { * * @return array * Array of deleted values. - * @access public */ function civicrm_api3_batch_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/Campaign.php b/api/v3/Campaign.php index fea469f4ee..67b68a7328 100644 --- a/api/v3/Campaign.php +++ b/api/v3/Campaign.php @@ -47,7 +47,6 @@ * @return array * campaign array * {@getfields campaign_create} - * @access public */ function civicrm_api3_campaign_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Campaign'); @@ -95,7 +94,6 @@ function civicrm_api3_campaign_get($params) { * (reference) returns flag true if successful, error * message otherwise * {@getfields campaign_delete} - * @access public */ function civicrm_api3_campaign_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/Case.php b/api/v3/Case.php index bf2e5f76f9..5e914200d0 100644 --- a/api/v3/Case.php +++ b/api/v3/Case.php @@ -311,7 +311,6 @@ function _civicrm_api3_case_deprecation() { * @return array * api result array * - * @access public */ function civicrm_api3_case_update($params) { //check parameters @@ -378,7 +377,6 @@ function civicrm_api3_case_update($params) { * @return boolean * true if success, else false * {@getfields case_delete} - * @access public */ function civicrm_api3_case_delete($params) { //check parameters diff --git a/api/v3/CaseType.php b/api/v3/CaseType.php index 752fb9307d..f2bbf9eef2 100644 --- a/api/v3/CaseType.php +++ b/api/v3/CaseType.php @@ -48,7 +48,6 @@ * @return array * API result array * - * @access public */ function civicrm_api3_case_type_create($params) { civicrm_api3_verify_mandatory($params, _civicrm_api3_get_DAO(__FUNCTION__)); @@ -75,7 +74,6 @@ function civicrm_api3_case_type_create($params) { * * @return array * case types keyed by id - * @access public */ function civicrm_api3_case_type_get($params) { if (!empty($params['options']) && !empty($params['options']['is_count'])) { diff --git a/api/v3/Contact.php b/api/v3/Contact.php index 4ef46ba2a8..a90d7b8511 100644 --- a/api/v3/Contact.php +++ b/api/v3/Contact.php @@ -53,7 +53,6 @@ * @return array * API Result Array * - * @access public */ function civicrm_api3_contact_create($params) { diff --git a/api/v3/RelationshipType.php b/api/v3/RelationshipType.php index db75b6add4..12501eea7f 100644 --- a/api/v3/RelationshipType.php +++ b/api/v3/RelationshipType.php @@ -113,7 +113,6 @@ function civicrm_api3_relationship_type_get($params) { * @return array * API Result Array * {@getfields RelationshipType_delete} - * @access public */ function civicrm_api3_relationship_type_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/ReportInstance.php b/api/v3/ReportInstance.php index 5031af7caf..ba05cfc73d 100644 --- a/api/v3/ReportInstance.php +++ b/api/v3/ReportInstance.php @@ -8,7 +8,6 @@ * * @return array * details of found instances - * @access public */ function civicrm_api3_report_instance_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -21,7 +20,6 @@ function civicrm_api3_report_instance_get($params) { * * @return array * Array of newly created report instance property values. - * @access public */ function civicrm_api3_report_instance_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -46,7 +44,6 @@ function _civicrm_api3_report_instance_create_spec(&$params) { * * @return array * Api result - * @access public */ function civicrm_api3_report_instance_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/ReportTemplate.php b/api/v3/ReportTemplate.php index a5d0b51bf4..17ecda8705 100644 --- a/api/v3/ReportTemplate.php +++ b/api/v3/ReportTemplate.php @@ -13,7 +13,6 @@ * @return array * details of found Option Values * {@getfields OptionValue_get} - * @access public */ function civicrm_api3_report_template_get($params) { require_once 'api/v3/OptionValue.php'; @@ -35,7 +34,6 @@ function civicrm_api3_report_template_get($params) { * @return array * Array of newly created option_value property values. * {@getfields OptionValue_create} - * @access public */ function civicrm_api3_report_template_create($params) { require_once 'api/v3/OptionValue.php'; @@ -77,7 +75,6 @@ function _civicrm_api3_report_template_create_spec(&$params) { * @return array * Api result * {@getfields ReportTemplate_create} - * @access public */ function civicrm_api3_report_template_delete($params) { require_once 'api/v3/OptionValue.php'; @@ -92,7 +89,6 @@ function civicrm_api3_report_template_delete($params) { * * @return array * details of found instances - * @access public */ function civicrm_api3_report_template_getrows($params) { civicrm_api3_verify_one_mandatory($params, NULL, array('report_id', 'instance_id')); @@ -170,7 +166,6 @@ function civicrm_api3_report_template_getstatistics($params) { * * @return array * details of found instances - * @access public */ 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 7c2c7249e5..797cb8537d 100644 --- a/api/v3/Setting.php +++ b/api/v3/Setting.php @@ -219,7 +219,6 @@ function _civicrm_api3_setting_fill_spec(&$params) { * @return array * api result array * {@getfields setting_create} - * @access public */ function civicrm_api3_setting_create($params) { $domains = _civicrm_api3_setting_getDomainArray($params); @@ -256,7 +255,6 @@ function _civicrm_api3_setting_create_spec(&$params) { * @return array * Array of matching settings * {@getfields setting_get} - * @access public */ function civicrm_api3_setting_get($params) { $domains = _civicrm_api3_setting_getDomainArray($params); @@ -291,7 +289,6 @@ function _civicrm_api3_setting_get_spec(&$params) { * @return array * Array of matching settings * {@getfields setting_get} - * @access public */ function civicrm_api3_setting_getvalue($params) { $config = CRM_Core_Config::singleton(); diff --git a/api/v3/SmsProvider.php b/api/v3/SmsProvider.php index 1b1bc32154..45ca0323e9 100644 --- a/api/v3/SmsProvider.php +++ b/api/v3/SmsProvider.php @@ -44,7 +44,6 @@ * * @return array * Array of newly created sms_provider property values. - * @access public */ function civicrm_api3_sms_provider_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -61,7 +60,6 @@ function civicrm_api3_sms_provider_create($params) { * * @return array * Array of retrieved sms_provider property values. - * @access public */ function civicrm_api3_sms_provider_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -78,7 +76,6 @@ function civicrm_api3_sms_provider_get($params) { * * @return array * Array of deleted values. - * @access public */ function civicrm_api3_sms_provider_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/Survey.php b/api/v3/Survey.php index 5815472d39..1012f1a3b0 100644 --- a/api/v3/Survey.php +++ b/api/v3/Survey.php @@ -45,7 +45,6 @@ * @return array * api result array * {@getfields survey_create} - * @access public */ function civicrm_api3_survey_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Survey'); @@ -73,7 +72,6 @@ function _civicrm_api3_survey_create_spec(&$params) { * @return array * API result Array of matching surveys * {@getfields survey_get} - * @access public */ function civicrm_api3_survey_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Survey'); @@ -92,7 +90,6 @@ function civicrm_api3_survey_get($params) { * @return array * api result array * {@getfields survey_delete} - * @access public */ function civicrm_api3_survey_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/System.php b/api/v3/System.php index 544e78596f..021cd61f20 100644 --- a/api/v3/System.php +++ b/api/v3/System.php @@ -163,7 +163,8 @@ function _civicrm_api3_system_log_spec(&$params) { /** * System.Get API * - * @param arary $params + * @param array $params + * @return array */ function civicrm_api3_system_get($params) { $returnValues = array( diff --git a/api/v3/Tag.php b/api/v3/Tag.php index 92ef857b7f..01f6efed53 100644 --- a/api/v3/Tag.php +++ b/api/v3/Tag.php @@ -47,7 +47,6 @@ * @return array * Array of newly created tag property values. * {@getfields tag_create} - * @access public */ function civicrm_api3_tag_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -75,7 +74,6 @@ function _civicrm_api3_tag_create_spec(&$params) { * @return array * API result array * {@getfields tag_delete} - * @access public */ function civicrm_api3_tag_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -95,7 +93,6 @@ function civicrm_api3_tag_delete($params) { * @return array * details of found tags else error * {@getfields tag_get} - * @access public */ function civicrm_api3_tag_get($params) { diff --git a/api/v3/UFField.php b/api/v3/UFField.php index 489c2c54ec..b40a547ba8 100644 --- a/api/v3/UFField.php +++ b/api/v3/UFField.php @@ -140,7 +140,6 @@ function _civicrm_api3_uf_field_create_spec(&$params) { * (reference) Array * {@getfields UFField_get * @example UFFieldGet.php - * @access public */ function civicrm_api3_uf_field_get($params) { return _civicrm_api3_basic_get('CRM_Core_BAO_UFField', $params); diff --git a/api/v3/UFGroup.php b/api/v3/UFGroup.php index 8195102872..10da47aa10 100644 --- a/api/v3/UFGroup.php +++ b/api/v3/UFGroup.php @@ -57,7 +57,6 @@ function _civicrm_api3_uf_group_create_spec(&$params) { * API result array * {@getfields UFGroup_create} * @example UFGroupCreate.php - * @access public */ function civicrm_api3_uf_group_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -75,7 +74,6 @@ function civicrm_api3_uf_group_create($params) { * Array of matching profiles * {@getfields UFGroup_get} * @example UFGroupGet.php - * @access public */ function civicrm_api3_uf_group_get($params) { diff --git a/api/v3/UFMatch.php b/api/v3/UFMatch.php index cdfd090a5c..26a80923fb 100644 --- a/api/v3/UFMatch.php +++ b/api/v3/UFMatch.php @@ -62,7 +62,6 @@ function civicrm_api3_uf_match_get($params) { * @return array * api result array * {@getfields uf_match_create} - * @access public */ function civicrm_api3_uf_match_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -92,7 +91,6 @@ function _civicrm_api3_uf_match_create_spec(&$params) { * @return array * api result array * {@getfields uf_match_create} - * @access public */ function civicrm_api3_uf_match_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/Website.php b/api/v3/Website.php index ec2debb21a..903a7acab5 100644 --- a/api/v3/Website.php +++ b/api/v3/Website.php @@ -113,7 +113,6 @@ function civicrm_api3_website_delete($params) { * @return array * details of found websites * - * @access public */ function civicrm_api3_website_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'website'); diff --git a/api/v3/WordReplacement.php b/api/v3/WordReplacement.php index 495bbeb777..37c2accb28 100644 --- a/api/v3/WordReplacement.php +++ b/api/v3/WordReplacement.php @@ -87,7 +87,6 @@ function _civicrm_api3_word_replacement_create_spec(&$params) { * @return array * api result array * - * @access public */ function civicrm_api3_word_replacement_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/utils.php b/api/v3/utils.php index 01cc0510b4..2f0a2ddf80 100644 --- a/api/v3/utils.php +++ b/api/v3/utils.php @@ -542,8 +542,7 @@ function _civicrm_api3_get_using_query_object($entity, $params, $additional_opti * @param array $params * @param string $mode * @param string $entity - * @return CRM_Core_DAO - * query object + * @return array(CRM_Core_DAO|CRM_Contact_BAO_Query) */ function _civicrm_api3_get_query_object($params, $mode, $entity) { $options = _civicrm_api3_get_options_from_params($params, TRUE, $entity, 'get'); @@ -873,7 +872,6 @@ function _civicrm_api3_get_unique_name_array(&$bao) { * * @return array * - * @access public */ function _civicrm_api3_dao_to_array($dao, $params = NULL, $uniqueFields = TRUE, $entity = "", $autoFind = TRUE) { $result = array(); @@ -945,7 +943,6 @@ function _civicrm_api3_custom_fields_are_required($entity, $params) { * @param array|bool $uniqueFields * * @return array - * @access public */ function _civicrm_api3_object_to_array(&$dao, &$values, $uniqueFields = FALSE) { @@ -1137,7 +1134,6 @@ function formatCheckBoxField(&$checkboxFieldValue, $customFieldLabel, $entity) { * @return bool * Sshould the missing fields be returned as an array (core error created as default) * true if all fields present, depending on $result a core error is created of an array of missing fields is returned - * @access public */ function _civicrm_api3_check_required_fields($params, $daoName, $return = FALSE) { //@deprecated - see notes -- 2.25.1