Handwritten PHP API Framework (1) PSR Specification

This article brings you relevant knowledge about PHP. It mainly talks about coding standards with you. It is also recommended that you try to follow the standards during development. Interested friends can take a look at it together. I hope it will be helpful to you. Everyone is helpful.

Original intention of creation

• Are you tired of using CURD?
• Are the various frameworks a bit overwhelming?
• Have you ever tried to design a framework yourself?
• I learned PHP syntax, but I don’t have any projects to put it into practice and lay a solid foundation

I hope it can help you quickly build a framework of your own, which can bring some benefits to your work or study. Come for some help and inspiration.

What can you learn

• PSR specification

• Usage of composer

• Quickly build an API interface framework

• Redis applications of various data types

• Cache application analysis

Before developing the framework, let me introduce the specifications followed by the framework development.

Most programming languages ​​have their own set of coding standards. As the "best language in the world", PHP certainly has its own coding standards. This specification is PHP Standard Recommendation (PSR for short).

Of course, from my own work, I found that many PHP programmers, especially junior programmers, do not know that PHP has such a specification. I think this is unscientific.

What is PSR?

Before introducing PSR, we need to introduce the organization that formulated this specification-----PHP-FIG, whose full name is PHP Framework Interoperability.

Organization members formulate specifications and implement them in their own projects. Although it is not an official organization, it also represents most PHP community projects, such as CakePHP, Composer, Drupal, PEAR, Slim, Yii framework, Zend Framework wait. And more and more projects are joining and following this standard.

The purpose of the PSR project is to develop a collaboration standard with the lowest level of restrictions through discussions between framework authors or representatives of the framework. Each framework follows unified coding standards to allow engineers to work together better.

Up to now, 20 items have been listed on the official website. Excluding those in drafting and discarded, there are the following 13 items.

Let’s take a look at these specifications:

PSR-1 Basic Coding Specification

• PHP code files must start with
• PHP code files must be encoded in UTF-8 without BOM
• PHP code should only define For declarations of classes, functions, constants, etc., or other operations that will produce side effects (such as generating file output and modifying .ini configuration files, etc.), you can only choose one of the two.
• Namespaces and classes must comply with PSR The automatic loading specification PSR-4
• The naming of the class must follow the StudlyCaps style camel case naming specification starting with a capital
• All letters of the constants in the class must be capitalized, and words are separated by underscores
• Method names must conform to the camelCase-style camelCase naming convention that begins with lowercase letters

PSR-12 code style specifications

PSR-12 specifications are very detailed. Contains descriptions of declarations, namespaces, classes and inheritance, and control structures.

Let’s take a look at a demo first:

<?php

declare(strict_types=1);

namespace Vendor\Package;

use Vendor\Package\{ClassA as A, ClassB, ClassC as C};
use Vendor\Package\SomeNamespace\ClassD as D;

use function Vendor\Package\{functionA, functionB, functionC};

use const Vendor\Package\{ConstantA, ConstantB, ConstantC};

class Foo extends Bar implements FooInterface
{
    public function sampleFunction(int $a, int $b = null): array
    {
        if ($a === $b) {
            bar();
        } elseif ($a > $b) {
            $foo->bar($arg1);
        } else {
            BazClass::bar($arg2, $arg3);
        }
    }

    final public static function bar()
    {
        // method body
    }
}

• The code must follow the coding specifications in [PSR-1]
• All PHP files must use Unix LF (linefeed ) as the line terminator;
• All PHP files must end with a blank line;
• Pure PHP code files must omit the final ?> closing tag
• Every The number of characters in a line should be softly kept within 80. In theory, it must not be more than 120, but there must be no hard limit; there must be no extra spaces after non-blank lines;
• empty lines It can make reading the code easier and help block the code.
• There must not be more than one statement per line
• The code must be indented with 4 spaces, and the tab key must not be used
• All PHP keywords must be all lowercase
• The basic specifications of the control structure are as follows:

控制结构关键词后必须有一个空格。
左括号 ( 后一定不能有空格。
右括号 ) 前也一定不能有空格。
右括号 ) 与开始花括号 { 间一定有一个空格。
结构体主体一定要有一次缩进。
结束花括号 } 一定在结构体主体后单独成行。复制代码

There are many code style specifications, so I won’t explain them one by one here. You can read them by yourself

PSR-4 Autoloading

Regarding the relevant specifications for automatically loading corresponding classes from file paths, this specification is interoperable and can be used as a supplement to any automatic loading specification, including PSR- 0. In addition, this PSR also includes the file storage path specification corresponding to the automatically loaded class.

• The "class" here refers to all classes, interfaces, traits reusable code blocks and other similar structures.

• A complete class name must have the following structure:

   \<命名空间>(\<子命名空间>)*\<类名>

  Copy after login

  • The complete class namemusthave a top-level Namespace, called "vendor namespace";

  • The complete class namecanhave one or more sub-namespaces;

  • The complete class namemusthave a final class name;

  • Underscores in any part of the complete class name have no special meaning ;

  • The complete class namecanbe composed of any uppercase and lowercase letters;

  • ##All class names are

    must Is case sensitive.

• When loading the corresponding file based on the complete class name...
  • In the complete class name, remove The first namespace delimiter, the preceding one or more consecutive namespaces and sub-namespaces, as the "namespace prefix", must correspond to at least one "file base directory";

  • The subnamespace

    immediately following the namespace prefix must match the corresponding "file base directory", and the namespace separator in it will be used as the directory separator. The class name at the end of

  • must have the same name as the corresponding file with the suffix .php.

  • The implementation of the autoloader

    must not throw an exception, must not trigger any level of error message and Should have a return value.

Example
The following table shows the file path corresponding to the complete class name, namespace prefix and file base directory that conforms to the specification.
Full class nameNamespace prefixFile base directoryFile path\Acme\Log\Writer\File_WriterAcme\Log\Writer./acme-log-writer/lib/./acme-log-writer/lib/File_Writer.php\Aura\Web\Response\StatusAura\Web/path/to/aura-web/src//path/to/aura-web/src/Response/Status.php\Symfony\Core \RequestSymfony\Core./vendor/Symfony/Core/./vendor/Symfony/Core/Request.php\Zend\AclZend/usr/includes/Zend//usr/includes/Zend/Acl.phpFor the time being, we will only introduce these three commonly used specifications.

Click to view more latest specification suggestions

---

This section mainly introduces the PHP coding specification PSR. It is recommended that everyone try to follow this specification during development, especially When developing as a team, we should not each have our own coding style, but should unify the style as much as possible. As the original intention of the PHP-FIG organization stated, the specifications they established are not to restrict everyone's coding freedom, but to find commonalities so that we can work better together.
Recommended learning: "

PHP Video Tutorial"

The above is the detailed content of Handwritten PHP API Framework (1) PSR Specification. For more information, please follow other related articles on the PHP Chinese website!