Skip to content

Commit

Permalink
cs standard corrections for doc blocks
Browse files Browse the repository at this point in the history
  • Loading branch information
euromark committed Jun 16, 2014
1 parent aef69a1 commit e2d79f1
Show file tree
Hide file tree
Showing 24 changed files with 34 additions and 34 deletions.
2 changes: 1 addition & 1 deletion src/Auth/AbstractPasswordHasher.php
Expand Up @@ -69,7 +69,7 @@ abstract public function check($password, $hashedPassword);
* on is the one provided by default in php 5.5+ or any compatible library
*
* @param string $password The password to verify
* @return boolean
* @return bool
*/
public function needsRehash($password) {
return password_needs_rehash($password, PASSWORD_DEFAULT);
Expand Down
2 changes: 1 addition & 1 deletion src/Auth/FallbackPasswordHasher.php
Expand Up @@ -90,7 +90,7 @@ public function check($password, $hashedPassword) {
* in the list of hashers
*
* @param string $password The password to verify
* @return boolean
* @return bool
*/
public function needsRehash($password) {
return $this->_hashers[0]->needsRehash($password);
Expand Down
2 changes: 1 addition & 1 deletion src/Auth/SimplePasswordHasher.php
Expand Up @@ -59,7 +59,7 @@ public function check($password, $hashedPassword) {
* created with anything else than the passwords generated by this class.
*
* @param string $password The password to verify
* @return boolean
* @return bool
*/
public function needsRehash($password) {
return password_needs_rehash($password, $this->_config['hashType']);
Expand Down
4 changes: 2 additions & 2 deletions src/Cache/Engine/FileEngine.php
Expand Up @@ -317,7 +317,7 @@ protected function _clearDirectory($path, $now, $threshold) {
* Not implemented
*
* @param string $key The key to decrement
* @param integer $offset The number to offset
* @param int $offset The number to offset
* @return void
* @throws \Cake\Error\Exception
*/
Expand All @@ -329,7 +329,7 @@ public function decrement($key, $offset = 1) {
* Not implemented
*
* @param string $key The key to decrement
* @param integer $offset The number to offset
* @param int $offset The number to offset
* @return void
* @throws \Cake\Error\Exception
*/
Expand Down
4 changes: 2 additions & 2 deletions src/Cache/Engine/XcacheEngine.php
Expand Up @@ -145,10 +145,10 @@ public function delete($key) {
/**
* Delete all keys from the cache
*
* @param boolean $check If true no deletes will occur and instead CakePHP will rely
* @param bool $check If true no deletes will occur and instead CakePHP will rely
* on key TTL values.
* Unused for Xcache engine.
* @return boolean True if the cache was successfully cleared, false otherwise
* @return bool True if the cache was successfully cleared, false otherwise
*/
public function clear($check) {
$this->_auth();
Expand Down
4 changes: 2 additions & 2 deletions src/Console/Command/OrmCacheShell.php
Expand Up @@ -33,7 +33,7 @@ class OrmCacheShell extends Shell {
* Build metadata.
*
* @param $name string
* @return boolean
* @return bool
*/
public function build($name = null) {
$schema = $this->_getSchema();
Expand All @@ -60,7 +60,7 @@ public function build($name = null) {
* Clear metadata.
*
* @param $name string
* @return boolean
* @return bool
*/
public function clear($name = null) {
$schema = $this->_getSchema();
Expand Down
4 changes: 2 additions & 2 deletions src/Console/Command/Task/ExtractTask.php
Expand Up @@ -563,8 +563,8 @@ protected function _writeHeader() {
/**
* Get the strings from the position forward
*
* @param integer &$position Actual position on tokens array
* @param integer $target Number of strings to extract
* @param int &$position Actual position on tokens array
* @param int $target Number of strings to extract
* @return array Strings extracted
*/
protected function _getStrings(&$position, $target) {
Expand Down
2 changes: 1 addition & 1 deletion src/Console/Command/Task/FixtureTask.php
Expand Up @@ -312,7 +312,7 @@ protected function _values($values) {
* Generate String representation of Records
*
* @param array $tableInfo Table schema array
* @param integer $recordCount The number of records to generate.
* @param int $recordCount The number of records to generate.
* @return array Array of records to use in the fixture.
*/
protected function _generateRecords(Table $table, $recordCount = 1) {
Expand Down
2 changes: 1 addition & 1 deletion src/Console/Command/Task/ProjectTask.php
Expand Up @@ -115,7 +115,7 @@ public function findComposer() {
* Search the $PATH for composer.
*
* @param array $path The paths to search.
* @return string|boolean
* @return string|bool
*/
protected function _searchPath($path) {
$composer = ['composer.phar', 'composer'];
Expand Down
2 changes: 1 addition & 1 deletion src/Console/Shell.php
Expand Up @@ -320,7 +320,7 @@ public function dispatchShell() {
* or methods on tasks.
*
* @param array $argv Array of arguments to run the shell with. This array should be missing the shell name.
* @param boolean $autoMethod Set to true to allow any public method to be called even if it
* @param bool $autoMethod Set to true to allow any public method to be called even if it
* was not defined as a subcommand. This is used by ShellDispatcher to make building simple shells easy.
* @return void
* @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::runCommand
Expand Down
2 changes: 1 addition & 1 deletion src/Console/ShellDispatcher.php
Expand Up @@ -193,7 +193,7 @@ public function findShell($shell) {
* Check if a shell class exists for the given name.
*
* @param string $shell The shell name to look for.
* @return string|boolean Either the classname or false.
* @return string|bool Either the classname or false.
*/
protected function _shellExists($shell) {
$class = array_map('Cake\Utility\Inflector::camelize', explode('.', $shell));
Expand Down
4 changes: 2 additions & 2 deletions src/Database/Driver/Sqlserver.php
Expand Up @@ -47,7 +47,7 @@ class Sqlserver extends \Cake\Database\Driver {
/**
* Establishes a connection to the database server
*
* @return boolean true on success
* @return bool true on success
*/
public function connect() {
if ($this->_connection) {
Expand Down Expand Up @@ -85,7 +85,7 @@ public function connect() {
/**
* Returns whether PHP is able to use this driver for connecting to database
*
* @return boolean true if it is valid to use this driver
* @return bool true if it is valid to use this driver
*/
public function enabled() {
return in_array('sqlsrv', PDO::getAvailableDrivers());
Expand Down
2 changes: 1 addition & 1 deletion src/Database/Expression/FunctionExpression.php
Expand Up @@ -83,7 +83,7 @@ public function name($name = null) {
* If associative the key would be used as argument when value is 'literal'
* @param array $types associative array of types to be associated with the
* passed arguments
* @param boolean $prepend Whehter to prepend or append to the list of arguments
* @param bool $prepend Whehter to prepend or append to the list of arguments
* @see FunctionExpression::__construct() for more details.
* @return FunctionExpression
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Database/Type/DateTimeType.php
Expand Up @@ -51,7 +51,7 @@ public function __construct($name = null) {
/**
* Convert DateTime instance into strings.
*
* @param string|integer|DateTime $value The value to convert.
* @param string|int|\DateTime $value The value to convert.
* @param Driver $driver The driver instance to convert with.
* @return string
*/
Expand Down
6 changes: 3 additions & 3 deletions src/Network/Session.php
Expand Up @@ -45,7 +45,7 @@ class Session {
/**
* Indicates whether the sessions has already started
*
* @var boolean
* @var bool
*/
protected $_started;

Expand All @@ -59,7 +59,7 @@ class Session {
/**
* Whehter this session is running under a CLI environment
*
* @var boolean
* @var bool
*/
protected $_isCli = false;

Expand Down Expand Up @@ -581,7 +581,7 @@ public function deleteFlash($key = 'flash') {
* Returns true if the session is no longer valid because the last time it was
* accessed was after the configured timeout.
*
* @return boolean
* @return bool
*/
protected function _timedOut() {
$time = $this->read('Config.time');
Expand Down
2 changes: 1 addition & 1 deletion src/ORM/Table.php
Expand Up @@ -1769,7 +1769,7 @@ public function validateMany($entities, array $options = []) {
* @param mixed $value The value of column to be checked for uniqueness
* @param array $options The options array, optionally containing the 'scope' key
* @param array $context The validation context as provided by the validation routine
* @return boolean true if the value is unique
* @return bool true if the value is unique
*/
public function validateUnique($value, array $options, array $context = []) {
if (empty($context)) {
Expand Down
2 changes: 1 addition & 1 deletion src/Routing/DispatcherFilter.php
Expand Up @@ -143,7 +143,7 @@ public function handle(Event $event) {
* Check to see if the incoming request matches this filter's criteria.
*
* @param \Cake\Event\Event $event The event to match.
* @return boolean
* @return bool
*/
public function matches(Event $event) {
$request = $event->data['request'];
Expand Down
4 changes: 2 additions & 2 deletions src/TestSuite/TestCase.php
Expand Up @@ -240,7 +240,7 @@ public function assertTextEndsNotWith($suffix, $string, $message = '') {
* @param string $needle The string to search for.
* @param string $haystack The string to search through.
* @param string $message The message to display on failure.
* @param boolean $ignoreCase Whether or not the search should be case-sensitive.
* @param bool $ignoreCase Whether or not the search should be case-sensitive.
* @return void
*/
public function assertTextContains($needle, $haystack, $message = '', $ignoreCase = false) {
Expand All @@ -256,7 +256,7 @@ public function assertTextContains($needle, $haystack, $message = '', $ignoreCas
* @param string $needle The string to search for.
* @param string $haystack The string to search through.
* @param string $message The message to display on failure.
* @param boolean $ignoreCase Whether or not the search should be case-sensitive.
* @param bool $ignoreCase Whether or not the search should be case-sensitive.
* @return void
*/
public function assertTextNotContains($needle, $haystack, $message = '', $ignoreCase = false) {
Expand Down
2 changes: 1 addition & 1 deletion src/Utility/Number.php
Expand Up @@ -241,7 +241,7 @@ public static function formatDelta($value, array $options = array()) {
* Alternative number_format() to accommodate multibyte decimals and thousands < PHP 5.4
*
* @param float $value Value to format.
* @param integer $places Decimal places to use.
* @param int $places Decimal places to use.
* @param string $decimals Decimal position string.
* @param string $thousands Thousands separator string.
* @return string
Expand Down
6 changes: 3 additions & 3 deletions src/Validation/Validation.php
Expand Up @@ -107,9 +107,9 @@ public static function lengthBetween($check, $min, $max) {
* Alias of Validator::lengthBetween() for backwards compatibility.
*
* @param string $check Value to check for length
* @param integer $min Minimum value in range (inclusive)
* @param integer $max Maximum value in range (inclusive)
* @return boolean Success
* @param int $min Minimum value in range (inclusive)
* @param int $max Maximum value in range (inclusive)
* @return bool Success
* @see Validator::lengthBetween()
* @deprecated 2.6 Use Validator::lengthBetween() instead.
*/
Expand Down
2 changes: 1 addition & 1 deletion src/View/Helper/CacheHelper.php
Expand Up @@ -284,7 +284,7 @@ protected function _parseOutput($cache) {
*
* @param string $content view content to write to a cache file.
* @param string $timestamp Duration to set for cache file.
* @param boolean $useCallbacks Whether to include statements in cached file which
* @param bool $useCallbacks Whether to include statements in cached file which
* run callbacks.
* @return bool success of caching view.
*/
Expand Down
2 changes: 1 addition & 1 deletion src/View/Helper/NumberHelper.php
Expand Up @@ -98,7 +98,7 @@ public function precision($number, $precision = 3) {
/**
* Returns a formatted-for-humans file size.
*
* @param integer $size Size in bytes
* @param int $size Size in bytes
* @return string Human readable size
* @see \Cake\Utility\Number::toReadableSize()
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/number.html#NumberHelper::toReadableSize
Expand Down
2 changes: 1 addition & 1 deletion src/View/Helper/TextHelper.php
Expand Up @@ -309,7 +309,7 @@ public function truncate($text, $length = 100, array $options = array()) {
* - `exact` If false, $text will not be cut mid-word
*
* @param string $text String to truncate.
* @param integer $length Length of returned string, including ellipsis.
* @param int $length Length of returned string, including ellipsis.
* @param array $options An array of html attributes and options.
* @return string Trimmed string.
* @see String::tail()
Expand Down
2 changes: 1 addition & 1 deletion src/View/JsonView.php
Expand Up @@ -58,7 +58,7 @@ class JsonView extends View {
/**
* JSON layouts are located in the json sub directory of `Layouts/`
*
* @var string
* @var string
*/
public $layoutPath = 'json';

Expand Down

0 comments on commit e2d79f1

Please sign in to comment.