From 2793dca6710ce1d83d6215e4e63cbee3d15fc394 Mon Sep 17 00:00:00 2001 From: Eric Martins <3ricm2@gmail.com> Date: Fri, 7 Feb 2014 12:45:00 -0200 Subject: [PATCH] Fix ApiGen errors --- lib/Cake/Console/Command/ServerShell.php | 4 ++ lib/Cake/Console/Command/Task/ExtractTask.php | 1 + lib/Cake/Console/ConsoleOutput.php | 8 +++ lib/Cake/Console/Shell.php | 6 ++ lib/Cake/Controller/Component/Acl/PhpAcl.php | 6 ++ .../Controller/Component/AuthComponent.php | 2 + lib/Cake/Core/App.php | 8 +-- lib/Cake/Core/Object.php | 2 + lib/Cake/Error/ErrorHandler.php | 2 +- .../Model/Datasource/Database/Sqlserver.php | 2 + lib/Cake/Network/Email/CakeEmail.php | 11 ++-- lib/Cake/Routing/Router.php | 35 +++++++++- lib/Cake/Utility/Folder.php | 6 +- lib/Cake/View/Helper/NumberHelper.php | 24 +++++++ lib/Cake/View/Helper/TextHelper.php | 20 ++++++ lib/Cake/View/Helper/TimeHelper.php | 64 +++++++++++++++++++ lib/Cake/View/View.php | 6 ++ lib/Cake/View/ViewBlock.php | 4 +- 18 files changed, 194 insertions(+), 17 deletions(-) diff --git a/lib/Cake/Console/Command/ServerShell.php b/lib/Cake/Console/Command/ServerShell.php index 58f35fe85..7247973c0 100644 --- a/lib/Cake/Console/Command/ServerShell.php +++ b/lib/Cake/Console/Command/ServerShell.php @@ -26,11 +26,15 @@ class ServerShell extends AppShell { /** * Default ServerHost + * + * @var string */ const DEFAULT_HOST = 'localhost'; /** * Default ListenPort + * + * @var integer */ const DEFAULT_PORT = 80; diff --git a/lib/Cake/Console/Command/Task/ExtractTask.php b/lib/Cake/Console/Command/Task/ExtractTask.php index 608e091ee..8180570b5 100644 --- a/lib/Cake/Console/Command/Task/ExtractTask.php +++ b/lib/Cake/Console/Command/Task/ExtractTask.php @@ -501,6 +501,7 @@ class ExtractTask extends AppShell { * @param array $rules the set of validation rules for the field * @param string $file the file name where this validation rule was found * @param string $domain default domain to bind the validations to + * @param string $category the translation category * @return void */ protected function _processValidationRules($field, $rules, $file, $domain, $category = 'LC_MESSAGES') { diff --git a/lib/Cake/Console/ConsoleOutput.php b/lib/Cake/Console/ConsoleOutput.php index ca4037e3c..fa021b565 100644 --- a/lib/Cake/Console/ConsoleOutput.php +++ b/lib/Cake/Console/ConsoleOutput.php @@ -46,21 +46,29 @@ class ConsoleOutput { /** * Raw output constant - no modification of output text. + * + * @var integer */ const RAW = 0; /** * Plain output - tags will be stripped. + * + * @var integer */ const PLAIN = 1; /** * Color output - Convert known tags in to ANSI color escape codes. + * + * @var integer */ const COLOR = 2; /** * Constant for a newline. + * + * @var string */ const LF = PHP_EOL; diff --git a/lib/Cake/Console/Shell.php b/lib/Cake/Console/Shell.php index 7a6bb5af3..d7b1d1ad9 100644 --- a/lib/Cake/Console/Shell.php +++ b/lib/Cake/Console/Shell.php @@ -33,16 +33,22 @@ class Shell extends Object { /** * Output constant making verbose shells. + * + * @var integer */ const VERBOSE = 2; /** * Output constant for making normal shells. + * + * @var integer */ const NORMAL = 1; /** * Output constants for making quiet shells. + * + * @var integer */ const QUIET = 0; diff --git a/lib/Cake/Controller/Component/Acl/PhpAcl.php b/lib/Cake/Controller/Component/Acl/PhpAcl.php index d9120a9b9..d8f757333 100644 --- a/lib/Cake/Controller/Component/Acl/PhpAcl.php +++ b/lib/Cake/Controller/Component/Acl/PhpAcl.php @@ -26,11 +26,15 @@ class PhpAcl extends Object implements AclInterface { /** * Constant for deny + * + * @var boolean */ const DENY = false; /** * Constant for allow + * + * @var boolean */ const ALLOW = true; @@ -364,6 +368,8 @@ class PhpAro { /** * role to resolve to when a provided ARO is not listed in * the internal tree + * + * @var string */ const DEFAULT_ROLE = 'Role/default'; diff --git a/lib/Cake/Controller/Component/AuthComponent.php b/lib/Cake/Controller/Component/AuthComponent.php index f2dc7b2ff..42bf84839 100644 --- a/lib/Cake/Controller/Component/AuthComponent.php +++ b/lib/Cake/Controller/Component/AuthComponent.php @@ -39,6 +39,8 @@ class AuthComponent extends Component { /** * Constant for 'all' + * + * @var string */ const ALL = 'all'; diff --git a/lib/Cake/Core/App.php b/lib/Cake/Core/App.php index 558de586d..c5674b3ec 100644 --- a/lib/Cake/Core/App.php +++ b/lib/Cake/Core/App.php @@ -66,28 +66,28 @@ class App { /** * Append paths * - * @constant APPEND + * @var string */ const APPEND = 'append'; /** * Prepend paths * - * @constant PREPEND + * @var string */ const PREPEND = 'prepend'; /** * Register package * - * @constant REGISTER + * @var string */ const REGISTER = 'register'; /** * Reset paths instead of merging * - * @constant RESET + * @var boolean */ const RESET = true; diff --git a/lib/Cake/Core/Object.php b/lib/Cake/Core/Object.php index 1e35c6ba1..3e3cf9a2e 100644 --- a/lib/Cake/Core/Object.php +++ b/lib/Cake/Core/Object.php @@ -152,6 +152,8 @@ class Object { * * @param string $msg Log message * @param integer $type Error type constant. Defined in app/Config/core.php. + * @param null|string|array $scope The scope(s) a log message is being created in. + * See CakeLog::config() for more information on logging scopes. * @return boolean Success of log write */ public function log($msg, $type = LOG_ERR, $scope = null) { diff --git a/lib/Cake/Error/ErrorHandler.php b/lib/Cake/Error/ErrorHandler.php index c2672c6b9..3e6eca2a7 100644 --- a/lib/Cake/Error/ErrorHandler.php +++ b/lib/Cake/Error/ErrorHandler.php @@ -1,6 +1,6 @@ Number->addFormat('NOK', array('before' => 'Kr. ')); }}} + * + * You can now use `NOK` as a shortform when formatting currency amounts. + * + * {{{ $this->Number->currency($value, 'NOK'); }}} + * + * Added formats are merged with the defaults defined in Cake\Utility\Number::$_currencyDefaults + * See Cake\Utility\Number::currency() for more information on the various options and their function. + * * @see CakeNumber::addFormat() * * @param string $formatName The format name to be used in the future. @@ -150,6 +172,8 @@ class NumberHelper extends AppHelper { } /** + * Getter/setter for default currency + * * @see CakeNumber::defaultCurrency() * * @param string $currency The currency to be used in the future. diff --git a/lib/Cake/View/Helper/TextHelper.php b/lib/Cake/View/Helper/TextHelper.php index a3f07856c..451aa17b6 100644 --- a/lib/Cake/View/Helper/TextHelper.php +++ b/lib/Cake/View/Helper/TextHelper.php @@ -215,6 +215,9 @@ class TextHelper extends AppHelper { } /** + * Highlights a given phrase in a text. You can specify any expression in highlighter that + * may include the \1 expression to include the $phrase found. + * * @see String::highlight() * * @param string $text Text to search the phrase in @@ -251,6 +254,8 @@ class TextHelper extends AppHelper { } /** + * Strips given text of all links (Time->format('2012-02-15', '%m-%d-%Y'); // returns 02-15-2012 + * $this->Time->format('2012-02-15 23:01:01', '%c'); // returns preferred date and time based on configured locale + * $this->Time->format('0000-00-00', '%d-%m-%Y', 'N/A'); // return N/A becuase an invalid date was passed + * $this->Time->format('2012-02-15 23:01:01', '%c', 'N/A', 'America/New_York'); // converts passed date to timezone + * }}} + * * @see CakeTime::format() * * @param integer|string|DateTime $format date format string (or a UNIX timestamp, strtotime() valid string or DateTime object) @@ -442,6 +503,9 @@ class TimeHelper extends AppHelper { } /** + * Returns a formatted date string, given either a UNIX timestamp or a valid strtotime() date string. + * It takes into account the default date format for the current language if a LC_TIME file is used. + * * @see CakeTime::i18nFormat() * * @param integer|string|DateTime $date UNIX timestamp, strtotime() valid string or DateTime object diff --git a/lib/Cake/View/View.php b/lib/Cake/View/View.php index dfc1b4654..d6d7a9108 100644 --- a/lib/Cake/View/View.php +++ b/lib/Cake/View/View.php @@ -299,16 +299,22 @@ class View extends Object { /** * Constant for view file type 'view' + * + * @var string */ const TYPE_VIEW = 'view'; /** * Constant for view file type 'element' + * + * @var string */ const TYPE_ELEMENT = 'element'; /** * Constant for view file type 'layout' + * + * @var string */ const TYPE_LAYOUT = 'layout'; diff --git a/lib/Cake/View/ViewBlock.php b/lib/Cake/View/ViewBlock.php index f0c74c5ca..28667c8c3 100644 --- a/lib/Cake/View/ViewBlock.php +++ b/lib/Cake/View/ViewBlock.php @@ -28,14 +28,14 @@ class ViewBlock { /** * Append content * - * @constant APPEND + * @var string */ const APPEND = 'append'; /** * Prepend content * - * @constant PREPEND + * @var string */ const PREPEND = 'prepend';