remove some @access from phpdoc
authorEileen McNaughton <eileen@fuzion.co.nz>
Mon, 12 Jan 2015 23:26:04 +0000 (12:26 +1300)
committerEileen McNaughton <eileen@fuzion.co.nz>
Mon, 12 Jan 2015 23:26:04 +0000 (12:26 +1300)
42 files changed:
CRM/Activity/BAO/ICalendar.php
CRM/Activity/Selector/Activity.php
CRM/Activity/Selector/Search.php
CRM/Campaign/BAO/Campaign.php
CRM/Campaign/BAO/Petition.php
CRM/Campaign/Selector/Search.php
CRM/Case/BAO/Case.php
CRM/Case/Selector/Search.php
CRM/Contact/BAO/GroupOrganization.php
CRM/Contact/BAO/Query.php
CRM/Contact/BAO/Relationship.php
CRM/Contact/Form/Domain.php
CRM/Contact/Selector/Custom.php
CRM/Contribute/BAO/Contribution.php
CRM/Contribute/Selector/Search.php
api/api.php
api/v3/Acl.php
api/v3/AclRole.php
api/v3/ActionSchedule.php
api/v3/ActivityContact.php
api/v3/ActivityType.php
api/v3/Address.php
api/v3/Attachment.php
api/v3/Batch.php
api/v3/Campaign.php
api/v3/Case.php
api/v3/CaseType.php
api/v3/Contact.php
api/v3/RelationshipType.php
api/v3/ReportInstance.php
api/v3/ReportTemplate.php
api/v3/Setting.php
api/v3/SmsProvider.php
api/v3/Survey.php
api/v3/System.php
api/v3/Tag.php
api/v3/UFField.php
api/v3/UFGroup.php
api/v3/UFMatch.php
api/v3/Website.php
api/v3/WordReplacement.php
api/v3/utils.php

index 582a3220139f48b803e3830e2bf154c1c0433b46..7cb7ed51af0abcd9ae29a4da988b4ce22b617818 100644 (file)
@@ -51,7 +51,6 @@ class CRM_Activity_BAO_ICalendar {
    *   Reference to an activity object.
    *
    * @return \CRM_Activity_BAO_ICalendar
-   * @access public
    */
   public function __construct(&$act) {
     $this->activity = $act;
index 217d3e1471259f63f911d30124151ffc6318c987..4187319007295284ab1cbf7c5aa115c3c6d5df62 100644 (file)
@@ -74,7 +74,6 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C
    * @param null $activityTypeIDs
    *
    * @return \CRM_Activity_Selector_Activity
-   * @access public
    */
   function __construct(
     $contactId,
index ade1404e27564324fa376d8e7cec593673d5383e..082b835b0803f27b4bb75856a1c44d24d95ea0bc 100644 (file)
@@ -152,7 +152,6 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM
    * @param null $compContext
    *
    * @return \CRM_Activity_Selector_Search
-   * @access public
    */
   function __construct(
     &$queryParams,
index e9ab3a0e34617e8fbeb74b839d0c126e75e996cf..940a04e6df970bb9600bf8aa99fa51e04873ff9c 100644 (file)
@@ -154,7 +154,6 @@ class CRM_Campaign_BAO_Campaign extends CRM_Campaign_DAO_Campaign {
    *
    * @return mixed
    *   $campaigns a set of campaigns.
-   * @access public
    */
   public static function getCampaigns(
     $includeId = NULL,
index 8258970aa4e81b135e1b0e08072ffa2684d9d2c4..30136a430ec9fa4e661e4ab8ce088cee26f1081d 100644 (file)
@@ -536,7 +536,6 @@ AND         tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )";
    *
    * @throws Exception
    * @return void
-   * @access public
    */
   public static function sendEmail($params, $sendEmailMode) {
 
index d246c2e9b4ed1acd806545468a296dc6f0d5c7b5..6928b2c23bd0ec0fc9b20546e2e18a33341565a6 100755 (executable)
@@ -144,7 +144,6 @@ class CRM_Campaign_Selector_Search extends CRM_Core_Selector_Base implements CRM
    * @param string $context
    *
    * @return \CRM_Campaign_Selector_Search
-   * @access public
    */
   function __construct(
     &$queryParams,
index fade780f006b52e198738ea981eb88ea72b5d8bc..c51b09920316b9444f6e42866e8c0ed79049c706 100644 (file)
@@ -1587,7 +1587,6 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
    *
    * @return array|void
    *   $activity object of newly creted activity via email
-   * @access public
    */
   public static function recordActivityViaEmail($file) {
     if (!file_exists($file) ||
index 611107dc40289889e742be9c85132f10f7cb077f..2320e1ff21d5b698c492c2f2e7367dd5e65a6912 100644 (file)
@@ -140,7 +140,6 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base {
    * @param string $context
    *
    * @return \CRM_Case_Selector_Search
-   * @access public
    */
   function __construct(
     &$queryParams,
index 8da6664c5749e66b282474f4a329c5cc30a83700..9315b543c68ccec1833e36ee59493bd160adb069 100644 (file)
@@ -143,7 +143,6 @@ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganizatio
    *
    * @return int|null
    *   no of deleted group organization on success, false otherwise
-   * @access public
    */
   public static function deleteGroupOrganization($groupOrganizationID) {
     $results = NULL;
index 5fd747d830c13f0a8595f0dc2d498ae772eb860a..c5b9ba0f62033178c70083ded985ee5d7b7b2776 100644 (file)
@@ -408,7 +408,6 @@ class CRM_Contact_BAO_Query {
    * @param string $operator
    *
    * @return \CRM_Contact_BAO_Query
-   * @access public
    */
   function __construct(
     $params = NULL, $returnProperties = NULL, $fields = NULL,
index 6dd71afc8a24f6f942389b1dc9a2148367007ea9..fd6fe906476e7dc3f3a36c0eea0439e8e0350c9a 100644 (file)
@@ -712,7 +712,6 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship {
    *   This is contact id for adding relationship.
    *
    * @return string
-   * @access public
    */
   public static function checkValidRelationship($params, $ids, $contactId) {
     $errors = '';
index dbb1c5a02ad66b86a6a44ea6751f3dea68e5a1bf..22328fb9db9a79110d1d061ab5a43d7043805655 100644 (file)
@@ -97,7 +97,6 @@ class CRM_Contact_Form_Domain extends CRM_Core_Form {
    * @return array
    *   reference to the array of default values
    *
-   * @access public
    */
   public function setDefaultValues() {
     $defaults = array();
index 5f5fde7b5f34a1d2e4003370da79c306411a99c9..b0a8cf111e939d8d042e43b56d1d9991e7e66a9e 100644 (file)
@@ -116,7 +116,6 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
    * @param null $contextMenu
    *
    * @return \CRM_Contact_Selector_Custom
-   * @access public
    */
   function __construct(
     $customSearchClass,
index 41b9b61890d03bbcb69eda46c43fc71c69b00291..2a7df6cb53ccd6542b511d8810c35c8a07e55bfe 100644 (file)
@@ -770,7 +770,6 @@ INNER JOIN  civicrm_contact contact ON ( contact.id = civicrm_contribution.conta
    *
    * @return mixed|null
    *   $results no of deleted Contribution on success, false otherwise
-   * @access public
    */
   public static function deleteContribution($id) {
     CRM_Utils_Hook::pre('delete', 'Contribution', $id, CRM_Core_DAO::$_nullArray);
index e409697f611de77bf5c784aad7bf9805071fdf0c..3da2901603211207ed213d27157726de87725cc0 100644 (file)
@@ -162,7 +162,6 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C
    * @param null $compContext
    *
    * @return \CRM_Contribute_Selector_Search
-   * @access public
    */
   function __construct(
     &$queryParams,
index 1c8f3671f382b95ae22c6ff09b50fbc1419ed817..3d526247ecd93104440d27614136f34df86cea95 100644 (file)
@@ -91,7 +91,6 @@ function _civicrm_api3_api_getfields(&$apiRequest) {
  *
  * @return boolean
  *   true if error, false otherwise
- * @access public
  */
 function civicrm_error($result) {
   if (is_array($result)) {
index f6eadc717d35217262bcc78f6af99741972111a8..6998d3982ffc4bdde87fd04631c07c471146fb52 100644 (file)
@@ -36,7 +36,6 @@
 /**
  * Save an acl
  *
- * Allowed @params array keys are:
  * {@getfields acl_create}
  * @example aclCreate.php
  *
@@ -44,7 +43,6 @@
  *
  * @return array
  *   Array of newly created acl property values.
- * @access public
  */
 function civicrm_api3_acl_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -53,7 +51,6 @@ function civicrm_api3_acl_create($params) {
 /**
  * Get an acl
  *
- * Allowed @params array keys are:
  * {@getfields acl_get}
  * @example aclCreate.php
  *
@@ -61,7 +58,6 @@ function civicrm_api3_acl_create($params) {
  *
  * @return array
  *   Array of retrieved acl property values.
- * @access public
  */
 function civicrm_api3_acl_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -70,7 +66,6 @@ function civicrm_api3_acl_get($params) {
 /**
  * Delete an acl
  *
- * Allowed @params array keys are:
  * {@getfields acl_delete}
  * @example aclCreate.php
  *
@@ -78,7 +73,6 @@ function civicrm_api3_acl_get($params) {
  *
  * @return array
  *   Array of deleted values.
- * @access public
  */
 function civicrm_api3_acl_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
index dd32d5c51df6a3398fc3e2d87686acd8db2d4708..26798697178f516a6b0eefa882e0efa00c97f713 100644 (file)
@@ -44,7 +44,6 @@
  *
  * @return array
  *   Array of newly created acl_role property values.
- * @access public
  */
 function civicrm_api3_acl_role_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -61,7 +60,6 @@ function civicrm_api3_acl_role_create($params) {
  *
  * @return array
  *   Array of retrieved acl_role property values.
- * @access public
  */
 function civicrm_api3_acl_role_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -78,7 +76,6 @@ function civicrm_api3_acl_role_get($params) {
  *
  * @return array
  *   Array of deleted values.
- * @access public
  */
 function civicrm_api3_acl_role_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
index 777935839359096fb6b4c9284804bb3cdc7f5d56..bd4899699fd03240fc48c46199e5ac96ede55e9f 100644 (file)
@@ -87,7 +87,6 @@ function _civicrm_api3_action_schedule_create_spec(&$params) {
  * @return array
  *   API result array
  *
- * @access public
  */
 function civicrm_api3_action_schedule_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
index 9d8a3abd807180a27bbeb999c48960af23fd3a07..fe3d3899c33db4929c7b98ddcf5fed6f03e9d268 100644 (file)
@@ -46,7 +46,6 @@
  *
  * @return array
  *   Array of newly created activity contact records.
- * @access public
  */
 function civicrm_api3_activity_contact_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -73,7 +72,6 @@ function _civicrm_api3_activity_contact_create_spec(&$params) {
  *   Api Result
  *
  * @example ActivityContact.php
- * @access public
  */
 function civicrm_api3_activity_contact_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -90,7 +88,6 @@ function civicrm_api3_activity_contact_delete($params) {
  * @return array
  *   details of found tags else error
  *
- * @access public
  */
 function civicrm_api3_activity_contact_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
index a139f3b253b7b7046757ce4631dfc828148b7a98..52158cfa0bb8956f789a1a2a82995369ab422e00 100644 (file)
@@ -52,9 +52,6 @@ function _civicrm_api3_activity_type_deprecation() {
  *
  * @return array
  *   activity types keyed by id
- * @access public
- *
- * @example ActivityTypeGet.php
  * @deprecated - use getoptions
  */
 function civicrm_api3_activity_type_get($params) {
@@ -67,14 +64,10 @@ function civicrm_api3_activity_type_get($params) {
  * create activity type (
  *
  * @param array $params
- *   Associated array of fields.
- *                 $params['option_value_id'] is required for updation of activity type
  *
  * @return array
  *   created / updated activity type
  *
- * @access public
- *
  * @deprecated - use option_value create
  */
 function civicrm_api3_activity_type_create($params) {
@@ -115,8 +108,6 @@ function _civicrm_api3_activity_type_create_spec(&$params) {
  * @return array
  *   API result array
  *
- * @access public
- *
  * @deprecated - we will introduce OptionValue Delete- plse consider helping with this if not done
  */
 function civicrm_api3_activity_type_delete($params) {
index 7a045fd3e45a11d54361e028aafb818b4988520e..f1f9185682ce01ed66fcc02bb2c6d78e12b08e4a 100644 (file)
@@ -46,7 +46,6 @@
  *
  * @return array
  *   Array of newly created tag property values.
- * @access public
  */
 function civicrm_api3_address_create(&$params) {
   /**
@@ -133,7 +132,6 @@ function _civicrm_api3_address_get_spec(&$params) {
  *
  * @return array
  *   api result array
- * @access public
  */
 function civicrm_api3_address_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -152,7 +150,6 @@ function civicrm_api3_address_delete($params) {
  * @return array
  *   details of found addresses else error
  * {@getfields address_get}
- * @access public
  */
 function civicrm_api3_address_get(&$params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Address');
index 2b22752b0f7860a46e8a5f9d79ae2def5804f5c6..85e6cbb1676ec930b0dd1a63dbe0b6183fa9f397 100644 (file)
@@ -90,7 +90,6 @@ function _civicrm_api3_attachment_create_spec(&$spec) {
  * @param array $params
  * @return array
  *   Array of newly created file property values.
- * @access public
  * @throws API_Exception validation errors
  */
 function civicrm_api3_attachment_create($params) {
@@ -179,6 +178,9 @@ function civicrm_api3_attachment_get($params) {
   return civicrm_api3_create_success($result, $params, 'Attachment', 'create');
 }
 
+/**
+ * @param $spec
+ */
 function _civicrm_api3_attachment_delete_spec(&$spec) {
   unset($spec['id']['api.required']);
   $entityFileFields = CRM_Core_DAO_EntityFile::fields();
index ae9e2a91dedd8cdcf7aab4c263cc5bfb4b3e9e1f..5c52f3a5598476d3892cb87debf6108490f6ebce 100644 (file)
@@ -44,7 +44,6 @@
  *
  * @return array
  *   Array of newly created batch property values.
- * @access public
  */
 function civicrm_api3_batch_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -81,7 +80,6 @@ function _civicrm_api3_batch_create_spec(&$params) {
  *
  * @return array
  *   Array of retrieved batch property values.
- * @access public
  */
 function civicrm_api3_batch_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -98,7 +96,6 @@ function civicrm_api3_batch_get($params) {
  *
  * @return array
  *   Array of deleted values.
- * @access public
  */
 function civicrm_api3_batch_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
index fea469f4eec43d1e486cbc20ceeeecbc1c572fd6..67b68a7328284df18bcc711c0eb07a920f84c244 100644 (file)
@@ -47,7 +47,6 @@
  * @return array
  *   campaign array
  * {@getfields campaign_create}
- * @access public
  */
 function civicrm_api3_campaign_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Campaign');
@@ -95,7 +94,6 @@ function civicrm_api3_campaign_get($params) {
  *   (reference) returns flag true if successful, error
  *                message otherwise
  * {@getfields campaign_delete}
- * @access public
  */
 function civicrm_api3_campaign_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
index bf2e5f76f9421064ae430701eeb070cebbdafae0..5e914200d06cccb8ef483a59aaccced68a6bccc3 100644 (file)
@@ -311,7 +311,6 @@ function _civicrm_api3_case_deprecation() {
  * @return array
  *   api result array
  *
- * @access public
  */
 function civicrm_api3_case_update($params) {
   //check parameters
@@ -378,7 +377,6 @@ function civicrm_api3_case_update($params) {
  * @return boolean
  *   true if success, else false
  * {@getfields case_delete}
- * @access public
  */
 function civicrm_api3_case_delete($params) {
   //check parameters
index 752fb9307df55ef885b00f7e5e69088aa3ecf4b5..f2bbf9eef2368173b1931577fbe1d1d333dbda64 100644 (file)
@@ -48,7 +48,6 @@
  * @return array
  *   API result array
  *
- * @access public
  */
 function civicrm_api3_case_type_create($params) {
   civicrm_api3_verify_mandatory($params, _civicrm_api3_get_DAO(__FUNCTION__));
@@ -75,7 +74,6 @@ function civicrm_api3_case_type_create($params) {
  *
  * @return array
  *   case types keyed by id
- * @access public
  */
 function civicrm_api3_case_type_get($params) {
   if (!empty($params['options']) && !empty($params['options']['is_count'])) {
index 4ef46ba2a8cf558f227b0a4005385f29a0832d8d..a90d7b8511e0d198334b98b6d3c08c0f86544f81 100644 (file)
@@ -53,7 +53,6 @@
  * @return array
  *   API Result Array
  *
- * @access public
  */
 function civicrm_api3_contact_create($params) {
 
index db75b6add4e5332884e685e742fb3342be8ca9e1..12501eea7f0bf2c50adc48da200cfe8626949946 100644 (file)
@@ -113,7 +113,6 @@ function civicrm_api3_relationship_type_get($params) {
  * @return array
  *   API Result Array
  * {@getfields RelationshipType_delete}
- * @access public
  */
 function civicrm_api3_relationship_type_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
index 5031af7caf3fcb37c6cbb7abd07b4632ee2f507a..ba05cfc73dc6afc32212254c94a9f94d126b46b4 100644 (file)
@@ -8,7 +8,6 @@
  *
  * @return array
  *   details of found instances
- * @access public
  */
 function civicrm_api3_report_instance_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -21,7 +20,6 @@ function civicrm_api3_report_instance_get($params) {
  *
  * @return array
  *   Array of newly created report instance property values.
- * @access public
  */
 function civicrm_api3_report_instance_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -46,7 +44,6 @@ function _civicrm_api3_report_instance_create_spec(&$params) {
  *
  * @return array
  *   Api result
- * @access public
  */
 function civicrm_api3_report_instance_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
index a5d0b51bf4fffe9b20bf5706d89ed8a868c7eb65..17ecda8705bd3baad962987fb606a455b922c2d5 100644 (file)
@@ -13,7 +13,6 @@
  * @return array
  *   details of found Option Values
  * {@getfields OptionValue_get}
- * @access public
  */
 function civicrm_api3_report_template_get($params) {
   require_once 'api/v3/OptionValue.php';
@@ -35,7 +34,6 @@ function civicrm_api3_report_template_get($params) {
  * @return array
  *   Array of newly created option_value property values.
  * {@getfields OptionValue_create}
- * @access public
  */
 function civicrm_api3_report_template_create($params) {
   require_once 'api/v3/OptionValue.php';
@@ -77,7 +75,6 @@ function _civicrm_api3_report_template_create_spec(&$params) {
  * @return array
  *   Api result
  * {@getfields ReportTemplate_create}
- * @access public
  */
 function civicrm_api3_report_template_delete($params) {
   require_once 'api/v3/OptionValue.php';
@@ -92,7 +89,6 @@ function civicrm_api3_report_template_delete($params) {
  *
  * @return array
  *   details of found instances
- * @access public
  */
 function civicrm_api3_report_template_getrows($params) {
   civicrm_api3_verify_one_mandatory($params, NULL, array('report_id', 'instance_id'));
@@ -170,7 +166,6 @@ function civicrm_api3_report_template_getstatistics($params) {
  *
  * @return array
  *   details of found instances
- * @access public
  */
 function _civicrm_api3_report_template_getrows_spec(&$params) {
   $params['report_id'] = array(
index 7c2c7249e578acb82eec45d4627dd7a3f7490e2f..797cb8537d720696a33ba7774659be4262dc7b4a 100644 (file)
@@ -219,7 +219,6 @@ function _civicrm_api3_setting_fill_spec(&$params) {
  * @return array
  *   api result array
  * {@getfields setting_create}
- * @access public
  */
 function civicrm_api3_setting_create($params) {
   $domains = _civicrm_api3_setting_getDomainArray($params);
@@ -256,7 +255,6 @@ function _civicrm_api3_setting_create_spec(&$params) {
  * @return array
  *   Array of matching settings
  * {@getfields setting_get}
- * @access public
  */
 function civicrm_api3_setting_get($params) {
   $domains = _civicrm_api3_setting_getDomainArray($params);
@@ -291,7 +289,6 @@ function _civicrm_api3_setting_get_spec(&$params) {
  * @return array
  *   Array of matching settings
  * {@getfields setting_get}
- * @access public
  */
 function civicrm_api3_setting_getvalue($params) {
   $config = CRM_Core_Config::singleton();
index 1b1bc32154e87740dea497a76a7e58d96935ebc9..45ca0323e9c5bccf08b039ff3c28d83225b9e6cb 100644 (file)
@@ -44,7 +44,6 @@
  *
  * @return array
  *   Array of newly created sms_provider property values.
- * @access public
  */
 function civicrm_api3_sms_provider_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -61,7 +60,6 @@ function civicrm_api3_sms_provider_create($params) {
  *
  * @return array
  *   Array of retrieved sms_provider property values.
- * @access public
  */
 function civicrm_api3_sms_provider_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -78,7 +76,6 @@ function civicrm_api3_sms_provider_get($params) {
  *
  * @return array
  *   Array of deleted values.
- * @access public
  */
 function civicrm_api3_sms_provider_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
index 5815472d391634a2bc8ad590175ff52b244068a6..1012f1a3b0a87b1c047cc8c54cae6309719f56d1 100644 (file)
@@ -45,7 +45,6 @@
  * @return array
  *   api result array
  * {@getfields survey_create}
- * @access public
  */
 function civicrm_api3_survey_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Survey');
@@ -73,7 +72,6 @@ function _civicrm_api3_survey_create_spec(&$params) {
  * @return array
  *   API result Array of matching surveys
  * {@getfields survey_get}
- * @access public
  */
 function civicrm_api3_survey_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Survey');
@@ -92,7 +90,6 @@ function civicrm_api3_survey_get($params) {
  * @return array
  *   api result array
  * {@getfields survey_delete}
- * @access public
  */
 function civicrm_api3_survey_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
index 544e78596f8e1a501060b8219dea39bb15494445..021cd61f20d4763f8397230aa0f4c1211a681a40 100644 (file)
@@ -163,7 +163,8 @@ function _civicrm_api3_system_log_spec(&$params) {
 /**
  * System.Get API
  *
- * @param arary $params
+ * @param array $params
+ * @return array
  */
 function civicrm_api3_system_get($params) {
   $returnValues = array(
index 92ef857b7ff605fe52867de2433a68d5fbb90d30..01f6efed539739ad531019ba430d056c015af413 100644 (file)
@@ -47,7 +47,6 @@
  * @return array
  *   Array of newly created tag property values.
  * {@getfields tag_create}
- * @access public
  */
 function civicrm_api3_tag_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -75,7 +74,6 @@ function _civicrm_api3_tag_create_spec(&$params) {
  * @return array
  *   API result array
  * {@getfields tag_delete}
- * @access public
  */
 function civicrm_api3_tag_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -95,7 +93,6 @@ function civicrm_api3_tag_delete($params) {
  * @return array
  *   details of found tags else error
  * {@getfields tag_get}
- * @access public
  */
 function civicrm_api3_tag_get($params) {
 
index 489c2c54ec36aa863a9f4d52297c2e16a80a1dfc..b40a547ba802c61b2c23e438c14c363b37f51766 100644 (file)
@@ -140,7 +140,6 @@ function _civicrm_api3_uf_field_create_spec(&$params) {
  *   (reference) Array
  * {@getfields UFField_get
  * @example UFFieldGet.php
- * @access public
  */
 function civicrm_api3_uf_field_get($params) {
   return _civicrm_api3_basic_get('CRM_Core_BAO_UFField', $params);
index 8195102872b9c68b1b25060358cea2ee48b92452..10da47aa103d32387c4309d398940ae6d8737073 100644 (file)
@@ -57,7 +57,6 @@ function _civicrm_api3_uf_group_create_spec(&$params) {
  *   API result array
  * {@getfields UFGroup_create}
  * @example UFGroupCreate.php
- * @access public
  */
 function civicrm_api3_uf_group_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -75,7 +74,6 @@ function civicrm_api3_uf_group_create($params) {
  *   Array of matching profiles
  * {@getfields UFGroup_get}
  * @example UFGroupGet.php
- * @access public
  */
 function civicrm_api3_uf_group_get($params) {
 
index cdfd090a5ca237f9da0640c4fa41ab3d1ff77a5d..26a80923fba3aeb820b76c157a09c4413f2c7662 100644 (file)
@@ -62,7 +62,6 @@ function civicrm_api3_uf_match_get($params) {
  * @return array
  *   api result array
  * {@getfields uf_match_create}
- * @access public
  */
 function civicrm_api3_uf_match_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -92,7 +91,6 @@ function _civicrm_api3_uf_match_create_spec(&$params) {
  * @return array
  *   api result array
  * {@getfields uf_match_create}
- * @access public
  */
 function civicrm_api3_uf_match_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
index ec2debb21a6da10b60d232ff5507fae4c2ae8978..903a7acab505df7d80dd88a7acc4b1c67e77a823 100644 (file)
@@ -113,7 +113,6 @@ function civicrm_api3_website_delete($params) {
  * @return array
  *   details of found websites
  *
- * @access public
  */
 function civicrm_api3_website_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'website');
index 495bbeb777e7064f062603f51c8060202fec5ac6..37c2accb28428e4cbf747b11c21f4c37d692abb9 100644 (file)
@@ -87,7 +87,6 @@ function _civicrm_api3_word_replacement_create_spec(&$params) {
  * @return array
  *   api result array
  *
- * @access public
  */
 function civicrm_api3_word_replacement_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
index 01cc0510b492cb30127a52b15539bb8b3948f601..2f0a2ddf807243083d9729898a49f8cac70f85ce 100644 (file)
@@ -542,8 +542,7 @@ function _civicrm_api3_get_using_query_object($entity, $params, $additional_opti
  * @param array $params
  * @param string $mode
  * @param string $entity
- * @return CRM_Core_DAO
- *   query object
+ * @return array(CRM_Core_DAO|CRM_Contact_BAO_Query)
  */
 function _civicrm_api3_get_query_object($params, $mode, $entity) {
   $options          = _civicrm_api3_get_options_from_params($params, TRUE, $entity, 'get');
@@ -873,7 +872,6 @@ function _civicrm_api3_get_unique_name_array(&$bao) {
  *
  * @return array
  *
- * @access public
  */
 function _civicrm_api3_dao_to_array($dao, $params = NULL, $uniqueFields = TRUE, $entity = "", $autoFind = TRUE) {
   $result = array();
@@ -945,7 +943,6 @@ function _civicrm_api3_custom_fields_are_required($entity, $params) {
  * @param array|bool $uniqueFields
  *
  * @return array
- * @access public
  */
 function _civicrm_api3_object_to_array(&$dao, &$values, $uniqueFields = FALSE) {
 
@@ -1137,7 +1134,6 @@ function formatCheckBoxField(&$checkboxFieldValue, $customFieldLabel, $entity) {
  * @return bool
  *   Sshould the missing fields be returned as an array (core error created as default)
  *   true if all fields present, depending on $result a core error is created of an array of missing fields is returned
- * @access public
  */
 function _civicrm_api3_check_required_fields($params, $daoName, $return = FALSE) {
   //@deprecated - see notes