Skip to content

Latest commit

 

History

History
149 lines (100 loc) · 5.07 KB

README.md

File metadata and controls

149 lines (100 loc) · 5.07 KB
Raw

Pivotal Agency PHP Style Guide

We use the PSR-1 Basic Coding Standard and the PSR-12 Extended Coding Style Guide.

Naming Conventions

We use the "camelCase" format for all variable/property and function/method names.

As per PSR-12 (section 4.3 & 4.4) do not use leading underscores to indicate private or protected visibility (eg. $this->_badPrivateMethodName(), $_badPrivateVariable).

Example of good property and method names:

    $firstName = 'Joe';

    function printName($firstName)
    {
      echo $firstName;
    }

Commenting

Comment as much as possible, to help the reader understand what you're doing, as quick as possible. They say it’s better to have too many comments than too few.

Although, keep in mind:

  • It's better to focus on creating readable code, than having to explain every line
  • It’s fair to assume that the reader has a basic understanding of syntax (eg. how a for-loop works); so there’s no need to add a comment such as // iterate over the customer array if the variables are self-explanatory

Main sections

Use the DocComment format for functions, class methods and even main sections of code.

This helps:

  • Other developers understand what this function does, what each parameter should do (if necessary) and what the function should return (if necessary)
  • To separate functionality and blocks of code in a file, to make it easier when skimming through the document

eg.

/**
  * Title of this method/function/section
  *
  * This is a more detailed description of this functionality if needed
  *
  * @param string $argument1 This is the description.
  * @return array The list of products
  */

Helper comments

There are other points where you just need to explain what something is doing, within a section of code. For these cases, use the single line comment format, eg.

    // Get this customer's orders
    $orders = $objectManager
        ->create('Magento\Sales\Model\Order')
        ->getCollection()
        ->addFieldToFilter('customer_id', $customerId);

Logical Operators

Always use && and || instead of AND and OR (respectively). If you MUST use AND/OR, wrap them in brackets to ensure they behave as intended.

  // Good
  $a = true && false;
  $b = false || true;

  // Using brackets with AND/OR
  $c = (true AND false);
  $d = (false OR true);

  // BAD!
  $e = true AND false;
  $f = false OR true;

Not sure why this is so important? See example #1 here.

Control structure syntax ({} vs : endif)

It's best to be consistent with the framework you're using. However as a general rule, we:

  • Always use the standard syntax (curly braces)
  • If you've got a deep nest of curly braces 1) consider refactoring or 2) use comments to monitor what each closing brace is for (eg. } // end if - VIPs)
  • When mixing HTML and PHP, use the alternative syntax

Examples:

// Deep nesting
foreach ($myArray as $customerId => $customer) {
    if ($customer['admin'] !== 1) {
        if ($customer['vip'] === 1) {
            // Do something
        } // end if - VIPs
    } // end if - standard users
} // end foreach

// Mixing PHP and HTML
<?php if ($customer['vip'] === 1) : ?>
    <span class="vip_customer"></span>
<?php endif; ?>

Editor Configuration

Ensure your editor is setup to use .editorconfig files, and use the .editorconfig file in the repo root in all new PHP projects.

This will automatically apply settings like indent spacing (4 spaces), line endings (LF), trim trailing whitespace etc, to ensure code written by various developers is consistent.

PhpStorm

Make sure that the "EditorConfig" plugin is enabled. The plugin is bundled with WebStorm and is activated by default. If the plugin is not activated, enable it on the Plugins page of the Settings / Preferences Dialog as described in Enabling and Disabling Plugins.

Next, make sure your code style is set to PSR-1 / PSR-12.

Atom

Install these packages:

You may need to restart Atom for these packages to take effect.

Sublime Text 3

Install these packages: