Skip to content

Loading…

Psr 1 style guide #25

Merged
merged 36 commits into from
@pmjones
PHP FIG member

Final draft of the style guide, with the survey data incorporated.

@gnugat

I don't really get why class constants, properties, and methods have a different brace placement than control structures?
Is it because most coding style mix them? If that's the case I would understand, but else I find it a bit unconsistent...

@pmjones
PHP FIG member

@gnugat It is because most projects in the survey follow the K&R style, which has control braces on the same line but class and method braces on the next line. Note the survey data at the end of this commit:

pmjones@f418d79

@milesj

PSR should not define a standard for syntax placement. The only thing the PSR should do is define standards for interoperability and packaging schemas.

@henrikbjorn

@milesj isnt that what PSR-0 did ?

@milesj

Yes, what I am saying is that many things in PSR-1 regarding syntax should not be enforced or even mentioned. Telling someone where to place their curlies, or how to format if statements, whether to use tabs or spaces, how to place modifiers, etc, have nothing to do with programming or interoperability. All it has to do with is personal preference, which differs greatly between each individual.

And on top of that, it's not like I will be editing your code, or you editing mine, so why do we care about those things? The only thing we need to care about is situations where both our code is used in the same environment.

Out of this whole PSR, the only thing that I believe are necessary are:

  • Use only <?php and <?= opening tags for PHP code; leave out the closing ?> tag when the file contains only PHP code.
  • Namespace all classes
  • Declare class names in StudlyCaps (PSR-0)
  • Declare method names in camelCase (up for debate)
  • Use only UTF-8 (no BOM) for PHP code. Do not use other character encodings.
  • Use the Unix LF (linefeed) line ending on all PHP files.

IDEs render most of these suggestions obsolete anyways.

@pmjones
PHP FIG member

Your opinion is duly noted; however, please note the introductory text:

"This guide is derived from commonalities among the various member
projects. If one project has its own style guide, that's fine for that
project. But when various authors collaborate across multiple projects, it
helps to have one set of guidelines to be used among all those projects.
Thus, the benefit of this guide is not in the rules themselves, but in the
sharing of those rules."

@milesj

Yes but like I said, we won't be working in each others code (for the most part), so defining syntax rules aren't needed.

@henrikbjorn

@milesj well in a perfect world we all collaborate on stuff and help each other out if a bug is found :) But that is the perfect world, but i dont see why we cant have rules helping with that by reducing the barrier a bit.

@milesj

Aesthetic syntax is just that, aesthetics. Nothing in your comment supports the need for these rules. Using tabs over spaces or placing curlies on different lines isn't reducing any barrier.

In my opinion, PSR should only convey rules for hard requirements.

@harikt

@milesj I am not sure whether you missed why a standard is being introduced.
Each project for eg : Symfony2 , Drupal , PHPBB, ZF2 , Aura, Doctrine2 and many more are making use of components or libraries of different other projects.
So lets take Drupal , Drupal going to use many of Symfony2 components . Both have a different set of CS. And in the collaboration its always a good way to have a single CS. As mentioned by @pmjones these standards are taken comparing various projects which were added in the Excel at one time.
Hope that make sense.

@pmjones
PHP FIG member

@milesj "Using tabs over spaces or placing curlies on different lines isn't reducing any barrier." Many of us believe it is reducing a barrier, and are working toward that. I get that you don't agree; but then, if they don't really matter, then it doesn't matter what we all agree on, so long as we agree on it.

@milesj

Completely disagree.

How someone structures there syntax should not matter, just as long as the libraries work together in the same environment without causing conflicts. Thats all this standard should be used for, a set of guidelines for interoperability and possibly a set of interfaces to follow. I'll end this discussion here and it should be in the Groups more than anything.

@cbandy

I think the Properties section should be reduced to the few requirements that are actually stated:

Declare visibility on all properties; do not use var to declare a property, and declare only one property per statement.

In the same vein, this sentence should be removed from the Methods section:

Some projects prefix method names with a single underscore to indicate protected or private visibility; this guide discourages but does not disallow that practice.

This paragraph should be removed from the Control Structures section:

N.b.: There appears to be no consistency between projects, and often not even within the same project, on the use of else if vs elseif. This guide encourages the use of elseif so that all control structures look like single words.

In my opinion, the Control Structures section is too vague. It begins with a series of general rules, then omits specific rules for specific structures. For example, is the position of else a suggestion or a requirement? Is the presence of a // no break line a suggestion or a requirement?

@pmjones
PHP FIG member

@cbandy We felt it was important to explicitly say "we make no recommendation on properties" so that it was clear nothing else should be used to imply a recommendation.

Re: methods, there are a lot of folks still using that, and while it's discouraged, we feel it's not exactly a problem.

Re: elseif, I wanted to point out that we did look at the projects, and that they themselves don't have a standard ... then go on to suggest one.

The position of else is a requirement, as noted by the phrase " else and elseif are on the same line as the closing brace from the earlier body." Same goes for // no break, it's mentioned specifically in the lead-in to the example.

@tcz

Do we really need this? I mean most if IDEs can format your code in the way it's more comfortable for you to read if you really need this (see for example Netbeans Format command).

Not to mention that code formatting is something totally subjective, there are no arguments here. Who defines the standard and on what ground?

Oh, and don't forget: http://xkcd.com/927/

@kriswallsmith

Has there been any discussion of standardizing whether to include an end of file new line?

@pmjones
PHP FIG member

Strangely, no. Where have you been for the past two months? ;-)

pmjones and others added some commits
@pmjones pmjones split tied PSR-1 into basic and advanced 8a63271
@pmjones pmjones clarify language on closing braces ad3b516
@pmjones pmjones incorporate some ideas from Andrew Eddie, most notably section number…
…ing and the 'Files' section
236f82d
@pmjones pmjones Merge branch 'psr-1-style-guide' of github.com:pmjones/fig-standards …
…into psr-1-style-guide
dca8fc2
@pmjones pmjones monospace change 39e69d2
@pmjones pmjones typo fix 4150d91
@pmjones pmjones add note about underscore-preixed properties d05236c
@pmjones pmjones add side-effects section with brief example 22208ae
@pmjones pmjones Merge branch 'psr-1-style-guide' of github.com:pmjones/fig-standards …
…into psr-1-style-guide
02801f5
@pmjones pmjones remove scare quotes d83d579
@pmjones pmjones remove visibility note on properties 15d3de6
@pmjones pmjones extend the examples of side effects 35c7849
@pmjones pmjones add RFC 2119 keywords f831115
@pmjones pmjones add survey legend aef0d3c
@pmjones pmjones update with RFC 2119 keywords 3777aed
@pmjones pmjones expanded on method and function calls cf69a61
@pmjones pmjones in deference to Joomla, the Vendor_ prefix on 5.2.x code is now a SHO…
…ULD, not a MUST
bdd2d8b
@Seldaek Seldaek Add overview example of rules ef8efb6
@pmjones pmjones Merge pull request #1 from Seldaek/patch-1
Overview example
277184a
@pmjones pmjones add interface examples per Drak e693281
@pmjones pmjones appendices are letters; and some minor edits to use 'when present' 628433c
@pmjones pmjones apply notes from fgmarand 6af5cbf
@pmjones pmjones fix survey legend for github-flavored markdown 47dc359
@pmjones pmjones clarify preamble, add keywords/true/false/null, clarify 'no break' co…
…mment in switch/case
6f19b33
@pmjones pmjones add section on closures 65a1bd6
@pmjones pmjones use consistent phrasing regarding 'split across multiple lines' a5f646c
@pmjones pmjones typo fix; thanks harikt 1cfa0b8
@pmjones pmjones explictly note that first item goes on next line 4cf424f
@pmjones pmjones fix parse error; thanks, bobthecow 044398c
@pmjones pmjones add example for closure as direct argument 1433ce7
@pmjones pmjones extend an overview bullet point 746dace
@pmjones pmjones add note about non-empty case bodies 37e6ad4
@pmjones pmjones remove extra words 6788066
@sstok

In the case of else/elseif how about not placing anything after the }.

if ($expr1) {
    // if body
} elseif ($expr2) {
    // elseif body
} else {
    // else body;
}

Becomes.

if ($expr1) {
    // if body
}
elseif ($expr2) {
    // elseif body
}
else {
    // else body;
}

This keeps it readable, does not ad extensive whitespace and gives a more natural flow as the statement is on its own line.
Only applying this to elseif could be done to, but that looks weird.

@mermshaus

Is there a reason why sections 4.4 and 6 of PSR-2 use two or three spaces for indentation? That seems inconsistent to me.

Besides, there are two sections labeled 4.4 right now.

@RobLoach

How is this different from #14 ? Should the two be merged?

@harikt

@RobLoach the one you mentioned is a start and later through the various discussion , this PR is here.

@RobLoach

@harikt Thanks for the clarification :-) .

@pmjones pmjones merged commit 38dc2dc into php-fig:master
@klimov-paul

Have ever read this:
http://en.wikipedia.org/wiki/Indent_style

Espesially the following part:

In old versions of the C programming language, the functions, however, were braced distinctly. The opening function brace of a function was placed on >the line following after the declaration section and at the same indentation level as the declaration (header of the function). This is because in the original C >language, argument types needed to be declared on the subsequent line (i. e., just after the header of the function), whereas when no arguments were >necessary, the opening brace would not appear in the same line with the function declaration. The opening brace for function declarations was an >exception to the currently basic rule stating that the statements and blocks of a function are all enclosed in the function braces.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Mar 24, 2012
  1. @pmjones

    add PSR-1 proposal

    pmjones committed
  2. @pmjones
Commits on Mar 28, 2012
  1. @pmjones
Commits on May 4, 2012
  1. @pmjones
  2. @pmjones
Commits on May 7, 2012
  1. @pmjones

    incorporate some ideas from Andrew Eddie, most notably section number…

    pmjones committed
    …ing and the 'Files' section
  2. @pmjones
Commits on May 8, 2012
  1. @pmjones

    monospace change

    pmjones committed
  2. @pmjones

    typo fix

    pmjones committed
Commits on May 10, 2012
  1. @pmjones
  2. @pmjones
  3. @pmjones
  4. @pmjones

    remove scare quotes

    pmjones committed
  5. @pmjones
  6. @pmjones
  7. @pmjones

    add RFC 2119 keywords

    pmjones committed
  8. @pmjones

    add survey legend

    pmjones committed
Commits on May 11, 2012
  1. @pmjones

    update with RFC 2119 keywords

    pmjones committed
  2. @pmjones
  3. @pmjones
  4. @Seldaek

    Add overview example of rules

    Seldaek committed
  5. @pmjones

    Merge pull request #1 from Seldaek/patch-1

    pmjones committed
    Overview example
  6. @pmjones

    add interface examples per Drak

    pmjones committed
  7. @pmjones
  8. @pmjones

    apply notes from fgmarand

    pmjones committed
  9. @pmjones
  10. @pmjones
Commits on May 15, 2012
  1. @pmjones

    add section on closures

    pmjones committed
  2. @pmjones
  3. @pmjones

    typo fix; thanks harikt

    pmjones committed
  4. @pmjones
Commits on May 16, 2012
  1. @pmjones
Commits on May 17, 2012
  1. @pmjones
  2. @pmjones

    extend an overview bullet point

    pmjones committed
Commits on May 18, 2012
  1. @pmjones
  2. @pmjones

    remove extra words

    pmjones committed
Showing with 1,530 additions and 0 deletions.
  1. +172 −0 proposed/PSR-1-basic.md
  2. +555 −0 proposed/PSR-1.md
  3. +803 −0 proposed/PSR-2-advanced.md
View
172 proposed/PSR-1-basic.md
@@ -0,0 +1,172 @@
+Basic Coding Standard
+=====================
+
+This section of the standard comprises what should be considered the standard
+coding elements that are required to ensure a high level of technical
+interoperability between shared PHP code.
+
+The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
+"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
+interpreted as described in [RFC 2119][].
+
+[RFC 2119]: http://www.ietf.org/rfc/rfc2119.txt
+[PSR-0]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md
+
+
+1. Overview
+-----------
+
+- Files MUST use only `<?php` and `<?=` tags.
+
+- Files MUST use only UTF-8 without BOM for PHP code.
+
+- Files SHOULD *either* declare symbols (classes, functions, constants, etc.)
+ *or* cause side-effects (e.g. generate output, change .ini settings, etc.)
+ but SHOULD NOT do both.
+
+- Namespaces and classes MUST follow [PSR-0][].
+
+- Class names MUST be declared in `StudlyCaps`.
+
+- Class constants MUST be declared in all upper case with underscore separators.
+
+- Method names MUST be declared in `camelCase`.
+
+
+2. Files
+--------
+
+### 2.1. PHP Tags
+
+PHP code MUST use the long `<?php ?>` tags or the short-echo `<?= ?>` tags; it
+MUST NOT use the other tag variations.
+
+### 2.2. Character Encoding
+
+PHP code MUST use only UTF-8 without BOM.
+
+### 2.3. Side Effects
+
+A file SHOULD declare new symbols (classes, functions, constants,
+etc.) and cause no other side effects, or it SHOULD execute logic with side
+effects, but SHOULD NOT do both.
+
+The phrase "side effects" means execution of logic not directly related to
+declaring classes, functions, constants, etc., *merely from including the
+file*.
+
+"Side effects" include but are not limited to: generating output, explicit
+use of `require` or `include`, connecting to external services, modifying ini
+settings, emitting errors or exceptions, modifying global or static variables,
+reading from or writing to a file, and so on.
+
+The following is an example of a file with both declarations and side effects;
+i.e, an example of what to avoid:
+
+```php
+<?php
+// side effect: change ini settings
+ini_set('error_reporting', E_ALL);
+
+// side effect: loads a file
+include "file.php";
+
+// side effect: generates output
+echo "<html>\n";
+
+// declaration
+function foo()
+{
+ // function body
+}
+```
+
+The following example is of a file that contains declarations without side
+effects; i.e., an example of what to emulate:
+
+```php
+<?php
+// declaration
+function foo()
+{
+ // function body
+}
+
+// conditional declaration is *not* a side effect
+if (! function_exists('bar')) {
+ function bar()
+ {
+ // function body
+ }
+}
+```
+
+
+3. Namespace and Class Names
+----------------------------
+
+Namespaces and classes MUST follow [PSR-0][].
+
+This means each class is in a file by itself, and is in a namespace of at
+least one level: a top-level vendor name.
+
+Class names MUST be declared in `StudlyCaps`.
+
+Code written for PHP 5.3 and after MUST use formal namespaces.
+
+For example:
+
+```php
+<?php
+// PHP 5.3 and later:
+namespace Vendor\Model;
+
+class Foo
+{
+}
+```
+
+Code written for 5.2.x and before SHOULD use the pseudo-namespacing convention
+of `Vendor_` prefixes on class names.
+
+```php
+<?php
+// PHP 5.2.x and earlier:
+class Vendor_Model_Foo
+{
+}
+```
+
+4. Class Constants, Properties, and Methods
+-------------------------------------------
+
+The term "class" refers to all classes, interfaces, and traits.
+
+### 4.1. Constants
+
+Class constants MUST be declared in all upper case with underscore separators.
+For example:
+
+```php
+<?php
+namespace Vendor\Model;
+
+class Foo
+{
+ const VERSION = '1.0';
+ const DATE_APPROVED = '2012-06-01';
+}
+```
+
+### 4.2. Properties
+
+This guide intentionally avoids any recommendation regarding the use of
+`$StudlyCaps`, `$camelCase`, or `$under_score` property names.
+
+Whatever naming convention is used SHOULD be applied consistently within a
+reasonable scope. That scope may be vendor-level, package-level, class-level,
+or method-level.
+
+### 4.3. Methods
+
+Method names MUST be declared in `camelCase()`.
View
555 proposed/PSR-1.md
@@ -0,0 +1,555 @@
+PSR-1 Coding Style Guide
+========================
+
+The intent of this guide is to reduce cognitive friction when scanning code
+from different authors. It does so by enumerating a shared set of rules and
+expectations about how to format PHP code.
+
+This guide is derived from commonalities among the various member projects. If
+one project has its own style guide, that's fine for that project. But when
+various authors collaborate across multiple projects, it helps to have one set
+of guidelines to be used among all those projects. Thus, the benefit of this
+guide is not in the rules themselves, but in the sharing of those rules.
+
+
+Overview
+--------
+
+Please review the remainder of this guide for details on each of the following
+points.
+
+- Use only `<?php` and `<?=` opening tags for PHP code; leave out the closing
+ `?>` tag when the file contains only PHP code.
+
+- Use 4 spaces for indenting, not tabs.
+
+- There is no hard limit on line length; the soft limit is 120 characters;
+ lines of 80 characters or less are encouraged. Do not add trailing
+ whitespace at the end of lines. Use Unix line endings (LF).
+
+- Namespace all classes; place one blank line after the `namespace`
+ declaration, and one blank line after the block of `use` declarations.
+
+- Declare class names in `StudlyCaps`; opening braces for classes go on the
+ next line, and closing braces go on their own line.
+
+- Declare method names in `camelCase`; opening braces for methods go on the
+ next line, and closing braces go on their own line.
+
+- Declare visibility on all properties and methods; declare `abstract` and
+ `final` before the visibility, and declare `static` after the visibility.
+
+- Control structure keywords have one space after them; function and method
+ calls do not.
+
+- Opening braces for control structures go on the same line, and closing
+ braces go on their own line.
+
+- Opening parentheses for control structures have no space after them, and
+ closing parentheses for control structures have no space before.
+
+
+General
+-------
+
+### PHP Tags
+
+Use the long `<?php ?>` tags for PHP code. Use of short-echo `<?= ?>` tags is
+also allowed. Do not use the other tag variations.
+
+In files that contain only PHP, leave out the closing `?>` tag.
+
+
+### Character Encoding
+
+Use only UTF-8 (no BOM) for PHP code. Do not use other character encodings.
+
+
+### Indenting
+
+Use an indent of 4 spaces. Do not use tabs.
+
+> N.b.: Using only spaces, and not mixing spaces with tabs, helps to avoid
+> problems with diffs, patches, history, and annotations. The use of spaces
+> also makes it easy to insert fine-grained sub-indentation for inter-line
+> alignment.
+
+
+### Lines
+
+There is no hard limit on line length. The soft limit on line length is 120
+characters; automated style checkers must warn but not error at the soft
+limit. This guide encourages lines no longer than 80 characters, and
+encourages splitting longer lines into multiple subsequent lines of no more
+than 80 characters each.
+
+Use the Unix LF (linefeed) line ending on all PHP files.
+
+Do not add trailing spaces at the end of lines.
+
+Blank lines may be added to improve readability and to indicate related blocks
+of code.
+
+Use at most one statement per line.
+
+
+`namespace`, `use`, and `class`
+-------------------------------
+
+> N.b.: Formal namespaces were introduced in PHP 5.3. Code written for 5.2.x
+> and before must use the pseudo-namespacing convention of `Vendor_`
+> prefixes on class names. Code written for PHP 5.3 and after must use
+> formal namespaces.
+
+All namespaces and classes are to be named with [PSR-0][] in mind. This means each
+class is in a file by itself, and is in a namespace of at least one level: a
+top-level vendor name.
+
+[PSR-0]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md
+
+The `namespace` line has one blank line after it.
+
+All `use` declarations go after the `namespace` declaration. There is one
+`use` keyword per declaration.
+
+The `use` block has one blank line after it.
+
+Class names are in `StudlyCaps`. The opening and closing braces for the
+class go on their own line.
+
+The `extends` and `implements` keywords are on the same line as the class
+name.
+
+```php
+<?php
+namespace Vendor\Package;
+
+use FooClass;
+use BarClass as Bar;
+use OtherVendor\OtherPackage\BazClass;
+
+class ClassName extends ParentClass implements InterfaceName
+{
+ // constants, properties, methods
+}
+```
+
+Lists of `implements` may be split across multiple lines, where each
+subsequent line is indented once. List only one interface per line.
+
+```php
+<?php
+namespace Vendor\Package;
+
+use FooClass;
+use BarClass as Bar;
+use OtherVendor\OtherPackage\BazClass;
+
+class ClassName extends ParentClass implements
+ InterfaceName,
+ AnotherInterfaceName,
+ YetAnotherInterface,
+ InterfaceInterface
+{
+ // constants, properties, methods
+}
+```
+
+Class Constants, Properties, and Methods
+----------------------------------------
+
+> N.b.: The term "class" refers to all classes, interfaces, and traits.
+
+
+### Constants
+
+Class constants are all upper case with underscore separators.
+
+```php
+<?php
+namespace Vendor\Package;
+
+class ClassName
+{
+ const CONSTANT_NAME = 'constant value';
+}
+```
+
+### Properties
+
+This guide expressly avoids any recommendation regarding the use of
+`$StudlyCaps`, `$camelCase`, or `$under_score` property names. It is often the
+case that property names map directly to field names in external data sources.
+Changing between naming conventions when changing contexts merely to suit a
+style guide would be counterproductive in such cases.
+
+Whatever naming convention is used must be applied consistently within a
+reasonable scope. That scope may be vendor-level, package-level, class-level,
+or method-level.
+
+Declare visibility on all properties; do not use `var` to declare a property,
+and declare only one property per statement. Some projects prefix property
+names with a single underscore to indicate protected or private visibility;
+this guide discourages but does not disallow that practice.
+
+A property declaration looks like the following.
+
+```php
+<?php
+namespace Vendor\Package;
+
+class ClassName
+{
+ public $foo = null;
+}
+```
+
+### Methods
+
+Declare method names in `camelCase()` with no space after the method name. The
+opening and closing braces go on their own line. There is no space after the
+opening parenthesis, and there is no space before the closing parenthesis.
+
+Declare visibility on all methods. Some projects prefix method names with a
+single underscore to indicate protected or private visibility; this guide
+discourages but does not disallow that practice.
+
+A method declaration looks like the following. Note the placement of
+parentheses, commas, spaces, and braces:
+
+```php
+<?php
+namespace Vendor\Package;
+
+class ClassName
+{
+ public function fooBarBaz($arg1, &$arg2, $arg3 = [])
+ {
+ // method body
+ }
+}
+```
+
+### Method Arguments
+
+Method arguments with default values always go at the end of the argument
+list.
+
+```php
+<?php
+namespace Vendor\Package;
+
+class ClassName
+{
+ public function foo($arg1, &$arg2, $arg3 = [])
+ {
+ // method body
+ }
+}
+```
+
+Argument lists may be split across subsequent indented lines; list only one
+argument per line. When the argument list is split across multiple lines, the
+closing parenthesis and opening brace are placed together on their own line.
+
+```php
+<?php
+namespace Vendor\Package;
+
+class ClassName
+{
+ public function aVeryLongMethodName(
+ ClassTypeHint $arg1,
+ &$arg2,
+ array $arg3 = []
+ ) {
+ // method body
+ }
+}
+```
+
+### `abstract`, `final`, and `static`
+
+When present, the `abstract` and `final` declarations precede the
+visibility declaration.
+
+When present, the `static` declaration comes after the visibility declaration.
+
+```php
+<?php
+namespace Vendor\Package;
+
+class ClassName
+{
+ protected static $foo;
+
+ abstract protected zim();
+
+ final public static bar()
+ {
+ // method body
+ }
+}
+```
+
+Control Structures
+------------------
+
+The general style rules for control structures are as follows:
+
+- one space after the control structure keyword
+- no space after the opening parenthesis
+- no space before the closing parenthesis
+- one space between the closing parenthesis and the opening brace
+- structure body indented once
+- closing brace on its own line, outdented once from the body
+
+Always use braces to enclose the body of each structure. This standardizes how
+the structures look, and reduces the likelihood of introducing errors as new
+lines get added to the body.
+
+
+### `if`, `elseif`, `else`
+
+An `if` structure looks like the following. Note the placement of parentheses,
+spaces, and braces; and that `else` and `elseif` are on the same line as the
+closing brace from the earlier body.
+
+```php
+<?php
+if ($expr1) {
+ // if body
+} elseif ($expr2) {
+ // elseif body
+} else {
+ // else body;
+}
+```
+
+> N.b.: There appears to be no consistency between projects, and often not
+> even within the same project, on the use of `else if` vs `elseif`. This
+> guide encourages the use of `elseif` so that all control structures look
+> like single words.
+
+
+### `switch`, `case`
+
+A `switch` structure looks like the following. Note the placement of
+parentheses, spaces, and braces; the indent levels for `case` and `break`; and
+the presence of a `// no break` comment when a break is intentionally omitted.
+
+```php
+<?php
+switch ($expr) {
+ case 1:
+ echo 'First case';
+ break;
+ case 2:
+ echo 'Second case';
+ // no break
+ default:
+ echo 'Default case';
+ break;
+}
+```
+
+### `while`, `do while`
+
+A `while` statement looks like the following. Note the placement of
+parentheses, spaces, and braces.
+
+```php
+<?php
+while ($expr) {
+ // structure body
+}
+```
+
+Similarly, a `do while` statement looks like the following. Note the placement
+of parentheses, spaces, and braces.
+
+```php
+<?php
+do {
+ // structure body;
+} while ($expr);
+```
+
+### `for`
+
+A `for` statement looks like the following. Note the placement of parentheses,
+spaces, and braces.
+
+```php
+<?php
+for ($i = 0; $i < 10; $i++) {
+ // for body
+}
+```
+
+### `foreach`
+
+A `foreach` statement looks like the following. Note the placement of
+parentheses, spaces, and braces.
+
+```php
+<?php
+foreach ($iterable as $key => $value) {
+ // foreach body
+}
+```
+
+### `try`, `catch`
+
+A `try catch` block looks like the following. Note the placement of
+parentheses, spaces, and braces.
+
+```php
+<?php
+try {
+ // try body
+} catch (FirstExceptionType $e) {
+ // catch body
+} catch (OtherExceptionType $e) {
+ // catch body
+}
+```
+
+Conclusion
+----------
+
+There are many elements of style and practice intentionally omitted by this
+guide; these include but are not limited to:
+
+- Declaration of global variables and global constants
+
+- Declaration of functions outside classes, including anonymous functions
+ and closures
+
+- Operators and assignment
+
+- Inter-line alignment
+
+- Comments and documentation blocks
+
+- Class name prefixes and suffixes
+
+- Best practices
+
+Future PSRs may revise and extend this guide to address those or other
+elements of style and practice.
+
+
+Appendices
+----------
+
+### Survey Data
+
+ url,http://www.horde.org/apps/horde/docs/CODING_STANDARDS,http://pear.php.net/manual/en/standards.php,http://solarphp.com/manual/appendix-standards.style,http://framework.zend.com/manual/en/coding-standard.html,http://symfony.com/doc/2.0/contributing/code/standards.html,http://www.ppi.io/docs/coding-standards.html,https://github.com/ezsystems/ezp-next/wiki/codingstandards,http://book.cakephp.org/2.0/en/contributing/cakephp-coding-conventions.html,https://github.com/UnionOfRAD/lithium/wiki/Spec%3A-Coding,http://drupal.org/coding-standards,http://code.google.com/p/sabredav/,http://area51.phpbb.com/docs/31x/coding-guidelines.html,https://docs.google.com/a/zikula.org/document/edit?authkey=CPCU0Us&hgd=1&id=1fcqb93Sn-hR9c0mkN6m_tyWnmEvoswKBtSc0tKkZmJA,http://www.chisimba.com,n/a,https://github.com/Respect/project-info/blob/master/coding-standards-sample.php,n/a,Object Calisthenics for PHP,http://doc.nette.org/en/coding-standard,http://flow3.typo3.org,https://github.com/propelorm/Propel2/wiki/Coding-Standards,http://developer.joomla.org/coding-standards.html
+ voting,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,no,no,no,?,yes,no,yes
+ indent_type,4,4,4,4,4,tab,4,tab,tab,2,4,tab,4,4,4,4,4,4,tab,tab,4,tab
+ line_length_limit_soft,75,75,75,75,no,85,120,120,80,80,80,no,100,80,80,?,?,120,80,120,no,150
+ line_length_limit_hard,85,85,85,85,no,no,no,no,100,?,no,no,no,100,100,?,120,120,no,no,no,no
+ class_names,studly,studly,studly,studly,studly,studly,studly,studly,studly,studly,studly,lower_under,studly,lower,studly,studly,studly,studly,?,studly,studly,studly
+ class_brace_line,next,next,next,next,next,same,next,same,same,same,same,next,next,next,next,next,next,next,next,same,next,next
+ constant_names,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper
+ true_false_null,lower,lower,lower,lower,lower,lower,lower,lower,lower,upper,lower,lower,lower,upper,lower,lower,lower,lower,lower,upper,lower,lower
+ method_names,camel,camel,camel,camel,camel,camel,camel,camel,camel,camel,camel,lower_under,camel,camel,camel,camel,camel,camel,camel,camel,camel,camel
+ method_brace_line,next,next,next,next,next,same,next,same,same,same,same,next,next,same,next,next,next,next,next,same,next,next
+ control_brace_line,same,same,same,same,same,same,next,same,same,same,same,next,same,same,next,same,same,same,same,same,same,next
+ control_space_after,yes,yes,yes,yes,yes,no,yes,yes,yes,yes,no,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes
+ always_use_control_braces,yes,yes,yes,yes,yes,yes,no,yes,yes,yes,no,yes,yes,yes,yes,no,yes,yes,yes,yes,yes,yes
+ else_elseif_line,same,same,same,same,same,same,next,same,same,next,same,next,same,next,next,same,same,same,same,same,same,next
+ case_break_indent_from_switch,0/1,0/1,0/1,1/2,1/2,1/2,1/2,1/1,1/1,1/2,1/2,1/1,1/2,1/2,1/2,1/2,1/2,1/2,0/1,1/1,1/2,1/2
+ function_space_after,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no
+ closing_php_tag_required,no,no,no,no,no,no,no,no,yes,no,no,no,no,yes,no,no,no,no,no,yes,no,no
+ line_endings,LF,LF,LF,LF,LF,LF,LF,LF,?,LF,?,LF,LF,LF,LF,?,,LF,?,LF,LF,LF
+ static_or_visibility_first,static,?,static,either,either,either,visibility,visibility,visibility,either,static,either,?,visibility,?,?,either,either,visibility,visibility,static,?
+ control_space_parens,no,no,no,no,no,no,yes,no,no,no,no,no,no,yes,?,no,no,no,no,no,no,no
+ blank_line_after_php,no,no,no,no,yes,no,no,no,no,yes,yes,no,no,yes,?,yes,yes,no,yes,no,yes,no
+ class_method_control_brace,next/next/same,next/next/same,next/next/same,next/next/same,next/next/same,same/same/same,next/next/next,same/same/same,same/same/same,same/same/same,same/same/same,next/next/next,next/next/same,next/same/same,next/next/next,next/next/same,next/next/same,next/next/same,next/next/same,same/same/same,next/next/same,next/next/next
+
+
+### Survey Results
+
+ indent_type:
+ tab: 7
+ 2: 1
+ 4: 14
+ line_length_limit_soft:
+ ?: 2
+ no: 3
+ 75: 4
+ 80: 6
+ 85: 1
+ 100: 1
+ 120: 4
+ 150: 1
+ line_length_limit_hard:
+ ?: 2
+ no: 11
+ 85: 4
+ 100: 3
+ 120: 2
+ class_names:
+ ?: 1
+ lower: 1
+ lower_under: 1
+ studly: 19
+ class_brace_line:
+ next: 16
+ same: 6
+ constant_names:
+ upper: 22
+ true_false_null:
+ lower: 19
+ upper: 3
+ method_names:
+ camel: 21
+ lower_under: 1
+ method_brace_line:
+ next: 15
+ same: 7
+ control_brace_line:
+ next: 4
+ same: 18
+ control_space_after:
+ no: 2
+ yes: 20
+ always_use_control_braces:
+ no: 3
+ yes: 19
+ else_elseif_line:
+ next: 6
+ same: 16
+ case_break_indent_from_switch:
+ 0/1: 4
+ 1/1: 4
+ 1/2: 14
+ function_space_after:
+ no: 22
+ closing_php_tag_required:
+ no: 19
+ yes: 3
+ line_endings:
+ ?: 5
+ LF: 17
+ static_or_visibility_first:
+ ?: 5
+ either: 7
+ static: 4
+ visibility: 6
+ control_space_parens:
+ ?: 1
+ no: 19
+ yes: 2
+ blank_line_after_php:
+ ?: 1
+ no: 13
+ yes: 8
+ class_method_control_brace:
+ next/next/next: 4
+ next/next/same: 11
+ next/same/same: 1
+ same/same/same: 6
+
View
803 proposed/PSR-2-advanced.md
@@ -0,0 +1,803 @@
+Coding Style Guide
+==================
+
+This guide extends and expands on [PSR-1][], the basic coding standard.
+
+The intent of this guide is to reduce cognitive friction when scanning code
+from different authors. It does so by enumerating a shared set of rules and
+expectations about how to format PHP code.
+
+The style rules herein are derived from commonalities among the various member
+projects. When various authors collaborate across multiple projects, it helps
+to have one set of guidelines to be used among all those projects. Thus, the
+benefit of this guide is not in the rules themselves, but in the sharing of
+those rules.
+
+The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
+"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
+interpreted as described in [RFC 2119][].
+
+[RFC 2119]: http://www.ietf.org/rfc/rfc2119.txt
+[PSR-0]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md
+[PSR-1]: http://example.com
+
+
+1. Overview
+-----------
+
+- Code MUST follow [PSR-1][].
+
+- Code MUST use 4 spaces for indenting, not tabs.
+
+- There MUST NOT be a hard limit on line length; the soft limit MUST be 120
+ characters; lines SHOULD be 80 characters or less.
+
+- There MUST be one blank line after the `namespace` declaration, and there
+ MUST be one blank line after the block of `use` declarations.
+
+- Opening braces for classes MUST go on the next line, and closing braces MUST
+ go on the next line after the body.
+
+- Opening braces for methods MUST go on the next line, and closing braces MUST
+ go on the next line after the body.
+
+- Visibility MUST be declared on all properties and methods; `abstract` and
+ `final` MUST be declared before the visibility; `static` MUST be declared
+ after the visibility.
+
+- Control structure keywords MUST have one space after them; method and
+ function calls MUST NOT.
+
+- Opening braces for control structures MUST go on the same line, and closing
+ braces MUST go on the next line after the body.
+
+- Opening parentheses for control structures MUST NOT have a space after them,
+ and closing parentheses for control structures MUST NOT have a space before.
+
+### 1.1 Example
+
+This example encompasses some of the rules below as a quick overview:
+
+```php
+<?php
+namespace Vendor\Package;
+
+use FooInterface;
+use BarClass as Bar;
+use OtherVendor\OtherPackage\BazClass;
+
+class Foo extends Bar implements FooInterface
+{
+ public function sampleFunction($a, $b = null)
+ {
+ if ($a === $b) {
+ bar();
+ } elseif ($a > $b) {
+ $foo->bar($arg1);
+ } else {
+ BazClass::bar($arg2, $arg3);
+ }
+ }
+
+ final public static function bar()
+ {
+ // method body
+ }
+}
+```
+
+2. General
+----------
+
+### 2.1 Basic Coding Standard
+
+Code MUST follow all rules outlined in [PSR-1][].
+
+### 2.2 Files
+
+All PHP files MUST use the Unix LF (linefeed) line ending.
+
+All PHP files MUST end with a single blank line.
+
+The closing `?>` tag MUST be omitted from files containing only PHP.
+
+### 2.3 Lines
+
+There MUST NOT be a hard limit on line length.
+
+The soft limit on line length MUST be 120 characters; automated style checkers
+MUST warn but MUST NOT error at the soft limit.
+
+Lines SHOULD NOT be longer than 80 characters; lines longer than that SHOULD
+be split into multiple subsequent lines of no more than 80 characters each.
+
+There MUST NOT be trailing whitespace at the end of non-blank lines.
+
+Blank lines MAY be added to improve readability and to indicate related
+blocks of code.
+
+There MUST NOT be more than one statement per line.
+
+### 2.4 Indenting
+
+Code MUST use an indent of 4 spaces, and MUST NOT use tabs for indenting.
+
+> N.b.: Using only spaces, and not mixing spaces with tabs, helps to avoid
+> problems with diffs, patches, history, and annotations. The use of spaces
+> also makes it easy to insert fine-grained sub-indentation for inter-line
+> alignment.
+
+### 2.5 Keywords and True/False/Null
+
+PHP [keywords][] MUST be in lower case.
+
+The PHP constants `true`, `false`, and `null` MUST be in lower case.
+
+[keywords]: http://php.net/manual/en/reserved.keywords.php
+
+
+
+3. Namespace and Use Declarations
+---------------------------------
+
+When present, there MUST be one blank line after the `namespace` declaration.
+
+When present, all `use` declarations MUST go after the `namespace`
+declaration.
+
+There MUST be one `use` keyword per declaration.
+
+There MUST be one blank line after the `use` block.
+
+For example:
+
+```php
+<?php
+namespace Vendor\Package;
+
+use FooClass;
+use BarClass as Bar;
+use OtherVendor\OtherPackage\BazClass;
+
+// ... additional PHP code ...
+
+```
+
+
+4. Classes, Properties, and Methods
+-----------------------------------
+
+The term "class" refers to all classes, interfaces, and traits.
+
+### 4.1. Extends and Implements
+
+The `extends` and `implements` keywords MUST be declared on the same line as
+the class name.
+
+The opening brace for the class go MUST go on its own line; the closing brace
+for the class MUST go on the next line after the body.
+
+```php
+<?php
+namespace Vendor\Package;
+
+use FooClass;
+use BarClass as Bar;
+use OtherVendor\OtherPackage\BazClass;
+
+class ClassName extends ParentClass implements \ArrayAccess, \Countable
+{
+ // constants, properties, methods
+}
+```
+
+Lists of `implements` MAY be split across multiple lines, where each
+subsequent line is indented once. When doing so, the first item in the list
+MUST be on the next line, and there MUST be only one interface per line.
+
+```php
+<?php
+namespace Vendor\Package;
+
+use FooClass;
+use BarClass as Bar;
+use OtherVendor\OtherPackage\BazClass;
+
+class ClassName extends ParentClass implements
+ \ArrayAccess,
+ \Countable,
+ \Serializable
+{
+ // constants, properties, methods
+}
+```
+
+### 4.2. Properties
+
+Visibility MUST be declared on all properties.
+
+The `var` keyword MUST NOT be used to declare a property.
+
+There MUST NOT be more than one property declared per statement.
+
+Property names SHOULD NOT be prefixed with a single underscore to indicate
+protected or private visibility.
+
+A property declaration looks like the following.
+
+```php
+<?php
+namespace Vendor\Package;
+
+class ClassName
+{
+ public $foo = null;
+}
+```
+
+### 4.3 Methods
+
+Visibility MUST be declared on all methods.
+
+Method names SHOULD NOT be prefixed with a single underscore to indicate
+protected or private visibility.
+
+Method names MUST NOT be declared with a space after the method name. The
+opening brace MUST go on its own line, and the closing brace MUST go on the
+next line following the body. There MUST NOT be a space after the opening
+parenthesis, and there MUST NOT be a space before the closing parenthesis.
+
+A method declaration looks like the following. Note the placement of
+parentheses, commas, spaces, and braces:
+
+```php
+<?php
+namespace Vendor\Package;
+
+class ClassName
+{
+ public function fooBarBaz($arg1, &$arg2, $arg3 = [])
+ {
+ // method body
+ }
+}
+```
+
+### 4.3 Method Arguments
+
+In the argument list, there MUST NOT be a space before each comma, and there
+MUST be one space after each comma.
+
+Method arguments with default values MUST go at the end of the argument
+list.
+
+```php
+<?php
+namespace Vendor\Package;
+
+class ClassName
+{
+ public function foo($arg1, &$arg2, $arg3 = [])
+ {
+ // method body
+ }
+}
+```
+
+Argument lists MAY be split across multiple lines, where each subsequent line
+is indented once. When doing so, the first item in the list MUST be on the
+next line, and there MUST be only one argument per line.
+
+When the argument list is split across multiple lines, the closing parenthesis
+and opening brace MUST be placed together on their own line with one space
+between them.
+
+```php
+<?php
+namespace Vendor\Package;
+
+class ClassName
+{
+ public function aVeryLongMethodName(
+ ClassTypeHint $arg1,
+ &$arg2,
+ array $arg3 = []
+ ) {
+ // method body
+ }
+}
+```
+
+### 4.4. `abstract`, `final`, and `static`
+
+When present, the `abstract` and `final` declarations MUST precede the
+visibility declaration.
+
+When present, the `static` declaration MUST come after the visibility
+declaration.
+
+```php
+<?php
+namespace Vendor\Package;
+
+abstract class ClassName
+{
+ protected static $foo;
+
+ abstract protected function zim();
+
+ final public static function bar()
+ {
+ // method body
+ }
+}
+```
+
+### 4.4 Method and Function Calls
+
+When making a method or function call, there MUST NOT be a space between the
+method or function name and the opening parenthesis, there MUST NOT be a space
+after the opening parenthesis, and there MUST NOT be a space before the
+closing parenthesis. In the argument list, there MUST NOT be a space before
+each comma, and there MUST be one space after each comma.
+
+```php
+<?php
+bar();
+$foo->bar($arg1);
+Foo::bar($arg2, $arg3);
+```
+
+Argument lists MAY be split across multiple lines, where each subsequent line
+is indented once. When doing so, the first item in the list MUST be on the
+next line, and there MUST be only one argument per line.
+
+```php
+<?php
+$foo->bar(
+ $longArgument,
+ $longerArgument,
+ $muchLongerArgument
+);
+```
+
+5. Control Structures
+---------------------
+
+The general style rules for control structures are as follows:
+
+- There MUST be one space after the control structure keyword
+- There MUST NOT be a space after the opening parenthesis
+- There MUST NOT be a space before the closing parenthesis
+- There MUST be one space between the closing parenthesis and the opening
+ brace
+- The structure body MUST be indented once
+- The closing brace MUST be on the next line after the body
+
+The body of each structure MUST be enclosed by braces. This standardizes how
+the structures look, and reduces the likelihood of introducing errors as new
+lines get added to the body.
+
+
+### 5.1. `if`, `elseif`, `else`
+
+An `if` structure looks like the following. Note the placement of parentheses,
+spaces, and braces; and that `else` and `elseif` are on the same line as the
+closing brace from the earlier body.
+
+```php
+<?php
+if ($expr1) {
+ // if body
+} elseif ($expr2) {
+ // elseif body
+} else {
+ // else body;
+}
+```
+
+The keyword `elseif` SHOULD be used instead of `else if` so that all control
+keywords looks like single words.
+
+
+### 5.2. `switch`, `case`
+
+A `switch` structure looks like the following. Note the placement of
+parentheses, spaces, and braces. The `case` statement MUST be indented once
+from `switch`, and the `break` keyword (or other terminating keyword) MUST be
+indented at the same level as the `case` body. There MUST be a comment such as
+`// no break` when fall-through is intentional in a non-empty `case` body.
+
+```php
+<?php
+switch ($expr) {
+ case 0:
+ echo 'First case, with a break';
+ break;
+ case 1:
+ echo 'Second case, which falls through';
+ // no break
+ case 2:
+ case 3:
+ case 4:
+ echo 'Third case, return instead of break';
+ return;
+ default:
+ echo 'Default case';
+ break;
+}
+```
+
+
+### 5.3 `while`, `do while`
+
+A `while` statement looks like the following. Note the placement of
+parentheses, spaces, and braces.
+
+```php
+<?php
+while ($expr) {
+ // structure body
+}
+```
+
+Similarly, a `do while` statement looks like the following. Note the placement
+of parentheses, spaces, and braces.
+
+```php
+<?php
+do {
+ // structure body;
+} while ($expr);
+```
+
+### 5.4. `for`
+
+A `for` statement looks like the following. Note the placement of parentheses,
+spaces, and braces.
+
+```php
+<?php
+for ($i = 0; $i < 10; $i++) {
+ // for body
+}
+```
+
+### 5.5. `foreach`
+
+A `foreach` statement looks like the following. Note the placement of
+parentheses, spaces, and braces.
+
+```php
+<?php
+foreach ($iterable as $key => $value) {
+ // foreach body
+}
+```
+
+### 5.6. `try`, `catch`
+
+A `try catch` block looks like the following. Note the placement of
+parentheses, spaces, and braces.
+
+```php
+<?php
+try {
+ // try body
+} catch (FirstExceptionType $e) {
+ // catch body
+} catch (OtherExceptionType $e) {
+ // catch body
+}
+```
+
+6. Closures
+-----------
+
+Closures MUST be declared with a space after the `function` keyword, and a
+space before and after the `use` keyword.
+
+The opening brace MUST go on the same line, and the closing brace MUST go on
+the next line following the body.
+
+There MUST NOT be a space after the opening parenthesis of the argument list
+or variable list, and there MUST NOT be a space before the closing parenthesis
+of the argument list or variable list.
+
+In the argument list and variable list, there MUST NOT be a space before each
+comma, and there MUST be one space after each comma.
+
+Closure arguments with default values MUST go at the end of the argument
+list.
+
+A closure declaration looks like the following. Note the placement of
+parentheses, commas, spaces, and braces:
+
+```php
+<?php
+$closureWithArgs = function ($arg1, $arg2) {
+ // body
+};
+
+$closureWithArgsAndVars = function ($arg1, $arg2) use ($var1, $var2) {
+ // body
+};
+```
+
+Argument lists and variable lists MAY be split across multiple lines, where
+each subsequent line is indented once. When doing so, the first item in the
+list MUST be on the next line, and there MUST be only one argument or variable
+per line.
+
+When the ending list (whether or arguments or variables) is split across
+multiple lines, the closing parenthesis and opening brace MUST be placed
+together on their own line with one space between them.
+
+The following are examples of closures with and without argument lists and
+variable lists split across multiple lines.
+
+```php
+<?php
+$longArgs_noVars = function (
+ $longArgument,
+ $longerArgument,
+ $muchLongerArgument
+) {
+ // body
+};
+
+$noArgs_longVars = function () use (
+ $longVar1,
+ $longerVar2,
+ $muchLongerVar3
+) {
+ // body
+};
+
+$longArgs_longVars = function (
+ $longArgument,
+ $longerArgument,
+ $muchLongerArgument
+) use (
+ $longVar1,
+ $longerVar2,
+ $muchLongerVar3
+) {
+ // body
+};
+
+$longArgs_shortVars = function (
+ $longArgument,
+ $longerArgument,
+ $muchLongerArgument
+) use ($var1) {
+ // body
+};
+
+$shortArgs_longVars = function ($arg) use (
+ $longVar1,
+ $longerVar2,
+ $muchLongerVar3
+) {
+ // body
+};
+```
+
+Note that the formatting rules also apply when the closure is used directly
+in a function or method call as an argument.
+
+```php
+<?php
+$foo->bar(
+ $arg1,
+ function ($arg2) use ($var1) {
+ // body
+ },
+ $arg3
+);
+```
+
+
+7. Conclusion
+--------------
+
+There are many elements of style and practice intentionally omitted by this
+guide. These include but are not limited to:
+
+- Declaration of global variables and global constants
+
+- Declaration of functions
+
+- Operators and assignment
+
+- Inter-line alignment
+
+- Comments and documentation blocks
+
+- Class name prefixes and suffixes
+
+- Best practices
+
+Future recommendations MAY revise and extend this guide to address those or
+other elements of style and practice.
+
+
+Appendix A: Survey
+------------------
+
+In writing this style guide, the group took a survey of member projects to
+determine common practices. The survey is retained herein for posterity.
+
+### A.1 Survey Data
+
+ url,http://www.horde.org/apps/horde/docs/CODING_STANDARDS,http://pear.php.net/manual/en/standards.php,http://solarphp.com/manual/appendix-standards.style,http://framework.zend.com/manual/en/coding-standard.html,http://symfony.com/doc/2.0/contributing/code/standards.html,http://www.ppi.io/docs/coding-standards.html,https://github.com/ezsystems/ezp-next/wiki/codingstandards,http://book.cakephp.org/2.0/en/contributing/cakephp-coding-conventions.html,https://github.com/UnionOfRAD/lithium/wiki/Spec%3A-Coding,http://drupal.org/coding-standards,http://code.google.com/p/sabredav/,http://area51.phpbb.com/docs/31x/coding-guidelines.html,https://docs.google.com/a/zikula.org/document/edit?authkey=CPCU0Us&hgd=1&id=1fcqb93Sn-hR9c0mkN6m_tyWnmEvoswKBtSc0tKkZmJA,http://www.chisimba.com,n/a,https://github.com/Respect/project-info/blob/master/coding-standards-sample.php,n/a,Object Calisthenics for PHP,http://doc.nette.org/en/coding-standard,http://flow3.typo3.org,https://github.com/propelorm/Propel2/wiki/Coding-Standards,http://developer.joomla.org/coding-standards.html
+ voting,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,no,no,no,?,yes,no,yes
+ indent_type,4,4,4,4,4,tab,4,tab,tab,2,4,tab,4,4,4,4,4,4,tab,tab,4,tab
+ line_length_limit_soft,75,75,75,75,no,85,120,120,80,80,80,no,100,80,80,?,?,120,80,120,no,150
+ line_length_limit_hard,85,85,85,85,no,no,no,no,100,?,no,no,no,100,100,?,120,120,no,no,no,no
+ class_names,studly,studly,studly,studly,studly,studly,studly,studly,studly,studly,studly,lower_under,studly,lower,studly,studly,studly,studly,?,studly,studly,studly
+ class_brace_line,next,next,next,next,next,same,next,same,same,same,same,next,next,next,next,next,next,next,next,same,next,next
+ constant_names,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper
+ true_false_null,lower,lower,lower,lower,lower,lower,lower,lower,lower,upper,lower,lower,lower,upper,lower,lower,lower,lower,lower,upper,lower,lower
+ method_names,camel,camel,camel,camel,camel,camel,camel,camel,camel,camel,camel,lower_under,camel,camel,camel,camel,camel,camel,camel,camel,camel,camel
+ method_brace_line,next,next,next,next,next,same,next,same,same,same,same,next,next,same,next,next,next,next,next,same,next,next
+ control_brace_line,same,same,same,same,same,same,next,same,same,same,same,next,same,same,next,same,same,same,same,same,same,next
+ control_space_after,yes,yes,yes,yes,yes,no,yes,yes,yes,yes,no,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes
+ always_use_control_braces,yes,yes,yes,yes,yes,yes,no,yes,yes,yes,no,yes,yes,yes,yes,no,yes,yes,yes,yes,yes,yes
+ else_elseif_line,same,same,same,same,same,same,next,same,same,next,same,next,same,next,next,same,same,same,same,same,same,next
+ case_break_indent_from_switch,0/1,0/1,0/1,1/2,1/2,1/2,1/2,1/1,1/1,1/2,1/2,1/1,1/2,1/2,1/2,1/2,1/2,1/2,0/1,1/1,1/2,1/2
+ function_space_after,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no
+ closing_php_tag_required,no,no,no,no,no,no,no,no,yes,no,no,no,no,yes,no,no,no,no,no,yes,no,no
+ line_endings,LF,LF,LF,LF,LF,LF,LF,LF,?,LF,?,LF,LF,LF,LF,?,,LF,?,LF,LF,LF
+ static_or_visibility_first,static,?,static,either,either,either,visibility,visibility,visibility,either,static,either,?,visibility,?,?,either,either,visibility,visibility,static,?
+ control_space_parens,no,no,no,no,no,no,yes,no,no,no,no,no,no,yes,?,no,no,no,no,no,no,no
+ blank_line_after_php,no,no,no,no,yes,no,no,no,no,yes,yes,no,no,yes,?,yes,yes,no,yes,no,yes,no
+ class_method_control_brace,next/next/same,next/next/same,next/next/same,next/next/same,next/next/same,same/same/same,next/next/next,same/same/same,same/same/same,same/same/same,same/same/same,next/next/next,next/next/same,next/same/same,next/next/next,next/next/same,next/next/same,next/next/same,next/next/same,same/same/same,next/next/same,next/next/next
+
+### A.2 Survey Legend
+
+`indent_type`:
+The type of indenting. `tab` = "Use a tab", `2` or `4` = "number of spaces"
+
+`line_length_limit_soft`:
+The "soft" line length limit, in characters. `?` = not discernible or no response, `no` means no limit.
+
+`line_length_limit_hard`:
+The "hard" line length limit, in characters. `?` = not discernible or no response, `no` means no limit.
+
+`class_names`:
+How classes are named. `lower` = lowercase only, `lower_under` = lowercase with underscore separators, `studly` = StudlyCase.
+
+`class_brace_line`:
+Does the opening brace for a class go on the `same` line as the class keyword, or on the `next` line after it?
+
+`constant_names`:
+How are class constants named? `upper` = Uppercase with underscore separators.
+
+`true_false_null`:
+Are the `true`, `false`, and `null` keywords spelled as all `lower` case, or all `upper` case?
+
+`method_names`:
+How are methods named? `camel` = `camelCase`, `lower_under` = lowercase with underscore separators.
+
+`method_brace_line`:
+Does the opening brace for a method go on the `same` line as the method name, or on the `next` line?
+
+`control_brace_line`:
+Does the opening brace for a control structure go on the `same` line, or on the `next` line?
+
+`control_space_after`:
+Is there a space after the control structure keyword?
+
+`always_use_control_braces`:
+Do control structures always use braces?
+
+`else_elseif_line`:
+When using `else` or `elseif`, does it go on the `same` line as the previous closing brace, or does it go on the `next` line?
+
+`case_break_indent_from_switch`:
+How many times are `case` and `break` indented from an opening `switch` statement?
+
+`function_space_after`:
+Do function calls have a space after the function name and before the opening parenthesis?
+
+`closing_php_tag_required`:
+In files containing only PHP, is the closing `?>` tag required?
+
+`line_endings`:
+What type of line ending is used?
+
+`static_or_visibility_first`:
+When declaring a method, does `static` come first, or does the visibility come first?
+
+`control_space_parens`:
+In a control structure expression, is there a space after the opening parenthesis and a space before the closing parenthesis? `yes` = `if ( $expr )`, `no` = `if ($expr)`.
+
+`blank_line_after_php`:
+Is there a blank line after the opening PHP tag?
+
+`class_method_control_brace`:
+A summary of what line the opening braces go on for classes, methods, and control structures.
+
+### A.3 Survey Results
+
+ indent_type:
+ tab: 7
+ 2: 1
+ 4: 14
+ line_length_limit_soft:
+ ?: 2
+ no: 3
+ 75: 4
+ 80: 6
+ 85: 1
+ 100: 1
+ 120: 4
+ 150: 1
+ line_length_limit_hard:
+ ?: 2
+ no: 11
+ 85: 4
+ 100: 3
+ 120: 2
+ class_names:
+ ?: 1
+ lower: 1
+ lower_under: 1
+ studly: 19
+ class_brace_line:
+ next: 16
+ same: 6
+ constant_names:
+ upper: 22
+ true_false_null:
+ lower: 19
+ upper: 3
+ method_names:
+ camel: 21
+ lower_under: 1
+ method_brace_line:
+ next: 15
+ same: 7
+ control_brace_line:
+ next: 4
+ same: 18
+ control_space_after:
+ no: 2
+ yes: 20
+ always_use_control_braces:
+ no: 3
+ yes: 19
+ else_elseif_line:
+ next: 6
+ same: 16
+ case_break_indent_from_switch:
+ 0/1: 4
+ 1/1: 4
+ 1/2: 14
+ function_space_after:
+ no: 22
+ closing_php_tag_required:
+ no: 19
+ yes: 3
+ line_endings:
+ ?: 5
+ LF: 17
+ static_or_visibility_first:
+ ?: 5
+ either: 7
+ static: 4
+ visibility: 6
+ control_space_parens:
+ ?: 1
+ no: 19
+ yes: 2
+ blank_line_after_php:
+ ?: 1
+ no: 13
+ yes: 8
+ class_method_control_brace:
+ next/next/next: 4
+ next/next/same: 11
+ next/same/same: 1
+ same/same/same: 6
Something went wrong with that request. Please try again.