Browse Source

Update inline docblocks.

ADmad 8 years ago
parent
commit
63f1dd5aed

+ 1 - 1
src/Controller/Component/AuthComponent.php

@@ -284,7 +284,7 @@ class AuthComponent extends Component
             return null;
         }
 
-        /* @var \Cake\Controller\Controller $controller */
+        /** @var \Cake\Controller\Controller $controller */
         $controller = $event->getSubject();
 
         $action = strtolower($controller->request->getParam('action'));

+ 1 - 1
src/Controller/Component/CsrfComponent.php

@@ -78,7 +78,7 @@ class CsrfComponent extends Component
      */
     public function startup(Event $event)
     {
-        /* @var \Cake\Controller\Controller $controller */
+        /** @var \Cake\Controller\Controller $controller */
         $controller = $event->getSubject();
         $request = $controller->request;
         $response = $controller->response;

+ 3 - 3
src/Controller/Component/RequestHandlerComponent.php

@@ -189,7 +189,7 @@ class RequestHandlerComponent extends Component
      */
     public function startup(Event $event)
     {
-        /* @var \Cake\Controller\Controller $controller */
+        /** @var \Cake\Controller\Controller $controller */
         $controller = $event->getSubject();
         $request = $controller->request;
         $response = $controller->response;
@@ -273,7 +273,7 @@ class RequestHandlerComponent extends Component
             list($url, $querystr) = explode('?', $url, 2);
             parse_str($querystr, $query);
         }
-        /* @var \Cake\Controller\Controller $controller */
+        /** @var \Cake\Controller\Controller $controller */
         $controller = $event->getSubject();
         $response->body($controller->requestAction($url, [
             'return',
@@ -313,7 +313,7 @@ class RequestHandlerComponent extends Component
      */
     public function beforeRender(Event $event)
     {
-        /* @var \Cake\Controller\Controller $controller */
+        /** @var \Cake\Controller\Controller $controller */
         $controller = $event->getSubject();
         $response = $controller->response;
         $request = $controller->request;

+ 1 - 1
src/Controller/Component/SecurityComponent.php

@@ -99,7 +99,7 @@ class SecurityComponent extends Component
      */
     public function startup(Event $event)
     {
-        /* @var \Cake\Controller\Controller $controller */
+        /** @var \Cake\Controller\Controller $controller */
         $controller = $event->getSubject();
         $this->session = $controller->request->getSession();
         $this->_action = $controller->request->getParam('action');

+ 1 - 1
src/Core/ObjectRegistry.php

@@ -126,7 +126,7 @@ abstract class ObjectRegistry implements Countable, IteratorAggregate
         if (empty($config)) {
             return;
         }
-        /* @var \Cake\Core\InstanceConfigTrait $existing */
+        /** @var \Cake\Core\InstanceConfigTrait $existing */
         $existingConfig = $existing->getConfig();
         unset($config['enabled'], $existingConfig['enabled']);
 

+ 1 - 1
src/Error/ErrorHandler.php

@@ -133,7 +133,7 @@ class ErrorHandler extends BaseErrorHandler
             if (!$rendererClassName) {
                 throw new Exception("$rendererClassName is an invalid class.");
             }
-            /* @var \Cake\Error\ExceptionRendererInterface $renderer */
+            /** @var \Cake\Error\ExceptionRendererInterface $renderer */
             $renderer = new $rendererClassName($exception);
             $response = $renderer->render();
             $this->_clearOutput();

+ 2 - 0
src/I18n/RelativeTimeFormatter.php

@@ -115,6 +115,7 @@ class RelativeTimeFormatter
         }
 
         if ($diff > abs($now - (new FrozenTime($options['end']))->format('U'))) {
+            /** @var \Cake\I18n\DateFormatTrait $time */
             return sprintf($options['absoluteString'], $time->i18nFormat($options['format']));
         }
 
@@ -305,6 +306,7 @@ class RelativeTimeFormatter
         }
 
         if ($diff > abs($now - (new FrozenDate($options['end']))->format('U'))) {
+            /** @var \Cake\I18n\DateFormatTrait $time */
             return sprintf($options['absoluteString'], $date->i18nFormat($options['format']));
         }
 

+ 4 - 4
src/ORM/Marshaller.php

@@ -106,7 +106,7 @@ class Marshaller
             }
             if (isset($options['isMerge'])) {
                 $callback = function ($value, $entity) use ($assoc, $nested) {
-                    /* @var \Cake\Datasource\EntityInterface $entity */
+                    /** @var \Cake\Datasource\EntityInterface $entity */
                     $options = $nested + ['associated' => [], 'association' => $assoc];
 
                     return $this->_mergeAssociation($entity->get($assoc->getProperty()), $assoc, $value, $options);
@@ -170,7 +170,7 @@ class Marshaller
 
         $primaryKey = (array)$this->_table->getPrimaryKey();
         $entityClass = $this->_table->getEntityClass();
-        /* @var \Cake\Datasource\EntityInterface $entity */
+        /** @var \Cake\Datasource\EntityInterface $entity */
         $entity = new $entityClass();
         $entity->setSource($this->_table->getRegistryAlias());
 
@@ -409,7 +409,7 @@ class Marshaller
         if (!empty($conditions)) {
             $query = $target->find();
             $query->andWhere(function ($exp) use ($conditions) {
-                /* @var \Cake\Database\Expression\QueryExpression $exp */
+                /** @var \Cake\Database\Expression\QueryExpression $exp */
                 return $exp->or_($conditions);
             });
 
@@ -686,7 +686,7 @@ class Marshaller
                 return count(array_filter($keys, 'strlen')) === count($primary);
             })
             ->reduce(function ($query, $keys) use ($primary) {
-                /* @var \Cake\ORM\Query $query */
+                /** @var \Cake\ORM\Query $query */
                 $fields = array_map([$this->_table, 'aliasField'], $primary);
 
                 return $query->orWhere($query->newExpr()->and_(array_combine($fields, $keys)));

+ 2 - 2
src/ORM/Table.php

@@ -1289,7 +1289,7 @@ class Table implements RepositoryInterface, EventListenerInterface, EventDispatc
         );
 
         return $query->formatResults(function ($results) use ($options) {
-            /* @var \Cake\Collection\CollectionInterface $results */
+            /** @var \Cake\Collection\CollectionInterface $results */
             return $results->combine(
                 $options['keyField'],
                 $options['valueField'],
@@ -1339,7 +1339,7 @@ class Table implements RepositoryInterface, EventListenerInterface, EventDispatc
         $options = $this->_setFieldMatchers($options, ['keyField', 'parentField']);
 
         return $query->formatResults(function ($results) use ($options) {
-            /* @var \Cake\Collection\CollectionInterface $results */
+            /** @var \Cake\Collection\CollectionInterface $results */
             return $results->nest($options['keyField'], $options['parentField'], $options['nestingKey']);
         });
     }

+ 1 - 1
src/Shell/OrmCacheShell.php

@@ -94,7 +94,7 @@ class OrmCacheShell extends Shell
      */
     protected function _getSchema()
     {
-        /* @var \Cake\Database\Connection $source */
+        /** @var \Cake\Database\Connection $source */
         $source = ConnectionManager::get($this->params['connection']);
         if (!method_exists($source, 'schemaCollection')) {
             $msg = sprintf(

+ 1 - 1
src/Shell/Task/ExtractTask.php

@@ -364,7 +364,7 @@ class ExtractTask extends Shell
      */
     protected function _extractTokens()
     {
-        /* @var \Cake\Shell\Helper\ProgressHelper $progress */
+        /** @var \Cake\Shell\Helper\ProgressHelper $progress */
         $progress = $this->helper('progress');
         $progress->init(['total' => count($this->_files)]);
         $isVerbose = $this->param('verbose');

+ 1 - 1
src/TestSuite/IntegrationTestCase.php

@@ -557,7 +557,7 @@ abstract class IntegrationTestCase extends TestCase
         if (empty($class) || !class_exists($class)) {
             $class = 'Cake\Error\ExceptionRenderer';
         }
-        /* @var \Cake\Error\ExceptionRenderer $instance */
+        /** @var \Cake\Error\ExceptionRenderer $instance */
         $instance = new $class($exception);
         $this->_response = $instance->render();
     }

+ 1 - 1
src/TestSuite/TestCase.php

@@ -661,7 +661,7 @@ abstract class TestCase extends BaseTestCase
         $options += ['alias' => $baseClass, 'connection' => $connection];
         $options += TableRegistry::config($alias);
 
-        /* @var \Cake\ORM\Table $mock */
+        /** @var \Cake\ORM\Table $mock */
         $mock = $this->getMockBuilder($options['className'])
             ->setMethods($methods)
             ->setConstructorArgs([$options])

+ 1 - 1
src/Utility/Hash.php

@@ -160,7 +160,7 @@ class Hash
 
             foreach ($context[$_key] as $item) {
                 if (is_object($item) && method_exists($item, 'toArray')) {
-                    /* @var \Cake\Datasource\EntityInterface $item */
+                    /** @var \Cake\Datasource\EntityInterface $item */
                     $item = $item->toArray();
                 }
                 foreach ((array)$item as $k => $v) {

+ 1 - 1
src/View/Form/EntityContext.php

@@ -157,7 +157,7 @@ class EntityContext implements ContextInterface
             $entity instanceof Traversable
         );
 
-        /* @var \Cake\Datasource\RepositoryInterface $table */
+        /** @var \Cake\Datasource\RepositoryInterface $table */
         $alias = $this->_rootName = $table->getAlias();
         $this->_tables[$alias] = $table;
     }