(NFC) Correct type hints for bad null default values
authorBradley Taylor <hello@brad-taylor.co.uk>
Sat, 22 Jan 2022 11:48:26 +0000 (11:48 +0000)
committerBradley Taylor <hello@brad-taylor.co.uk>
Sat, 22 Jan 2022 11:48:26 +0000 (11:48 +0000)
26 files changed:
CRM/Bridge/OG/Utils.php
CRM/Case/PseudoConstant.php
CRM/Contact/BAO/Relationship.php
CRM/Contribute/Import/Parser/Contribution.php
CRM/Core/Action.php
CRM/Core/BAO/Tag.php
CRM/Core/Payment.php
CRM/Core/Payment/PayPalImpl.php
CRM/Core/Permission.php
CRM/Event/Import/Parser/Participant.php
CRM/Logging/Schema.php
CRM/Profile/Page/Dynamic.php
CRM/Profile/Selector/Listings.php
CRM/Report/Form.php
CRM/Report/Form/Activity.php
CRM/Report/Page/TemplateList.php
CRM/Utils/HttpClient.php
api/api.php
ext/eventcart/CRM/Event/Cart/BAO/EventInCart.php
ext/eventcart/CRM/Event/Cart/BAO/MerParticipant.php
ext/eventcart/CRM/Event/Cart/Controller/Checkout.php
ext/legacycustomsearches/CRM/Contact/Form/Search/Custom/Sample.php
install/index.php
tools/scripts/solr/createSolrJSON.php
tools/scripts/solr/createSolrXML.php
tools/scripts/solr/createSyncJSON.php

index 5fb44c7d8182653e11f928660b718157ae5c2db9..a7a5fa1e161ebbc235cb7d833a94447ea7450c01 100644 (file)
@@ -99,8 +99,8 @@ class CRM_Bridge_OG_Utils {
   }
 
   /**
-   * @param $source
-   * @param null $title
+   * @param string $source
+   * @param string|null $title
    * @param bool $abort
    *
    * @return null|string
index f94d74686cfe1857230ae7cb8aacad7471f09859..f480d04f1149c0240dc98227db09117b562ac27b 100644 (file)
@@ -47,8 +47,7 @@ class CRM_Case_PseudoConstant extends CRM_Core_PseudoConstant {
   /**
    * Get all the redaction rules.
    *
-   *
-   * @param null $filter
+   * @param int $filter
    *
    * @return array
    *   array reference of all redaction rules
index bb4d2ab503f7816a46101ee55085d3e02eda5920..3294f08471f2816669712c00be64465fb1806a4c 100644 (file)
@@ -1862,7 +1862,7 @@ AND cc.sort_name LIKE '%$name%'";
    *
    * @param array $params
    *   Api input array.
-   * @param null $direction
+   * @param string $direction
    *
    * @return array|void
    * @throws \CiviCRM_API3_Exception
index 2f1e78d81c91a7bbd94c1e76aa9f88377d616fe1..01dae94d3889978f3662164810c512607497aaa8 100644 (file)
@@ -607,14 +607,12 @@ class CRM_Contribute_Import_Parser_Contribution extends CRM_Contribute_Import_Pa
    * 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.
+   *   Associative array of property name/value
+   *   pairs to insert in new contact.
    * @param array $values
    *   The reformatted properties that we can use internally.
-   *                            '
-   *
    * @param bool $create
-   * @param null $onDuplicate
+   * @param int $onDuplicate
    *
    * @return array|CRM_Error
    */
index 2211d6cdb6eedc9c105a0c01e8fa0ceb4bf6e8c9..fc1dcd7c4a85c53fdbe738318a1c70aa8b21d78d 100644 (file)
@@ -166,7 +166,7 @@ class CRM_Core_Action {
    *
    * @param array $links
    *   The set of link items.
-   * @param int $mask
+   * @param int|null $mask
    *   The mask to be used. a null mask means all items.
    * @param array $values
    *   The array of values for parameter substitution in the link items.
@@ -311,8 +311,8 @@ class CRM_Core_Action {
    *   The mask to be used. a null mask means all items.
    * @param array $values
    *   The array of values for parameter substitution in the link items.
-   * @param null $op
-   * @param null $objectName
+   * @param string|null $op
+   * @param string|null $objectName
    * @param int $objectId
    *
    * @return array|null
index 5ef7ec12312eb8b667afccdc29b41970526de900..32c92d5b7abc8f7e8ef5abfe7edbdbf440415606 100644 (file)
@@ -61,7 +61,8 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag {
    * Build a nested array from hierarchical tags.
    *
    * Supports infinite levels of nesting.
-   * @param null $usedFor
+   *
+   * @param string|null $usedFor
    * @param bool $excludeHidden
    */
   public function buildTree($usedFor = NULL, $excludeHidden = FALSE) {
index 6b599e0bf30563cdbc4ff2e789be9a8ac06dc201..26a62af3a98ed9b43341a7cbc21fa4b41798ba55 100644 (file)
@@ -1674,8 +1674,7 @@ abstract class CRM_Core_Payment {
    * it is better to standardise to being here.
    *
    * @param int $invoiceId The ID to check.
-   *
-   * @param null $contributionID
+   * @param int|null $contributionID
    *   If a contribution exists pass in the contribution ID.
    *
    * @return bool
@@ -1693,8 +1692,8 @@ abstract class CRM_Core_Payment {
   /**
    * Get url for users to manage this recurring contribution for this processor.
    *
-   * @param int $entityID
-   * @param null $entity
+   * @param int|null $entityID
+   * @param string|null $entity
    * @param string $action
    *
    * @return string|null
@@ -1724,6 +1723,10 @@ abstract class CRM_Core_Payment {
         }
         $url = 'civicrm/contribute/updaterecur';
         break;
+
+      default:
+        $url = '';
+        break;
     }
 
     $userId = CRM_Core_Session::singleton()->get('userID');
index fbec70ca29961ed77d8c730ff4e49f9fcdd5bdc1..6d854859c0e2079c1039266db64cd5fc12b7ffce 100644 (file)
@@ -695,7 +695,7 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment {
    * Get url for users to manage this recurring contribution for this processor.
    *
    * @param int $entityID
-   * @param null $entity
+   * @param string|null $entity
    * @param string $action
    *
    * @return string|null
index bfa8cdd1d2a68a35bbaaa9f66517835cb126c505..47b0350d7b8e8d0bbd526e7c594dc1021688f24c 100644 (file)
@@ -335,7 +335,7 @@ class CRM_Core_Permission {
 
   /**
    * @param int $type
-   * @param null $prefix
+   * @param string $prefix
    * @param bool $returnUFGroupIds
    *
    * @return array|string
index e9ce6d6b71d8e52dffdc23850ad6c0bbfb3813c8..6c9cf49cb9ffc126fb925aaa68994c19c825d3fd 100644 (file)
@@ -40,10 +40,8 @@ class CRM_Event_Import_Parser_Participant extends CRM_Event_Import_Parser {
    * Class constructor.
    *
    * @param array $mapperKeys
-   * @param null $mapperLocType
-   * @param null $mapperPhoneType
    */
-  public function __construct(&$mapperKeys, $mapperLocType = NULL, $mapperPhoneType = NULL) {
+  public function __construct(&$mapperKeys) {
     parent::__construct();
     $this->_mapperKeys = &$mapperKeys;
   }
index d9a633c77d7dfbfe9852be07f19e88baf95e1394..a8ef7185ad64cecb7c75f3d56f7600a4ed4a309c 100644 (file)
@@ -924,7 +924,7 @@ COLS;
    * Get trigger info.
    *
    * @param array $info
-   * @param null $tableName
+   * @param string|null $tableName
    * @param bool $force
    */
   public function triggerInfo(&$info, $tableName = NULL, $force = FALSE) {
index 10f4037c25b7ef54985bc3f0fc3fee9ac07ada1c..fe01add14987f79be1a8231aa58f1a75e6bfdf03 100644 (file)
@@ -104,7 +104,7 @@ class CRM_Profile_Page_Dynamic extends CRM_Core_Page {
    *
    * @param $restrict
    * @param bool $skipPermission
-   * @param null $profileIds
+   * @param int[]|null $profileIds
    *
    * @param bool $isShowEmailTaskLink
    *
index 72cad9e97db92b1e79899937d7ce9e301bf4b28c..6aefb13117cb60b592e12faee168083d136ab970 100644 (file)
@@ -181,7 +181,7 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR
    * @param bool $map
    * @param bool $editLink
    * @param bool $ufLink
-   * @param null $gids
+   * @param int[]|null $gids
    *
    * @return array
    */
index 4341726fb6a06da40c440211f43a7845fd7ba57c..21b1355ad5da716df8c5c06909aa226f142f4694 100644 (file)
@@ -5221,7 +5221,7 @@ LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_a
    *
    * @param string $baseTable
    * @param string $field
-   * @param null $tableAlias
+   * @param string|null $tableAlias
    */
   public function setFromBase($baseTable, $field = 'id', $tableAlias = NULL) {
     if (!$tableAlias) {
index 8a2019704913cc3f5fca92432a761a79149e3c3f..d91c95e010656be4a116ef8a8289813391fc8bc6 100644 (file)
@@ -397,7 +397,7 @@ class CRM_Report_Form_Activity extends CRM_Report_Form {
    * @todo get rid of $recordType param. It's only because 3 separate contact tables
    * are mis-declared as one that we need it.
    *
-   * @param null $recordType deprecated
+   * @param string $recordType deprecated
    *   Parameter to hack around the bad decision made in construct to misrepresent
    *   different tables as the same table.
    */
index 289b8175984ed1fafee61d2c76f907378145f985..eb24cafac18b0952a5a426fef70fcecf8d5f4ad8 100644 (file)
@@ -22,7 +22,7 @@ class CRM_Report_Page_TemplateList extends CRM_Core_Page {
 
   /**
    * @param int $compID
-   * @param null $grouping
+   * @param string|null $grouping
    *
    * @return array
    */
index 0286c4f793263d50225ab2106091b1d7881bff8f..3a34e18970c665a5c3b3e68a6871ec71863c27f0 100644 (file)
@@ -48,7 +48,8 @@ class CRM_Utils_HttpClient {
   }
 
   /**
-   * @param null $connectionTimeout
+   * @param int|null $connectionTimeout
+   *   seconds; or NULL to use system default
    */
   public function __construct($connectionTimeout = NULL) {
     $this->connectionTimeout = $connectionTimeout;
index b8aeec4e0dc6a9b47d5ed601ec192712e24c1589..2a857a1db1b8598b568cc1234ad15a044db6d2a9 100644 (file)
@@ -180,7 +180,7 @@ function _civicrm_api3_api_getfields(&$apiRequest) {
  * 'format.is_success' => 1
  * will result in a boolean success /fail being returned if that is what you need.
  *
- * @param $result
+ * @param mixed $result
  *
  * @return bool
  *   true if error, false otherwise
index 82c144e11835a7d81c565048f4c2afeda5f5f46b..97cc92d256df8cc320a2378535b7afcf1b9dfad7 100644 (file)
@@ -157,7 +157,7 @@ class CRM_Event_Cart_BAO_EventInCart extends CRM_Event_Cart_DAO_EventInCart impl
   }
 
   /**
-   * @param null $event_cart
+   * @param CRM_Event_Cart_BAO_Cart|null $event_cart
    */
   public function load_associations($event_cart = NULL) {
     if ($this->assocations_loaded) {
index 4cdf4e341b9c90d17b4ac33c3bb9c26b7ca0e260..c1324e2d9beed436f805095cb01222bf488c06dd 100644 (file)
@@ -30,8 +30,7 @@ class CRM_Event_Cart_BAO_MerParticipant extends CRM_Event_BAO_Participant {
   public $cart = NULL;
 
   /**
-   * XXX.
-   * @param null $participant
+   * @param array $participant
    */
   public function __construct($participant = NULL) {
     parent::__construct();
index a00044bdda636a2b1254ac672a99d12674394610..10ccc2c4077342bdbafb1c4570c78f83005a5d90 100644 (file)
@@ -6,7 +6,7 @@
 class CRM_Event_Cart_Controller_Checkout extends CRM_Core_Controller {
 
   /**
-   * @param null $title
+   * @param string $title
    * @param bool|int $action
    * @param bool $modal
    */
index 70bc6b8f19a6c49c460e99ca9766a6bbd36bd28b..775dada57bf6b34fd9626f9b868f9ff234ec2e71 100644 (file)
@@ -83,7 +83,7 @@ class CRM_Contact_Form_Search_Custom_Sample extends CRM_Contact_Form_Search_Cust
   /**
    * @param int $offset
    * @param int $rowcount
-   * @param null $sort
+   * @param string|null $sort
    * @param bool $returnSQL
    *
    * @return string
@@ -95,7 +95,7 @@ class CRM_Contact_Form_Search_Custom_Sample extends CRM_Contact_Form_Search_Cust
   /**
    * @param int $offset
    * @param int $rowcount
-   * @param null $sort
+   * @param string|null $sort
    * @param bool $includeContactIDs
    * @param bool $justIDs
    *
index a56b5289c6a50997df8bf14a4ebfa485da1b313e..0c6b62c2c92dfa679ce3f6af39a9c7bbc2d281b7 100644 (file)
@@ -839,7 +839,7 @@ class InstallRequirements {
   }
 
   /**
-   * @param null $section
+   * @param string|null $section
    */
   public function showTable($section = NULL) {
     if ($section) {
index a836ec00da374f2400107f98c6c711a6e9edaf6f..54b37c1f0de0961166cbd41892269da68a74899d 100644 (file)
@@ -133,7 +133,7 @@ function getValues(&$contactIDs, &$values) {
  * @param $tableName
  * @param $fields
  * @param $whereField
- * @param null $additionalWhereCond
+ * @param string|null $additionalWhereCond
  */
 function getTableInfo(&$contactIDs, &$values, $tableName, &$fields, $whereField, $additionalWhereCond = NULL) {
   $selectString = implode(',', array_keys($fields));
index c98d064aabd8575a22f29879d5d0adff4bfd8558..d3399513ebf4ff73122047987da157e352b25179 100644 (file)
@@ -106,7 +106,7 @@ function getValues(&$contactIDs, &$values) {
  * @param $tableName
  * @param $fields
  * @param $whereField
- * @param null $additionalWhereCond
+ * @param string|null $additionalWhereCond
  */
 function getTableInfo(&$contactIDs, &$values, $tableName, &$fields, $whereField, $additionalWhereCond = NULL) {
   $selectString = implode(',', array_keys($fields));
index cb7c6172c98648a262f0f6b1d52c24dcb90d41fc..e5a101f516d35816487f9cd3c9a1667da8c41178 100644 (file)
@@ -84,7 +84,7 @@ function getValues(&$contactIDs, &$values, &$allContactIDs, &$addditionalContact
  * @param $tableName
  * @param $fields
  * @param $whereField
- * @param null $additionalWhereCond
+ * @param string|null $additionalWhereCond
  * @param bool $flat
  */
 function getTableInfo(&$contactIDs, &$values, $tableName, &$fields,