PHPDoc corrections

CRM/Case/Form/Activity.php

@@ -23,14 +23,14 @@ class CRM_Case_Form_Activity extends CRM_Activity_Form_Activity {
   /**
    * Cases this activity belongs to.
    *
-   * @var []int
+   * @var int[]
    */
   public $_caseId;
 
   /**
    * The default case type variable defined.
    *
-   * @var []int
+   * @var int[]
    */
   public $_caseType;
 

CRM/Case/XMLProcessor/Process.php

@@ -78,7 +78,7 @@ public function get($caseType, $fieldSet, $isLabel = FALSE, $maskAction = FALSE)
   }
 
   /**
-   * @param $xml
+   * @param SimpleXMLElement $xml
    * @param array $params
    *
    * @throws Exception

CRM/Contact/BAO/ContactType.php

@@ -526,7 +526,7 @@ public static function self_hook_civicrm_post(\Civi\Core\Event\PostEvent $event)
    * @param array $params
    *   An assoc array of name/value pairs.
    *
-   * @return object|void
+   * @return CRM_Contact_DAO_ContactType|NULL
    * @throws \CRM_Core_Exception
    */
   public static function add($params) {

CRM/Contact/BAO/RelationshipType.php

@@ -129,7 +129,7 @@ public static function self_hook_civicrm_pre(PreEvent $event): void {
    * We check that contact_type_a is Individual, but not contact_type_b because there's
    * nowhere in the code that requires it to be Organization.
    *
-   * @return int|string
+   * @return int
    *
    * @throws \CRM_Core_Exception
    */

CRM/Contribute/Import/Parser/Contribution.php

@@ -501,7 +501,7 @@ public function import(array $values): void {
    *
    * @throws \CRM_Core_Exception
    *
-   * @return array|null
+   * @return array
    */
   private function lookupContribution(array $params): array {
     $where = [];

CRM/Core/Payment/FirstData.php

@@ -138,7 +138,7 @@ public function mapProcessorFieldstoParams($params) {
    * This function sends request and receives response from
    * the processor
    *
-   * @param array|PropertyBag $params
+   * @param array|\Civi\Payment\PropertyBag $params
    *
    * @param string $component
    *

CRM/Core/Payment/PayJunction.php

@@ -41,7 +41,7 @@ public function __construct($mode, &$paymentProcessor) {
    * This function sends request and receives response from
    * PayJunction payment process
    *
-   * @param array|PropertyBag $params
+   * @param array|\Civi\Payment\PropertyBag $params
    *
    * @param string $component
    *

CRM/Core/Smarty/plugins/function.crmKey.php

@@ -18,7 +18,7 @@
 /**
  * Generate a CRM_Core_Key of a given name
  *
- * @param string $params
+ * @param array $params
  *   Params of the {crmKey} call, with the ‘name’ key holding the name of the key.
  * @param CRM_Core_Smarty $smarty
  *   The Smarty object.

CRM/Event/Page/ParticipantListing/Simple.php

@@ -22,6 +22,9 @@ class CRM_Event_Page_ParticipantListing_Simple extends CRM_Core_Page {
 
   protected $_eventTitle;
 
+  /**
+   * @var CRM_Utils_Pager
+   */
   protected $_pager;
 
   public function preProcess() {

CRM/Event/Selector/Search.php

@@ -516,7 +516,7 @@ public function alphabetQuery() {
   }
 
   /**
-   * @return string
+   * @return CRM_Contact_BAO_Query
    */
   public function &getQuery() {
     return $this->_query;

CRM/Export/Form/Select.php

@@ -428,7 +428,7 @@ protected function isShowContactMergeOptions() {
   /**
    * Get the name of the component.
    *
-   * @return array
+   * @return string
    */
   protected function getComponentName(): string {
     // CRM_Export_Controller_Standalone has this method

CRM/Financial/BAO/Order.php

@@ -1125,7 +1125,7 @@ protected function addTotalsToLineBasedOnOverrideTotal(int $financialTypeID, arr
   /**
    * Get the line items from a template.
    *
-   * @return \Civi\Api4\Generic\Result
+   * @return array
    *
    * @throws \CRM_Core_Exception
    */

CRM/Mailing/Event/BAO/MailingEventReply.php

@@ -34,7 +34,7 @@ class CRM_Mailing_Event_BAO_MailingEventReply extends CRM_Mailing_Event_DAO_Mail
    *
    * @param null $replyto
    *
-   * @return object|null
+   * @return CRM_Mailing_BAO_Mailing|null
    *   The mailing object, or null on failure
    */
   public static function &reply($job_id, $queue_id, $hash, $replyto = NULL) {
@@ -78,7 +78,7 @@ public static function &reply($job_id, $queue_id, $hash, $replyto = NULL) {
    *
    * @param int $queue_id
    *   Queue event ID of the sender.
-   * @param string $mailing
+   * @param CRM_Mailing_BAO_Mailing $mailing
    *   The mailing object.
    * @param string $bodyTxt
    *   Text part of the body (ignored if $fullEmail provided).

CRM/Utils/Date.php

@@ -2231,7 +2231,7 @@ public static function convertFormDateToApiFormat(&$params, $dateField, $isDateP
   /**
    * Print out a date object in specified format in local timezone
    *
-   * @param DateTimeObject $dateObject
+   * @param DateTimeInterface $dateObject
    * @param string $format
    * @return string
    */

CRM/Utils/String.php

@@ -670,8 +670,8 @@ public static function ellipsify($string, $maxLen) {
   /**
    * Generate a random string.
    *
-   * @param $len
-   * @param $alphabet
+   * @param int $len
+   * @param string $alphabet
    * @return string
    */
   public static function createRandom($len, $alphabet) {

Civi/Api4/Query/SqlEquation.php

@@ -76,7 +76,7 @@ public function getArgs(): array {
   /**
    * Render the expression for insertion into the sql query
    *
-   * @param Civi\Api4\Query\Api4SelectQuery $query
+   * @param \Civi\Api4\Query\Api4SelectQuery $query
    * @return string
    */
   public function render(Api4SelectQuery $query): string {

Civi/Api4/Query/SqlExpression.php

@@ -140,7 +140,7 @@ public function getFields(): array {
   /**
    * Renders expression to a sql string, replacing field names with column names.
    *
-   * @param Civi\Api4\Query\Api4SelectQuery $query
+   * @param \Civi\Api4\Query\Api4SelectQuery $query
    * @return string
    */
   abstract public function render(Api4SelectQuery $query): string;

Civi/Api4/Query/SqlFunction.php

@@ -106,7 +106,7 @@ public function formatOutputValue($value, &$dataType) {
   /**
    * Render the expression for insertion into the sql query
    *
-   * @param Civi\Api4\Query\Api4SelectQuery $query
+   * @param \Civi\Api4\Query\Api4SelectQuery $query
    * @return string
    */
   public function render(Api4SelectQuery $query): string {
@@ -122,7 +122,7 @@ public function render(Api4SelectQuery $query): string {
 
   /**
    * @param array $arg
-   * @param Civi\Api4\Query\Api4SelectQuery $query
+   * @param \Civi\Api4\Query\Api4SelectQuery $query
    * @return string
    */
   private function renderArg($arg, Api4SelectQuery $query): string {

Civi/Core/CiviEventDispatcher.php

@@ -21,7 +21,7 @@ class CiviEventDispatcher implements CiviEventDispatcherInterface {
   const DEFAULT_HOOK_PRIORITY = -100;
 
   /**
-   * @var Symfony\Component\EventDispatcher\EventDispatcher
+   * @var \Symfony\Component\EventDispatcher\EventDispatcher
    */
   private $dispatcher;
 

ext/search_kit/Civi/Api4/Service/Spec/Provider/SearchSegmentExtraFieldProvider.php

@@ -71,7 +71,7 @@ private static function getSets($entity) {
    * Generates the sql case statement with a clause for each item.
    *
    * @param array $field
-   * @param Civi\Api4\Query\Api4SelectQuery $query
+   * @param \Civi\Api4\Query\Api4SelectQuery $query
    * @return string
    */
   public static function renderSql(array $field, Api4SelectQuery $query): string {