(NFC) Upgrade Civi Folder to the new coder version
authorSeamus Lee <seamuslee001@gmail.com>
Sat, 6 Apr 2019 05:12:54 +0000 (16:12 +1100)
committerSeamus Lee <seamuslee001@gmail.com>
Sat, 6 Apr 2019 05:12:54 +0000 (16:12 +1100)
57 files changed:
Civi/API/Event/PrepareEvent.php
Civi/API/Event/ResolveEvent.php
Civi/API/Exception/NotImplementedException.php
Civi/API/Exception/UnauthorizedException.php
Civi/API/ExternalBatch.php
Civi/API/Kernel.php
Civi/API/Provider/MagicFunctionProvider.php
Civi/API/Provider/ProviderInterface.php
Civi/API/Provider/ReflectionProvider.php
Civi/API/Provider/StaticProvider.php
Civi/API/SelectQuery.php
Civi/API/Subscriber/APIv3SchemaAdapter.php
Civi/API/Subscriber/ChainSubscriber.php
Civi/API/Subscriber/DynamicFKAuthorization.php
Civi/API/Subscriber/I18nSubscriber.php
Civi/API/Subscriber/PermissionCheck.php
Civi/API/Subscriber/TransactionSubscriber.php
Civi/API/Subscriber/WhitelistSubscriber.php
Civi/API/Subscriber/XDebugSubscriber.php
Civi/API/WhitelistRule.php
Civi/ActionSchedule/Event/MailingQueryEvent.php
Civi/ActionSchedule/Event/MappingRegisterEvent.php
Civi/ActionSchedule/Mapping.php
Civi/Angular/Manager.php
Civi/CCase/CaseChangeListener.php
Civi/CCase/Event/CaseChangeEvent.php
Civi/CCase/Events.php
Civi/CiUtil/Arrays.php
Civi/CiUtil/Command/AntagonistCommand.php
Civi/CiUtil/Command/CompareCommand.php
Civi/CiUtil/Command/LsCommand.php
Civi/CiUtil/ComparisonPrinter.php
Civi/CiUtil/CsvPrinter.php
Civi/CiUtil/JenkinsParser.php
Civi/CiUtil/PHPUnitParser.php
Civi/CiUtil/PHPUnitScanner.php
Civi/Core/AssetBuilder.php
Civi/Core/Container.php
Civi/Core/LocalizationInitializer.php
Civi/Core/Resolver.php
Civi/Core/SettingsManager.php
Civi/Core/SqlTrigger/StaticTriggers.php
Civi/Core/SqlTrigger/TimestampTriggers.php
Civi/Core/SqlTriggers.php
Civi/Install/Requirements.php
Civi/Test.php
Civi/Test/Api3TestTrait.php
Civi/Test/CiviEnvBuilder/CallbackStep.php
Civi/Test/CiviEnvBuilder/ExtensionsStep.php
Civi/Test/CiviEnvBuilder/SqlFileStep.php
Civi/Test/CiviEnvBuilder/SqlStep.php
Civi/Test/CiviEnvBuilder/StepInterface.php
Civi/Test/CiviTestListener.php
Civi/Token/AbstractTokenSubscriber.php
Civi/Token/TokenCompatSubscriber.php
Civi/Token/TokenProcessor.php
Civi/Token/TokenRow.php

index 7d8d7738d20620a76397180ce8caa9568380da91..cc06e179ec1fe5729f4c2cea248e099c5ba5f66c 100644 (file)
@@ -32,6 +32,7 @@ namespace Civi\API\Event;
  * @package Civi\API\Event
  */
 class PrepareEvent extends Event {
+
   /**
    * @param array $apiRequest
    *   The full description of the API request.
index b41da5b22b7ad92e4087daa8befb11ac01ad6047..396418649173f00d679f6742100e8f736200c40e 100644 (file)
@@ -32,6 +32,7 @@ namespace Civi\API\Event;
  * @package Civi\API\Event
  */
 class ResolveEvent extends Event {
+
   /**
    * @param array $apiRequest
    *   The full description of the API request.
index 0c263d4f8b472dbb3c1358a893e30433b149df5f..b8f253f13ebdde72c4fecf7fc514335a2621ba3b 100644 (file)
@@ -8,6 +8,7 @@ require_once 'api/Exception.php';
  * @package Civi\API\Exception
  */
 class NotImplementedException extends \API_Exception {
+
   /**
    * @param string $message
    *   The human friendly error message.
index e35cf3faa308ae2eba1e2d819698c8e9bcae0216..4e3bdbf7379e38a517b723f1a97385843dd876df 100644 (file)
@@ -8,6 +8,7 @@ require_once 'api/Exception.php';
  * @package Civi\API\Exception
  */
 class UnauthorizedException extends \API_Exception {
+
   /**
    * @param string $message
    *   The human friendly error message.
index d2f039a85468c02de50c13191af25aa5d6863f65..f9ea3ae69cf271ebb7c66429998fce78fe170722 100644 (file)
@@ -119,7 +119,7 @@ class ExternalBatch {
     while (!empty($this->processes)) {
       usleep(self::POLL_INTERVAL);
       foreach (array_keys($this->processes) as $idx) {
-        /** @var Process $process */
+        /** @var \Symfony\Component\Process\Process $process */
         $process = $this->processes[$idx];
         if (!$process->isRunning()) {
           $parsed = json_decode($process->getOutput(), TRUE);
@@ -179,7 +179,7 @@ class ExternalBatch {
   /**
    * @param array $apiCall
    *   Array with keys: entity, action, params.
-   * @return Process
+   * @return \Symfony\Component\Process\Process
    * @throws \CRM_Core_Exception
    */
   public function createProcess($apiCall) {
index 96167a8e8e477d9536415bbf7051ce48b5dea921..cc0cc3805f2c1934e0eb6baf2b071a78a21727e9 100644 (file)
@@ -31,7 +31,6 @@ use Civi\API\Event\PrepareEvent;
 use Civi\API\Event\ExceptionEvent;
 use Civi\API\Event\ResolveEvent;
 use Civi\API\Event\RespondEvent;
-use Civi\API\Provider\ProviderInterface;
 
 /**
  * @package Civi
@@ -217,7 +216,7 @@ class Kernel {
    *   Array(0 => ProviderInterface, 1 => array $apiRequest).
    */
   public function resolve($apiRequest) {
-    /** @var ResolveEvent $resolveEvent */
+    /** @var \Civi\API\Event\ResolveEvent $resolveEvent */
     $resolveEvent = $this->dispatcher->dispatch(Events::RESOLVE, new ResolveEvent($apiRequest, $this));
     $apiRequest = $resolveEvent->getApiRequest();
     if (!$resolveEvent->getApiProvider()) {
@@ -229,14 +228,14 @@ class Kernel {
   /**
    * Determine if the API request is allowed (under current policy)
    *
-   * @param ProviderInterface $apiProvider
+   * @param \Civi\API\Provider\ProviderInterface $apiProvider
    *   The API provider responsible for executing the request.
    * @param array $apiRequest
    *   The full description of the API request.
    * @throws Exception\UnauthorizedException
    */
   public function authorize($apiProvider, $apiRequest) {
-    /** @var AuthorizeEvent $event */
+    /** @var \Civi\API\Event\AuthorizeEvent $event */
     $event = $this->dispatcher->dispatch(Events::AUTHORIZE, new AuthorizeEvent($apiProvider, $apiRequest, $this));
     if (!$event->isAuthorized()) {
       throw new \Civi\API\Exception\UnauthorizedException("Authorization failed");
@@ -246,7 +245,7 @@ class Kernel {
   /**
    * Allow third-party code to manipulate the API request before execution.
    *
-   * @param ProviderInterface $apiProvider
+   * @param \Civi\API\Provider\ProviderInterface $apiProvider
    *   The API provider responsible for executing the request.
    * @param array $apiRequest
    *   The full description of the API request.
@@ -254,7 +253,7 @@ class Kernel {
    *   The revised API request.
    */
   public function prepare($apiProvider, $apiRequest) {
-    /** @var PrepareEvent $event */
+    /** @var \Civi\API\Event\PrepareEvent $event */
     $event = $this->dispatcher->dispatch(Events::PREPARE, new PrepareEvent($apiProvider, $apiRequest, $this));
     return $event->getApiRequest();
   }
@@ -262,7 +261,7 @@ class Kernel {
   /**
    * Allow third-party code to manipulate the API response after execution.
    *
-   * @param ProviderInterface $apiProvider
+   * @param \Civi\API\Provider\ProviderInterface $apiProvider
    *   The API provider responsible for executing the request.
    * @param array $apiRequest
    *   The full description of the API request.
@@ -272,7 +271,7 @@ class Kernel {
    *   The revised $result.
    */
   public function respond($apiProvider, $apiRequest, $result) {
-    /** @var RespondEvent $event */
+    /** @var \Civi\API\Event\RespondEvent $event */
     $event = $this->dispatcher->dispatch(Events::RESPOND, new RespondEvent($apiProvider, $apiRequest, $result, $this));
     return $event->getResponse();
   }
@@ -287,7 +286,7 @@ class Kernel {
     // Question: Would it better to eliminate $this->apiProviders and just use $this->dispatcher?
     $entityNames = [];
     foreach ($this->getApiProviders() as $provider) {
-      /** @var ProviderInterface $provider */
+      /** @var \Civi\API\Provider\ProviderInterface $provider */
       $entityNames = array_merge($entityNames, $provider->getEntityNames($version));
     }
     $entityNames = array_unique($entityNames);
@@ -307,7 +306,7 @@ class Kernel {
     // Question: Would it better to eliminate $this->apiProviders and just use $this->dispatcher?
     $actionNames = [];
     foreach ($this->getApiProviders() as $provider) {
-      /** @var ProviderInterface $provider */
+      /** @var \Civi\API\Provider\ProviderInterface $provider */
       $actionNames = array_merge($actionNames, $provider->getActionNames($version, $entity));
     }
     $actionNames = array_unique($actionNames);
@@ -345,7 +344,8 @@ class Kernel {
     $data['action'] = \CRM_Utils_Array::value('action', $apiRequest);
 
     if (\CRM_Utils_Array::value('debug', \CRM_Utils_Array::value('params', $apiRequest))
-      && empty($data['trace']) // prevent recursion
+      // prevent recursion
+      && empty($data['trace'])
     ) {
       $data['trace'] = $e->getTraceAsString();
     }
@@ -459,7 +459,7 @@ class Kernel {
   }
 
   /**
-   * @param ProviderInterface $apiProvider
+   * @param \Civi\API\Provider\ProviderInterface $apiProvider
    *   The API provider responsible for executing the request.
    * @return Kernel
    */
index 27324e452e4a7bca5a3f9dcca554bbc8abf27ae6..346b47035987f7e74464c4b587e96f50f8582703 100644 (file)
@@ -35,6 +35,7 @@ use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  * conventions.
  */
 class MagicFunctionProvider implements EventSubscriberInterface, ProviderInterface {
+
   /**
    * @return array
    */
@@ -285,7 +286,8 @@ class MagicFunctionProvider implements EventSubscriberInterface, ProviderInterfa
     }
 
     // Check for standalone action files; to match _civicrm_api_resolve(), only load the first one
-    $loaded_files = []; // array($relativeFilePath => TRUE)
+    // array($relativeFilePath => TRUE)
+    $loaded_files = [];
     $include_dirs = array_unique(explode(PATH_SEPARATOR, get_include_path()));
     foreach ($include_dirs as $include_dir) {
       foreach ([$camelName, 'Generic'] as $name) {
@@ -299,7 +301,8 @@ class MagicFunctionProvider implements EventSubscriberInterface, ProviderInterfa
         foreach ($iterator as $fileinfo) {
           $file = $fileinfo->getFilename();
           if (array_key_exists($file, $loaded_files)) {
-            continue; // action provided by an earlier item on include_path
+            // action provided by an earlier item on include_path
+            continue;
           }
 
           $parts = explode(".", $file);
index c002eeec012781b6e5fc26ea8c739b13574cc644..4fbc8b7e316a3d583c9970a3ff57dc8a9196755b 100644 (file)
 
 namespace Civi\API\Provider;
 
-use Civi\API\Events;
-use Symfony\Component\EventDispatcher\EventSubscriberInterface;
-
 /**
  * An API "provider" provides a means to execute API requests.
  */
 interface ProviderInterface {
+
   /**
    * @param array $apiRequest
    *   The full description of the API request.
index 48a680d29fbb5cacecc3de68cfc4f405ea954f25..e3c74e51833fcd69606830ab32b6b6a1a21fbae8 100644 (file)
@@ -34,6 +34,7 @@ use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  * This class defines operations for inspecting the API's metadata.
  */
 class ReflectionProvider implements EventSubscriberInterface, ProviderInterface {
+
   /**
    * @return array
    */
@@ -68,7 +69,8 @@ class ReflectionProvider implements EventSubscriberInterface, ProviderInterface
     $this->apiKernel = $apiKernel;
     $this->actions = [
       'Entity' => ['get', 'getactions'],
-      '*' => ['getactions'], // 'getfields'
+      // 'getfields'
+      '*' => ['getactions'],
     ];
   }
 
index f4e2701e0530774a12cef84a99049f34edbc3fb6..0a10aee85a95ababc01dd49cad534b598c168bf6 100644 (file)
@@ -102,7 +102,7 @@ class StaticProvider extends AdhocProvider {
    * @param array $apiRequest
    *   The full description of the API request.
    * @return array
-   *    Formatted API result
+   *   Formatted API result
    * @throws \API_Exception
    */
   public function doCreate($apiRequest) {
@@ -131,7 +131,7 @@ class StaticProvider extends AdhocProvider {
    * @param array $apiRequest
    *   The full description of the API request.
    * @return array
-   *    Formatted API result
+   *   Formatted API result
    * @throws \API_Exception
    */
   public function doGet($apiRequest) {
@@ -142,7 +142,7 @@ class StaticProvider extends AdhocProvider {
    * @param array $apiRequest
    *   The full description of the API request.
    * @return array
-   *    Formatted API result
+   *   Formatted API result
    * @throws \API_Exception
    */
   public function doDelete($apiRequest) {
index 9a03d7eb39be703aecc75bb4ea9afcedb7be5a24..f7b61cd8910b11025b36535ae360e4f64db82202 100644 (file)
@@ -25,6 +25,7 @@
  +--------------------------------------------------------------------+
  */
 namespace Civi\API;
+
 use Civi\API\Exception\UnauthorizedException;
 
 /**
index af77d3b7ea5ed066582c97e80db88575a2b84153..e6428711eb4dfb846002957b4ef275cd669f2c7f 100644 (file)
@@ -35,6 +35,7 @@ use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  * and validates that the fields are provided correctly.
  */
 class APIv3SchemaAdapter implements EventSubscriberInterface {
+
   /**
    * @return array
    */
index 5fb27c1ed69ed36576cb2c8d28717e3c2e1e7442..84b55753a0e9f7c23b4b352d06b3381f5173e27d 100644 (file)
@@ -50,6 +50,7 @@ use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  * eg Amy's contact_id).
  */
 class ChainSubscriber implements EventSubscriberInterface {
+
   /**
    * @return array
    */
index 03ba52d0b42bf61b651d48139d26413ea7169cc4..647172ceddfbbdaa99722e652c31ce7716be151e 100644 (file)
@@ -227,7 +227,8 @@ class DynamicFKAuthorization implements EventSubscriberInterface {
     $exception = NULL;
     $self = $this;
     \CRM_Core_Transaction::create(TRUE)->run(function($tx) use ($entity, $action, $entityId, &$exception, $self) {
-      $tx->rollback(); // Just to be safe.
+      // Just to be safe.
+      $tx->rollback();
 
       $params = [
         'version' => 3,
index 632064f3cfa46fc30f7f9a2afd696d61f0a409be..c430928202ba17ce3ee49a709a0485c305d2b003 100644 (file)
@@ -35,6 +35,7 @@ use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  * @package Civi\API\Subscriber
  */
 class I18nSubscriber implements EventSubscriberInterface {
+
   /**
    * @return array
    */
index 0a8248ef57bd73b6a592d430523cb74bb96dcb85..c4fe5c748139742bb81dff02cf9b03f11d35387f 100644 (file)
@@ -36,6 +36,7 @@ use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  * Civi\API\Annotation\Permission.
  */
 class PermissionCheck implements EventSubscriberInterface {
+
   /**
    * @return array
    */
index 8b110ab70c4017113d7696497b5bef161f4303c3..4f7b0c64d870de2e302f80aef0ca460c5f2cbcec 100644 (file)
@@ -44,6 +44,7 @@ use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  * @package Civi\API\Subscriber
  */
 class TransactionSubscriber implements EventSubscriberInterface {
+
   /**
    * @return array
    */
index 3c69c04af14064ce95034cc5be3ec57c80fab548..fbb272d3959d87646d0ad5d5a9655d79c757ea93 100644 (file)
@@ -29,7 +29,6 @@ namespace Civi\API\Subscriber;
 use Civi\API\Events;
 use Civi\API\Event\AuthorizeEvent;
 use Civi\API\Event\RespondEvent;
-use Civi\API\WhitelistRule;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
 /**
@@ -75,7 +74,7 @@ class WhitelistSubscriber implements EventSubscriberInterface {
   public function __construct($rules) {
     $this->rules = [];
     foreach ($rules as $rule) {
-      /** @var WhitelistRule $rule */
+      /** @var \Civi\API\WhitelistRule $rule */
       if ($rule->isValid()) {
         $this->rules[] = $rule;
       }
@@ -89,7 +88,7 @@ class WhitelistSubscriber implements EventSubscriberInterface {
    * Determine which, if any, whitelist rules apply this request.
    * Reject unauthorized requests.
    *
-   * @param AuthorizeEvent $event
+   * @param \Civi\API\Event\AuthorizeEvent $event
    * @throws \CRM_Core_Exception
    */
   public function onApiAuthorize(AuthorizeEvent $event) {
@@ -108,7 +107,7 @@ class WhitelistSubscriber implements EventSubscriberInterface {
 
   /**
    * Apply any filtering rules based on the chosen whitelist rule.
-   * @param RespondEvent $event
+   * @param \Civi\API\Event\RespondEvent $event
    */
   public function onApiRespond(RespondEvent $event) {
     $apiRequest = $event->getApiRequest();
index 294ed9fd23aa632a1ab2d7b37881791ab854a1c1..0648cf50b73b415cb2473ed7c87d852eb6d9acc2 100644 (file)
@@ -35,6 +35,7 @@ use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  * @package Civi\API\Subscriber
  */
 class XDebugSubscriber implements EventSubscriberInterface {
+
   /**
    * @return array
    */
index 50d5b3e232bc150e61255ee1adc81b575a1ec08a..0cc9ef01292ed53c623697753cba11b72aa3c3cb 100644 (file)
@@ -48,7 +48,7 @@ namespace Civi\API;
  */
 class WhitelistRule {
 
-  static $IGNORE_FIELDS = [
+  public static $IGNORE_FIELDS = [
     'check_permissions',
     'debug',
     'offset',
index 472c1c3bcdd48168c23d9cd094d24135d5eb75ee..e8b136e84dc41506a8aaa5961664af2785573402 100644 (file)
@@ -1,7 +1,6 @@
 <?php
 namespace Civi\ActionSchedule\Event;
 
-use Civi\ActionSchedule\MappingInterface;
 use Symfony\Component\EventDispatcher\Event;
 
 /**
@@ -51,7 +50,7 @@ class MailingQueryEvent extends Event {
   /**
    * The mapping record which produced this mailing.
    *
-   * @var MappingInterface
+   * @var \Civi\ActionSchedule\MappingInterface
    */
   public $mapping;
 
@@ -64,7 +63,7 @@ class MailingQueryEvent extends Event {
 
   /**
    * @param \CRM_Core_DAO_ActionSchedule $actionSchedule
-   * @param MappingInterface $mapping
+   * @param \Civi\ActionSchedule\MappingInterface $mapping
    * @param \CRM_Utils_SQL_Select $query
    */
   public function __construct($actionSchedule, $mapping, $query) {
index 9392dbd984a635c9477202aef7a4eaa03d1a6cda..d3a29c3c5a282562a76adcd3aa0c9df2dae3389d 100644 (file)
@@ -21,7 +21,7 @@ class MappingRegisterEvent extends Event {
   /**
    * Register a new mapping.
    *
-   * @param MappingInterface $mapping
+   * @param \Civi\ActionSchedule\MappingInterface $mapping
    *   The new mapping.
    * @return MappingRegisterEvent
    */
index 1040a5012a287bc7fd11706d3f61cf13b06d68a2..9e6dcbf91972951e223d38730e0b3e6729227879 100644 (file)
@@ -112,7 +112,7 @@ abstract class Mapping implements MappingInterface {
   /**
    * The basic entity to query (label).
    *
-   * @var
+   * @var string
    *   Ex: 'Activity', 'Event'
    */
   private $entity_label;
@@ -339,6 +339,6 @@ abstract class Mapping implements MappingInterface {
    * @param array $defaultParams
    * @return \CRM_Utils_SQL_Select
    */
-  public abstract function createQuery($schedule, $phase, $defaultParams);
+  abstract public function createQuery($schedule, $phase, $defaultParams);
 
 }
index 2d2e5ed02532a148f85e926db0c07b70708d994c..f822d481d5c61cc938e43cea61dee36e5031ee42 100644 (file)
@@ -44,6 +44,7 @@ class Manager {
   /**
    * @param \CRM_Core_Resources $res
    *   The resource manager.
+   * @param $cache
    */
   public function __construct($res, \CRM_Utils_Cache_Interface $cache = NULL) {
     $this->res = $res;
index 65f115b6e99cc76b3eafced0285b616d68d0246f..b473a090e03defdb3d556739099c7dcbc5217257 100644 (file)
@@ -32,6 +32,7 @@ namespace Civi\CCase;
  * @package Civi\CCase
  */
 interface CaseChangeListener {
+
   /**
    * @param \Civi\CCase\Event\CaseChangeEvent $event
    *
index e091ac4ba7b3f64481dee26e7ca62873ba619373..a873b519f937c11f20c5cbe8f19232f9fa62c530 100644 (file)
@@ -26,6 +26,7 @@
  */
 
 namespace Civi\CCase\Event;
+
 use Civi\Core\Event\GenericHookEvent;
 
 /**
index 278590dfa9321da1398143c48ee4baa486e0f944..a3890248f2747a688cde0ded12fd2321491aeafa 100644 (file)
@@ -37,7 +37,7 @@ class Events {
    *
    * We do not want to fire case-change events recursively.
    */
-  static $isActive = [];
+  public static $isActive = [];
 
   /**
    * Following a change to an activity or case, fire the case-change event.
index 48b6c226d412d028ee8bf3a589078ff12a21822f..e3933ee126a257e86cb6af9e72f6f8d839b83d16 100644 (file)
@@ -7,6 +7,7 @@ namespace Civi\CiUtil;
  * @package Civi\CiUtil
  */
 class Arrays {
+
   /**
    * @param $arr
    * @param $col
index 4f7e4791166396ef7aa33069cf6a5e91392bb3ed..d8d9761ffe1a0c41bb9f787333be34983a32ab01 100644 (file)
@@ -7,6 +7,7 @@ namespace Civi\CiUtil\Command;
  * @package Civi\CiUtil\Command
  */
 class AntagonistCommand {
+
   /**
    * @param $argv
    */
index 84b7064239de7672318e38907e8b78baf22dd6e1..beae7ac77976f9441581a744c8e830d73305a643 100644 (file)
@@ -7,6 +7,7 @@ namespace Civi\CiUtil\Command;
  * @package Civi\CiUtil\Command
  */
 class CompareCommand {
+
   /**
    * @param $argv
    */
@@ -19,7 +20,8 @@ class CompareCommand {
 
     $parser = ['\Civi\CiUtil\PHPUnitParser', 'parseJsonResults'];
     $printerType = 'txt';
-    $suites = []; // array('file' => string, 'results' => array)
+    // array('file' => string, 'results' => array)
+    $suites = [];
     for ($i = 1; $i < count($argv); $i++) {
       switch ($argv[$i]) {
         case '--phpunit-json':
@@ -50,7 +52,8 @@ class CompareCommand {
       }
     }
 
-    $tests = []; // array(string $name)
+    // array(string $name)
+    $tests = [];
     foreach ($suites as $suite) {
       $tests = array_unique(array_merge(
         $tests,
index 88f0d84947e30db2755c4e40193e7a42bd656bf6..f0db547cf54c6d123d2dc8f43691193eb86c281f 100644 (file)
@@ -7,6 +7,7 @@ namespace Civi\CiUtil\Command;
  * @package Civi\CiUtil\Command
  */
 class LsCommand {
+
   /**
    * @param $argv
    */
index a58a83eb6704af9b2d420099d1d623ea1dbc37e6..27acd8908c6c8106da2928f2c1e65a00cb38ebee 100644 (file)
@@ -7,8 +7,8 @@ namespace Civi\CiUtil;
  * @package Civi\CiUtil
  */
 class ComparisonPrinter {
-  var $headers;
-  var $hasHeader = FALSE;
+  public $headers;
+  public $hasHeader = FALSE;
 
   /**
    * @param $headers
index 4c4ec185a3efbd5d542725af792503a1549dbbbf..55c7dbba4393422c75b98c28e6716cdee6a1b02e 100644 (file)
@@ -7,9 +7,9 @@ namespace Civi\CiUtil;
  * @package Civi\CiUtil
  */
 class CsvPrinter {
-  var $file;
-  var $headers;
-  var $hasHeader = FALSE;
+  public $file;
+  public $headers;
+  public $hasHeader = FALSE;
 
   /**
    * @param $file
index 616219ced24ebe238c6d81d4ddfa10c3b7b9dfcb..4a1429876869a9f9603cba691d3177d1b31e4da2 100644 (file)
@@ -5,6 +5,7 @@ namespace Civi\CiUtil;
  * Parse Jenkins result files
  */
 class JenkinsParser {
+
   /**
    * @param string $content
    *   Xml data.
index e956388adf1c8945a172bf97f69bbf4cefdb972e..9ff2b7d572c2eafc157c70320a7371e707dced68 100644 (file)
@@ -5,6 +5,7 @@ namespace Civi\CiUtil;
  * Parse phpunit result files
  */
 class PHPUnitParser {
+
   /**
    * @param string $content
    *   Phpunit streaming JSON.
index 8264e9e2660bbcf4e515066e49bc974b729f9f99..a1028f52f5c8986f3f5088284e1d8cb9ba3f54f4 100644 (file)
@@ -7,6 +7,7 @@ use Symfony\Component\Finder\Finder;
  * Search for PHPUnit test cases
  */
 class PHPUnitScanner {
+
   /**
    * @param $path
    * @return array <string> class names
index 595a53ce4054f1e8fa73268cb24e019132111751..b60f41e20bcc10c58c531b4d4b42767106618c9a 100644 (file)
@@ -84,6 +84,9 @@ class AssetBuilder {
     ];
   }
 
+  /**
+   * @var mixed
+   */
   protected $cacheEnabled;
 
   /**
@@ -238,8 +241,7 @@ class AssetBuilder {
   protected function getCachePath($fileName = NULL) {
     // imageUploadDir has the correct functional properties but a wonky name.
     $suffix = ($fileName === NULL) ? '' : (DIRECTORY_SEPARATOR . $fileName);
-    return
-      \CRM_Utils_File::addTrailingSlash(\CRM_Core_Config::singleton()->imageUploadDir)
+    return \CRM_Utils_File::addTrailingSlash(\CRM_Core_Config::singleton()->imageUploadDir)
       . 'dyn' . $suffix;
   }
 
@@ -255,8 +257,7 @@ class AssetBuilder {
   protected function getCacheUrl($fileName = NULL) {
     // imageUploadURL has the correct functional properties but a wonky name.
     $suffix = ($fileName === NULL) ? '' : ('/' . $fileName);
-    return
-      \CRM_Utils_File::addTrailingSlash(\CRM_Core_Config::singleton()->imageUploadURL, '/')
+    return \CRM_Utils_File::addTrailingSlash(\CRM_Core_Config::singleton()->imageUploadURL, '/')
       . 'dyn' . $suffix;
   }
 
index 2763d763d7ce5a253c7815bbbe5930419de6b5ff..4e01f4a9dbd860602f8c5603fe5a797fb468d76e 100644 (file)
@@ -1,23 +1,13 @@
 <?php
 namespace Civi\Core;
 
-use Civi\API\Provider\ActionObjectProvider;
 use Civi\Core\Event\SystemInstallEvent;
 use Civi\Core\Lock\LockManager;
-use Doctrine\Common\Annotations\AnnotationReader;
-use Doctrine\Common\Annotations\AnnotationRegistry;
-use Doctrine\Common\Annotations\FileCacheReader;
-use Doctrine\Common\Cache\FilesystemCache;
-use Doctrine\ORM\EntityManager;
-use Doctrine\ORM\Mapping\Driver\AnnotationDriver;
-use Doctrine\ORM\Tools\Setup;
 use Symfony\Component\Config\ConfigCache;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
-use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Dumper\PhpDumper;
 use Symfony\Component\DependencyInjection\Reference;
-use Symfony\Component\EventDispatcher\ContainerAwareEventDispatcher;
 use Symfony\Component\EventDispatcher\DependencyInjection\RegisterListenersPass;
 
 // TODO use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
@@ -58,7 +48,7 @@ class Container {
    *   - CIVICRM_DOMAIN_ID
    *   - CIVICRM_TEMPLATE_COMPILEDIR
    *
-   * @return ContainerInterface
+   * @return \Symfony\Component\DependencyInjection\ContainerInterface
    */
   public function loadContainer() {
     // Note: The container's raison d'etre is to manage construction of other
@@ -95,7 +85,7 @@ class Container {
   /**
    * Construct a new container.
    *
-   * @var ContainerBuilder
+   * @var \Symfony\Component\DependencyInjection\ContainerBuilder
    * @return \Symfony\Component\DependencyInjection\ContainerBuilder
    */
   public function createContainer() {
@@ -309,7 +299,7 @@ class Container {
   }
 
   /**
-   * @param ContainerInterface $container
+   * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
    * @return \Symfony\Component\EventDispatcher\ContainerAwareEventDispatcher
    */
   public function createEventDispatcher($container) {
@@ -352,7 +342,7 @@ class Container {
   }
 
   /**
-   * @return LockManager
+   * @return \Civi\Core\Lock\LockManager
    */
   public static function createLockManager() {
     // Ideally, downstream implementers could override any definitions in
@@ -424,7 +414,7 @@ class Container {
   }
 
   /**
-   * @param ContainerInterface $container
+   * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
    * @return \CRM_Core_Resources
    */
   public static function createResources($container) {
@@ -437,7 +427,7 @@ class Container {
   }
 
   /**
-   * @param ContainerInterface $container
+   * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
    * @return \CRM_Core_PrevNextCache_Interface
    */
   public static function createPrevNextCache($container) {
index 6fb2dabbd2f9e6a3e1193849047586c608794260..9f38e6d23e9ad4bd7f995e84f93ea411a8eb3558 100644 (file)
@@ -27,7 +27,6 @@
 
 namespace Civi\Core;
 
-use Civi;
 use Civi\Core\Event\SystemInstallEvent;
 
 /**
index 3583a6303bbba161a265647dce144bcc9c76f44f..b1e54684a627629d4004068b9e83330177c76f38 100644 (file)
@@ -250,7 +250,8 @@ class ResolverApi {
 }
 
 class ResolverGlobalCallback {
-  private $mode, $path;
+  private $mode;
+  private $path;
 
   /**
    * Class constructor.
index 6ceab0519a15bf051b665a7a2e0d18fdf1007b53..1954404ca3812cc1ee8cd2009a721826392a639a 100644 (file)
@@ -67,10 +67,17 @@ class SettingsManager {
   protected $cache;
 
   /**
-   * @var
+   * @var array
    *   Array (int $id => SettingsBag $bag).
    */
-  protected $bagsByDomain = [], $bagsByContact = [];
+  protected $bagsByDomain = [];
+
+
+  /**
+   * @var array
+   *   Array (int $id => SettingsBag $bag).
+   */
+  protected $bagsByContact = [];
 
   /**
    * @var array|NULL
@@ -310,7 +317,8 @@ class SettingsManager {
     $this->mandatory = NULL;
 
     $this->cache->flush();
-    \Civi::cache('settings')->flush(); // SettingsMetadata; not guaranteed to use same cache.
+    // SettingsMetadata; not guaranteed to use same cache.
+    \Civi::cache('settings')->flush();
 
     foreach ($this->bagsByDomain as $bag) {
       /** @var SettingsBag $bag */
index e97213967f7086525421d3c818c29cd0a0a3889d..c0f6f981b773fdf079ca4e66254d2008dfe4f069 100644 (file)
@@ -56,7 +56,6 @@ class StaticTriggers {
     $this->triggers = $triggers;
   }
 
-
   /**
    * Add our list of triggers to the global list.
    *
index 235ce70b604c457f5e7932442aa98d7789c543f7..c2249cf07d45d03f1bfd5affb7803de57278f322 100644 (file)
@@ -28,8 +28,6 @@
 
 namespace Civi\Core\SqlTrigger;
 
-use Civi\Core\Event\GenericHookEvent;
-
 /**
  * Build a set of SQL triggers for tracking timestamps on an entity.
  *
index 172e7d0e79e01d97a646f69e9d511b374b685fa3..ce54d184489930bde232f96f77aae3cd98c8f1f0 100644 (file)
@@ -207,8 +207,8 @@ class SqlTriggers {
       if (!file_exists($this->getFile())) {
         // Ugh. Need to let user know somehow. This is the first change.
         \CRM_Core_Session::setStatus(ts('The mysql commands you need to run are stored in %1', [
-            1 => $this->getFile(),
-          ]),
+          1 => $this->getFile(),
+        ]),
           '',
           'alert',
           ['expires' => 0]
index e4423e8f51e2e39d162a8af835e8b11865ac6959..7d8fd3821c4ecacaa2595cb6be6eb027b10b39bb 100644 (file)
@@ -23,6 +23,9 @@ class Requirements {
    */
   const REQUIREMENT_ERROR = 2;
 
+  /**
+   * @var array
+   */
   protected $system_checks = [
     'checkMemory',
     'checkServerVariables',
@@ -106,7 +109,7 @@ class Requirements {
   /**
    * Generates a mysql connection
    *
-   * @param $db_confic array
+   * @param $db_config array
    * @return object mysqli connection
    */
   protected function connect($db_config) {
@@ -488,7 +491,8 @@ class Requirements {
       return $results;
     }
 
-    $r = mysqli_query($conn, "SHOW VARIABLES LIKE 'thread_stack'"); // bytes => kb
+    // bytes => kb
+    $r = mysqli_query($conn, "SHOW VARIABLES LIKE 'thread_stack'");
     if (!$r) {
       $results['severity'] = $this::REQUIREMENT_ERROR;
       $results['details'] = 'Could not query thread_stack value';
index 8e44fcd5094fdd6bf3346cd22660c677dc003caa..51d929054daba3313c9292e58342d8456100655c 100644 (file)
@@ -45,7 +45,7 @@ class Test {
   /**
    * Get a connection to the test database.
    *
-   * @return PDO
+   * @return \PDO
    */
   public static function pdo() {
     if (!isset(self::$singletons['pdo'])) {
@@ -127,7 +127,6 @@ class Test {
     return self::$singletons['schema'];
   }
 
-
   /**
    * @return \Civi\Test\Data
    */
index 4b85837021c3ae5163d2f0af3907f6ec0ddee89a..5386e93969dcfe902f011afc02881274435215a8 100644 (file)
@@ -16,6 +16,7 @@ trait Api3TestTrait {
 
   /**
    * Api version - easier to override than just a define
+   * @var int
    */
   protected $_apiversion = 3;
 
@@ -206,7 +207,7 @@ trait Api3TestTrait {
       throw new \Exception(
         'Invalid getsingle result' . print_r($result, TRUE)
         . "\n entity: $entity . \n params \n " . print_r($params, TRUE)
-        . "\n entities retrieved with blank params \n" .  print_r($unfilteredResult, TRUE)
+        . "\n entities retrieved with blank params \n" . print_r($unfilteredResult, TRUE)
       );
     }
     if ($checkAgainst) {
index 6d0c9f055c3af48610bc44b4425328b177511057..8e6110bee38ef2fc02f881806e40378ffbf4ce32 100644 (file)
@@ -1,5 +1,6 @@
 <?php
 namespace Civi\Test\CiviEnvBuilder;
+
 class CallbackStep implements StepInterface {
   private $callback;
   private $sig;
index 3dcedfd7707b4f96993979edea20b116ab9e9609..58058919d602e266ad5d72f6b3ecbd17422ea3b3 100644 (file)
@@ -1,5 +1,6 @@
 <?php
 namespace Civi\Test\CiviEnvBuilder;
+
 class ExtensionsStep implements StepInterface {
   private $action;
   private $names;
index b753761e23764a582f2c1e7729b7a2ba81b0d516..ffb9ca1b0d46036d3c5575d9fd048ab913aaf03e 100644 (file)
@@ -12,7 +12,6 @@ class SqlFileStep implements StepInterface {
     $this->file = $file;
   }
 
-
   public function getSig() {
     return implode(' ', [
       $this->file,
index 7a2736b019c8f7bfa7aa9bf8b2729bb0f2e2dcae..e892883e03ce6ce11cd82175583b35aa34b9b7ea 100644 (file)
@@ -1,5 +1,6 @@
 <?php
 namespace Civi\Test\CiviEnvBuilder;
+
 class SqlStep implements StepInterface {
   private $sql;
 
@@ -11,7 +12,6 @@ class SqlStep implements StepInterface {
     $this->sql = $sql;
   }
 
-
   public function getSig() {
     return md5($this->sql);
   }
index 3d6dc95cc1e37f192ad1cebba8757c938cf5d63a..8ed2c2ce77df3269d8f5ce5393da339f657ff4b8 100644 (file)
@@ -2,6 +2,7 @@
 namespace Civi\Test\CiviEnvBuilder;
 
 interface StepInterface {
+
   public function getSig();
 
   public function isValid();
index 8eca8cbf756a478ac4aff5f9c58e140ba03a93d3..255eb8628f71ff864e434a2862c70ff2af527934 100644 (file)
@@ -98,7 +98,8 @@ class CiviTestListener extends \PHPUnit_Framework_BaseTestListener {
     \CRM_Utils_System::flushCache();
     \Civi::reset();
     \CRM_Core_Session::singleton()->set('userID', NULL);
-    $config = \CRM_Core_Config::singleton(TRUE, TRUE); // ugh, performance
+    // ugh, performance
+    $config = \CRM_Core_Config::singleton(TRUE, TRUE);
 
     if (property_exists($config->userPermissionClass, 'permissions')) {
       $config->userPermissionClass->permissions = NULL;
index 38d2875ce3f57d97009bd67d781c4bab4cc78027..012d306930ae04762faa2f22d5a060759a195792 100644 (file)
@@ -110,7 +110,7 @@ abstract class AbstractTokenSubscriber implements EventSubscriberInterface {
   /**
    * Register the declared tokens.
    *
-   * @param TokenRegisterEvent $e
+   * @param \Civi\Token\Event\TokenRegisterEvent $e
    *   The registration event. Add new tokens using register().
    */
   public function registerTokens(TokenRegisterEvent $e) {
@@ -133,7 +133,7 @@ abstract class AbstractTokenSubscriber implements EventSubscriberInterface {
    * This is method is not always appropriate, but if you're specifically
    * focused on scheduled reminders, it can be convenient.
    *
-   * @param MailingQueryEvent $e
+   * @param \Civi\ActionSchedule\Event\MailingQueryEvent $e
    *   The pending query which may be modified. See discussion on
    *   MailingQueryEvent::$query.
    */
@@ -143,7 +143,7 @@ abstract class AbstractTokenSubscriber implements EventSubscriberInterface {
   /**
    * Populate the token data.
    *
-   * @param TokenValueEvent $e
+   * @param \Civi\Token\Event\TokenValueEvent $e
    *   The event, which includes a list of rows and tokens.
    */
   public function evaluateTokens(TokenValueEvent $e) {
@@ -204,6 +204,6 @@ abstract class AbstractTokenSubscriber implements EventSubscriberInterface {
    *   Any data that was returned by the prefetch().
    * @return mixed
    */
-  public abstract function evaluateToken(TokenRow $row, $entity, $field, $prefetch = NULL);
+  abstract public function evaluateToken(TokenRow $row, $entity, $field, $prefetch = NULL);
 
 }
index 2e8721e67696be45f05df20359146b408170a5ba..672080d29ba43d09c93390678803ea4f68597d42 100644 (file)
@@ -33,7 +33,7 @@ class TokenCompatSubscriber implements EventSubscriberInterface {
   /**
    * Load token data.
    *
-   * @param TokenValueEvent $e
+   * @param \Civi\Token\Event\TokenValueEvent $e
    * @throws TokenException
    */
   public function onEvaluate(TokenValueEvent $e) {
@@ -59,7 +59,8 @@ class TokenCompatSubscriber implements EventSubscriberInterface {
           ['contact_id', '=', $contactId, 0, 0],
         ];
         list($contact, $_) = \CRM_Contact_BAO_Query::apiQuery($params);
-        $contact = reset($contact); //CRM-4524
+        //CRM-4524
+        $contact = reset($contact);
         if (!$contact || is_a($contact, 'CRM_Core_Error')) {
           // FIXME: Need to differentiate errors which kill the batch vs the individual row.
           throw new TokenException("Failed to generate token data. Invalid contact ID: " . $row->context['contactId']);
@@ -109,7 +110,7 @@ class TokenCompatSubscriber implements EventSubscriberInterface {
   /**
    * Apply the various CRM_Utils_Token helpers.
    *
-   * @param TokenRenderEvent $e
+   * @param \Civi\Token\Event\TokenRenderEvent $e
    */
   public function onRender(TokenRenderEvent $e) {
     $isHtml = ($e->message['format'] == 'text/html');
index c989773435462bca6ed891509dc343de7a406d87..1364ed714faa336dcef5fca0638b8d9ec2af2aaa 100644 (file)
@@ -4,7 +4,6 @@ namespace Civi\Token;
 use Civi\Token\Event\TokenRegisterEvent;
 use Civi\Token\Event\TokenRenderEvent;
 use Civi\Token\Event\TokenValueEvent;
-use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Traversable;
 
 class TokenProcessor {
@@ -33,7 +32,7 @@ class TokenProcessor {
   public $context;
 
   /**
-   * @var EventDispatcherInterface
+   * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
    */
   protected $dispatcher;
 
@@ -82,7 +81,7 @@ class TokenProcessor {
   protected $next = 0;
 
   /**
-   * @param EventDispatcherInterface $dispatcher
+   * @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $dispatcher
    * @param array $context
    */
   public function __construct($dispatcher, $context) {
@@ -188,6 +187,7 @@ class TokenProcessor {
    *
    * @param string $field
    *   Ex: 'contactId'.
+   * @param $subfield
    * @return array
    *   Ex: [12, 34, 56].
    */
@@ -278,7 +278,9 @@ class TokenProcessor {
     $row->fill($message['format']);
     $useSmarty = !empty($row->context['smarty']);
 
-    // FIXME preg_callback.
+    /**
+     *@FIXME preg_callback.
+     */
     $tokens = $this->rowValues[$row->tokenRow][$message['format']];
     $flatTokens = [];
     \CRM_Utils_Array::flatten($tokens, $flatTokens, '', '.');
@@ -304,10 +306,11 @@ class TokenRowIterator extends \IteratorIterator {
 
   /**
    * @param TokenProcessor $tokenProcessor
-   * @param Traversable $iterator
+   * @param \Traversable $iterator
    */
   public function __construct(TokenProcessor $tokenProcessor, Traversable $iterator) {
-    parent::__construct($iterator); // TODO: Change the autogenerated stub
+    // TODO: Change the autogenerated stub
+    parent::__construct($iterator);
     $this->tokenProcessor = $tokenProcessor;
   }
 
index a57a37b5d0faa019fb2a8113377fd52dfeabe812..5287219a9401ed6045b790bc2d597c790140202a 100644 (file)
@@ -65,7 +65,8 @@ class TokenRow {
   public function __construct(TokenProcessor $tokenProcessor, $key) {
     $this->tokenProcessor = $tokenProcessor;
     $this->tokenRow = $key;
-    $this->format('text/plain'); // Set a default.
+    // Set a default.
+    $this->format('text/plain');
     $this->context = new TokenRowContext($tokenProcessor, $key);
   }
 
@@ -138,7 +139,7 @@ class TokenRow {
     $customFieldName = "custom_" . $customFieldID;
     $record = civicrm_api3($entity, "getSingle", [
       'return' => $customFieldName,
-       'id' => $entityID,
+      'id' => $entityID,
     ]);
     $fieldValue = \CRM_Utils_Array::value($customFieldName, $record, '');
 
@@ -305,8 +306,7 @@ class TokenRowContext implements \ArrayAccess, \IteratorAggregate, \Countable {
    * @return bool
    */
   public function offsetExists($offset) {
-    return
-      isset($this->tokenProcessor->rowContexts[$this->tokenRow][$offset])
+    return isset($this->tokenProcessor->rowContexts[$this->tokenRow][$offset])
       || isset($this->tokenProcessor->context[$offset]);
   }