CakePHP Developers will use the PSR-2 Coding Standards guide in addition to the following rules as coding standards. You can use the CakePHP Code Sniffer to check that your coding follows the required standards.<\/p>\n
Please make sure your IDE is set up to \u201ctrim right\u201d on whitespaces. There should be no trailing spaces per line.<\/p>\n
Four spaces should be used for indentation. If you are using the multiline function call then follow the following guidelines.<\/p>\n Line Length<\/strong> <\/code>\n<\/li>\n<\/ol>\n Ternary operators are permissible when the entire ternary operation fits on one line. Longer ternaries should be split into if-else statements. Ternary operators should not ever be nested. Optionally parentheses can be used around the condition check of the ternary for clarity: In template files (.ctp files) developers should use keyword control structures. Keyword control structures are easier to read in complex template files. Control structures can either be contained in a larger PHP block, or in separate PHP tags: Always try to be as Strict as possible: Functions should be called without space between the function\u2019s name and starting parenthesis. There should be one space between every parameter of a function call: Try to avoid unnecessary nesting by bailing early: Arguments that expect objects, arrays, or callbacks (callable) can be type hinted. We only type-hint public methods, though, as type hinting is not cost-free: Method chaining should have multiple methods spread across separate lines, and indented with four spaces: When including files with classes or libraries, use only and always the require_once function.<\/p>\n Always use long tags (<?php ?><\/strong>) instead of short tags (<? ?><\/strong>). The short echo should be used in template files (.ctp) where appropriate.<\/p>\n The short echo should be used in template files in place of \/\/ wrong = semicolon, no spaces Functions:<\/strong> Class names should be written in CamelCase, for example: Variable names should be as descriptive as possible, but also as short as possible. All variables should start with a lowercase letter and should be written in camelBack in case of multiple words. Variables referencing objects should in some way associate to the class a variable is an object of. Example: Use PHP\u2019s public, protected, and private keywords for methods and variables. Type Casting<\/strong> Constants<\/strong> While empty() is easy to use the function, it can mask errors and cause unintended effects when ‘0’ and 0 are given. When variables or properties are already defined, the usage of empty() is not recommended. When working with variables, it is better to rely on type-coercion to boolean instead of empty():
\nExample:
\n\/\/ base level
\n \/\/ level 1
\n \/\/ level 2
\n \/\/ level 1
\n\/\/ base level<\/code><\/p>\n\n
\n$matches = array_intersect_key($this->_listeners,
\n array_flip(preg_grep($matchPattern,
\n array_keys($this->_listeners), 0)));
\nUse this instead:
\n$matches = array_intersect_key(
\n $this->_listeners,
\n array_flip(
\n preg_grep($matchPattern, array_keys($this->_listeners), 0)
\n )
\n);<\/code><\/li>\n<\/ol>\n
\nIt is recommended to keep lines at approximately 100 characters long for better coding readability. Lines must not be longer than 120 characters.<\/p>\nControl Structures<\/h3>\n
\n
\nif ((expr_1) || (expr_2)) {
\n \/\/ action_1;
\n} elseif (!(expr_3) && (expr_4)) {
\n \/\/ action_2;
\n} else {
\n \/\/ default_action;
\n}<\/p>\n\n
\n \t statement;<\/li>\n
\n statement;
\n}<\/li>\n
\n statement;
\n}<\/li>\n
\nif ($variable) {
\n statement;
\n}<\/li>\n<\/ol>\nTernary operator<\/h3>\n
\n\/\/ Good, simple and readable
\n$variable = isset($options['variable']) ? $options['variable'] : true;
\n\/\/ Nested ternaries are bad
\n$variable = isset($options['variable']) ? isset($options['othervar']) ? true : false : false;<\/code><\/p>\nTemplate Files<\/h3>\n
\n<?php
\nif ($isAdmin):
\n echo '<p>You are the admin user.<\/p>';
\nendif;
\n?>
\n<p>The following is also acceptable:<\/p>
\n<?php if ($isAdmin): ?>
\n <p>You are the admin user.<\/p>
\n<?php endif; ?>
\n<\/code><\/p>\nComparison<\/h3>\n
\nFor testing if a variable is null, it is recommended to use a strict check:
\nif ($value === null) {
\n \/\/ ...
\n}
\nThe value to check against should be placed on the right side:
\n\/\/ not recommended
\nif (null === $this->foo()) {
\n \/\/ ...
\n}
\n\/\/ recommended
\nif ($this->foo() === null) {
\n \/\/ ...
\n}<\/code><\/p>\nFunction Calls<\/h3>\n
\n$var = foo($bar, $bar2, $bar3);
\nMethod Definitions
\npublic function someFunction($arg1, $arg2 = '')
\n{
\n if (expr) {
\n statement;
\n }
\n return $var;
\n}<\/code>
\nParameters with a default value should be placed last in the function definition. Try to make your functions return something, at least true or false, so it can be determined whether the function call was successful:<\/p>\nBail Early<\/h3>\n
\npublic function run(array $data)
\n{
\n ...
\n if (!$success) {
\n return false;
\n }
\n ...
\n}<\/code><\/p>\nType Hinting<\/h3>\n
\npublic function foo(Table $table, array $array, callable $callback, $boolean){}<\/code>
\nHere $table must be an instance of \\Cake\\ORM\\Table, $array must be an array and $callback must be of type callable (a valid callback).<\/p>\nMethod Chaining<\/h3>\n
\n$email->from('foo@example.com')
\n ->to('bar@example.com')
\n ->subject('A great message')
\n ->send();
\nIncluding Files
\ninclude, require, include_once, and require_once do not have parentheses:
\n\/\/ wrong = parentheses
\nrequire_once('ClassFileName.php');
\nrequire_once ($class);
\n\/\/ good = no parentheses
\nrequire_once 'ClassFileName.php';
\nrequire_once $class;<\/code><\/p>\nPHP Tags<\/h3>\n
Short Echo<\/h3>\n
\n<td><?=$name;?><\/td>
\n\/\/ good = spaces, no semicolon
\n<td><?= $name ?><\/td><\/code><\/p>\nNaming Conventions<\/h3>\n
\nWrite all functions in the camelBack case.
\nfunction longFunctionName()
\n{
\n}<\/code><\/p>\nClasses:<\/h3>\n
\nclass ExampleClass
\n{
\n}<\/code><\/p>\nVariables:<\/h3>\n
\n$user = 'John';
\n$users = ['John', 'Hans', 'Arne'];
\n$dispatcher = new Dispatcher();<\/code><\/p>\nMember Visibility<\/h3>\n
\nFiles<\/strong>
\nFile names which do not contain classes should be lowercase and underscore, for example:
\nlong_file_name.php<\/strong><\/p>\n
\nPlease use (int)$var instead of intval($var) and (float)$var instead of floatval($var) when applicable in Type Casting.<\/p>\n
\nConstants should be defined in capital letters:
\ndefine('CONSTANT', 1);
\nCareful when using the empty() \/ isset()<\/code><\/p>\n
\nfunction manipulate($var)
\n{
\n \/\/ Not recommended, $var is already defined in the scope
\n if (empty($var)) {
\n \/\/ ...
\n }
\n \/\/ Use boolean type coercion
\n if (!$var) {
\n \/\/ ...
\n }
\n if ($var) {
\n \/\/ ...
\n }
\n}<\/code><\/p>\n