From 16db86f21c57f37d2cb1f50020761045e87e2257 Mon Sep 17 00:00:00 2001 From: euromark <euromark@web.de> Date: Sun, 13 Apr 2014 04:01:40 +0200 Subject: [PATCH 1/3] Update conventions around docblocks. --- en/contributing/cakephp-coding-conventions.rst | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/en/contributing/cakephp-coding-conventions.rst b/en/contributing/cakephp-coding-conventions.rst index 18d85c4bd3..75813e2c05 100644 --- a/en/contributing/cakephp-coding-conventions.rst +++ b/en/contributing/cakephp-coding-conventions.rst @@ -404,11 +404,11 @@ Type Description mixed A variable with undefined (or multiple) type. -integer +int Integer type variable (whole number). float Float type (point number). -boolean +bool Logical type (true or false). string String type (any value in " " or ' '). @@ -421,6 +421,14 @@ resource Remember that when you specify the type as mixed, you should indicate whether it is unknown, or what the possible types are. +You can also combine types using the pipe char: + +:: + + int|bool + +For more than two types it is usually best to just use ``mixed``. + Casting ------- From ffe21ecf0d665db0f88862ad48c7d2eb002e8af3 Mon Sep 17 00:00:00 2001 From: euromark <euromark@web.de> Date: Sun, 13 Apr 2014 04:41:41 +0200 Subject: [PATCH 2/3] complete doc block docs. --- en/contributing/cakephp-coding-conventions.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/en/contributing/cakephp-coding-conventions.rst b/en/contributing/cakephp-coding-conventions.rst index 75813e2c05..d51221592e 100644 --- a/en/contributing/cakephp-coding-conventions.rst +++ b/en/contributing/cakephp-coding-conventions.rst @@ -412,14 +412,18 @@ bool Logical type (true or false). string String type (any value in " " or ' '). +null + Null type. Usually used in conjunction with another type. array Array type. object - Object type. + Object type. A specific class name should be used if possible. resource Resource type (returned by for example mysql\_connect()). Remember that when you specify the type as mixed, you should indicate whether it is unknown, or what the possible types are. +callable + Callable function. You can also combine types using the pipe char: From ea08879e9ba8241eb80c5974ca266af14e3b816d Mon Sep 17 00:00:00 2001 From: euromark <euromark@web.de> Date: Sun, 13 Apr 2014 12:50:52 +0200 Subject: [PATCH 3/3] simplify code blocks --- en/contributing/cakephp-coding-conventions.rst | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/en/contributing/cakephp-coding-conventions.rst b/en/contributing/cakephp-coding-conventions.rst index d51221592e..98ca8d7fdc 100644 --- a/en/contributing/cakephp-coding-conventions.rst +++ b/en/contributing/cakephp-coding-conventions.rst @@ -389,9 +389,7 @@ Files ----- File names which do not contain classes should be lowercased and underscored, for -example: - -:: +example:: long_file_name.php @@ -425,9 +423,7 @@ resource callable Callable function. -You can also combine types using the pipe char: - -:: +You can also combine types using the pipe char:: int|bool @@ -456,16 +452,12 @@ Type Constants --------- -Constants should be defined in capital letters: - -:: +Constants should be defined in capital letters:: define('CONSTANT', 1); If a constant name consists of multiple words, they should be separated -by an underscore character, for example: - -:: +by an underscore character, for example:: define('LONG_NAMED_CONSTANT', 2);