fostermadeco / php-standards

Visual Chefs PHP Standards

• Coding Standards
  • IDE Configuration
  • Special Cases
  • Namespaces
• Documentation Standards
  • Class Declaration
  • Class Property
  • Class Method
• Vetted Libraries/Packages
• Useful Resources

Coding Standards

For all projects, developers should follow PSR-0, PSR-1, PSR-2 coding standards.

IDE Configuration Settings

In this repository you will find a .editorconfig file. This helps standardize your IDE to what is suggested by this document.

To use this file:

1. put it in the root of your project.
2. Get the plugin for your IDE: editorconfig.org

Special Cases

When working on ExpressionEngine or CodeIgniter projects, developers should follow the class and method naming conventions specified by the framework, for compatibility reasons.

Namespaces

All standalone classes should be namespaced for better compatibility and packaging. For ease of writing, the VC namespace should be used, or alternatively VisualChefs if the first is not available. Secondary namespaces are encouraged, in order to better organize code into modules or packages (example: VC\Logger\Logger, VC\Logger\Handler).

Documentation Standards

Class Declaration

/**
 * desc
 *
 * @author
 * @copyright   (C) 2013. All rights reserved.
 * @version     1.0
 */

/**
 * desc
 *
 * @category
 * @package
 * @subpackage
 * @since       1.0
 */
class MyClass
{}

Class Properties

/**
 * My awesome var does the following thing.
 *
 * @var     boolean
 * @scope   protected
 */
protected $my_awesome_var;

Class Method

/**
 *
 *
 * @param   string   $my_var    A concise description of my_var
 * @return  boolean
 * @access  public
 * @static
 */
public static function myMethod($my_var = 'hello world')
{}

Vetted Libraries/Packages

Auth

• Sentry Full featured basic authentication.
• Sentry Social Social auth add-on for Sentry.

Debugging

• DebugBar for Laravel Helpful debug/profiling bar for Laravel 4.

Email

• Swiftmailer free feature-rich PHP mailer.

Geographic

• Geotools comprehensive set of geographic tools.

HTTP

• Guzzle is a PHP HTTP client & framework.

Logging

• Monolog sends your logs to files, sockets, inboxes, databases and various web services.

Markdown

• Markdown for Laravel Markdown library for Laravel 4.

Templating

• Twig the best templating engine for php.
• TwigBridge for Laravel bridge for Twig so it works with Laravel 4.

Useful Resources

• PHP the Right Way
• net.tutsplus.com
• Laravel
• Design Patterns PHP
• Debugging Laravel 4 Weirdness - Checklist

@TODO more to come

php-standards's Issues

Examples

• Class
• File with functions
• File with just an array
• Twig Template

❓ Any others that would be useful?

Vetted Libraries and Packages

Something that PHP has done so well the last few years are improving the quality of libraries. However there are still a lot of bad options out there. Some we may have even considered high quality years ago, have been replaced.

I added a "Vetted Libraries/Packages" section:

567dd98

I added a couple no-brainers (I hope 😕). But I would say to be critical to what we add.

Anyway, a solid list of solutions to common needs I think would make a great addition.

/ @smaida @alexmglover @akuzemchak @vcAndrew @vcmike