From c23f45d399981b29f079169078644507b0afe390 Mon Sep 17 00:00:00 2001 From: Eileen McNaughton Date: Tue, 13 Jan 2015 13:00:25 +1300 Subject: [PATCH] fix comment blocks --- CRM/Core/BAO/Note.php | 1 - CRM/Core/BAO/Tag.php | 1 - CRM/Core/DAO.php | 1 - CRM/Core/QuickForm/Action.php | 1 - CRM/Core/QuickForm/Action/Cancel.php | 1 - CRM/Core/QuickForm/Action/Display.php | 1 - CRM/Core/QuickForm/Action/Done.php | 1 - CRM/Core/QuickForm/Action/Jump.php | 1 - CRM/Core/QuickForm/Action/Next.php | 1 - CRM/Core/QuickForm/Action/Process.php | 1 - CRM/Core/QuickForm/Action/Refresh.php | 1 - CRM/Core/QuickForm/Action/Reload.php | 1 - CRM/Core/QuickForm/Action/Submit.php | 1 - CRM/Core/QuickForm/Action/Upload.php | 1 - CRM/Core/Selector/Controller.php | 1 - CRM/Core/ShowHideBlocks.php | 1 - CRM/Core/StateMachine.php | 1 - CRM/Dedupe/BAO/RuleGroup.php | 1 - CRM/Event/Form/Registration/Register.php | 1 - CRM/Event/Selector/Search.php | 1 - CRM/Financial/BAO/PaymentProcessor.php | 2 +- CRM/Grant/Selector/Search.php | 1 - CRM/Mailing/BAO/Mailing.php | 1 - CRM/Mailing/Selector/Browse.php | 1 - CRM/Mailing/Selector/Event.php | 1 - CRM/Mailing/Selector/Search.php | 1 - CRM/Member/Selector/Search.php | 1 - CRM/Pledge/Selector/Search.php | 1 - CRM/Profile/Selector/Listings.php | 1 - CRM/Report/BAO/ReportInstance.php | 1 - CRM/Upgrade/Form.php | 1 - CRM/Utils/Pager.php | 1 - CRM/Utils/Sort.php | 1 - CRM/Utils/Token.php | 2 -- api/v3/Campaign.php | 16 ++-------- api/v3/Case.php | 7 ----- api/v3/CaseType.php | 7 ++--- api/v3/Contact.php | 13 +------- api/v3/ContactType.php | 3 -- api/v3/Contribution.php | 27 +++-------------- api/v3/ContributionPage.php | 4 --- api/v3/ContributionRecur.php | 3 -- api/v3/ContributionSoft.php | 3 -- api/v3/Country.php | 3 -- api/v3/CustomField.php | 19 ++---------- api/v3/CustomGroup.php | 9 ++---- api/v3/CustomSearch.php | 3 -- api/v3/CustomValue.php | 2 -- api/v3/Dashboard.php | 11 ++----- api/v3/DashboardContact.php | 2 -- api/v3/Email.php | 3 -- api/v3/Event.php | 10 ------- api/v3/Extension.php | 16 ---------- api/v3/File.php | 3 -- api/v3/FinancialAccount.php | 3 -- api/v3/FinancialType.php | 3 -- api/v3/Grant.php | 3 -- api/v3/Group.php | 3 -- api/v3/GroupContact.php | 3 -- api/v3/GroupOrganization.php | 1 - api/v3/Im.php | 4 --- api/v3/Job.php | 38 +++--------------------- api/v3/LineItem.php | 3 -- api/v3/LocBlock.php | 3 -- api/v3/LocationType.php | 3 -- api/v3/MailSettings.php | 3 -- api/v3/Mailing.php | 37 +++++++++++++++++++---- api/v3/MailingComponent.php | 3 -- api/v3/MailingContact.php | 5 ---- api/v3/MailingEventConfirm.php | 1 - api/v3/MailingEventQueue.php | 10 ++++++- api/v3/MailingEventResubscribe.php | 1 - api/v3/MailingEventSubscribe.php | 1 - api/v3/MailingEventUnsubscribe.php | 1 - api/v3/MailingGroup.php | 16 +++++++++- api/v3/MailingJob.php | 1 - api/v3/MailingRecipients.php | 1 - api/v3/Membership.php | 5 ---- api/v3/MembershipBlock.php | 5 ---- api/v3/MembershipPayment.php | 2 -- api/v3/MembershipStatus.php | 4 --- api/v3/MembershipType.php | 5 ---- api/v3/MessageTemplate.php | 9 ------ api/v3/Note.php | 6 ---- api/v3/OptionGroup.php | 2 -- api/v3/OptionValue.php | 3 -- api/v3/Participant.php | 3 -- api/v3/ParticipantPayment.php | 3 -- api/v3/ParticipantStatusType.php | 3 -- api/v3/PaymentProcessor.php | 3 -- api/v3/PaymentProcessorType.php | 13 ++------ api/v3/Phone.php | 2 -- api/v3/Phone/Get.php | 12 ++++---- api/v3/Pledge.php | 3 -- api/v3/PledgePayment.php | 3 -- api/v3/Premium.php | 3 -- api/v3/PriceField.php | 3 -- api/v3/PriceFieldValue.php | 3 -- api/v3/PriceSet.php | 3 -- api/v3/PrintLabel.php | 3 -- api/v3/Product.php | 3 -- api/v3/Relationship.php | 2 -- api/v3/RelationshipType.php | 3 -- api/v3/SurveyRespondant.php | 6 ++-- api/v3/System.php | 6 +--- api/v3/UFField.php | 8 ----- api/v3/UFGroup.php | 3 -- api/v3/UFJoin.php | 6 ---- api/v3/UFMatch.php | 4 --- api/v3/Website.php | 7 +---- api/v3/examples/TagGetList.php | 1 - api/v3/utils.php | 2 +- tools/CRM/Auction/Info.php | 2 +- 113 files changed, 89 insertions(+), 412 deletions(-) diff --git a/CRM/Core/BAO/Note.php b/CRM/Core/BAO/Note.php index b127223cfd..bc8fd6c7a7 100644 --- a/CRM/Core/BAO/Note.php +++ b/CRM/Core/BAO/Note.php @@ -290,7 +290,6 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { * * @return int|NULL * no of deleted notes on success, null otherwise - * @access public */ public static function del($id, $showStatus = TRUE) { $return = NULL; diff --git a/CRM/Core/BAO/Tag.php b/CRM/Core/BAO/Tag.php index fd82d7fb01..7dabeda2d2 100644 --- a/CRM/Core/BAO/Tag.php +++ b/CRM/Core/BAO/Tag.php @@ -452,7 +452,6 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag { * * @return array * associated array of tag name and id - * @access public */ public static function getTagsNotInTagset() { $tags = $tagSets = array(); diff --git a/CRM/Core/DAO.php b/CRM/Core/DAO.php index e374d15e74..5216ab7202 100644 --- a/CRM/Core/DAO.php +++ b/CRM/Core/DAO.php @@ -81,7 +81,6 @@ class CRM_Core_DAO extends DB_DataObject { * Class constructor * * @return \CRM_Core_DAO - * @access public */ public function __construct() { $this->initialize(); diff --git a/CRM/Core/QuickForm/Action.php b/CRM/Core/QuickForm/Action.php index 7aecbd07b4..094a30106b 100644 --- a/CRM/Core/QuickForm/Action.php +++ b/CRM/Core/QuickForm/Action.php @@ -54,7 +54,6 @@ class CRM_Core_QuickForm_Action extends HTML_QuickForm_Action { * Reference to state machine object. * * @return \CRM_Core_QuickForm_Action - * @access public */ public function __construct(&$stateMachine) { $this->_stateMachine = &$stateMachine; diff --git a/CRM/Core/QuickForm/Action/Cancel.php b/CRM/Core/QuickForm/Action/Cancel.php index 5d548aa532..484daf5656 100644 --- a/CRM/Core/QuickForm/Action/Cancel.php +++ b/CRM/Core/QuickForm/Action/Cancel.php @@ -42,7 +42,6 @@ class CRM_Core_QuickForm_Action_Cancel extends CRM_Core_QuickForm_Action { * Reference to state machine object. * * @return \CRM_Core_QuickForm_Action_Cancel - * @access public */ public function __construct(&$stateMachine) { parent::__construct($stateMachine); diff --git a/CRM/Core/QuickForm/Action/Display.php b/CRM/Core/QuickForm/Action/Display.php index 54a127d1b8..0ecfc42c43 100644 --- a/CRM/Core/QuickForm/Action/Display.php +++ b/CRM/Core/QuickForm/Action/Display.php @@ -54,7 +54,6 @@ class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action { * Reference to state machine object. * * @return \CRM_Core_QuickForm_Action_Display - * @access public */ public function __construct(&$stateMachine) { parent::__construct($stateMachine); diff --git a/CRM/Core/QuickForm/Action/Done.php b/CRM/Core/QuickForm/Action/Done.php index 88cc21d7b9..281cfcfe2b 100644 --- a/CRM/Core/QuickForm/Action/Done.php +++ b/CRM/Core/QuickForm/Action/Done.php @@ -42,7 +42,6 @@ class CRM_Core_QuickForm_Action_Done extends CRM_Core_QuickForm_Action { * Reference to state machine object. * * @return \CRM_Core_QuickForm_Action_Done - * @access public */ public function __construct(&$stateMachine) { parent::__construct($stateMachine); diff --git a/CRM/Core/QuickForm/Action/Jump.php b/CRM/Core/QuickForm/Action/Jump.php index d77008b065..b70a7cea45 100644 --- a/CRM/Core/QuickForm/Action/Jump.php +++ b/CRM/Core/QuickForm/Action/Jump.php @@ -42,7 +42,6 @@ class CRM_Core_QuickForm_Action_Jump extends CRM_Core_QuickForm_Action { * Reference to state machine object. * * @return \CRM_Core_QuickForm_Action_Jump - * @access public */ public function __construct(&$stateMachine) { parent::__construct($stateMachine); diff --git a/CRM/Core/QuickForm/Action/Next.php b/CRM/Core/QuickForm/Action/Next.php index 6ad9ecce61..983966bfff 100644 --- a/CRM/Core/QuickForm/Action/Next.php +++ b/CRM/Core/QuickForm/Action/Next.php @@ -42,7 +42,6 @@ class CRM_Core_QuickForm_Action_Next extends CRM_Core_QuickForm_Action { * Reference to state machine object. * * @return \CRM_Core_QuickForm_Action_Next - * @access public */ public function __construct(&$stateMachine) { parent::__construct($stateMachine); diff --git a/CRM/Core/QuickForm/Action/Process.php b/CRM/Core/QuickForm/Action/Process.php index f65b18b706..565f6de5ec 100644 --- a/CRM/Core/QuickForm/Action/Process.php +++ b/CRM/Core/QuickForm/Action/Process.php @@ -42,7 +42,6 @@ class CRM_Core_QuickForm_Action_Process extends CRM_Core_QuickForm_Action { * Reference to state machine object. * * @return \CRM_Core_QuickForm_Action_Process - * @access public */ public function __construct(&$stateMachine) { parent::__construct($stateMachine); diff --git a/CRM/Core/QuickForm/Action/Refresh.php b/CRM/Core/QuickForm/Action/Refresh.php index 9990687560..16d5726817 100644 --- a/CRM/Core/QuickForm/Action/Refresh.php +++ b/CRM/Core/QuickForm/Action/Refresh.php @@ -42,7 +42,6 @@ class CRM_Core_QuickForm_Action_Refresh extends CRM_Core_QuickForm_Action { * Reference to state machine object. * * @return \CRM_Core_QuickForm_Action_Refresh - * @access public */ public function __construct(&$stateMachine) { parent::__construct($stateMachine); diff --git a/CRM/Core/QuickForm/Action/Reload.php b/CRM/Core/QuickForm/Action/Reload.php index 439665363a..be6daba226 100644 --- a/CRM/Core/QuickForm/Action/Reload.php +++ b/CRM/Core/QuickForm/Action/Reload.php @@ -45,7 +45,6 @@ class CRM_Core_QuickForm_Action_Reload extends CRM_Core_QuickForm_Action { * Reference to state machine object. * * @return \CRM_Core_QuickForm_Action_Reload - * @access public */ public function __construct(&$stateMachine) { parent::__construct($stateMachine); diff --git a/CRM/Core/QuickForm/Action/Submit.php b/CRM/Core/QuickForm/Action/Submit.php index b5bf6c625b..9f608882d7 100644 --- a/CRM/Core/QuickForm/Action/Submit.php +++ b/CRM/Core/QuickForm/Action/Submit.php @@ -42,7 +42,6 @@ class CRM_Core_QuickForm_Action_Submit extends CRM_Core_QuickForm_Action { * Reference to state machine object. * * @return \CRM_Core_QuickForm_Action_Submit - * @access public */ public function __construct(&$stateMachine) { parent::__construct($stateMachine); diff --git a/CRM/Core/QuickForm/Action/Upload.php b/CRM/Core/QuickForm/Action/Upload.php index 05db31e4e9..a4fea83a62 100644 --- a/CRM/Core/QuickForm/Action/Upload.php +++ b/CRM/Core/QuickForm/Action/Upload.php @@ -58,7 +58,6 @@ class CRM_Core_QuickForm_Action_Upload extends CRM_Core_QuickForm_Action { * Element names of the various uploadable files. * * @return \CRM_Core_QuickForm_Action_Upload - * @access public */ public function __construct(&$stateMachine, $uploadDir, $uploadNames) { parent::__construct($stateMachine); diff --git a/CRM/Core/Selector/Controller.php b/CRM/Core/Selector/Controller.php index b3ade8e354..157a25d763 100644 --- a/CRM/Core/Selector/Controller.php +++ b/CRM/Core/Selector/Controller.php @@ -192,7 +192,6 @@ class CRM_Core_Selector_Controller { * @param null $case * * @return \CRM_Core_Selector_Controller - * @access public */ public function __construct($object, $pageID, $sortID, $action, $store = NULL, $output = self::TEMPLATE, $prefix = NULL, $case = NULL) { diff --git a/CRM/Core/ShowHideBlocks.php b/CRM/Core/ShowHideBlocks.php index 18607a7479..dd614ce72b 100644 --- a/CRM/Core/ShowHideBlocks.php +++ b/CRM/Core/ShowHideBlocks.php @@ -64,7 +64,6 @@ class CRM_Core_ShowHideBlocks { * Initial value of hide array. * * @return \CRM_Core_ShowHideBlocks the newly created object - * @access public */ public function __construct($show = NULL, $hide = NULL) { if (!empty($show)) { diff --git a/CRM/Core/StateMachine.php b/CRM/Core/StateMachine.php index 8b0abce1cb..5ccb534066 100644 --- a/CRM/Core/StateMachine.php +++ b/CRM/Core/StateMachine.php @@ -91,7 +91,6 @@ class CRM_Core_StateMachine { * @param \const|int $action * * @return \CRM_Core_StateMachine - * @access public */ public function __construct(&$controller, $action = CRM_Core_Action::NONE) { $this->_controller = &$controller; diff --git a/CRM/Dedupe/BAO/RuleGroup.php b/CRM/Dedupe/BAO/RuleGroup.php index 680e609beb..0ef208d6c7 100644 --- a/CRM/Dedupe/BAO/RuleGroup.php +++ b/CRM/Dedupe/BAO/RuleGroup.php @@ -386,7 +386,6 @@ class CRM_Dedupe_BAO_RuleGroup extends CRM_Dedupe_DAO_RuleGroup { * * @return array * (rule field => weight) array and threshold associated to rule group - * @access public */ public static function dedupeRuleFieldsWeight($params) { $rgBao = new CRM_Dedupe_BAO_RuleGroup(); diff --git a/CRM/Event/Form/Registration/Register.php b/CRM/Event/Form/Registration/Register.php index a0c9fca334..f7cf8a7180 100644 --- a/CRM/Event/Form/Registration/Register.php +++ b/CRM/Event/Form/Registration/Register.php @@ -1215,7 +1215,6 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration { * @param int $contactID * * @return void - * @access public */ public function processRegistration($params, $contactID = NULL) { $session = CRM_Core_Session::singleton(); diff --git a/CRM/Event/Selector/Search.php b/CRM/Event/Selector/Search.php index 15c618b557..4087968304 100644 --- a/CRM/Event/Selector/Search.php +++ b/CRM/Event/Selector/Search.php @@ -156,7 +156,6 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co * @param null $compContext * * @return \CRM_Event_Selector_Search - * @access public */ function __construct( &$queryParams, diff --git a/CRM/Financial/BAO/PaymentProcessor.php b/CRM/Financial/BAO/PaymentProcessor.php index 1366ab75cd..879c7d113b 100644 --- a/CRM/Financial/BAO/PaymentProcessor.php +++ b/CRM/Financial/BAO/PaymentProcessor.php @@ -311,7 +311,7 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces * return $processors; * } * } - * */ + */ $retrievalParameters = array( 'is_active' => TRUE, 'options' => array('sort' => 'is_default DESC, name'), diff --git a/CRM/Grant/Selector/Search.php b/CRM/Grant/Selector/Search.php index 748109601e..7e0d26c15b 100644 --- a/CRM/Grant/Selector/Search.php +++ b/CRM/Grant/Selector/Search.php @@ -142,7 +142,6 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co * @param string $context * * @return \CRM_Grant_Selector_Search - * @access public */ function __construct( &$queryParams, diff --git a/CRM/Mailing/BAO/Mailing.php b/CRM/Mailing/BAO/Mailing.php index 8d966f9040..a51530a1ea 100644 --- a/CRM/Mailing/BAO/Mailing.php +++ b/CRM/Mailing/BAO/Mailing.php @@ -2758,7 +2758,6 @@ SELECT $mailing.id as mailing_id * * @return array * array content/component. - * @access public */ public static function getMailingContent(&$report, &$form, $isSMS = FALSE) { $htmlHeader = $textHeader = NULL; diff --git a/CRM/Mailing/Selector/Browse.php b/CRM/Mailing/Selector/Browse.php index 88507cc47a..287364beba 100644 --- a/CRM/Mailing/Selector/Browse.php +++ b/CRM/Mailing/Selector/Browse.php @@ -59,7 +59,6 @@ class CRM_Mailing_Selector_Browse extends CRM_Core_Selector_Base implements CRM_ * * * @return \CRM_Mailing_Selector_Browse - * @access public */ public function __construct() { } diff --git a/CRM/Mailing/Selector/Event.php b/CRM/Mailing/Selector/Event.php index 7b716f4734..3275ff8337 100644 --- a/CRM/Mailing/Selector/Event.php +++ b/CRM/Mailing/Selector/Event.php @@ -95,7 +95,6 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C * If the event type is a click-through, do we want only those from a specific url?. * * @return \CRM_Mailing_Selector_Event - * @access public */ public function __construct($event, $distinct, $mailing, $job = NULL, $url = NULL) { $this->_event_type = $event; diff --git a/CRM/Mailing/Selector/Search.php b/CRM/Mailing/Selector/Search.php index 14314eb19d..490ffa8f01 100644 --- a/CRM/Mailing/Selector/Search.php +++ b/CRM/Mailing/Selector/Search.php @@ -146,7 +146,6 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_ * @param null $compContext * * @return \CRM_Mailing_Selector_Search - * @access public */ function __construct( &$queryParams, diff --git a/CRM/Member/Selector/Search.php b/CRM/Member/Selector/Search.php index 2e52f5c605..e7c9a1e4d3 100644 --- a/CRM/Member/Selector/Search.php +++ b/CRM/Member/Selector/Search.php @@ -142,7 +142,6 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C * @param string $context * * @return \CRM_Member_Selector_Search - * @access public */ function __construct( &$queryParams, diff --git a/CRM/Pledge/Selector/Search.php b/CRM/Pledge/Selector/Search.php index 970bf0e9aa..d1407fe50a 100644 --- a/CRM/Pledge/Selector/Search.php +++ b/CRM/Pledge/Selector/Search.php @@ -145,7 +145,6 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base { * @param string $context * * @return \CRM_Pledge_Selector_Search - * @access public */ function __construct( &$queryParams, diff --git a/CRM/Profile/Selector/Listings.php b/CRM/Profile/Selector/Listings.php index 049b63bc32..2816bf2260 100644 --- a/CRM/Profile/Selector/Listings.php +++ b/CRM/Profile/Selector/Listings.php @@ -138,7 +138,6 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR * @param bool $linkToUF * * @return \CRM_Profile_Selector_Listings - * @access public */ function __construct( &$params, diff --git a/CRM/Report/BAO/ReportInstance.php b/CRM/Report/BAO/ReportInstance.php index a3a79df21b..bfdf4d572a 100644 --- a/CRM/Report/BAO/ReportInstance.php +++ b/CRM/Report/BAO/ReportInstance.php @@ -230,7 +230,6 @@ class CRM_Report_BAO_ReportInstance extends CRM_Report_DAO_ReportInstance { * * @return mixed * $results no of deleted Instance on success, false otherwise - * @access public */ public static function del($id = NULL) { $dao = new CRM_Report_DAO_ReportInstance(); diff --git a/CRM/Upgrade/Form.php b/CRM/Upgrade/Form.php index a688e0d464..475e04dd2f 100644 --- a/CRM/Upgrade/Form.php +++ b/CRM/Upgrade/Form.php @@ -91,7 +91,6 @@ class CRM_Upgrade_Form extends CRM_Core_Form { * The name of the form if different from class name. * * @return \CRM_Core_Form - * @access public */ /** * @param null|object $state diff --git a/CRM/Utils/Pager.php b/CRM/Utils/Pager.php index d69f822d46..3c9960de44 100644 --- a/CRM/Utils/Pager.php +++ b/CRM/Utils/Pager.php @@ -79,7 +79,6 @@ class CRM_Utils_Pager extends Pager_Sliding { * @internal param \perPage $int the number of items displayed per page * * @return \CRM_Utils_Pager the newly created and initialized pager object - * @access public */ public function __construct($params) { if ($params['status'] === NULL) { diff --git a/CRM/Utils/Sort.php b/CRM/Utils/Sort.php index 4023d53c24..8bc250f036 100644 --- a/CRM/Utils/Sort.php +++ b/CRM/Utils/Sort.php @@ -122,7 +122,6 @@ class CRM_Utils_Sort { * Order to sort. * * @return \CRM_Utils_Sort - * @access public */ public function __construct(&$vars, $defaultSortOrder = NULL) { $this->_vars = array(); diff --git a/CRM/Utils/Token.php b/CRM/Utils/Token.php index b62d93a479..5bad565d82 100644 --- a/CRM/Utils/Token.php +++ b/CRM/Utils/Token.php @@ -861,7 +861,6 @@ class CRM_Utils_Token { * @param $str ref to the string that will be scanned and modified * @return void * this function works directly on the string that is passed - * @access public */ public static function unescapeTokens(&$str) { $str = preg_replace('/\\\\|\{(\{\w+\.\w+\})\}/', '\\1', $str); @@ -1093,7 +1092,6 @@ class CRM_Utils_Token { * * @return array * array of tokens mentioned in field - * @access public */ public static function getTokens($string) { $matches = array(); diff --git a/api/v3/Campaign.php b/api/v3/Campaign.php index 67b68a7328..3aee6f4c81 100644 --- a/api/v3/Campaign.php +++ b/api/v3/Campaign.php @@ -41,12 +41,8 @@ * be in $params array. * * @param array $params - * (reference) Associative array of property. - * name/value pairs to insert in new 'campaign' * * @return array - * campaign array - * {@getfields campaign_create} */ function civicrm_api3_campaign_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Campaign'); @@ -67,14 +63,10 @@ function _civicrm_api3_campaign_create_spec(&$params) { * Returns array of campaigns matching a set of one or more group properties * * @param array $params - * Array of one or more valid. - * property_name=>value pairs. If $params is set - * as null, all campaigns will be returned + * Array per getfields * * @return array * Array of matching campaigns - * @access public - * {@getfields campaign_get} */ function civicrm_api3_campaign_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Campaign'); @@ -87,13 +79,9 @@ function civicrm_api3_campaign_get($params) { * to be deleted is required field in $params array * * @param array $params - * (reference) array containing id of the group. - * to be deleted + * array containing id of the group to be deleted * * @return array - * (reference) returns flag true if successful, error - * message otherwise - * {@getfields campaign_delete} */ 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 5e914200d0..28ff9898c4 100644 --- a/api/v3/Case.php +++ b/api/v3/Case.php @@ -58,9 +58,6 @@ * @throws API_Exception * @return array * api result array - * - * @access public - * {@getfields case_create} */ function civicrm_api3_case_create($params) { @@ -193,13 +190,10 @@ function _civicrm_api3_case_delete_spec(&$params) { * 'activity_id' => returns the case containing a specific activity * 'contact_id' => finds all cases associated with a contact (in any role, not just client) * - * {@getfields case_get} * * @throws API_Exception * @return array * (get mode, case_id provided): Array with case details, case roles, case activity ids, (search mode, case_id not provided): Array of cases found - * @access public - * @todo Erik Hommel 16 dec 2010 check if all DB fields are returned */ function civicrm_api3_case_get($params) { $options = _civicrm_api3_get_options_from_params($params); @@ -376,7 +370,6 @@ function civicrm_api3_case_update($params) { * @throws API_Exception * @return boolean * true if success, else false - * {@getfields case_delete} */ function civicrm_api3_case_delete($params) { //check parameters diff --git a/api/v3/CaseType.php b/api/v3/CaseType.php index f2bbf9eef2..c165555f11 100644 --- a/api/v3/CaseType.php +++ b/api/v3/CaseType.php @@ -88,7 +88,7 @@ function civicrm_api3_case_type_get($params) { * format definition * * @param array $result - * @return mixed + * @return array * @throws \CRM_Core_Exception */ function _civicrm_api3_case_type_get_formatResult(&$result) { @@ -112,12 +112,9 @@ function _civicrm_api3_case_type_get_formatResult(&$result) { * * @param array $params * Array including id of case_type to delete. - + * * @return array * API result array - * - * @access public - * */ function civicrm_api3_case_type_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/Contact.php b/api/v3/Contact.php index a90d7b8511..d4179d0f81 100644 --- a/api/v3/Contact.php +++ b/api/v3/Contact.php @@ -145,11 +145,6 @@ function _civicrm_api3_contact_create_spec(&$params) { * * @return array * API Result Array - * (@getfields contact_get} - * @access public - * - * @example ContactGet.php Standard GET example - * */ function civicrm_api3_contact_get($params) { $options = array(); @@ -267,14 +262,10 @@ function _civicrm_api3_contact_get_supportanomalies(&$params, &$options) { * Delete a contact with given contact id * * @param array $params - * (reference ) input parameters, contact_id element required. + * input parameters per getfields * * @return array * API Result Array - * @access public - * - * @example ContactDelete.php - * {@getfields contact_delete} */ function civicrm_api3_contact_delete($params) { @@ -431,7 +422,6 @@ function _civicrm_api3_contact_update($params, $contactID = NULL) { * * @throws API_Exception * - * @access public */ function _civicrm_api3_greeting_format_params($params) { $greetingParams = array('', '_id', '_custom'); @@ -877,7 +867,6 @@ function _civicrm_api3_contact_deprecation() { * @return array * API Result Array * - * @access public */ function civicrm_api3_contact_merge($params) { $mode = CRM_Utils_Array::value('mode', $params, 'safe'); diff --git a/api/v3/ContactType.php b/api/v3/ContactType.php index fa9b956334..4cffddfe82 100644 --- a/api/v3/ContactType.php +++ b/api/v3/ContactType.php @@ -47,7 +47,6 @@ * @return array * contact_type array * - * @access public */ function civicrm_api3_contact_type_create($params) { civicrm_api3_verify_mandatory($params, _civicrm_api3_get_DAO(__FUNCTION__), array('name', 'parent_id')); @@ -75,7 +74,6 @@ function civicrm_api3_contact_type_create($params) { * * @return array * Array of matching contact_types - * @access public */ function civicrm_api3_contact_type_get($params) { civicrm_api3_verify_mandatory($params); @@ -95,7 +93,6 @@ function civicrm_api3_contact_type_get($params) { * @return array * API Result Array * - * @access public */ function civicrm_api3_contact_type_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/Contribution.php b/api/v3/Contribution.php index f9b3230745..42712ee6df 100644 --- a/api/v3/Contribution.php +++ b/api/v3/Contribution.php @@ -45,9 +45,6 @@ * @throws API_Exception * @return array * Api result array - * @access public - * @example ContributionCreate.php - * {@getfields Contribution_create} */ function civicrm_api3_contribution_create(&$params) { $values = array(); @@ -178,9 +175,6 @@ function _civicrm_api3_contribution_create_legacy_support_45(&$params) { * * @return boolean * true if success, else false - * @access public - * {@getfields Contribution_delete} - * @example ContributionDelete.php */ function civicrm_api3_contribution_delete($params) { @@ -209,9 +203,6 @@ function _civicrm_api3_contribution_delete_spec(&$params) { * * @return array * Array of contributions, if error an array with an error id and error message - * @access public - * {@getfields Contribution_get} - * @example ContributionGet.php */ function civicrm_api3_contribution_get($params) { @@ -268,18 +259,13 @@ function _civicrm_api3_contribution_get_spec(&$params) { * convert it into the same format that we use in QF and BAO object * * @param array $params - * Associative array of property name/value. - * pairs to insert in new contact. + * property name/value pairs to insert in new contact. * @param array $values * The reformatted properties that we can use internally. - * ' * - * @param bool $create - * - * @return array|CRM_Error - * @access public + * @return array */ -function _civicrm_api3_contribute_format_params($params, &$values, $create = FALSE) { +function _civicrm_api3_contribute_format_params($params, &$values) { //legacy way of formatting from v2 api - v3 way is to define metadata & do it in the api layer _civicrm_api3_filter_fields_for_bao('Contribution', $params, $values); return array(); @@ -305,9 +291,7 @@ function _civicrm_api3_contribution_transact_spec(&$params) { * (reference ) input parameters. * * @return array - * (reference ) contribution of created or updated record (or a civicrm error) - * @access public - * + * contribution of created or updated record (or a civicrm error) */ function civicrm_api3_contribution_transact($params) { // Set some params specific to payment processing @@ -355,12 +339,10 @@ function civicrm_api3_contribution_transact($params) { * * @param array $params * Input parameters. - * {@getfields Contribution_sendconfirmation} * * @throws Exception * @return array * Api result array - * @access public */ function civicrm_api3_contribution_sendconfirmation($params) { $contribution = new CRM_Contribute_BAO_Contribution(); @@ -417,7 +399,6 @@ function _civicrm_api3_contribution_sendconfirmation_spec(&$params) { * @throws API_Exception * @return array * Api result array - * @access public */ function civicrm_api3_contribution_completetransaction(&$params) { diff --git a/api/v3/ContributionPage.php b/api/v3/ContributionPage.php index 346536b45e..af878bdadf 100644 --- a/api/v3/ContributionPage.php +++ b/api/v3/ContributionPage.php @@ -45,7 +45,6 @@ * @return array * api result array * {@getfields contribution_page_create} - * @access public */ function civicrm_api3_contribution_page_create($params) { $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -76,7 +75,6 @@ function _civicrm_api3_contribution_page_create_spec(&$params) { * @return array * API Result array Array of matching contribution_pages * {@getfields contribution_page_get} - * @access public */ function civicrm_api3_contribution_page_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -95,7 +93,6 @@ function civicrm_api3_contribution_page_get($params) { * @return array * API result Array * {@getfields contribution_page_delete} - * @access public */ function civicrm_api3_contribution_page_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -114,7 +111,6 @@ function civicrm_api3_contribution_page_delete($params) { * @return array * API result array * {@getfields contribution_page_delete} - * @access public */ function civicrm_api3_contribution_page_submit($params) { $result = CRM_Contribute_Form_Contribution_Confirm::submit($params); diff --git a/api/v3/ContributionRecur.php b/api/v3/ContributionRecur.php index 17345ccd4e..459f0c2404 100644 --- a/api/v3/ContributionRecur.php +++ b/api/v3/ContributionRecur.php @@ -44,7 +44,6 @@ * @return array * api result array * {@getfields contribution_recur_create} - * @access public */ function civicrm_api3_contribution_recur_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -75,7 +74,6 @@ function _civicrm_api3_contribution_recur_create_spec(&$params) { * @return array * API result Array of matching contribution_recurs * {@getfields contribution_recur_get} - * @access public */ function civicrm_api3_contribution_recur_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -110,7 +108,6 @@ function civicrm_api3_contribution_recur_cancel($params) { * API result array * message otherwise * {@getfields contribution_recur_delete} - * @access public */ function civicrm_api3_contribution_recur_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/ContributionSoft.php b/api/v3/ContributionSoft.php index 8d159beb3a..5134e94f5b 100644 --- a/api/v3/ContributionSoft.php +++ b/api/v3/ContributionSoft.php @@ -49,7 +49,6 @@ * @return array * API result array * {@getfields contribution_soft_create} - * @access public */ function civicrm_api3_contribution_soft_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -78,7 +77,6 @@ function _civicrm_api3_contribution_soft_create_spec(&$params) { * @return boolean * | error true if successfull, error otherwise * {@getfields contribution_soft_delete} - * @access public */ function civicrm_api3_contribution_soft_delete($params) { // non standard BAO - we have to write custom code to cope @@ -100,7 +98,6 @@ function civicrm_api3_contribution_soft_delete($params) { * @return array * api result * {@getfields contribution_soft_get} - * @access public */ function civicrm_api3_contribution_soft_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/Country.php b/api/v3/Country.php index a0a9dc0f07..19eff2160c 100644 --- a/api/v3/Country.php +++ b/api/v3/Country.php @@ -50,7 +50,6 @@ require_once 'CRM/Core/DAO/Country.php'; * @return array * API result array * @throws \API_Exception - * @access public */ function civicrm_api3_country_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_DAO(__FUNCTION__), $params); @@ -77,7 +76,6 @@ function _civicrm_api3_country_create_spec(&$params) { * @return boolean * | error true if successfull, error otherwise * {@getfields country_delete} - * @access public */ function civicrm_api3_country_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_DAO(__FUNCTION__), $params); @@ -97,7 +95,6 @@ function civicrm_api3_country_delete($params) { * @return array * api result array * {@getfields country_get} - * @access public */ function civicrm_api3_country_get($params) { diff --git a/api/v3/CustomField.php b/api/v3/CustomField.php index 4c455090c0..bee0711b8d 100644 --- a/api/v3/CustomField.php +++ b/api/v3/CustomField.php @@ -46,13 +46,6 @@ * * @return array * API success array - * - * @access public - * - * @example CustomFieldCreate.php - * {@getfields CustomField_create} - * {@example CustomFieldCreate.php 0} - * */ function civicrm_api3_custom_field_create($params) { @@ -106,12 +99,7 @@ function _civicrm_api3_custom_field_create_spec(&$params) { * Array id of the field to be deleted. * * @return array - * @example CustomFieldDelete.php - * - * {@example CustomFieldDelete.php 0} - * {@getfields CustomField_delete} - * @access public - **/ + */ function civicrm_api3_custom_field_delete($params) { $field = new CRM_Core_BAO_CustomField(); $field->id = $params['id']; @@ -128,10 +116,7 @@ function civicrm_api3_custom_field_delete($params) { * Array to search on. * * @return array - * @getfields CustomField_get - * @access public - * - **/ + */ function civicrm_api3_custom_field_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); } diff --git a/api/v3/CustomGroup.php b/api/v3/CustomGroup.php index 4246321e8f..ebfa6901c6 100644 --- a/api/v3/CustomGroup.php +++ b/api/v3/CustomGroup.php @@ -61,7 +61,6 @@ * * @return array * @todo $params['extends'] is array format - is that std compatible - * @access public */ function civicrm_api3_custom_group_create($params) { if (isset($params['extends']) && is_string($params['extends'])) { @@ -100,10 +99,7 @@ function _civicrm_api3_custom_group_create_spec(&$params) { * * @return Null * if success - * @access public - * {@getfields CustomGroup_delete} - * @example CustomGroupDelete.php - **/ + */ function civicrm_api3_custom_group_delete($params) { $values = new CRM_Core_DAO_CustomGroup(); @@ -121,8 +117,7 @@ function civicrm_api3_custom_group_delete($params) { * Array to search on. * * @return array - * @access public - * {@getfields CustomGroup_get} + * * {@getfields CustomGroup_get} * @example CustomGroupGet.php **/ function civicrm_api3_custom_group_get($params) { diff --git a/api/v3/CustomSearch.php b/api/v3/CustomSearch.php index 7d4bd8e6fe..2b37825c6f 100644 --- a/api/v3/CustomSearch.php +++ b/api/v3/CustomSearch.php @@ -13,7 +13,6 @@ * @return array * details of found Option Values * {@getfields OptionValue_get} - * @access public */ function civicrm_api3_custom_search_get($params) { require_once 'api/v3/OptionValue.php'; @@ -35,7 +34,6 @@ function civicrm_api3_custom_search_get($params) { * @return array * Array of newly created option_value property values. * {@getfields OptionValue_create} - * @access public */ function civicrm_api3_custom_search_create($params) { require_once 'api/v3/OptionValue.php'; @@ -75,7 +73,6 @@ function _civicrm_api3_custom_search_create_spec(&$params) { * @return array * Api result * {@getfields ReportTemplate_create} - * @access public */ function civicrm_api3_custom_search_delete($params) { require_once 'api/v3/OptionValue.php'; diff --git a/api/v3/CustomValue.php b/api/v3/CustomValue.php index 08fa2326c3..7f905a0c8c 100644 --- a/api/v3/CustomValue.php +++ b/api/v3/CustomValue.php @@ -65,7 +65,6 @@ * @return array * ['values' => TRUE] or ['is_error' => 1, 'error_message' => 'what went wrong'] * - * @access public */ 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) @@ -138,7 +137,6 @@ function _civicrm_api3_custom_value_create_spec(&$params) { * @return array * * - * @access public */ function civicrm_api3_custom_value_get($params) { diff --git a/api/v3/Dashboard.php b/api/v3/Dashboard.php index 9762626fc3..9cc600bcda 100644 --- a/api/v3/Dashboard.php +++ b/api/v3/Dashboard.php @@ -42,12 +42,9 @@ * Creates or updates an Dashlet. * * @param array $params - * Array of property name/value. - * pairs for the Dashlet. * * @return array * Array containing 'is_error' to denote success or failure and details of the created activity - * */ function civicrm_api3_dashboard_create($params) { civicrm_api3_verify_one_mandatory($params, NULL, array( @@ -74,11 +71,8 @@ function _civicrm_api3_dashboard_create_spec(&$params) { * Gets a CiviCRM Dashlets according to parameters * * @param array $params - * Associative array of property name/value. - * pairs for the activity. * * @return array - * */ function civicrm_api3_dashboard_get($params) { $bao = new CRM_Core_BAO_Dashboard(); @@ -91,10 +85,9 @@ function civicrm_api3_dashboard_get($params) { * Delete a specified Dashlet. * * @param array $params - * Array holding 'id' OR 'name' of dashlet to be deleted. - * - * @return void|CRM_Core_Error An error if 'name or ID' is invalid, + * Array holding 'id' of dashlet to be deleted. * + * @return array */ function civicrm_api3_dashboard_delete($params) { if (CRM_Core_BAO_Dashboard::deleteDashlet($params['id'])) { diff --git a/api/v3/DashboardContact.php b/api/v3/DashboardContact.php index 3ee7f1ef6a..11393c6722 100644 --- a/api/v3/DashboardContact.php +++ b/api/v3/DashboardContact.php @@ -106,8 +106,6 @@ function _civicrm_api3_dashboard_contact_check_params(&$params) { * This method is used to delete any existing dashboard-board. the id of the dashboard-contact * is required field in $params array * - * {@getfields dashboard_contact_delete} - * @access public * @param array $params * @return array * @throws \API_Exception diff --git a/api/v3/Email.php b/api/v3/Email.php index 3be98786b7..288c4981f9 100644 --- a/api/v3/Email.php +++ b/api/v3/Email.php @@ -47,7 +47,6 @@ * @return array * API result array * {@getfields email_create} - * @access public */ function civicrm_api3_email_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -77,7 +76,6 @@ function _civicrm_api3_email_create_spec(&$params) { * @return boolean * | error true if successfull, error otherwise * {@getfields email_delete} - * @access public */ function civicrm_api3_email_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -97,7 +95,6 @@ function civicrm_api3_email_delete($params) { * @return array * api result array * {@getfields email_get} - * @access public */ function civicrm_api3_email_get($params) { diff --git a/api/v3/Event.php b/api/v3/Event.php index c9bc92e6fb..cc4f08fe10 100644 --- a/api/v3/Event.php +++ b/api/v3/Event.php @@ -49,7 +49,6 @@ * * @return array * API result Array. - * @access public */ function civicrm_api3_event_create($params) { civicrm_api3_verify_one_mandatory($params, NULL, array('event_type_id', 'template_id')); @@ -96,15 +95,10 @@ function _civicrm_api3_event_create_legacy_support_42(&$params) { /** * Get Event record. * - * * @param array $params - * An associative array of name/value property values of civicrm_event. - * {@getfields event_get} * * @return array * Array of all found event property values. - * @access public - * */ function civicrm_api3_event_get($params) { @@ -191,10 +185,6 @@ function _civicrm_api3_event_get_legacy_support_42(&$event, $event_id) { * * @param array $params * @return array - * - * @access public - * note API has legacy support for 'event_id' - * {@getfields event_delete} */ 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')); diff --git a/api/v3/Extension.php b/api/v3/Extension.php index e76c3a7ee1..4bf680fc60 100644 --- a/api/v3/Extension.php +++ b/api/v3/Extension.php @@ -50,9 +50,6 @@ define('API_V3_EXTENSION_DELIMITER', ','); * * @return array * API result - * @access public - * @example ExtensionInstall.php - * */ function civicrm_api3_extension_install($params) { $keys = _civicrm_api3_getKeys($params); @@ -75,8 +72,6 @@ function civicrm_api3_extension_install($params) { * * @return array * API result - * @access public - * */ function civicrm_api3_extension_upgrade() { CRM_Core_Invoke::rebuildMenuAndCaches(TRUE); @@ -113,9 +108,6 @@ function civicrm_api3_extension_upgrade() { * * @return array * API result - * @access public - * @example ExtensionEnable.php - * */ function civicrm_api3_extension_enable($params) { $keys = _civicrm_api3_getKeys($params); @@ -138,9 +130,7 @@ function civicrm_api3_extension_enable($params) { * * @return array * API result - * @access public * @example ExtensionDisable.php - * */ function civicrm_api3_extension_disable($params) { $keys = _civicrm_api3_getKeys($params); @@ -164,9 +154,6 @@ function civicrm_api3_extension_disable($params) { * * @return array * API result - * @access public - * @example ExtensionUninstall.php - * */ function civicrm_api3_extension_uninstall($params) { $keys = _civicrm_api3_getKeys($params); @@ -190,7 +177,6 @@ function civicrm_api3_extension_uninstall($params) { * @throws API_Exception * @return array * API result - * @access public * @example ExtensionDownload.php */ function civicrm_api3_extension_download($params) { @@ -241,7 +227,6 @@ function civicrm_api3_extension_download($params) { * * @return array * API result - * @access public * @example ExtensionRefresh.php * */ @@ -273,7 +258,6 @@ function civicrm_api3_extension_refresh($params) { * * @return array * API result - * @access public * @example ExtensionGet.php */ function civicrm_api3_extension_get($params) { diff --git a/api/v3/File.php b/api/v3/File.php index b0867261e8..f99dd39359 100644 --- a/api/v3/File.php +++ b/api/v3/File.php @@ -49,7 +49,6 @@ * * @return array * Array of newly created file property values. - * @access public */ function civicrm_api3_file_create($params) { @@ -87,7 +86,6 @@ function civicrm_api3_file_create($params) { * * @return array * Array of all found file object property values. - * @access public */ function civicrm_api3_file_get($params) { civicrm_api3_verify_one_mandatory($params); @@ -133,7 +131,6 @@ function civicrm_api3_file_update($params) { * * @return array * API result array - * @access public */ function civicrm_api3_file_delete($params) { diff --git a/api/v3/FinancialAccount.php b/api/v3/FinancialAccount.php index f8070b89ae..c71d6807cd 100644 --- a/api/v3/FinancialAccount.php +++ b/api/v3/FinancialAccount.php @@ -44,7 +44,6 @@ * * @return array * Array of newly created financial_account property values. - * @access public */ function civicrm_api3_financial_account_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -61,7 +60,6 @@ function civicrm_api3_financial_account_create($params) { * * @return array * Array of retrieved financial_account property values. - * @access public */ function civicrm_api3_financial_account_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -78,7 +76,6 @@ function civicrm_api3_financial_account_get($params) { * * @return array * Array of deleted values. - * @access public */ function civicrm_api3_financial_account_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/FinancialType.php b/api/v3/FinancialType.php index 838ada8097..7357bb35b1 100644 --- a/api/v3/FinancialType.php +++ b/api/v3/FinancialType.php @@ -44,7 +44,6 @@ * * @return array * Array of newly created financial_type property values. - * @access public */ function civicrm_api3_financial_type_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -61,7 +60,6 @@ function civicrm_api3_financial_type_create($params) { * * @return array * Array of retrieved financial_type property values. - * @access public */ function civicrm_api3_financial_type_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -78,7 +76,6 @@ function civicrm_api3_financial_type_get($params) { * * @return array * Array of deleted values. - * @access public */ function civicrm_api3_financial_type_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/Grant.php b/api/v3/Grant.php index 469c7a1731..8a21f412ef 100644 --- a/api/v3/Grant.php +++ b/api/v3/Grant.php @@ -47,7 +47,6 @@ * @return array * grant array * {@getfields grant_create} - * @access public */ function civicrm_api3_grant_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Grant'); @@ -76,7 +75,6 @@ function _civicrm_api3_grant_create_spec(&$params) { * @return array * Array of matching grants * {@getfields grant_get} - * @access public */ function civicrm_api3_grant_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Grant'); @@ -95,7 +93,6 @@ function civicrm_api3_grant_get($params) { * @return array * API Result Array * {@getfields grant_delete} - * @access public */ function civicrm_api3_grant_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/Group.php b/api/v3/Group.php index aa12f4ce69..9621603dc9 100644 --- a/api/v3/Group.php +++ b/api/v3/Group.php @@ -50,7 +50,6 @@ * API result array * @example GroupCreate.php * {@getfields group_create} - * @access public */ function civicrm_api3_group_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Group'); @@ -80,7 +79,6 @@ function _civicrm_api3_group_create_spec(&$params) { * Array of matching groups * @example GroupGet.php * {@getfields group_get} - * @access public */ function civicrm_api3_group_get($params) { $options = _civicrm_api3_get_options_from_params($params, TRUE, 'group', 'get'); @@ -110,7 +108,6 @@ function civicrm_api3_group_get($params) { * @example GroupDelete.php * {@getfields group_delete} * - * @access public */ function civicrm_api3_group_delete($params) { diff --git a/api/v3/GroupContact.php b/api/v3/GroupContact.php index 1879cd8246..e03110b172 100644 --- a/api/v3/GroupContact.php +++ b/api/v3/GroupContact.php @@ -71,9 +71,6 @@ function civicrm_api3_group_contact_get($params) { /** * Add contact(s) to group(s) - * - * @access public - * * @param array $params * Input parameters. * diff --git a/api/v3/GroupOrganization.php b/api/v3/GroupOrganization.php index 78c502f0a8..759371df7b 100644 --- a/api/v3/GroupOrganization.php +++ b/api/v3/GroupOrganization.php @@ -101,7 +101,6 @@ function _civicrm_api3_group_organization_create_spec(&$params) { * API Result * {@getfields GroupOrganization_delete} * @example GroupOrganizationDelete.php - * @access public */ function civicrm_api3_group_organization_delete($params) { diff --git a/api/v3/Im.php b/api/v3/Im.php index 8d4efa936e..f117aec300 100644 --- a/api/v3/Im.php +++ b/api/v3/Im.php @@ -44,7 +44,6 @@ * * @return array * Array of newly created IM property values. - * @access public */ function civicrm_api3_im_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -69,8 +68,6 @@ function _civicrm_api3_im_create_spec(&$params) { * * @return array * API result Array - * @access public - * @todo convert to using Basic delete - BAO function non standard */ function civicrm_api3_im_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -87,7 +84,6 @@ function civicrm_api3_im_delete($params) { * @return array * details of found IM * - * @access public */ function civicrm_api3_im_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/Job.php b/api/v3/Job.php index cdde39dcf3..89aa49acb1 100644 --- a/api/v3/Job.php +++ b/api/v3/Job.php @@ -64,8 +64,6 @@ function _civicrm_api3_job_create_spec(&$params) { * * @return array * {@getfields Job_create} - * @access public - * {@schema Core/Job.xml} */ function civicrm_api3_job_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -77,7 +75,6 @@ function civicrm_api3_job_create($params) { * @return array * api result array * {@getfields email_get} - * @access public */ function civicrm_api3_job_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -91,7 +88,6 @@ function civicrm_api3_job_get($params) { * @return array * API Result Array * {@getfields Job_delete} - * @access public */ function civicrm_api3_job_delete($params) { _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -106,9 +102,6 @@ function civicrm_api3_job_delete($params) { * * @return array * API Result Array - * - * @access public - * */ function civicrm_api3_job_execute($params) { $facility = new CRM_Core_JobManager(); @@ -135,11 +128,6 @@ function _civicrm_api3_job_execute_spec(&$params) { * * @return array * API Result Array - * {@getfields contact_geocode} - * - * @access public - * - * */ function civicrm_api3_job_geocode($params) { $gc = new CRM_Utils_Address_BatchUpdate($params); @@ -176,15 +164,12 @@ function _civicrm_api3_job_geocode_spec(&$params) { * now - the time to use, in YmdHis format * - makes testing a bit simpler since we can simulate past/future time * - * @return boolean - * true if success, else false - * @access public - * + * @return array */ function civicrm_api3_job_send_reminder($params) { //note that $params['rowCount' can be overridden by one of the preferred syntaxes ($options['limit'] = x //It's not clear whether than syntax can be passed in via the UI config - but this keeps the pre 4.4.4 behaviour - // in that case (ie. makes it unconfigurable via the UI). Another approach would be to set a default of 0 + // in that case (ie. makes it non-configurable via the UI). Another approach would be to set a default of 0 // in the _spec function - but since that is a deprecated value it seems more contentious than this approach $params['rowCount'] = 0; $lock = new CRM_Core_Lock('civimail.job.EmailProcessor'); @@ -226,10 +211,7 @@ function _civicrm_api3_job_send_reminder(&$params) { * instanceId - Integer - the report instance ID * resetVal - Integer - should we reset form state (always true)? * - * @return boolean - * true if success, else false - * @access public - * + * @return array */ function civicrm_api3_job_mail_report($params) { $result = CRM_Report_Utils_Report::processReport($params); @@ -255,7 +237,6 @@ function civicrm_api3_job_mail_report($params) { * * @return boolean * true if success, else false - * @access public */ function civicrm_api3_job_update_greeting($params) { @@ -310,12 +291,7 @@ function _civicrm_api3_job_update_greeting_spec(&$params) { * Mass update pledge statuses * * @param array $params - * (reference ) input parameters. - * - * @return boolean - * true if success, else false - * @access public - * + * @return array */ function civicrm_api3_job_process_pledge($params) { // *** Uncomment the next line if you want automated reminders to be sent @@ -422,7 +398,6 @@ function civicrm_api3_job_fetch_activities($params) { * * @return array * array of properties, if error an array with an error id and error message - * @access public */ function civicrm_api3_job_process_participant($params) { $result = CRM_Event_BAO_ParticipantStatusType::process($params); @@ -448,7 +423,6 @@ function civicrm_api3_job_process_participant($params) { * * @return boolean * true if success, else false - * @access public */ function civicrm_api3_job_process_membership($params) { $lock = new CRM_Core_Lock('civimail.job.updateMembership'); @@ -475,7 +449,6 @@ function civicrm_api3_job_process_membership($params) { * * @return boolean * true if success, else false - * @access public */ function civicrm_api3_job_process_respondent($params) { $result = CRM_Campaign_BAO_Survey::releaseRespondent($params); @@ -504,7 +477,6 @@ function civicrm_api3_job_process_respondent($params) { * @return array * API Result Array * - * @access public */ function civicrm_api3_job_process_batch_merge($params) { $rgid = CRM_Utils_Array::value('rgid', $params); @@ -532,7 +504,6 @@ function civicrm_api3_job_process_batch_merge($params) { * Expected @params array keys are: * {string 'processor_name' - the name of the payment processor, eg: Sagepay} * - * @access public */ function civicrm_api3_job_run_payment_cron($params) { @@ -567,7 +538,6 @@ function civicrm_api3_job_run_payment_cron($params) { * * @return boolean * true if success, else false - * @access public */ function civicrm_api3_job_cleanup($params) { $session = CRM_Utils_Array::value('session', $params, true ); diff --git a/api/v3/LineItem.php b/api/v3/LineItem.php index 5492bc79ca..2bcf1a33d3 100644 --- a/api/v3/LineItem.php +++ b/api/v3/LineItem.php @@ -45,7 +45,6 @@ * @return array * api result array * {@getfields line_item_create} - * @access public */ function civicrm_api3_line_item_create($params) { $params = CRM_Contribute_BAO_Contribution::checkTaxAmount($params,True); @@ -77,7 +76,6 @@ function _civicrm_api3_line_item_create_spec(&$params) { * @return array * Array of matching line_items * {@getfields line_item_get} - * @access public */ function civicrm_api3_line_item_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -96,7 +94,6 @@ function civicrm_api3_line_item_get($params) { * @return array * API result array * {@getfields line_item_delete} - * @access public */ function civicrm_api3_line_item_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/LocBlock.php b/api/v3/LocBlock.php index ec9ce33475..a9af5405f2 100644 --- a/api/v3/LocBlock.php +++ b/api/v3/LocBlock.php @@ -45,7 +45,6 @@ * @return array * api result array * {@getfields loc_block_create} - * @access public */ function civicrm_api3_loc_block_create($params) { $entities = array(); @@ -97,7 +96,6 @@ function civicrm_api3_loc_block_create($params) { * @return array * Array of matching loc_blocks * {@getfields loc_block_get} - * @access public */ function civicrm_api3_loc_block_get($params) { $options = _civicrm_api3_get_options_from_params($params); @@ -136,7 +134,6 @@ function civicrm_api3_loc_block_get($params) { * @return array * API result array * {@getfields loc_block_delete} - * @access public */ function civicrm_api3_loc_block_delete($params) { return _civicrm_api3_basic_delete('CRM_Core_DAO_LocBlock', $params); diff --git a/api/v3/LocationType.php b/api/v3/LocationType.php index ec9c7b55eb..1e01f5a94b 100644 --- a/api/v3/LocationType.php +++ b/api/v3/LocationType.php @@ -47,7 +47,6 @@ * @return array * API result array * {@getfields email_create} - * @access public */ function civicrm_api3_location_type_create($params) { //set display_name equal to name if it's not defined @@ -80,7 +79,6 @@ function _civicrm_api3_location_type_create_spec(&$params) { * @return array * API result array * {@getfields LocationType_delete} - * @access public */ function civicrm_api3_location_type_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -100,7 +98,6 @@ function civicrm_api3_location_type_delete($params) { * @return array * api result * {@getfields LocationType_get} - * @access public */ function civicrm_api3_location_type_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/MailSettings.php b/api/v3/MailSettings.php index b488468076..d136b8a668 100644 --- a/api/v3/MailSettings.php +++ b/api/v3/MailSettings.php @@ -44,7 +44,6 @@ * @return array * api result array * {@getfields mail_settings_create} - * @access public */ function civicrm_api3_mail_settings_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -72,7 +71,6 @@ function _civicrm_api3_mail_settings_create_spec(&$params) { * @return array * Array of matching mail_settings * {@getfields mail_settings_get} - * @access public */ function civicrm_api3_mail_settings_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -91,7 +89,6 @@ function civicrm_api3_mail_settings_get($params) { * @return array * api result array * {@getfields mail_settings_delete} - * @access public */ function civicrm_api3_mail_settings_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/Mailing.php b/api/v3/Mailing.php index 3c44188856..3963b92770 100755 --- a/api/v3/Mailing.php +++ b/api/v3/Mailing.php @@ -40,12 +40,12 @@ * Handle a create event. * * @param array $params - * @param array $ids - * - * @return array - * API Success Array + * @return array API Success Array + * API Success Array + * @throws \API_Exception + * @throws \Civi\API\Exception\UnauthorizedException */ -function civicrm_api3_mailing_create($params, $ids = array()) { +function civicrm_api3_mailing_create($params) { if (CRM_Mailing_Info::workflowEnabled()) { if (!CRM_Core_Permission::check('create mailings')) { throw new \Civi\API\Exception\UnauthorizedException("This system uses advanced CiviMail workflows which require additional permissions"); @@ -64,6 +64,11 @@ function civicrm_api3_mailing_create($params, $ids = array()) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); } +/** + * @param array $params + * @return array + * @throws \API_Exception + */ function civicrm_api3_mailing_get_token($params) { if (!array_key_exists("usage", $params)) { throw new API_Exception('Mandatory keys missing from params array: entity'); @@ -128,6 +133,9 @@ function civicrm_api3_mailing_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); } +/** + * @param array $spec + */ function _civicrm_api3_mailing_submit_spec(&$spec) { $mailingFields = CRM_Mailing_DAO_Mailing::fields(); $spec['id'] = $mailingFields['id']; @@ -381,6 +389,11 @@ function civicrm_api3_mailing_event_open($params) { return civicrm_api3_create_success($params); } +/** + * @param array $params + * @return array + * @throws \API_Exception + */ function civicrm_api3_mailing_preview($params) { civicrm_api3_verify_mandatory($params, 'CRM_Mailing_DAO_Mailing', @@ -425,11 +438,20 @@ function civicrm_api3_mailing_preview($params) { )); } +/** + * @param array $spec + */ function _civicrm_api3_mailing_send_test_spec(&$spec) { $spec['test_group']['title'] = 'Test Group ID'; $spec['test_email']['title'] = 'Test Email Address'; } +/** + * @param array $params + * @return array + * @throws \API_Exception + * @throws \CiviCRM_API3_Exception + */ function civicrm_api3_mailing_send_test($params) { if (!array_key_exists('test_group', $params) && !array_key_exists('test_email', $params)) { throw new API_Exception("Mandatory key(s) missing from params array: test_group and/or test_email field are required"); @@ -525,6 +547,11 @@ function _civicrm_api3_mailing_stats_spec(&$params) { $params['date']['title'] = 'Date'; } +/** + * @param array $params + * @return array + * @throws \API_Exception + */ function civicrm_api3_mailing_stats($params) { civicrm_api3_verify_mandatory($params, 'CRM_Mailing_DAO_MailingJob', diff --git a/api/v3/MailingComponent.php b/api/v3/MailingComponent.php index 1b8d415e8f..804975114c 100644 --- a/api/v3/MailingComponent.php +++ b/api/v3/MailingComponent.php @@ -45,7 +45,6 @@ * @throws API_Exception * @return array * Array of newly created mailing_component property values. - * @access public */ function civicrm_api3_mailing_component_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -62,7 +61,6 @@ function civicrm_api3_mailing_component_create($params) { * * @return array * Array of retrieved mailing_component property values. - * @access public */ function civicrm_api3_mailing_component_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -80,7 +78,6 @@ function civicrm_api3_mailing_component_get($params) { * @throws API_Exception * @return array * Array of deleted values. - * @access public */ function civicrm_api3_mailing_component_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/MailingContact.php b/api/v3/MailingContact.php index 3c7fe297fb..7bf53d370a 100644 --- a/api/v3/MailingContact.php +++ b/api/v3/MailingContact.php @@ -44,8 +44,6 @@ * * @return array * API result - * @access public - * */ function civicrm_api3_mailing_contact_get($params) { return civicrm_api3_create_success(_civicrm_api3_mailing_contact_getresults($params, FALSE)); @@ -279,9 +277,6 @@ INNER JOIN civicrm_mailing_event_bounce meb ON meb.event_queue_id = meq.id * * @return array * API result - * @access public - * @example CRM/Mailing/BAO/Mailing.php - * */ function civicrm_api3_mailing_contact_getcount($params) { return _civicrm_api3_mailing_contact_getresults($params, TRUE); diff --git a/api/v3/MailingEventConfirm.php b/api/v3/MailingEventConfirm.php index 9a66bb024e..eca1e34032 100644 --- a/api/v3/MailingEventConfirm.php +++ b/api/v3/MailingEventConfirm.php @@ -47,7 +47,6 @@ * @return array * api result array * {@getfields mailing_event_confirm_create} - * @access public */ function civicrm_api3_mailing_event_confirm_create($params) { diff --git a/api/v3/MailingEventQueue.php b/api/v3/MailingEventQueue.php index 7c7b681f26..ed13e1c9a0 100644 --- a/api/v3/MailingEventQueue.php +++ b/api/v3/MailingEventQueue.php @@ -45,7 +45,6 @@ * @return array * api result array * {@getfields mailing_event_confirm_create} - * @access public */ function civicrm_api3_mailing_event_queue_create($params) { if (!array_key_exists('id', $params) && !array_key_exists('email_id', $params) && !array_key_exists('phone_id', $params)) { @@ -59,10 +58,19 @@ function civicrm_api3_mailing_event_queue_create($params) { return _civicrm_api3_basic_create('CRM_Mailing_Event_BAO_Queue', $params); } +/** + * @param array $params + * @return array + */ function civicrm_api3_mailing_event_queue_get($params) { return _civicrm_api3_basic_get('CRM_Mailing_Event_BAO_Queue', $params); } +/** + * @param array $params + * @return array + * @throws \API_Exception + */ function civicrm_api3_mailing_event_queue_delete($params) { return _civicrm_api3_basic_delete('CRM_Mailing_Event_BAO_Queue', $params); } diff --git a/api/v3/MailingEventResubscribe.php b/api/v3/MailingEventResubscribe.php index 4dbd065d62..aa3bdf7d89 100644 --- a/api/v3/MailingEventResubscribe.php +++ b/api/v3/MailingEventResubscribe.php @@ -46,7 +46,6 @@ * @return array * api result array * {@getfields mailing_event_subscribe_create} - * @access public */ function civicrm_api3_mailing_event_resubscribe_create($params) { diff --git a/api/v3/MailingEventSubscribe.php b/api/v3/MailingEventSubscribe.php index fcb947dea2..1ff9f8e14d 100644 --- a/api/v3/MailingEventSubscribe.php +++ b/api/v3/MailingEventSubscribe.php @@ -47,7 +47,6 @@ * @return array * api result array * {@getfields mailing_event_subscribe_create} - * @access public */ function civicrm_api3_mailing_event_subscribe_create($params) { $email = $params['email']; diff --git a/api/v3/MailingEventUnsubscribe.php b/api/v3/MailingEventUnsubscribe.php index 5362b5001b..79fe5b7b66 100644 --- a/api/v3/MailingEventUnsubscribe.php +++ b/api/v3/MailingEventUnsubscribe.php @@ -46,7 +46,6 @@ * @return array * api result array * {@getfields mailing_event_unsubscribe_create} - * @access public */ function civicrm_api3_mailing_event_unsubscribe_create($params) { diff --git a/api/v3/MailingGroup.php b/api/v3/MailingGroup.php index d7139885ff..b71a4ccdc2 100644 --- a/api/v3/MailingGroup.php +++ b/api/v3/MailingGroup.php @@ -94,6 +94,11 @@ function civicrm_api3_mailing_group_event_subscribe($params) { return civicrm_api('mailing_event_subscribe', 'create', $params); } +/** + * @param array $params + * @return array + * @throws \API_Exception + */ function civicrm_api3_mailing_group_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); } @@ -107,10 +112,19 @@ function civicrm_api3_mailing_group_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); } -function civicrm_api3_mailing_group_delete($params, $ids = array()) { +/** + * @param array $params + * @return array + * @throws \API_Exception + */ +function civicrm_api3_mailing_group_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); } +/** + * @param array $params + * @return array + */ function civicrm_api3_mailing_group_getfields($params) { $dao = _civicrm_api3_get_DAO('Subscribe'); $d = new $dao(); diff --git a/api/v3/MailingJob.php b/api/v3/MailingJob.php index 595755b7e9..05c027bef1 100644 --- a/api/v3/MailingJob.php +++ b/api/v3/MailingJob.php @@ -69,7 +69,6 @@ function _civicrm_api3_mailing_job_create_spec(&$params) { * @return array * API return Array of matching mailing jobs * {@getfields mailing_job_get} - * @access public */ function civicrm_api3_mailing_job_get($params, $ids = array()) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/MailingRecipients.php b/api/v3/MailingRecipients.php index dcf1b96ceb..b2ea3a4fee 100644 --- a/api/v3/MailingRecipients.php +++ b/api/v3/MailingRecipients.php @@ -47,7 +47,6 @@ * @return array * API return Array of matching mailing jobs * {@getfields mailing_recipient_get} - * @access public */ function civicrm_api3_mailing_recipients_get($params, $ids = array()) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/Membership.php b/api/v3/Membership.php index 8b1d132616..d16aff5ec8 100644 --- a/api/v3/Membership.php +++ b/api/v3/Membership.php @@ -47,7 +47,6 @@ * @return array * api result * {@getfields membership_delete} - * @access public */ function civicrm_api3_membership_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -65,7 +64,6 @@ function civicrm_api3_membership_delete($params) { * @return array * Array of newly created membership property values. * {@getfields membership_create} - * @access public */ function civicrm_api3_membership_create($params) { // check params for membership id during update @@ -190,9 +188,6 @@ function _civicrm_api3_membership_get_spec(&$params) { * * @return array * Array of all found membership property values. - * @access public - * @todo needs some love - basically only a get for a given contact right now - * {@getfields membership_get} */ function civicrm_api3_membership_get($params) { $activeOnly = $membershipTypeId = $membershipType = NULL; diff --git a/api/v3/MembershipBlock.php b/api/v3/MembershipBlock.php index 20163ef092..acfb043eba 100644 --- a/api/v3/MembershipBlock.php +++ b/api/v3/MembershipBlock.php @@ -44,8 +44,6 @@ * * @return array * newly created or updated membership type property values. - * @access public - * {getfields MembershipBlock_get} */ function civicrm_api3_membership_block_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -75,7 +73,6 @@ function _civicrm_api3_membership_block_create_spec(&$params) { * * @return array * api result array of all found membership block property values. - * @access public */ function civicrm_api3_membership_block_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -91,8 +88,6 @@ function civicrm_api3_membership_block_get($params) { * * @return array * api result array - * @access public - * {getfields MembershipBlock_delete} */ function civicrm_api3_membership_block_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/MembershipPayment.php b/api/v3/MembershipPayment.php index 4a0dd124b4..71de334053 100644 --- a/api/v3/MembershipPayment.php +++ b/api/v3/MembershipPayment.php @@ -45,7 +45,6 @@ * (reference ) membership_payment_id of created or updated record * {@getfields MembershipPayment_create} * @example MembershipPaymentCreate.php - * @access public */ function civicrm_api3_membership_payment_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -74,7 +73,6 @@ function _civicrm_api3_membership_payment_create_spec(&$params) { * array of properties, if error an array with an error id and error message * @example MembershipPaymentGet * {@getfields MembershipPayment_get} - * @access public */ function civicrm_api3_membership_payment_get($params) { return _civicrm_api3_basic_get('CRM_Member_DAO_MembershipPayment', $params); diff --git a/api/v3/MembershipStatus.php b/api/v3/MembershipStatus.php index 6abf7474e3..10aaa8c28c 100644 --- a/api/v3/MembershipStatus.php +++ b/api/v3/MembershipStatus.php @@ -47,7 +47,6 @@ * @return array * Array of newly created membership status property values. * {@getfields MembershipStatus_create} - * @access public */ function civicrm_api3_membership_status_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -64,7 +63,6 @@ function civicrm_api3_membership_status_create($params) { * @return array * Array of all found membership status property values. * {@getfields MembershipStatus_get} - * @access public */ function civicrm_api3_membership_status_get($params) { return _civicrm_api3_basic_get('CRM_Member_BAO_MembershipStatus', $params); @@ -82,7 +80,6 @@ function civicrm_api3_membership_status_get($params) { * * @return array * Array of updated membership status property values - * @access public */ function &civicrm_api3_membership_status_update($params) { @@ -124,7 +121,6 @@ function &civicrm_api3_membership_status_update($params) { * * @return array * i - * @access public */ function civicrm_api3_membership_status_delete($params) { diff --git a/api/v3/MembershipType.php b/api/v3/MembershipType.php index 7477e2cf04..eef2a96ad0 100644 --- a/api/v3/MembershipType.php +++ b/api/v3/MembershipType.php @@ -44,8 +44,6 @@ * * @return array * newly created or updated membership type property values. - * @access public - * {getfields MembershipType_get} */ function civicrm_api3_membership_type_create($params) { $ids['membershipType'] = CRM_Utils_Array::value('id', $params); @@ -89,7 +87,6 @@ function _civicrm_api3_membership_type_create_spec(&$params) { * * @return array * Array of all found membership type property values. - * @access public */ function civicrm_api3_membership_type_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -105,8 +102,6 @@ function civicrm_api3_membership_type_get($params) { * * @return boolean * true if success, else false - * @access public - * {getfields MembershipType_delete} */ function civicrm_api3_membership_type_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/MessageTemplate.php b/api/v3/MessageTemplate.php index 41db4ce4d1..5683f8593a 100644 --- a/api/v3/MessageTemplate.php +++ b/api/v3/MessageTemplate.php @@ -32,7 +32,6 @@ */ /** - * @access public * @param array $params * @return array * @throws \API_Exception @@ -63,7 +62,6 @@ function _civicrm_api3_message_template_create_spec(&$params) { * @return boolean * | error true if successfull, error otherwise * {@getfields message_template_delete} - * @access public */ function civicrm_api3_message_template_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -78,18 +76,11 @@ function _civicrm_api3_message_template_get_spec(&$params) { /** * Retrieve one or more message_template * - * @param array input parameters - * - * - * @example SepaCreditorGet.php Standard Get Example - * * @param array $params * An associative array of name/value pairs. * * @return array * api result array - * {@getfields message_template_get} - * @access public */ function civicrm_api3_message_template_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/Note.php b/api/v3/Note.php index 2609cba110..82542c550f 100644 --- a/api/v3/Note.php +++ b/api/v3/Note.php @@ -48,10 +48,6 @@ * * @return array * API result array - * @access public - * @example NoteCreate.php Create example - * - * */ function civicrm_api3_note_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -81,7 +77,6 @@ function _civicrm_api3_note_create_spec(&$params) { * {@getfields note_delete} * * @return null - * @access public */ function civicrm_api3_note_delete($params) { @@ -99,7 +94,6 @@ function civicrm_api3_note_delete($params) { * array of properties, * if error an array with an error id and error message * {@getfields note_get} - * @access public */ function civicrm_api3_note_get($params) { diff --git a/api/v3/OptionGroup.php b/api/v3/OptionGroup.php index fbd1c79ad5..1fc5136caa 100644 --- a/api/v3/OptionGroup.php +++ b/api/v3/OptionGroup.php @@ -23,7 +23,6 @@ function civicrm_api3_option_group_get($params) { * @return array * survey array * - * @access public */ function civicrm_api3_option_group_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -54,7 +53,6 @@ function _civicrm_api3_option_group_create_spec(&$params) { * API Result Array * message otherwise * {@getfields OptionGroup_delete} - * @access public */ function civicrm_api3_option_group_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/OptionValue.php b/api/v3/OptionValue.php index e78fe76f61..b552e30314 100644 --- a/api/v3/OptionValue.php +++ b/api/v3/OptionValue.php @@ -11,7 +11,6 @@ * @return array * details of found Option Values * {@getfields OptionValue_get} - * @access public */ function civicrm_api3_option_value_get($params) { @@ -40,7 +39,6 @@ function civicrm_api3_option_value_get($params) { * @return array * Array of newly created option_value property values. * {@getfields OptionValue_create} - * @access public */ function civicrm_api3_option_value_create($params) { $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -82,7 +80,6 @@ function _civicrm_api3_option_value_create_spec(&$params) { * @return array * Api result * {@getfields OptionValue_create} - * @access public */ function civicrm_api3_option_value_delete($params) { // we will get the option group id before deleting so we can flush pseudoconstants diff --git a/api/v3/Participant.php b/api/v3/Participant.php index 4480d49ae1..9ce240473d 100644 --- a/api/v3/Participant.php +++ b/api/v3/Participant.php @@ -49,7 +49,6 @@ * @return array * apiresult * {@getfields participant_create} - * @access public */ function civicrm_api3_participant_create($params) { //check that event id is not an template - should be done @ BAO layer @@ -165,7 +164,6 @@ function _civicrm_api3_participant_create_spec(&$params) { * @return array * (reference ) array of properties, if error an array with an error id and error message * {@getfields participant_get} - * @access public */ function civicrm_api3_participant_get($params) { $mode = CRM_Contact_BAO_Query::MODE_EVENT; @@ -206,7 +204,6 @@ function _civicrm_api3_participant_get_spec(&$params) { * {@getfields participant_delete} * @throws Exception * @return array - * @access public */ function civicrm_api3_participant_delete($params) { diff --git a/api/v3/ParticipantPayment.php b/api/v3/ParticipantPayment.php index 28849881ed..be5ff03ba8 100644 --- a/api/v3/ParticipantPayment.php +++ b/api/v3/ParticipantPayment.php @@ -50,7 +50,6 @@ * @return array * Array of newly created payment property values. * {@getfields ParticipantPayment_create} - * @access public */ function civicrm_api3_participant_payment_create($params) { @@ -89,7 +88,6 @@ function _civicrm_api3_participant_payment_create_spec(&$params) { * API result * @example ParticipantPaymentDelete.php * {@getfields ParticipantPayment_delete} - * @access public */ function civicrm_api3_participant_payment_delete($params) { $participant = new CRM_Event_BAO_ParticipantPayment(); @@ -107,7 +105,6 @@ function civicrm_api3_participant_payment_delete($params) { * array of properties, if error an array with an error id and error message * @example ParticipantPaymentGet * {@getfields ParticipantPayment_get} - * @access public */ function civicrm_api3_participant_payment_get($params) { return _civicrm_api3_basic_get('CRM_Event_DAO_ParticipantPayment', $params); diff --git a/api/v3/ParticipantStatusType.php b/api/v3/ParticipantStatusType.php index 233c51063e..e789623e0f 100644 --- a/api/v3/ParticipantStatusType.php +++ b/api/v3/ParticipantStatusType.php @@ -48,7 +48,6 @@ * participant_status array * {@getfields ParticipantStatusType_create} * @example ParticipantStatusTypeCreate.php - * @access public */ function civicrm_api3_participant_status_type_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -66,7 +65,6 @@ function civicrm_api3_participant_status_type_create($params) { * Array of matching participant_statuses * {@getfields ParticipantStatusType_get} * @example ParticipantStatusTypeGet.php - * @access public */ function civicrm_api3_participant_status_type_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -86,7 +84,6 @@ function civicrm_api3_participant_status_type_get($params) { * api result array * {@getfields ParticipantStatusType_delete} * @example ParticipantStatusTypeDelete.php - * @access public */ function civicrm_api3_participant_status_type_delete($params) { if (CRM_Event_BAO_ParticipantStatusType::deleteParticipantStatusType($params['id'])) { diff --git a/api/v3/PaymentProcessor.php b/api/v3/PaymentProcessor.php index 41fc0dfc67..9385eb1473 100644 --- a/api/v3/PaymentProcessor.php +++ b/api/v3/PaymentProcessor.php @@ -44,7 +44,6 @@ * * @return array * Array of newly created PaymentProcessor property values. - * @access public */ function civicrm_api3_payment_processor_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -71,7 +70,6 @@ function _civicrm_api3_payment_processor_create_spec(&$params) { * * @return array * API result Array - * @access public */ function civicrm_api3_payment_processor_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -87,7 +85,6 @@ function civicrm_api3_payment_processor_delete($params) { * * @return array * details of found PaymentProcessor - * @access public */ function civicrm_api3_payment_processor_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/PaymentProcessorType.php b/api/v3/PaymentProcessorType.php index 50650e7b23..aa2a9e5ac9 100644 --- a/api/v3/PaymentProcessorType.php +++ b/api/v3/PaymentProcessorType.php @@ -47,9 +47,6 @@ * Associative array of property name/value pairs to insert in new payment_processor type. * * @return array - * {@getfields PaymentProcessorType_create} - * @access public - * {@schema Core/PaymentProcessorType.xml} */ function civicrm_api3_payment_processor_type_create($params) { $ids = array(); @@ -85,11 +82,7 @@ function _civicrm_api3_payment_processor_type_create_spec(&$params) { } /** - * get all payment_processor type - * retruns An array of PaymentProcessor_type - * @access public - * {@getfields PaymentProcessorType_get} - * @example PaymentProcessorTypeGet.php + * get all payment_processor types * @param array $params * @return array */ @@ -100,12 +93,10 @@ function civicrm_api3_payment_processor_type_get($params) { /** * Delete a payment_processor type delete * - * @param id of payment_processor type $id + * @param array $params * * @return array * API Result Array - * {@getfields PaymentProcessorType_delete} - * @access public */ function civicrm_api3_payment_processor_type_delete($params) { if ($params['id'] != NULL && !CRM_Utils_Rule::integer($params['id'])) { diff --git a/api/v3/Phone.php b/api/v3/Phone.php index a2f754c565..982521889d 100644 --- a/api/v3/Phone.php +++ b/api/v3/Phone.php @@ -46,7 +46,6 @@ * * @return array * Array of newly created phone property values. - * @access public */ function civicrm_api3_phone_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Phone'); @@ -75,7 +74,6 @@ function _civicrm_api3_phone_create_spec(&$params) { * Api Result * {@getfields phone_delete} * @example PhoneDelete.php - * @access public */ function civicrm_api3_phone_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/Phone/Get.php b/api/v3/Phone/Get.php index 4b5eec5e5f..403aa6bbe7 100644 --- a/api/v3/Phone/Get.php +++ b/api/v3/Phone/Get.php @@ -2,20 +2,18 @@ /** * Retrieve one or more phones + * This function has been declared there instead than in api/v3/Phone.php + * for no specific reasons, beside to demonstrate this feature + * (that might be useful in your module, eg if you want to implement a + * civicrm_api ('Phone','Dial') that you would then simply put in + * your module under api/v3/Phone/Dial.php. * - * @param mixed[] (reference ) input parameters - * - * {@schema Core/Phone.xml} - * {@example PhoneDelete.php 0} * @param array $params * An associative array of name/value pairs. * * @return array * details of found phones else error - * @access public - * This function has been declared there instead than in api/v3/Phone.php for no specific reasons, beside to demonstrate this feature (that might be useful in your module, eg if you want to implement a civicrm_api ('Phone','Dial') that you would then simply put in your module under api/v3/Phone/Dial.php . */ function civicrm_api3_phone_get($params) { - return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); } diff --git a/api/v3/Pledge.php b/api/v3/Pledge.php index 81aab6a28f..5767a97744 100644 --- a/api/v3/Pledge.php +++ b/api/v3/Pledge.php @@ -72,7 +72,6 @@ function civicrm_api3_pledge_create($params) { * true if success, else false * {@getfields pledge_delete} * @example PledgeDelete.php - * @access public */ function civicrm_api3_pledge_delete($params) { if (CRM_Pledge_BAO_Pledge::deletePledge($params['id'])) { @@ -135,7 +134,6 @@ function _civicrm_api3_pledge_create_spec(&$params) { * array of pledges, if error an array with an error id and error message * {@getfields pledge_get} * @example PledgeGet.php - * @access public */ function civicrm_api3_pledge_get($params) { $mode = CRM_Contact_BAO_Query::MODE_PLEDGE; @@ -169,7 +167,6 @@ function _civicrm_api3_pledge_get_defaults() { * @param bool $create * * @return array|CRM_Error - * @access public */ function _civicrm_api3_pledge_format_params(&$values, $create = FALSE) { diff --git a/api/v3/PledgePayment.php b/api/v3/PledgePayment.php index c946fe4c94..bd7e9c8911 100644 --- a/api/v3/PledgePayment.php +++ b/api/v3/PledgePayment.php @@ -51,7 +51,6 @@ * * @return array * API Result - * @access public */ function civicrm_api3_pledge_payment_create($params) { @@ -100,7 +99,6 @@ function _civicrm_api3_pledge_payment_create_spec(&$params) { * * @return array * API result - * @access public */ function civicrm_api3_pledge_payment_delete($params) { @@ -122,7 +120,6 @@ function civicrm_api3_pledge_payment_delete($params) { * * @return array * (reference ) array of pledges, if error an array with an error id and error message - * @access public */ function civicrm_api3_pledge_payment_get($params) { diff --git a/api/v3/Premium.php b/api/v3/Premium.php index ca1bdda2d0..87bfe6fff9 100644 --- a/api/v3/Premium.php +++ b/api/v3/Premium.php @@ -45,7 +45,6 @@ * @throws API_Exception * @return array * Array of newly created premium property values. - * @access public */ function civicrm_api3_premium_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -62,7 +61,6 @@ function civicrm_api3_premium_create($params) { * * @return array * Array of retrieved premium property values. - * @access public */ function civicrm_api3_premium_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -80,7 +78,6 @@ function civicrm_api3_premium_get($params) { * @throws API_Exception * @return array * Array of deleted values. - * @access public */ function civicrm_api3_premium_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/PriceField.php b/api/v3/PriceField.php index bd40337b88..bfe932940d 100644 --- a/api/v3/PriceField.php +++ b/api/v3/PriceField.php @@ -45,7 +45,6 @@ * @return array * api result array * {@getfields price_field_create} - * @access public */ function civicrm_api3_price_field_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -72,7 +71,6 @@ function _civicrm_api3_price_field_create_spec(&$params) { * @return array * Array of matching price_fields * {@getfields price_field_get} - * @access public */ function civicrm_api3_price_field_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -91,7 +89,6 @@ function civicrm_api3_price_field_get($params) { * @return array * API result array * {@getfields price_field_delete} - * @access public */ function civicrm_api3_price_field_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/PriceFieldValue.php b/api/v3/PriceFieldValue.php index 6ae6ec1a2c..5aee7f9138 100644 --- a/api/v3/PriceFieldValue.php +++ b/api/v3/PriceFieldValue.php @@ -45,7 +45,6 @@ * @return array * api result array * {@getfields price_field_value_create} - * @access public */ function civicrm_api3_price_field_value_create($params) { $ids = array(); @@ -85,7 +84,6 @@ function _civicrm_api3_price_field_value_create_spec(&$params) { * @return array * Array of matching price_field_values * {@getfields price_field_value_get} - * @access public */ function civicrm_api3_price_field_value_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -104,7 +102,6 @@ function civicrm_api3_price_field_value_get($params) { * @return array * API result array * {@getfields price_field_value_delete} - * @access public */ function civicrm_api3_price_field_value_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/PriceSet.php b/api/v3/PriceSet.php index b44a85e59a..082b228075 100644 --- a/api/v3/PriceSet.php +++ b/api/v3/PriceSet.php @@ -45,7 +45,6 @@ * @return array * api result array * {@getfields price_set_create} - * @access public */ function civicrm_api3_price_set_create($params) { $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -86,7 +85,6 @@ function _civicrm_api3_price_set_create_spec(&$params) { * @return array * Array of matching price_sets * {@getfields price_set_get} - * @access public */ function civicrm_api3_price_set_get($params) { // hack to make getcount work. - not sure the best approach here @@ -115,7 +113,6 @@ function civicrm_api3_price_set_get($params) { * @return array * API result array * {@getfields price_set_delete} - * @access public */ function civicrm_api3_price_set_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/PrintLabel.php b/api/v3/PrintLabel.php index c1c843327f..c074e5b636 100644 --- a/api/v3/PrintLabel.php +++ b/api/v3/PrintLabel.php @@ -44,7 +44,6 @@ * * @return array * Array of newly created print_label property values. - * @access public */ function civicrm_api3_print_label_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -61,7 +60,6 @@ function civicrm_api3_print_label_create($params) { * * @return array * Array of retrieved print_label property values. - * @access public */ function civicrm_api3_print_label_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -78,7 +76,6 @@ function civicrm_api3_print_label_get($params) { * * @return array * Array of deleted values. - * @access public */ function civicrm_api3_print_label_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/Product.php b/api/v3/Product.php index 2b8bd5e7d1..cf19be7b87 100644 --- a/api/v3/Product.php +++ b/api/v3/Product.php @@ -45,7 +45,6 @@ * @throws API_Exception * @return array * Array of newly created product property values. - * @access public */ function civicrm_api3_product_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -62,7 +61,6 @@ function civicrm_api3_product_create($params) { * * @return array * Array of retrieved product property values. - * @access public */ function civicrm_api3_product_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -80,7 +78,6 @@ function civicrm_api3_product_get($params) { * @throws API_Exception * @return array * Array of deleted values. - * @access public */ function civicrm_api3_product_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/Relationship.php b/api/v3/Relationship.php index 347a6f9622..17a92bdf45 100644 --- a/api/v3/Relationship.php +++ b/api/v3/Relationship.php @@ -48,7 +48,6 @@ * @return array * API Result Array * {@getfields relationship_create} - * @access public */ function civicrm_api3_relationship_create($params) { _civicrm_api3_handle_relationship_type($params); @@ -78,7 +77,6 @@ function _civicrm_api3_relationship_create_spec(&$params) { * {@getfields relationship_delete} * @example RelationshipDelete.php Delete Example * - * @access public */ function civicrm_api3_relationship_delete($params) { diff --git a/api/v3/RelationshipType.php b/api/v3/RelationshipType.php index 12501eea7f..8697603b7c 100644 --- a/api/v3/RelationshipType.php +++ b/api/v3/RelationshipType.php @@ -43,9 +43,6 @@ * Associative array of property name/value pairs to insert in new relationship type. * * @return array - * {@getfields RelationshipType_create} - * @access public - * {@schema Contact/RelationshipType.xml} */ function civicrm_api3_relationship_type_create($params) { diff --git a/api/v3/SurveyRespondant.php b/api/v3/SurveyRespondant.php index 7b7099d443..11cd9170de 100644 --- a/api/v3/SurveyRespondant.php +++ b/api/v3/SurveyRespondant.php @@ -43,14 +43,12 @@ function _civicrm_api3_survey_respondant_deprecation() { /** * Get the list of signatories - * + * @deprecated - api currently not supported * @param array $params * (reference ) input parameters. * * @return array - * (reference ) contribution_id of created or updated record - * @access public - * @deprecated - api currently not supported + * contribution_id of created or updated record */ function civicrm_api3_survey_respondant_get(&$params) { diff --git a/api/v3/System.php b/api/v3/System.php index 021cd61f20..6c0f334250 100644 --- a/api/v3/System.php +++ b/api/v3/System.php @@ -44,11 +44,7 @@ * - triggers: bool, whether to drop/create SQL triggers; default: FALSE * - session: bool, whether to reset the CiviCRM session data; defaul: FALSE * - * @return boolean - * true if success, else false - * @access public - * @example SystemFlush.php - * + * @return array */ function civicrm_api3_system_flush($params) { CRM_Core_Invoke::rebuildMenuAndCaches( diff --git a/api/v3/UFField.php b/api/v3/UFField.php index b40a547ba8..7027417cdf 100644 --- a/api/v3/UFField.php +++ b/api/v3/UFField.php @@ -46,10 +46,6 @@ * * @return array * Newly created $ufFieldArray - * - * @access public - * {@getfields UFField_create} - * @example UFFieldCreate.php */ function civicrm_api3_uf_field_create($params) { civicrm_api3_verify_one_mandatory($params, NULL, array('field_name', 'uf_group_id')); @@ -153,10 +149,6 @@ function civicrm_api3_uf_field_get($params) { * @throws API_Exception * * @return array - * - * @access public - * {@getfields UFField_delete} - * @example UFFieldDelete.php */ function civicrm_api3_uf_field_delete($params) { $fieldId = $params['id']; diff --git a/api/v3/UFGroup.php b/api/v3/UFGroup.php index 10da47aa10..7f7573040b 100644 --- a/api/v3/UFGroup.php +++ b/api/v3/UFGroup.php @@ -87,9 +87,6 @@ function civicrm_api3_uf_group_get($params) { * * * @return array - * @access public - * {@getfields UFGroup_delete} - * @example UFGroupDelete.php */ function civicrm_api3_uf_group_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/UFJoin.php b/api/v3/UFJoin.php index d20c2fb08f..888501ca61 100644 --- a/api/v3/UFJoin.php +++ b/api/v3/UFJoin.php @@ -44,10 +44,6 @@ * * @return array * CRM_Core_DAO_UFJoin Array - * @access public - * @example UFJoinCreate.php - * {@getfields UFJoin_create} - * */ function civicrm_api3_uf_join_create($params) { @@ -78,8 +74,6 @@ function _civicrm_api3_uf_join_create_spec(&$params) { * @return array * CiviCRM Result Array or null * @todo Delete function missing - * @access public - * {getfields UFJoin_get} */ function civicrm_api3_uf_join_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/UFMatch.php b/api/v3/UFMatch.php index 26a80923fb..d57dbb770b 100644 --- a/api/v3/UFMatch.php +++ b/api/v3/UFMatch.php @@ -42,10 +42,6 @@ * @param array $params * * @return array - * @access public - * {@getfields UFMatch_get} - * @example UFMatchGet.php - * @todo this class is missing delete & create functions (do after exisitng functions upgraded to v3) */ function civicrm_api3_uf_match_get($params) { return _civicrm_api3_basic_get('CRM_Core_BAO_UFMatch', $params); diff --git a/api/v3/Website.php b/api/v3/Website.php index 903a7acab5..c8df00738f 100644 --- a/api/v3/Website.php +++ b/api/v3/Website.php @@ -47,7 +47,6 @@ * * @return array * Array of newly created website property values. - * @access public * @todo convert to using basic create - BAO function non-std */ function civicrm_api3_website_create($params) { @@ -72,16 +71,12 @@ function _civicrm_api3_website_create_spec(&$params) { /** * Deletes an existing Website - * + * @todo convert to using Basic delete - BAO function non standard * @param array $params * {@getfields website_delete} * @return array * API result * @throws \API_Exception - * @example WebsiteDelete.php Std Delete Example - * - * @access public - * @todo convert to using Basic delete - BAO function non standard */ function civicrm_api3_website_delete($params) { //DO NOT USE THIS FUNCTION AS THE BASIS FOR A NEW API http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards diff --git a/api/v3/examples/TagGetList.php b/api/v3/examples/TagGetList.php index 43d1b72baa..6655cfa341 100644 --- a/api/v3/examples/TagGetList.php +++ b/api/v3/examples/TagGetList.php @@ -1,7 +1,6 @@