Skip to content
Permalink
Browse files

Fix some more doc blocks and smells. Enable further clickability in IDE.

  • Loading branch information...
dereuromark committed Dec 19, 2016
1 parent 40fb946 commit 2312ab8023d583346a2d444984638f974d09bc4b
Showing with 176 additions and 159 deletions.
  1. +1 −1 src/Auth/DigestAuthenticate.php
  2. +1 −1 src/Auth/Storage/MemoryStorage.php
  3. +1 −1 src/Cache/Cache.php
  4. +1 −1 src/Cache/Engine/FileEngine.php
  5. +1 −1 src/Cache/Engine/WincacheEngine.php
  6. +2 −2 src/Collection/Iterator/MapReduce.php
  7. +1 −1 src/Console/ConsoleInputSubcommand.php
  8. +2 −2 src/Console/ConsoleOptionParser.php
  9. +2 −2 src/Console/ConsoleOutput.php
  10. +1 −1 src/Console/HelpFormatter.php
  11. +1 −1 src/Console/Shell.php
  12. +1 −1 src/Controller/Component/AuthComponent.php
  13. +2 −2 src/Controller/Component/CookieComponent.php
  14. +1 −1 src/Controller/Component/SecurityComponent.php
  15. +4 −4 src/Database/Connection.php
  16. +1 −1 src/Database/Dialect/SqlserverDialectTrait.php
  17. +2 −2 src/Database/Driver.php
  18. +4 −5 src/Database/Driver/PDODriverTrait.php
  19. +1 −1 src/Database/Expression/Comparison.php
  20. +1 −1 src/Database/Expression/ValuesExpression.php
  21. +3 −3 src/Database/Log/LoggedQuery.php
  22. +2 −2 src/Database/Log/LoggingStatement.php
  23. +1 −1 src/Database/Query.php
  24. +1 −1 src/Database/Schema/TableSchema.php
  25. +1 −0 src/Database/Statement/BufferedStatement.php
  26. +1 −1 src/Database/Statement/StatementDecorator.php
  27. +1 −1 src/Database/Type.php
  28. +1 −1 src/Database/Type/DecimalType.php
  29. +5 −5 src/Database/Type/FloatType.php
  30. +2 −2 src/Database/Type/IntegerType.php
  31. +2 −2 src/Datasource/QueryTrait.php
  32. +4 −4 src/Error/Debugger.php
  33. +8 −8 src/Error/ExceptionRenderer.php
  34. +1 −1 src/Event/Event.php
  35. +2 −2 src/Filesystem/Folder.php
  36. +2 −2 src/Http/ActionDispatcher.php
  37. +3 −3 src/Http/Client/Adapter/Stream.php
  38. +3 −3 src/Http/ControllerFactory.php
  39. +1 −1 src/Http/Response.php
  40. +1 −1 src/Http/ResponseTransformer.php
  41. +1 −1 src/Http/ServerRequestFactory.php
  42. +4 −4 src/I18n/I18n.php
  43. +2 −2 src/I18n/Number.php
  44. +2 −2 src/I18n/Time.php
  45. +1 −1 src/I18n/TranslatorRegistry.php
  46. +2 −2 src/Log/Log.php
  47. +4 −4 src/Mailer/Email.php
  48. +2 −2 src/Mailer/Transport/SmtpTransport.php
  49. +1 −1 src/Network/Session.php
  50. +3 −3 src/Network/Socket.php
  51. +1 −1 src/ORM/Behavior/TimestampBehavior.php
  52. +2 −2 src/ORM/Behavior/TranslateBehavior.php
  53. +2 −2 src/ORM/Behavior/TreeBehavior.php
  54. +9 −6 src/ORM/EagerLoader.php
  55. +1 −1 src/ORM/Query.php
  56. +1 −1 src/Routing/Dispatcher.php
  57. +1 −0 src/Routing/DispatcherFilter.php
  58. +2 −0 src/Routing/Filter/AssetFilter.php
  59. +1 −0 src/Routing/Filter/LocaleSelectorFilter.php
  60. +2 −0 src/Routing/Filter/RoutingFilter.php
  61. +1 −1 src/Routing/Route/Route.php
  62. +1 −1 src/Routing/RouteBuilder.php
  63. +1 −1 src/Routing/Router.php
  64. +1 −1 src/Shell/CommandListShell.php
  65. +1 −1 src/Shell/ServerShell.php
  66. +1 −1 src/Shell/Task/ExtractTask.php
  67. +2 −2 src/TestSuite/Fixture/FixtureInjector.php
  68. +15 −15 src/TestSuite/IntegrationTestCase.php
  69. +1 −1 src/TestSuite/MiddlewareDispatcher.php
  70. +1 −1 src/TestSuite/TestCase.php
  71. +3 −3 src/Utility/CookieCryptTrait.php
  72. +1 −1 src/Utility/Security.php
  73. +1 −1 src/View/Form/EntityContext.php
  74. +5 −3 src/View/Helper/FormHelper.php
  75. +2 −1 src/View/Helper/HtmlHelper.php
  76. +1 −1 src/View/Helper/NumberHelper.php
  77. +3 −3 src/View/Helper/PaginatorHelper.php
  78. +2 −2 src/View/Helper/TimeHelper.php
  79. +1 −1 src/View/SerializedView.php
  80. +1 −1 src/View/View.php
  81. +1 −1 src/View/Widget/MultiCheckboxWidget.php
  82. +1 −1 src/View/Widget/RadioWidget.php
  83. +5 −0 tests/TestCase/Controller/Component/CookieComponentTest.php
  84. +1 −1 tests/TestCase/Database/DriverTest.php
  85. +2 −2 tests/TestCase/Database/Type/FloatTypeTest.php
  86. +1 −1 tests/TestCase/View/Helper/TimeHelperTest.php
@@ -132,7 +132,7 @@ public function getUser(ServerRequest $request)
* Gets the digest headers from the request/environment.
*
* @param \Cake\Http\ServerRequest $request Request object.
* @return array Array of digest information.
* @return array|bool Array of digest information.
*/
protected function _getDigest(ServerRequest $request)
{
@@ -30,7 +30,7 @@ class MemoryStorage implements StorageInterface
/**
* Redirect url.
*
* @var string
* @var string|null
*/
protected $_redirectUrl;
@@ -102,7 +102,7 @@ class Cache
/**
* Cache Registry used for creating and using cache adapters.
*
* @var \Cake\Cache\CacheRegistry
* @var \Cake\Core\ObjectRegistry
*/
protected static $_registry;
@@ -36,7 +36,7 @@ class FileEngine extends CacheEngine
/**
* Instance of SplFileObject class
*
* @var \SplFileObject
* @var \SplFileObject|null
*/
protected $_File = null;
@@ -204,7 +204,7 @@ public function groups()
*/
public function clearGroup($group)
{
$success = null;
$success = false;
wincache_ucache_inc($this->_config['prefix'] . $group, 1, $success);
return $success;
@@ -52,7 +52,7 @@ class MapReduce implements IteratorAggregate
/**
* Holds the original data that needs to be processed
*
* @var \Traversable
* @var \Traversable|null
*/
protected $_data;
@@ -74,7 +74,7 @@ class MapReduce implements IteratorAggregate
/**
* Count of elements emitted during the Reduce phase
*
* @var string
* @var int
*/
protected $_counter = 0;
@@ -102,7 +102,7 @@ public function help($width = 0)
/**
* Get the usage value for this option
*
* @return mixed Either false or a ConsoleOptionParser
* @return \Cake\Console\ConsoleOptionParser|bool Either false or a ConsoleOptionParser
*/
public function parser()
{
@@ -100,7 +100,7 @@ class ConsoleOptionParser
/**
* Map of short -> long options, generated when using addOption()
*
* @var string
* @var array
*/
protected $_shortOptions = [];
@@ -501,7 +501,7 @@ public function addArgument($name, array $params = [])
if ($a->isEqualTo($arg)) {
return $this;
}
if ($options['required'] && !$a->isRequired()) {
if (!empty($options['required']) && !$a->isRequired()) {
throw new LogicException('A required argument cannot follow an optional one');
}
}
@@ -119,9 +119,9 @@ class ConsoleOutput
];
/**
* formatting options for colored output
* Formatting options for colored output.
*
* @var string
* @var array
*/
protected static $_options = [
'bold' => 1,
@@ -210,6 +210,6 @@ public function xml($string = true)
$argument->xml($arguments);
}
return $string ? $xml->asXml() : $xml;
return $string ? $xml->asXML() : $xml;
}
}
@@ -129,7 +129,7 @@ class Shell
/**
* Contains tasks to load and instantiate
*
* @var array
* @var array|bool
* @link http://book.cakephp.org/3.0/en/console-and-shells.html#Shell::$tasks
*/
public $tasks = [];
@@ -192,7 +192,7 @@ class AuthComponent extends Component
/**
* Storage object.
*
* @var \Cake\Auth\Storage\StorageInterface
* @var \Cake\Auth\Storage\StorageInterface|null
*/
protected $_storage;
@@ -85,7 +85,7 @@ class CookieComponent extends Component
*
* Accessed in the controller using $this->Cookie->read('Name.key');
*
* @var string
* @var array
*/
protected $_values = [];
@@ -104,7 +104,7 @@ class CookieComponent extends Component
* A reference to the Controller's Cake\Network\Response object.
* Currently unused.
*
* @var \Cake\Network\Response
* @var \Cake\Network\Response|null
* @deprecated 3.4.0 Will be removed in 4.0.0
*/
protected $_response = null;
@@ -637,7 +637,7 @@ protected function _matchExistingFields($dataFields, &$expectedFields, $intKeyMe
*
* @param array $expectedFields Expected fields
* @param string $missingMessage Message template
* @return string Error message about expected fields
* @return string|null Error message about expected fields
*/
protected function _debugExpectedFields($expectedFields = [], $missingMessage = '')
{
@@ -88,9 +88,9 @@ class Connection implements ConnectionInterface
/**
* The schema collection object
*
* @var \Cake\Database\Schema\Collection
* @var \Cake\Database\Schema\Collection|null
*/
protected $_schemaCollection;
protected $_schemaCollection = null;
/**
* Constructor.
@@ -612,7 +612,7 @@ public function rollbackSavepoint($name)
*/
public function disableForeignKeys()
{
$this->execute($this->_driver->disableForeignKeySql())->closeCursor();
$this->execute($this->_driver->disableForeignKeySQL())->closeCursor();
}
/**
@@ -622,7 +622,7 @@ public function disableForeignKeys()
*/
public function enableForeignKeys()
{
$this->execute($this->_driver->enableForeignKeySql())->closeCursor();
$this->execute($this->_driver->enableForeignKeySQL())->closeCursor();
}
/**
@@ -298,7 +298,7 @@ protected function _transformFunctionExpression(FunctionExpression $expression)
* Used by Cake\Schema package to reflect schema and
* generate schema.
*
* @return \Cake\Database\Schema\MysqlSchema
* @return \Cake\Database\Schema\SqlserverSchema
*/
public function schemaDialect()
{
@@ -86,7 +86,7 @@ public function __construct($config = [])
* If first argument is passed,
*
* @param null|\PDO $connection The connection object
* @return void
* @return \Cake\Database\Connection
*/
abstract public function connection($connection = null);
@@ -258,7 +258,7 @@ public function schemaValue($value)
is_numeric($value) && strpos($value, ',') === false &&
$value[0] !== '0' && strpos($value, 'e') === false)
) {
return $value;
return (string)$value;
}
return $this->_connection->quote($value, PDO::PARAM_STR);
@@ -27,9 +27,9 @@ trait PDODriverTrait
/**
* Instance of PDO.
*
* @var \PDO
* @var \PDO|null
*/
protected $_connection;
protected $_connection = null;
/**
* Establishes a connection to the database server
@@ -79,7 +79,7 @@ public function disconnect()
}
/**
* Check whether or not the driver is connected.
* Checks whether or not the driver is connected.
*
* @return bool
*/
@@ -94,9 +94,8 @@ public function isConnected()
$connected = false;
}
}
$this->connected = !empty($connected);
return $this->connected;
return (bool)$connected;
}
/**
@@ -42,7 +42,7 @@ class Comparison implements ExpressionInterface, FieldInterface
/**
* The type to be used for casting the value to a database representation
*
* @var string
* @var string|array
*/
protected $_type;
@@ -60,7 +60,7 @@ class ValuesExpression implements ExpressionInterface
* Whether or not values have been casted to expressions
* already.
*
* @var string
* @var bool
*/
protected $_castedExpressions = false;
@@ -33,14 +33,14 @@ class LoggedQuery
/**
* Number of milliseconds this query took to complete
*
* @var float
* @var int
*/
public $took = 0;
/**
* Associative array with the params bound to the query string
*
* @var string
* @var array
*/
public $params = [];
@@ -54,7 +54,7 @@ class LoggedQuery
/**
* The exception that was thrown by the execution of this query
*
* @var \Exception
* @var \Exception|null
*/
public $error;
@@ -28,7 +28,7 @@ class LoggingStatement extends StatementDecorator
/**
* Logger instance responsible for actually doing the logging task
*
* @var \Cake\Database\Log\QueryLogger
* @var \Cake\Database\Log\QueryLogger|null
*/
protected $_logger;
@@ -110,7 +110,7 @@ public function bindValue($column, $value, $type = 'string')
* it returns the currently setup logger instance
*
* @param object|null $instance Logger object instance.
* @return object Logger instance
* @return object|null Logger instance
*/
public function logger($instance = null)
{
@@ -1618,7 +1618,7 @@ public function func()
* iterated without having to call execute() manually, thus making it look like
* a result set instead of the query itself.
*
* @return \Iterator
* @return \Cake\Database\StatementInterface|null
*/
public function getIterator()
{
@@ -399,7 +399,7 @@ public function columnType($name, $type = null)
* based upon.
*
* @param string $column The column name to get the base type from
* @return string The base type name
* @return string|null The base type name
*/
public function baseColumnType($column)
{
@@ -46,6 +46,7 @@ class BufferedStatement extends StatementDecorator
/**
* Current record pointer
*
* @var int
*/
protected $_counter = 0;
@@ -37,7 +37,7 @@ class StatementDecorator implements StatementInterface, Countable, IteratorAggre
* Statement instance implementation, such as PDOStatement
* or any other custom implementation.
*
* @var mixed
* @var \Cake\Database\StatementInterface
*/
protected $_statement;
@@ -269,7 +269,7 @@ public static function boolval($value)
* Will convert values into strings
*
* @param mixed $value The value to convert to a string.
* @return bool
* @return string
* @deprecated 3.1.8 This method is now unused.
*/
public static function strval($value)
@@ -72,7 +72,7 @@ public function toDatabase($value, Driver $driver)
*
* @param null|string|resource $value The value to convert.
* @param \Cake\Database\Driver $driver The driver instance to convert with.
* @return float
* @return float|null
* @throws \Cake\Core\Exception\Exception
*/
public function toPHP($value, Driver $driver)
Oops, something went wrong.

0 comments on commit 2312ab8

Please sign in to comment.
You can’t perform that action at this time.