(NFC) Civi/API - Update for Drupal.Commenting.VariableComment.IncorrectVarType

diff --git a/Civi/API/Kernel.php b/Civi/API/Kernel.php
index 651b0861a4a65259214418ed4e117cad14ae6d10..c23658b952912e416dd996f6546249c764a045b7 100644 (file)
--- a/Civi/API/Kernel.php
+++ b/Civi/API/Kernel.php
@@ -28,7 +28,7 @@ class Kernel {
   protected $dispatcher;
 
   /**
-   * @var array<ProviderInterface>
+   * @var \Civi\API\Provider\ProviderInterface[]
    */
   protected $apiProviders;
 

diff --git a/Civi/API/Provider/AdhocProvider.php b/Civi/API/Provider/AdhocProvider.php
index aad4255c928176b6c63d336edfee69a3ffeba790..fcab72e1821f73283a499ebb38848438e4f8c661 100644 (file)
--- a/Civi/API/Provider/AdhocProvider.php
+++ b/Civi/API/Provider/AdhocProvider.php
@@ -37,7 +37,11 @@ class AdhocProvider implements EventSubscriberInterface, ProviderInterface {
   }
 
   /**
-   * @var array (string $name => array('perm' => string, 'callback' => callable))
+   * List of adhoc actions
+   *
+   * array(string $ame => array('perm' => string, 'callback' => callable))
+   *
+   * @var array
    */
   protected $actions = [];
 

diff --git a/Civi/API/Provider/MagicFunctionProvider.php b/Civi/API/Provider/MagicFunctionProvider.php
index cdeaab339f8cb15860b81e0052853bc1cf4485e5..8fab3ff19cabb41f1716b230bddae8b007147ea5 100644 (file)
--- a/Civi/API/Provider/MagicFunctionProvider.php
+++ b/Civi/API/Provider/MagicFunctionProvider.php
@@ -32,7 +32,11 @@ class MagicFunctionProvider implements EventSubscriberInterface, ProviderInterfa
   }
 
   /**
-   * @var array (string $cachekey => array('function' => string, 'is_generic' => bool))
+   * Local cache of function-mappings.
+   *
+   * array(string $cacheKey => array('function' => string, 'is_generic' => bool))
+   *
+   * @var array
    */
   private $cache;
 

diff --git a/Civi/API/Provider/ReflectionProvider.php b/Civi/API/Provider/ReflectionProvider.php
index 3d8e8eed724a9b329fdb2a3eb0275c488706831e..514b8469312592e879b06028992195b4cf2d561c 100644 (file)
--- a/Civi/API/Provider/ReflectionProvider.php
+++ b/Civi/API/Provider/ReflectionProvider.php
@@ -41,7 +41,11 @@ class ReflectionProvider implements EventSubscriberInterface, ProviderInterface
   private $apiKernel;
 
   /**
-   * @var array (string $entityName => array(string $actionName))
+   * List of all entities and their supported actions
+   *
+   * array(string $entityName => string[] $actionNames).
+   *
+   * @var array
    */
   private $actions;
 

diff --git a/Civi/API/Subscriber/DynamicFKAuthorization.php b/Civi/API/Subscriber/DynamicFKAuthorization.php
index 29374172ff5647ea992792810200f539c0828799..7747d0a6285ecfbdcfbbf9e256c27bfb7dda31ce 100644 (file)
--- a/Civi/API/Subscriber/DynamicFKAuthorization.php
+++ b/Civi/API/Subscriber/DynamicFKAuthorization.php
@@ -50,17 +50,21 @@ class DynamicFKAuthorization implements EventSubscriberInterface {
   public $kernel;
 
   /**
-   * @var string, the entity for which we want to manage permissions
+   * The entity for which we want to manage permissions.
+   *
+   * @var string
    */
   protected $entityName;
 
   /**
-   * @var array <string> the actions for which we want to manage permissions
+   * The actions for which we want to manage permissions
+   *
+   * @var string[]
    */
   protected $actions;
 
   /**
-   * @var string, SQL. Given a file ID, determine the entity+table it's attached to.
+   * SQL SELECT query - Given a file ID, determine the entity+table it's attached to.
    *
    * ex: "SELECT if(cf.id,1,0) as is_valid, cef.entity_table, cef.entity_id
    * FROM civicrm_file cf
@@ -72,14 +76,18 @@ class DynamicFKAuthorization implements EventSubscriberInterface {
    *  - is_valid: "1" if %1 identifies an actual record; otherwise "0"
    *  - entity_table: NULL or the name of a related table
    *  - entity_id: NULL or the ID of a row in the related table
+   *
+   * @var string
    */
   protected $lookupDelegateSql;
 
   /**
-   * @var string, SQL. Get a list of (field_name, table_name, extends) tuples.
+   * SQL SELECT query. Get a list of (field_name, table_name, extends) tuples.
    *
    * For example, one tuple might be ("custom_123", "civicrm_value_mygroup_4",
    * "Activity").
+   *
+   * @var string
    */
   protected $lookupCustomFieldSql;
 
@@ -91,7 +99,9 @@ class DynamicFKAuthorization implements EventSubscriberInterface {
   protected $lookupCustomFieldCache;
 
   /**
-   * @var array list of related tables for which FKs are allowed
+   * List of related tables for which FKs are allowed.
+   *
+   * @var array
    */
   protected $allowedDelegates;
 

diff --git a/Civi/API/Subscriber/TransactionSubscriber.php b/Civi/API/Subscriber/TransactionSubscriber.php
index 5680beec225981c86357655c3fe5dc5afaaf4406..8e7ff6a31bdb5df9da145dbfa68e177af45b0902 100644 (file)
--- a/Civi/API/Subscriber/TransactionSubscriber.php
+++ b/Civi/API/Subscriber/TransactionSubscriber.php
@@ -41,15 +41,21 @@ class TransactionSubscriber implements EventSubscriberInterface {
   }
 
   /**
-   * @var array (scalar $apiRequestId => CRM_Core_Transaction $tx)
+   * List of active transaction objects.
+   *
+   * array(scalar $apiRequestId => CRM_Core_Transaction $tx)
+   *
+   * @var array
    */
   private $transactions = [];
 
   /**
-   * @var array (scalar $apiRequestId => bool)
-   *
-   * A list of requests which should be forcibly rolled back to
+   * (Unused?) A list of requests which should be forcibly rolled back to
    * their save points.
+   *
+   * array (scalar $apiRequestId => bool)
+   *
+   * @var array
    */
   private $forceRollback = [];
 

diff --git a/Civi/API/Subscriber/WrapperAdapter.php b/Civi/API/Subscriber/WrapperAdapter.php
index 6a57a5c541a6317c168cf3e1166f15dfdb3e7ea2..6b90161e914aa92fd2a5769e66c763d88c1fa2e9 100644 (file)
--- a/Civi/API/Subscriber/WrapperAdapter.php
+++ b/Civi/API/Subscriber/WrapperAdapter.php
@@ -32,7 +32,7 @@ class WrapperAdapter implements EventSubscriberInterface {
   }
 
   /**
-   * @var array(\API_Wrapper)
+   * @var \API_Wrapper[]
    */
   protected $defaults;