Permalink
Browse files

Add missing data type documentation for constants

  • Loading branch information...
1 parent afa4b3f commit 6d46bdcdd9311722a57c139edd67bdaf6dcc64b5 @bcrowe bcrowe committed Jan 28, 2014
@@ -28,11 +28,15 @@ class ServerShell extends Shell {
/**
* Default ServerHost
+ *
+ * @var string
*/
const DEFAULT_HOST = 'localhost';
/**
* Default ListenPort
+ *
+ * @var integer
*/
const DEFAULT_PORT = 80;
@@ -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;
View
@@ -41,16 +41,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;
@@ -32,11 +32,15 @@ class PhpAcl extends Object implements AclInterface {
/**
* Constant for deny
+ *
+ * @var boolean
*/
const DENY = false;
/**
* Constant for allow
+ *
+ * @var boolean
*/
const ALLOW = true;
@@ -369,6 +373,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';
@@ -44,6 +44,8 @@ class AuthComponent extends Component {
/**
* Constant for 'all'
+ *
+ * @var string
*/
const ALL = 'all';
@@ -153,16 +153,67 @@ class Table {
self::ACTION_RESTRICT,
];
+/**
+ * Primary constraint type
+ *
+ * @var string
+ */
const CONSTRAINT_PRIMARY = 'primary';
+
+/**
+ * Unique constraint type
+ *
+ * @var string
+ */
const CONSTRAINT_UNIQUE = 'unique';
+
+/**
+ * Foreign constraint type
+ *
+ * @var string
+ */
const CONSTRAINT_FOREIGN = 'foreign';
+/**
+ * Index - index type
+ *
+ * @var string
+ */
const INDEX_INDEX = 'index';
+
+/**
+ * Fulltext index type
+ *
+ * @var string
+ */
const INDEX_FULLTEXT = 'fulltext';
+/**
+ * Foreign key cascade action
+ *
+ * @var string
+ */
const ACTION_CASCADE = 'cascade';
+
+/**
+ * Foreign key set null action
+ *
+ * @var string
+ */
const ACTION_SET_NULL = 'setNull';
+
+/**
+ * Foreign key no action
+ *
+ * @var string
+ */
const ACTION_NO_ACTION = 'noAction';
+
+/**
+ * Foreign key restrict action
+ *
+ * @var string
+ */
const ACTION_RESTRICT = 'restrict';
/**
@@ -48,35 +48,35 @@ class Email {
/**
* Default X-Mailer
*
- * @constant EMAIL_CLIENT
+ * @var string
*/
const EMAIL_CLIENT = 'CakePHP Email';
/**
* Line length - no should more - RFC 2822 - 2.1.1
*
- * @constant LINE_LENGTH_SHOULD
+ * @var integer
*/
const LINE_LENGTH_SHOULD = 78;
/**
* Line length - no must more - RFC 2822 - 2.1.1
*
- * @constant LINE_LENGTH_MUST
+ * @var integer
*/
const LINE_LENGTH_MUST = 998;
/**
* Type of message - HTML
*
- * @constant MESSAGE_HTML
+ * @var string
*/
const MESSAGE_HTML = 'html';
/**
* Type of message - TEXT
*
- * @constant MESSAGE_TEXT
+ * @var string
*/
const MESSAGE_TEXT = 'text';

0 comments on commit 6d46bdc

Please sign in to comment.