Skip to content

Added a note about coding standards and method arguments #6618

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

Added a note about coding standards and method arguments #6618

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6e36307
Added a note about coding standards and method arguments
javiereguiluz May 26, 2016
59a09bf
Added a new rule about class inheritance and interfaces
javiereguiluz May 29, 2016
d51c23b
Minor reword
javiereguiluz May 29, 2016
44c3fb5
Fixed a minor typo
javiereguiluz May 29, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions contributing/code/standards.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,13 +153,19 @@ Structure
that are not intended to be instantiated from the outside and thus are not
concerned by the `PSR-0`_ and `PSR-4`_ autoload standards;

* Declare the class inheritance (if any) and all the implemented interfaces (if
any) in the same line as the class name;
Copy link
Member

@xabbuh xabbuh May 29, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

on the same line (same below)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think "if any" is needed here.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree. Done both changes. Thanks.


* Declare class properties before methods;

* Declare public methods first, then protected ones and finally private ones.
The exceptions to this rule are the class constructor and the ``setUp`` and
``tearDown`` methods of PHPUnit tests, which should always be the first methods
to increase readability;

* Declare all the arguments in the same line as the method/function name, no
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Class name too.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm sorry I don't understand this comment.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See the second example of http://www.php-fig.org/psr/psr-2/#4-1-extends-and-implements

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@javiereguiluz

Something like this, inspired from @wouterj link.

Right:

class ClassName extends ParentClass implements \ArrayAccess, \Countable
{
    // constants, properties, methods
}

Wrong:

class ClassName extends ParentClass implements
    \ArrayAccess,
    \Countable,
    \Serializable
{
    // constants, properties, methods
}

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for explaining it to me. In 59a09bf I've proposed something for this.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this has to be "on the same line" as well

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done too. Thanks.

matter how many arguments there are;

* Use parentheses when instantiating classes regardless of the number of
arguments the constructor has;

Expand Down