Another set of PHPDoc fixes

CRM/ACL/BAO/ACLEntityRole.php

@@ -35,7 +35,7 @@ public static function entityTables(): array {
   /**
    * @param array $params
    *
-   * @return CRM_ACL_DAO_EntityRole
+   * @return CRM_ACL_BAO_ACLEntityRole
    */
   public static function create(&$params) {
     return self::writeRecord($params);

CRM/Activity/Controller/Search.php

@@ -33,7 +33,7 @@ class CRM_Activity_Controller_Search extends CRM_Core_Controller {
   /**
    * Class constructor.
    *
-   * @param null $title
+   * @param string $title
    * @param bool $modal
    * @param int|mixed|null $action
    */

CRM/Admin/Form/Job.php

@@ -116,7 +116,7 @@ public function buildQuickForm($check = FALSE) {
   }
 
   /**
-   * @param $fields
+   * @param array $fields
    *
    * @return array|bool
    * @throws API_Exception

CRM/Admin/Form/PaymentProcessor.php

@@ -269,7 +269,7 @@ public function buildQuickForm($check = FALSE) {
   }
 
   /**
-   * @param $fields
+   * @param array $fields
    *
    * @return array|bool
    */
@@ -297,7 +297,7 @@ public static function formRule($fields) {
   /**
    * @param array $fields
    * @param array $errors
-   * @param null $section
+   * @param string|null $section
    *
    * @return bool
    */

CRM/Admin/Form/Preferences/Address.php

@@ -46,7 +46,7 @@ public function buildQuickForm() {
   }
 
   /**
-   * @param $fields
+   * @param array $fields
    *
    * @return bool
    */

CRM/Admin/Form/Setting/Localization.php

@@ -98,7 +98,7 @@ public function buildQuickForm() {
   }
 
   /**
-   * @param $fields
+   * @param array $fields
    *
    * @return array|bool
    */

CRM/Admin/Form/Setting/Url.php

@@ -48,7 +48,7 @@ public function buildQuickForm() {
   }
 
   /**
-   * @param $fields
+   * @param array $fields
    *
    * @return array|bool
    */

CRM/Admin/Page/MessageTemplates.php

@@ -40,8 +40,8 @@ class CRM_Admin_Page_MessageTemplates extends CRM_Core_Page_Basic {
   protected $_revertedId;
 
   /**
-   * @param null $title
-   * @param null $mode
+   * @param string $title
+   * @param int $mode
    */
   public function __construct($title = NULL, $mode = NULL) {
     parent::__construct($title, $mode);

CRM/Badge/BAO/Badge.php

@@ -147,7 +147,7 @@ public static function formatLabel(&$row, &$layout) {
   }
 
   /**
-   * @param $formattedRow
+   * @param array $formattedRow
    */
   public function generateLabel($formattedRow) {
     switch ($formattedRow['labelFormat']) {
@@ -164,7 +164,7 @@ public function generateLabel($formattedRow) {
   }
 
   /**
-   * @param $formattedRow
+   * @param array $formattedRow
    * @param int $cellspacing
    */
   public function labelCreator(&$formattedRow, $cellspacing = 0) {
@@ -349,13 +349,12 @@ public function labelCreator(&$formattedRow, $cellspacing = 0) {
    *
    * @param string $img
    *   Image url.
-   *
-   * @param string $x
-   * @param string $y
-   * @param null $w
-   * @param null $h
+   * @param string|null $x
+   * @param string|null $y
+   * @param int|null $w
+   * @param int|null $h
    */
-  public function printImage($img, $x = '', $y = '', $w = NULL, $h = NULL) {
+  public function printImage($img, $x = NULL, $y = NULL, $w = NULL, $h = NULL) {
     if (!$x) {
       $x = $this->pdf->GetAbsX();
     }
@@ -375,12 +374,14 @@ public function printImage($img, $x = '', $y = '', $w = NULL, $h = NULL) {
   }
 
   /**
-   * @param $img
+   * @param string $img
+   *   Filename
    * @param int $imgRes
-   * @param null $w
-   * @param null $h
+   * @param int|null $w
+   * @param int|null $h
    *
-   * @return array
+   * @return int[]
+   *   [width, height]
    */
   public static function getImageProperties($img, $imgRes = 300, $w = NULL, $h = NULL) {
     $imgsize = getimagesize($img);

CRM/Campaign/Controller/Search.php

@@ -33,7 +33,7 @@ class CRM_Campaign_Controller_Search extends CRM_Core_Controller {
   /**
    * Class constructor.
    *
-   * @param null $title
+   * @param string $title
    * @param bool|int $action
    * @param bool $modal
    */

CRM/Case/BAO/Case.php

@@ -1515,16 +1515,16 @@ public static function restoreCase($caseId) {
   }
 
   /**
-   * @param $groupInfo
+   * @param array $groupInfo
    * @param null $sort
-   * @param null $showLinks
+   * @param bool $showLinks
    * @param bool $returnOnlyCount
    * @param int $offset
    * @param int $rowCount
    *
    * @return array
    */
-  public static function getGlobalContacts(&$groupInfo, $sort = NULL, $showLinks = NULL, $returnOnlyCount = FALSE, $offset = 0, $rowCount = 25) {
+  public static function getGlobalContacts(&$groupInfo, $sort = NULL, $showLinks = FALSE, $returnOnlyCount = FALSE, $offset = 0, $rowCount = 25) {
     $globalContacts = [];
 
     $settingsProcessor = new CRM_Case_XMLProcessor_Settings();

CRM/Case/PseudoConstant.php

@@ -26,7 +26,7 @@ class CRM_Case_PseudoConstant extends CRM_Core_PseudoConstant {
    *
    * @param string $column
    * @param bool $onlyActive
-   * @param null $condition
+   * @param string|null $condition
    * @param bool $fresh
    *
    * @return array

CRM/Case/Selector/Search.php

@@ -167,7 +167,7 @@ public function __construct(
    * - Edit
    *
    * @param bool $isDeleted
-   * @param null $key
+   * @param string|null $key
    *
    * @return array
    */

CRM/Case/XMLProcessor/Report.php

@@ -556,7 +556,7 @@ public function getCustomData($clientID, $activityDAO, &$activityTypeInfo) {
 
   /**
    * @param int $activityTypeID
-   * @param null $dateFormat
+   * @param string|null $dateFormat
    * @param bool $onlyActive
    *
    * @return mixed

CRM/Contact/BAO/Contact.php

@@ -1767,7 +1767,7 @@ public static function getHierContactDetails($contactId, $fields) {
    *
    * This is for the query to use, create the right sql.
    *
-   * @param $fields
+   * @param array $fields
    * @param int $contactId
    *   Contact id.
    *
@@ -1844,7 +1844,7 @@ public static function &makeHierReturnProperties($fields, $contactId = NULL) {
    *
    * @param int $contactId
    * @param bool $skipDefaultPrimary
-   * @param null $block
+   * @param string|null $block
    *
    * @return int|NULL
    *   $locationType location_type_id
@@ -2106,10 +2106,10 @@ public static function createProfileContact(
    * Format profile contact parameters.
    *
    * @param array $params
-   * @param $fields
-   * @param int $contactID
-   * @param int $ufGroupId
-   * @param null $ctype
+   * @param array $fields
+   * @param int|null $contactID
+   * @param int|null $ufGroupId
+   * @param string|null $ctype
    * @param bool $skipCustom
    *
    * @return array
@@ -2696,7 +2696,7 @@ public static function getValues(&$params, &$values) {
    * @param string $tableName
    *   Optional tableName if component is custom group.
    *
-   * @return int
+   * @return int|false
    *   total number in database
    */
   public static function getCountComponent($component, $contactId, $tableName = NULL) {
@@ -3367,8 +3367,8 @@ public static function getTimestamps($contactId) {
   /**
    * Get a list of triggers for the contact table.
    *
-   * @param $info
-   * @param null $tableName
+   * @param array $info
+   * @param string|null $tableName
    *
    * @see http://issues.civicrm.org/jira/browse/CRM-10554
    *

CRM/Contact/BAO/Contact/Location.php

@@ -65,8 +65,7 @@ public static function getEmailDetails($id, $isPrimary = TRUE, $locationTypeID =
    *
    * @param int $id
    *   Id of the contact.
-   *
-   * @param null $type
+   * @param string|null $type
    *
    * @return array
    *   tuple of display_name and sms if found, or (null,null)

CRM/Contact/BAO/Contact/Permission.php

@@ -504,7 +504,7 @@ public static function validateOnlyChecksum($contactID, &$form, $redirect = TRUE
 
   /**
    * @param bool $checkSumValidationResult
-   * @param null $form
+   * @param CRM_Core_Form|null $form
    */
   public static function initChecksumAuthSrc($checkSumValidationResult = FALSE, $form = NULL) {
     $session = CRM_Core_Session::singleton();

CRM/Contact/BAO/Contact/Utils.php

@@ -135,9 +135,8 @@ public static function checkContactType(&$contactIds) {
    *   Life of this checksum in hours/ 'inf' for infinite.
    * @param string $hash
    *   Contact hash, if sent, prevents a query in inner loop.
-   *
    * @param string $entityType
-   * @param null $hashSize
+   * @param int|null $hashSize
    *
    * @return string
    *   (Underscore separated: $cs, $ts, $live )
@@ -245,9 +244,9 @@ public static function validChecksum($contactID, $inputCheck) {
    *
    * @param int $contactID
    *   Contact id of the individual.
-   * @param $employerID
+   * @param int|string $employerID
    *   (id or name).
-   * @param null $previousEmployerID
+   * @param int|null $previousEmployerID
    * @param bool $newContact
    *
    * @throws \API_Exception
@@ -258,7 +257,7 @@ public static function createCurrentEmployerRelationship($contactID, $employerID
     if (!$employerID) {
       // This function is not called in core with no organization & should not be
       // Refs CRM-15368,CRM-15547
-      CRM_Core_Error::deprecatedWarning('calling this function with no organization is deprected');
+      CRM_Core_Error::deprecatedWarning('calling this function with no organization is deprecated');
       return;
     }
     if (!is_numeric($employerID)) {

CRM/Contact/BAO/ContactType.php

@@ -212,8 +212,8 @@ public static function contactTypeInfo($all = FALSE) {
    * Retrieve basic type pairs with name as 'built-in name' and 'label' as value.
    *
    * @param bool $all
-   * @param null $typeName
-   * @param null $delimiter
+   * @param array|string|null $typeName
+   * @param string|null $delimiter
    *
    * @return array|string
    *   Array of basictypes with name as 'built-in name' and 'label' as value

CRM/Contact/BAO/GroupContactCache.php

@@ -309,7 +309,7 @@ public static function deterministicCacheFlush() {
    * Remove one or more contacts from the smart group cache.
    *
    * @param int|array $cid
-   * @param null $groupId
+   * @param int|null $groupId
    *
    * @return bool
    *   TRUE if successful.

CRM/Contact/BAO/Relationship.php

@@ -1701,7 +1701,7 @@ public static function isRelatedMembershipExpired($membershipTypeRelationshipTyp
   /**
    * Get Current Employer for Contact.
    *
-   * @param $contactIds
+   * @param array $contactIds
    *   Contact Ids.
    *
    * @return array
@@ -2186,7 +2186,7 @@ private static function isRelationshipTypeCurrentEmployer(int $existingTypeID):
   /**
    * Is the inherited relationship invalidated by this relationship change.
    *
-   * @param $membershipValues
+   * @param array $membershipValues
    * @param array $values
    * @param int $cid
    *

CRM/Contact/BAO/SearchCustom.php

@@ -114,7 +114,7 @@ public static function contactIDSQL($csID, $ssID) {
   }
 
   /**
-   * @param $args
+   * @param string $args
    *
    * @return array
    */

CRM/Contact/Form/Contact.php

@@ -1143,7 +1143,7 @@ public static function blockDataExists(&$fields) {
    *
    * @param array $fields
    *   Fields array which are submitted.
-   * @param $errors
+   * @param array $errors
    * @param int $contactID
    *   Contact id.
    * @param string $contactType

CRM/Contact/Form/Relationship.php

@@ -473,7 +473,7 @@ protected function setMessage($outcome) {
   }
 
   /**
-   * @param $relationshipList
+   * @param array $relationshipList
    *
    * @return array
    */

CRM/Contact/Form/Task/LabelCommon.php

@@ -54,10 +54,10 @@ public static function createLabel($contactRows, $format, $fileName = 'MailingLa
   /**
    * Get the rows for the labels.
    *
-   * @param $contactIDs
+   * @param array $contactIDs
    * @param int $locationTypeID
    * @param bool $respectDoNotMail
-   * @param $mergeSameAddress
+   * @param bool $mergeSameAddress
    * @param bool $mergeSameHousehold
    *   UNUSED.
    *

CRM/Contact/Import/Controller.php

@@ -19,7 +19,7 @@ class CRM_Contact_Import_Controller extends CRM_Core_Controller {
   /**
    * Class constructor.
    *
-   * @param null $title
+   * @param string $title
    * @param bool|int $action
    * @param bool $modal
    */

CRM/Contact/Import/ImportJob.php

@@ -46,8 +46,8 @@ class CRM_Contact_Import_ImportJob {
   protected $_parser;
 
   /**
-   * @param null $tableName
-   * @param null $createSql
+   * @param string|null $tableName
+   * @param string|null $createSql
    * @param bool $createTable
    *
    * @throws \CRM_Core_Exception