Fix php comments
authorEileen McNaughton <emcnaughton@wikimedia.org>
Sun, 16 Jan 2022 21:29:09 +0000 (10:29 +1300)
committerEileen McNaughton <emcnaughton@wikimedia.org>
Sun, 16 Jan 2022 21:29:09 +0000 (10:29 +1300)
As per https://github.com/civicrm/civicrm-core/pull/22515

17 files changed:
CRM/Dedupe/Merger.php
CRM/Extension/Manager.php
CRM/Extension/MixinScanner.php
CRM/Financial/BAO/Order.php
CRM/Financial/BAO/PaymentProcessor.php
CRM/Queue/Runner.php
CRM/Utils/Check.php
CRM/Utils/Date.php
CRM/Utils/File.php
CRM/Utils/PDF/Utils.php
CRM/Utils/SQL/BaseParamQuery.php
CRM/Utils/SQL/Delete.php
CRM/Utils/SQL/Insert.php
CRM/Utils/SQL/Select.php
CRM/Utils/SQL/TempTable.php
CRM/Utils/String.php
CRM/Utils/System.php

index 8e321713391491b1b4440cb8ef754a97b73aca02..48e000f2a8cace9352699647acfec8fbf5c4c5f8 100644 (file)
@@ -1093,7 +1093,7 @@ INNER JOIN  civicrm_membership membership2 ON membership1.membership_type_id = m
    *
    * @param bool $checkPermissions
    *   Respect logged in user permissions.
-   * @param bool|NULL $reloadCacheIfEmpty
+   * @param bool|null $reloadCacheIfEmpty
    *  If not set explicitly this is calculated but it is preferred that it be set
    *  per comments on isSelected above.
    *
@@ -2625,7 +2625,7 @@ INNER JOIN  civicrm_membership membership2 ON membership1.membership_type_id = m
   /**
    * Build up the location block for the contact in dedupe-screen display format.
    *
-   * @param integer $cid
+   * @param int $cid
    * @param array $blockInfo
    * @param string $blockName
    *
index 14c7128dd6f2946e35dd6b556ac91602a9327a70..5b4fe20a09c58ada7d2a4ae5ee3814b831a963e2 100644 (file)
@@ -130,7 +130,7 @@ class CRM_Extension_Manager {
    * Class constructor.
    *
    * @param CRM_Extension_Container_Interface $fullContainer
-   * @param CRM_Extension_Container_Basic|FALSE $defaultContainer
+   * @param CRM_Extension_Container_Basic|false $defaultContainer
    * @param CRM_Extension_Mapper $mapper
    * @param array $typeManagers
    */
index 8e4039b6042a6076a2c3df64a4b93f300dee2b0e..d433757ce9a8c2b7c071378357af8a4fc5282908 100644 (file)
@@ -52,8 +52,8 @@ class CRM_Extension_MixinScanner {
 
   /**
    * CRM_Extension_ClassLoader constructor.
-   * @param \CRM_Extension_Mapper|NULL $mapper
-   * @param \CRM_Extension_Manager|NULL $manager
+   * @param \CRM_Extension_Mapper|null $mapper
+   * @param \CRM_Extension_Manager|null $manager
    * @param bool $relativize
    *   Whether to store paths in relative form.
    *   Enabling this may slow-down scanning a bit, and it has no benefit when for on-demand loaders.
index 9a0d8b1b2285c60e7136cc85c1d7144be8aa1d65..9e84402c55b75a2543eb72c1ae45ebce29373ce6 100644 (file)
@@ -316,7 +316,7 @@ class CRM_Financial_BAO_Order {
    *
    * @internal use in tested core code only.
    *
-   * @param \CRM_Core_Form|NULL $form
+   * @param \CRM_Core_Form|null $form
    */
   public function setForm(?CRM_Core_Form $form): void {
     $this->form = $form;
index d27b502fb3ba69893c5ba413914edb14d1b67ab9..f455c5e7fcdffe745c8d72efd241a046b17f94be 100644 (file)
@@ -92,7 +92,7 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces
 
   /**
    * Retrieve array of allowed credit cards for this payment processor.
-   * @param integer|null $paymentProcessorID id of processor.
+   * @param int|null $paymentProcessorID
    * @return array
    */
   public static function getCreditCards($paymentProcessorID = NULL) {
@@ -270,12 +270,12 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces
   /**
    * Get all payment processors as an array of objects.
    *
-   * @param string|NULL $mode
+   * @param string|null $mode
    * only return this mode - test|live or NULL for all
    * @param bool $reset
    * @param bool $isCurrentDomainOnly
    *   Do we only want to load payment processors associated with the current domain.
-   * @param bool|NULL $isActive
+   * @param bool|null $isActive
    *   Do we only want active processors, only inactive (FALSE) or all processors (NULL)
    *
    * @throws CiviCRM_API3_Exception
index 0652629c15b9dbfe908532466b57d01ef6d02bc5..e2a585a3c328c64a473c3ddfa1ceddf490444a73 100644 (file)
@@ -302,7 +302,7 @@ class CRM_Queue_Runner {
    *
    * @param bool $isOK
    *   TRUE if the task completed successfully.
-   * @param Exception|NULL $exception
+   * @param Exception|null $exception
    *   If applicable, an unhandled exception that arose during execution.
    *
    * @return array
index 618b332b7b3f0fcdae40b76339a8c6babe4fc445..08dd65b5beb5d3f0b9de15a6f57ff53d0e26d247 100644 (file)
@@ -146,7 +146,7 @@ class CRM_Utils_Check {
   /**
    * Throw an exception if any of the checks fail.
    *
-   * @param array|NULL $messages
+   * @param array|null $messages
    *   [CRM_Utils_Check_Message]
    * @param string $threshold
    *
index 45de25d68940aad3d76d53d74c976f59e87e6ada..318dfa996c149b74a164b7bf6cd23aaa7ebc91bb 100644 (file)
@@ -729,7 +729,7 @@ class CRM_Utils_Date {
   /**
    * Translate a TTL to a concrete expiration time.
    *
-   * @param NULL|int|DateInterval $ttl
+   * @param null|int|DateInterval $ttl
    * @param int $default
    *   The value to use if $ttl is not specified (NULL).
    * @return int
@@ -755,7 +755,7 @@ class CRM_Utils_Date {
   /**
    * Normalize a TTL.
    *
-   * @param NULL|int|DateInterval $ttl
+   * @param null|int|DateInterval $ttl
    * @param int $default
    *   The value to use if $ttl is not specified (NULL).
    * @return int
index b87b60e8a636e2e0972b6f7a146d15bb159a4500..cdda9aa217a92b69825e989ce6e87e445bf08ec7 100644 (file)
@@ -293,7 +293,7 @@ class CRM_Utils_File {
   }
 
   /**
-   * @param string|NULL $dsn
+   * @param string|null $dsn
    *   Use NULL to load the default/active connection from CRM_Core_DAO.
    *   Otherwise, give a full DSN string.
    * @param string $fileName
@@ -312,7 +312,7 @@ class CRM_Utils_File {
 
   /**
    *
-   * @param string|NULL $dsn
+   * @param string|null $dsn
    * @param string $queryString
    * @param string $prefix
    * @param bool $dieOnErrors
index 3378e8b410c179a3d9350726cbf5507d70c17125..a751baa1e38b9b72825d80d38a2c2e270598eaa3 100644 (file)
@@ -202,7 +202,7 @@ class CRM_Utils_PDF_Utils {
   }
 
   /**
-   * @param (float|int)[] $paper_size
+   * @param float|int[] $paper_size
    * @param string $orientation
    * @param array $margins
    * @param string $html
index 20125db2bdad4d4f45e991306069888f5655abd0..b0bf8633d0a34379653c80b3ddf08f33d732a4ee 100644 (file)
@@ -139,7 +139,7 @@ class CRM_Utils_SQL_BaseParamQuery implements ArrayAccess {
   }
 
   /**
-   * @param string|NULL $value
+   * @param string|null $value
    * @return string
    *   SQL expression, e.g. "it\'s great" (with-quotes) or NULL (without-quotes)
    */
index b31a7162eb6c80b5d4745035e31617b32127082f..af7eba56f6667c72d0f513c34218ab08c8e046df 100644 (file)
@@ -105,7 +105,7 @@ class CRM_Utils_SQL_Delete extends CRM_Utils_SQL_BaseParamQuery {
    * Merge something or other.
    *
    * @param CRM_Utils_SQL_Delete $other
-   * @param array|NULL $parts
+   * @param array|null $parts
    *   ex: 'wheres'
    * @return CRM_Utils_SQL_Delete
    */
@@ -177,7 +177,7 @@ class CRM_Utils_SQL_Delete extends CRM_Utils_SQL_BaseParamQuery {
   }
 
   /**
-   * @param array|NULL $parts
+   * @param array|null $parts
    *   List of fields to check (e.g. 'wheres').
    *   Defaults to all.
    * @return bool
@@ -224,7 +224,7 @@ class CRM_Utils_SQL_Delete extends CRM_Utils_SQL_BaseParamQuery {
    * To examine the results, use a function like `fetch()`, `fetchAll()`,
    * `fetchValue()`, or `fetchMap()`.
    *
-   * @param string|NULL $daoName
+   * @param string|null $daoName
    *   The return object should be an instance of this class.
    *   Ex: 'CRM_Contact_BAO_Contact'.
    * @param bool $i18nRewrite
index f70cbc5d80c42c5168393f06d823d30f4dd9feb4..96970e23c5f4bf0bfb4e9c514dbd907447ebcff6 100644 (file)
@@ -158,7 +158,7 @@ class CRM_Utils_SQL_Insert {
   /**
    * Escape string.
    *
-   * @param string|NULL $value
+   * @param string|null $value
    *
    * @return string
    *   SQL expression, e.g. "it\'s great" (with-quotes) or NULL (without-quotes)
index fa21fbde6feb103ac18b39947a35ca65f25bde13..94452cf94661fecb552a84ca962b805fdfc78a72 100644 (file)
@@ -128,7 +128,7 @@ class CRM_Utils_SQL_Select extends CRM_Utils_SQL_BaseParamQuery {
    * Merge something or other.
    *
    * @param array|CRM_Utils_SQL_Select $other
-   * @param array|NULL $parts
+   * @param array|null $parts
    *   ex: 'joins', 'wheres'
    * @return CRM_Utils_SQL_Select
    */
@@ -180,7 +180,7 @@ class CRM_Utils_SQL_Select extends CRM_Utils_SQL_BaseParamQuery {
    * Note: To add multiple JOINs at once, use $name===NULL and
    * pass an array of $exprs.
    *
-   * @param string|NULL $name
+   * @param string|null $name
    *   The effective alias of the joined table.
    * @param string|array $exprs
    *   The complete join expression (eg "INNER JOIN mytable myalias ON mytable.id = maintable.foo_id").
@@ -443,7 +443,7 @@ class CRM_Utils_SQL_Select extends CRM_Utils_SQL_BaseParamQuery {
   }
 
   /**
-   * @param array|NULL $parts
+   * @param array|null $parts
    *   List of fields to check (e.g. 'selects', 'joins').
    *   Defaults to all.
    * @return bool
@@ -540,7 +540,7 @@ class CRM_Utils_SQL_Select extends CRM_Utils_SQL_BaseParamQuery {
    * To examine the results, use a function like `fetch()`, `fetchAll()`,
    * `fetchValue()`, or `fetchMap()`.
    *
-   * @param string|NULL $daoName
+   * @param string|null $daoName
    *   The return object should be an instance of this class.
    *   Ex: 'CRM_Contact_BAO_Contact'.
    * @param bool $i18nRewrite
index 89ed932432e7d33f5435263676d62ce2162d9341..567b282d561bf1103ff0555923746f250769b725 100644 (file)
@@ -187,7 +187,7 @@ class CRM_Utils_SQL_TempTable {
   /**
    * @param string $action
    *   Ex: 'CREATE', 'DROP'
-   * @param string|NULL $ifne
+   * @param string|null $ifne
    *   Ex: 'IF EXISTS', 'IF NOT EXISTS'.
    * @return string
    *   Ex: 'CREATE TEMPORARY TABLE `civicrm_tmp_e_foo_abcd1234`'
@@ -268,7 +268,7 @@ class CRM_Utils_SQL_TempTable {
   }
 
   /**
-   * @param string|NULL $category
+   * @param string|null $category
    *
    * @return CRM_Utils_SQL_TempTable
    */
index 6ff102bfc30efc7dc3c911300f3b4dc246fa4f91..5ee79d831c24d622da13a9e617cd63a1d92216a6 100644 (file)
@@ -951,7 +951,7 @@ class CRM_Utils_String {
    * safe, standard data interchange formats such as JSON rather than PHP's
    * serialization format when dealing with user input.
    *
-   * @param string|NULL $string
+   * @param string|null $string
    *
    * @return mixed
    */
index f85e484e1f9c634522b8ed7f361c90a869ad574e..29c9bff4566fd6f355deb443a0488f2597d1b22c 100644 (file)
@@ -1247,7 +1247,7 @@ class CRM_Utils_System {
   /**
    * Redirect to SSL.
    *
-   * @param bool|FALSE $abort
+   * @param bool|false $abort
    *
    * @throws \CRM_Core_Exception
    */
@@ -1824,7 +1824,7 @@ class CRM_Utils_System {
   /**
    * Evaluate any tokens in a URL.
    *
-   * @param string|FALSE $url
+   * @param string|false $url
    *
    * @return string|FALSE
    */