Merge pull request #16382 from seamuslee001/crm_var_update

(NFC) Update Var declaration to be standard in CRM folder
civicrm · Jan 26, 2020 · ae1d599 · ae1d599
2 parents 53e5c14 + 51dda21
commit ae1d599
Show file tree

Hide file tree

Showing 17 changed files with 48 additions and 30 deletions.
diff --git a/CRM/Activity/BAO/ICalendar.php b/CRM/Activity/BAO/ICalendar.php
@@ -21,7 +21,8 @@
 class CRM_Activity_BAO_ICalendar {
 
   /**
-   * @var object The activity for which we're generating ical.
+   * @var \CRM_Activity_BAO_ICalendar
+   * The activity for which we're generating ical.
    */
   protected $activity;
 

diff --git a/CRM/Campaign/Form/Petition/Signature.php b/CRM/Campaign/Form/Petition/Signature.php
@@ -40,7 +40,8 @@ class CRM_Campaign_Form_Petition_Signature extends CRM_Core_Form {
   /**
    * The contact type
    *
-   * @var string ("Individual"/"Household"/"Organization"). Never been tested for something else than Individual
+   * @var string
+   * ("Individual"/"Household"/"Organization"). Never been tested for something else than Individual
    */
   protected $_ctype = 'Individual';
 

diff --git a/CRM/Case/XMLRepository.php b/CRM/Case/XMLRepository.php
@@ -22,7 +22,8 @@ class CRM_Case_XMLRepository {
   private static $singleton;
 
   /**
-   * @var array<String,SimpleXMLElement>
+   * @var array
+   * <String,SimpleXMLElement>
    */
   protected $xml = [];
 

diff --git a/CRM/Contact/Form/Search/Custom/Group.php b/CRM/Contact/Form/Search/Custom/Group.php
@@ -19,42 +19,46 @@ class CRM_Contact_Form_Search_Custom_Group extends CRM_Contact_Form_Search_Custo
   protected $_formValues;
 
   /**
-   * @var CRM_Utils_SQL_TemTable Object
+   * @var \CRM_Utils_SQL_TemTable
    */
   protected $_xGTable = NULL;
 
   /**
-   * @var CRM_Utils_SQL_TempTable object
+   * @var \CRM_Utils_SQL_TempTable
    */
   protected $_iGTable = NULL;
 
   /**
-   * @var string Table Name for xclude Groups
+   * @var string
+   * Table Name for xclude Groups
    */
   protected $_xGTableName = NULL;
 
   /**
-   * @var string Table Name for Inclue Groups
+   * @var string
+   * Table Name for Inclue Groups
    */
   protected $_iGTableName = NULL;
 
   /**
-   * @var CRM_Utils_SQL_TemTable Object
+   * @var \CRM_Utils_SQL_TempTable
    */
   protected $_xTTable = NULL;
 
   /**
-   * @var CRM_Utils_SQL_TempTable object
+   * @var \CRM_Utils_SQL_TempTable
    */
   protected $_iTTable = NULL;
 
   /**
-   * @var string Table Name for xclude Groups
+   * @var string
+   * Table Name for xclude Groups
    */
   protected $_xTTableName = NULL;
 
   /**
-   * @var string Table Name for Inclue Groups
+   * @var string
+   * Table Name for Inclue Groups
    */
   protected $_iTTableName = NULL;
 

diff --git a/CRM/Contribute/BAO/Contribution.php b/CRM/Contribute/BAO/Contribution.php
@@ -50,7 +50,8 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution {
    * This is used for composing messages because they have dependency on the
    * contribution_page or event page - although over time we may eliminate that
    *
-   * @var "contribution"\"event"
+   * @var string
+   * "contribution"\"event"
    */
   public $_component = NULL;
 

diff --git a/CRM/Extension/Container/Basic.php b/CRM/Extension/Container/Basic.php
@@ -35,28 +35,31 @@ class CRM_Extension_Container_Basic implements CRM_Extension_Container_Interface
   public $baseUrl;
 
   /**
-   * @var CRM_Utils_Cache_Interface|NULL
+   * @var CRM_Utils_Cache_Interface|null
    *
    * Note: Treat as private. This is only public to facilitate debugging.
    */
   public $cache;
 
   /**
-   * @var string the cache key used for any data stored by this container
+   * @var string
+   * The cache key used for any data stored by this container
    *
    * Note: Treat as private. This is only public to facilitate debugging.
    */
   public $cacheKey;
 
   /**
-   * @var array($key => $relPath)
+   * @var array
+   * ($key => $relPath)
    *
    * Note: Treat as private. This is only public to facilitate debugging.
    */
   public $relPaths = FALSE;
 
   /**
-   * @var array($key => $relUrl)
+   * @var array
+   * ($key => $relUrl)
    *
    * Derived from $relPaths. On Unix systems (where file-paths and
    * URL-paths both use '/' separator), this isn't necessary. On Windows

diff --git a/CRM/Extension/Downloader.php b/CRM/Extension/Downloader.php
@@ -17,12 +17,14 @@
  */
 class CRM_Extension_Downloader {
   /**
-   * @var CRM_Extension_Container_Basic the place where downloaded extensions are ultimately stored
+   * @var CRM_Extension_Container_Basic
+   * The place where downloaded extensions are ultimately stored
    */
   public $container;
 
   /**
-   * @var string local path to a temporary data directory
+   * @var string
+   * Local path to a temporary data directory
    */
   public $tmpDir;
 

diff --git a/CRM/Extension/Mapper.php b/CRM/Extension/Mapper.php
@@ -45,7 +45,8 @@ class CRM_Extension_Mapper {
   protected $container;
 
   /**
-   * @var array (key => CRM_Extension_Info)
+   * @var \CRM_Extension_Info[]
+   * (key => CRM_Extension_Info)
    */
   protected $infos = [];
 

diff --git a/CRM/Profile/Form.php b/CRM/Profile/Form.php
@@ -50,7 +50,8 @@ class CRM_Profile_Form extends CRM_Core_Form {
   protected $_gid;
 
   /**
-   * @var array details of the UFGroup used on this page
+   * @var array
+   * Details of the UFGroup used on this page
    */
   protected $_ufGroup = ['name' => 'unknown'];
 

diff --git a/CRM/Queue/Runner.php b/CRM/Queue/Runner.php
@@ -50,7 +50,8 @@ class CRM_Queue_Runner {
   public $qrid;
 
   /**
-   * @var array whether to display buttons, eg ('retry' => TRUE, 'skip' => FALSE)
+   * @var array
+   * Whether to display buttons, eg ('retry' => TRUE, 'skip' => FALSE)
    */
   public $buttons;
 

diff --git a/CRM/Queue/Task.php b/CRM/Queue/Task.php
@@ -25,17 +25,19 @@ class CRM_Queue_Task {
   const TASK_FAIL = 2;
 
   /**
-   * @var mixed, serializable
+   * @var mixed
+   * serializable
    */
   public $callback;
 
   /**
-   * @var array, serializable
+   * @var array
+   * serializable
    */
   public $arguments;
 
   /**
-   * @var string, NULL-able
+   * @var string|null
    */
   public $title;
 

diff --git a/CRM/Report/BAO/Hook.php b/CRM/Report/BAO/Hook.php
@@ -24,7 +24,7 @@
 class CRM_Report_BAO_Hook {
 
   /**
-   * @var array of CRM_Report_BAO_HookInterface objects
+   * @var \CRM_Report_BAO_HookInterface[]
    */
   protected $_queryObjects = NULL;
 

diff --git a/CRM/Upgrade/Incremental/php/FiveTwenty.php b/CRM/Upgrade/Incremental/php/FiveTwenty.php
@@ -14,7 +14,7 @@
 class CRM_Upgrade_Incremental_php_FiveTwenty extends CRM_Upgrade_Incremental_Base {
 
   /**
-   * @var $relationshipTypes array
+   * @var array
    *   api call result keyed on relationship_type.id
    */
   protected static $relationshipTypes;

diff --git a/CRM/Utils/Cache/Memcache.php b/CRM/Utils/Cache/Memcache.php
@@ -69,7 +69,7 @@ class CRM_Utils_Cache_Memcache implements CRM_Utils_Cache_Interface {
   protected $_cache;
 
   /**
-   * @var NULL|array
+   * @var null|array
    *
    * This is the effective prefix. It may be bumped up whenever the dataset is flushed.
    *

diff --git a/CRM/Utils/Cache/Memcached.php b/CRM/Utils/Cache/Memcached.php
@@ -70,7 +70,7 @@ class CRM_Utils_Cache_Memcached implements CRM_Utils_Cache_Interface {
   protected $_cache;
 
   /**
-   * @var NULL|array
+   * @var null|array
    *
    * This is the effective prefix. It may be bumped up whenever the dataset is flushed.
    *

diff --git a/CRM/Utils/Check/Component/Case.php b/CRM/Utils/Check/Component/Case.php
@@ -24,7 +24,7 @@ class CRM_Utils_Check_Component_Case extends CRM_Utils_Check_Component {
   protected $xmlRepo;
 
   /**
-   * @var array<string>
+   * @var string[]
    */
   protected $caseTypeNames;
 

diff --git a/CRM/Utils/Wrapper.php b/CRM/Utils/Wrapper.php
@@ -25,7 +25,7 @@ class CRM_Utils_Wrapper {
    * Simple Controller.
    *
    * The controller which will handle the display and processing of this page.
-   * @var \CRM_Core_Controller_Simple object
+   * @var \CRM_Core_Controller_Simple
    */
   protected $_controller;