From c989624f8053f28d2ac37f5e84dc436965235177 Mon Sep 17 00:00:00 2001 From: euromark Date: Fri, 5 Jul 2013 14:15:18 +0200 Subject: [PATCH] whitespace coding standards --- .../Component/Auth/BlowfishAuthenticate.php | 6 +++--- lib/Cake/Core/Object.php | 2 +- lib/Cake/Model/Behavior/ContainableBehavior.php | 2 +- lib/Cake/Model/Behavior/TreeBehavior.php | 2 +- lib/Cake/Model/Datasource/Database/Postgres.php | 2 +- lib/Cake/Model/Datasource/Database/Sqlite.php | 2 +- lib/Cake/Model/Datasource/DboSource.php | 2 +- lib/Cake/TestSuite/CakeTestCase.php | 2 +- lib/Cake/TestSuite/Reporter/CakeHtmlReporter.php | 3 ++- lib/Cake/Utility/CakeNumber.php | 2 +- lib/Cake/Utility/ClassRegistry.php | 6 +++--- lib/Cake/View/Helper.php | 2 +- lib/Cake/View/Helper/FormHelper.php | 8 ++++---- lib/Cake/View/Helper/NumberHelper.php | 2 +- lib/Cake/basics.php | 14 +++++++------- 15 files changed, 29 insertions(+), 28 deletions(-) diff --git a/lib/Cake/Controller/Component/Auth/BlowfishAuthenticate.php b/lib/Cake/Controller/Component/Auth/BlowfishAuthenticate.php index b18b008d4..a44b30aac 100644 --- a/lib/Cake/Controller/Component/Auth/BlowfishAuthenticate.php +++ b/lib/Cake/Controller/Component/Auth/BlowfishAuthenticate.php @@ -34,9 +34,9 @@ App::uses('FormAuthenticate', 'Controller/Component/Auth'); * For initial password hashing/creation see Security::hash(). Other than how the password is initially hashed, * BlowfishAuthenticate works exactly the same way as FormAuthenticate. * - * @package Cake.Controller.Component.Auth - * @since CakePHP(tm) v 2.3 - * @see AuthComponent::$authenticate + * @package Cake.Controller.Component.Auth + * @since CakePHP(tm) v 2.3 + * @see AuthComponent::$authenticate */ class BlowfishAuthenticate extends FormAuthenticate { diff --git a/lib/Cake/Core/Object.php b/lib/Cake/Core/Object.php index ed740659a..bfeaf59d6 100644 --- a/lib/Cake/Core/Object.php +++ b/lib/Cake/Core/Object.php @@ -112,7 +112,7 @@ class Object { * * @param string $method Name of the method to call * @param array $params Parameter list to use when calling $method - * @return mixed Returns the result of the method call + * @return mixed Returns the result of the method call */ public function dispatchMethod($method, $params = array()) { switch (count($params)) { diff --git a/lib/Cake/Model/Behavior/ContainableBehavior.php b/lib/Cake/Model/Behavior/ContainableBehavior.php index 18d430a63..6fb2121cd 100644 --- a/lib/Cake/Model/Behavior/ContainableBehavior.php +++ b/lib/Cake/Model/Behavior/ContainableBehavior.php @@ -88,7 +88,7 @@ class ContainableBehavior extends ModelBehavior { * ))); * }}} * - * @param Model $Model Model using the behavior + * @param Model $Model Model using the behavior * @param array $query Query parameters as set by cake * @return array */ diff --git a/lib/Cake/Model/Behavior/TreeBehavior.php b/lib/Cake/Model/Behavior/TreeBehavior.php index 1faeec819..bcb5e511b 100644 --- a/lib/Cake/Model/Behavior/TreeBehavior.php +++ b/lib/Cake/Model/Behavior/TreeBehavior.php @@ -105,7 +105,7 @@ class TreeBehavior extends ModelBehavior { /** * Runs before a find() operation * - * @param Model $Model Model using the behavior + * @param Model $Model Model using the behavior * @param array $query Query parameters as set by cake * @return array */ diff --git a/lib/Cake/Model/Datasource/Database/Postgres.php b/lib/Cake/Model/Datasource/Database/Postgres.php index 743feb35e..6a34064d3 100644 --- a/lib/Cake/Model/Datasource/Database/Postgres.php +++ b/lib/Cake/Model/Datasource/Database/Postgres.php @@ -328,7 +328,7 @@ class Postgres extends DboSource { * @param string|Model $table A string or model class representing the table to be truncated * @param boolean $reset true for resetting the sequence, false to leave it as is. * and if 1, sequences are not modified - * @return boolean SQL TRUNCATE TABLE statement, false if not applicable. + * @return boolean SQL TRUNCATE TABLE statement, false if not applicable. */ public function truncate($table, $reset = false) { $table = $this->fullTableName($table, false, false); diff --git a/lib/Cake/Model/Datasource/Database/Sqlite.php b/lib/Cake/Model/Datasource/Database/Sqlite.php index eabcb0876..613aeeefe 100644 --- a/lib/Cake/Model/Datasource/Database/Sqlite.php +++ b/lib/Cake/Model/Datasource/Database/Sqlite.php @@ -227,7 +227,7 @@ class Sqlite extends DboSource { * primary key, where applicable. * * @param string|Model $table A string or model class representing the table to be truncated - * @return boolean SQL TRUNCATE TABLE statement, false if not applicable. + * @return boolean SQL TRUNCATE TABLE statement, false if not applicable. */ public function truncate($table) { $this->_execute('DELETE FROM sqlite_sequence where name=' . $this->startQuote . $this->fullTableName($table, false, false) . $this->endQuote); diff --git a/lib/Cake/Model/Datasource/DboSource.php b/lib/Cake/Model/Datasource/DboSource.php index db80a4fa4..abdad2437 100644 --- a/lib/Cake/Model/Datasource/DboSource.php +++ b/lib/Cake/Model/Datasource/DboSource.php @@ -2031,7 +2031,7 @@ class DboSource extends DataSource { * primary key, where applicable. * * @param Model|string $table A string or model class representing the table to be truncated - * @return boolean SQL TRUNCATE TABLE statement, false if not applicable. + * @return boolean SQL TRUNCATE TABLE statement, false if not applicable. */ public function truncate($table) { return $this->execute('TRUNCATE TABLE ' . $this->fullTableName($table)); diff --git a/lib/Cake/TestSuite/CakeTestCase.php b/lib/Cake/TestSuite/CakeTestCase.php index a7364e8fb..467b6ba10 100644 --- a/lib/Cake/TestSuite/CakeTestCase.php +++ b/lib/Cake/TestSuite/CakeTestCase.php @@ -73,7 +73,7 @@ abstract class CakeTestCase extends PHPUnit_Framework_TestCase { * If no TestResult object is passed a new one will be created. * This method is run for each test method in this class * - * @param PHPUnit_Framework_TestResult $result + * @param PHPUnit_Framework_TestResult $result * @return PHPUnit_Framework_TestResult * @throws InvalidArgumentException */ diff --git a/lib/Cake/TestSuite/Reporter/CakeHtmlReporter.php b/lib/Cake/TestSuite/Reporter/CakeHtmlReporter.php index 91677bac0..c226790b5 100644 --- a/lib/Cake/TestSuite/Reporter/CakeHtmlReporter.php +++ b/lib/Cake/TestSuite/Reporter/CakeHtmlReporter.php @@ -372,7 +372,8 @@ class CakeHtmlReporter extends CakeBaseReporter { /** * A test suite started. * - * @param PHPUnit_Framework_TestSuite $suite + * @param PHPUnit_Framework_TestSuite $suite + * @return void */ public function startTestSuite(PHPUnit_Framework_TestSuite $suite) { if (!$this->_headerSent) { diff --git a/lib/Cake/Utility/CakeNumber.php b/lib/Cake/Utility/CakeNumber.php index 2a71088f9..c3ceb4878 100644 --- a/lib/Cake/Utility/CakeNumber.php +++ b/lib/Cake/Utility/CakeNumber.php @@ -371,7 +371,7 @@ class CakeNumber { /** * Getter/setter for default currency * - * @param string $currency Default currency string used by currency() if $currency argument is not provided + * @param string $currency Default currency string used by currency() if $currency argument is not provided * @return string Currency */ public static function defaultCurrency($currency = null) { diff --git a/lib/Cake/Utility/ClassRegistry.php b/lib/Cake/Utility/ClassRegistry.php index 6e39fb794..1f0108940 100644 --- a/lib/Cake/Utility/ClassRegistry.php +++ b/lib/Cake/Utility/ClassRegistry.php @@ -203,8 +203,8 @@ class ClassRegistry { /** * Add $object to the registry, associating it with the name $key. * - * @param string $key Key for the object in registry - * @param object $object Object to store + * @param string $key Key for the object in registry + * @param object $object Object to store * @return boolean True if the object was written, false if $key already exists */ public static function addObject($key, $object) { @@ -220,7 +220,7 @@ class ClassRegistry { /** * Remove object which corresponds to given key. * - * @param string $key Key of object to remove from registry + * @param string $key Key of object to remove from registry * @return void */ public static function removeObject($key) { diff --git a/lib/Cake/View/Helper.php b/lib/Cake/View/Helper.php index cc3638aed..6ad4ed380 100644 --- a/lib/Cake/View/Helper.php +++ b/lib/Cake/View/Helper.php @@ -247,7 +247,7 @@ class Helper extends Object { * an array of url parameters. Using an array for URLs will allow you to leverage * the reverse routing features of CakePHP. * @param boolean $full If true, the full base URL will be prepended to the result - * @return string Full translated URL with base path. + * @return string Full translated URL with base path. * @link http://book.cakephp.org/2.0/en/views/helpers.html */ public function url($url = null, $full = false) { diff --git a/lib/Cake/View/Helper/FormHelper.php b/lib/Cake/View/Helper/FormHelper.php index 1f6773bd3..d2860d9c0 100644 --- a/lib/Cake/View/Helper/FormHelper.php +++ b/lib/Cake/View/Helper/FormHelper.php @@ -649,14 +649,14 @@ class FormHelper extends AppHelper { * * ### Options: * - * - `escape` bool Whether or not to html escape the contents of the error. - * - `wrap` mixed Whether or not the error message should be wrapped in a div. If a + * - `escape` bool - Whether or not to html escape the contents of the error. + * - `wrap` mixed - Whether or not the error message should be wrapped in a div. If a * string, will be used as the HTML tag to use. - * - `class` string The classname for the error message + * - `class` string - The classname for the error message * * @param string $field A field name, like "Modelname.fieldname" * @param string|array $text Error message as string or array of messages. - * If array contains `attributes` key it will be used as options for error container + * If array contains `attributes` key it will be used as options for error container * @param array $options Rendering options for
wrapper tag * @return string If there are errors this method returns an error message, otherwise null. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::error diff --git a/lib/Cake/View/Helper/NumberHelper.php b/lib/Cake/View/Helper/NumberHelper.php index 7f359a5f9..79fcc9946 100644 --- a/lib/Cake/View/Helper/NumberHelper.php +++ b/lib/Cake/View/Helper/NumberHelper.php @@ -76,7 +76,7 @@ class NumberHelper extends AppHelper { /** * @see CakeNumber::precision() * - * @param float $number A floating point number. + * @param float $number A floating point number. * @param integer $precision The precision of the returned number. * @return float Formatted float. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/number.html#NumberHelper::precision diff --git a/lib/Cake/basics.php b/lib/Cake/basics.php index 14b31cb14..c9c0cb3f3 100644 --- a/lib/Cake/basics.php +++ b/lib/Cake/basics.php @@ -233,7 +233,7 @@ if (!function_exists('pr')) { * Print_r convenience function, which prints out 
 tags around
  * the output of given array. Similar to debug().
  *
- * @see	debug()
+ * @see debug()
  * @param array $var Variable to print out
  * @link http://book.cakephp.org/2.0/en/core-libraries/global-constants-and-functions.html#pr
  */
@@ -281,7 +281,7 @@ if (!function_exists('env')) {
  * IIS, or SCRIPT_NAME in CGI mode). Also exposes some additional custom
  * environment information.
  *
- * @param  string $key Environment variable name.
+ * @param string $key Environment variable name.
  * @return string Environment variable setting.
  * @link http://book.cakephp.org/2.0/en/core-libraries/global-constants-and-functions.html#env
  */
@@ -382,11 +382,11 @@ if (!function_exists('cache')) {
 /**
  * Reads/writes temporary data to cache files or session.
  *
- * @param  string $path	File path within /tmp to save the file.
- * @param  mixed  $data	The data to save to the temporary file.
- * @param  mixed  $expires A valid strtotime string when the data expires.
- * @param  string $target  The target of the cached data; either 'cache' or 'public'.
- * @return mixed  The contents of the temporary file.
+ * @param string $path File path within /tmp to save the file.
+ * @param mixed $data The data to save to the temporary file.
+ * @param mixed $expires A valid strtotime string when the data expires.
+ * @param string $target The target of the cached data; either 'cache' or 'public'.
+ * @return mixed The contents of the temporary file.
  * @deprecated Please use Cache::write() instead
  */
 	function cache($path, $data = null, $expires = '+1 day', $target = 'cache') {