Este artículo aborda un enfoque para escribir y escribir código PHP. Los siguientes puntos se formaron al analizar los enfoques existentes de la compañía y la experiencia personal.

Reglas para nombrar archivos y carpetas

Todos los nombres de carpetas y archivos deben tener significado y hablar (no requieren explicación adicional).

Carpetas

Todas las carpetas se nombran en minúsculas con separación de palabras usando el -signo menos.

Si la carpeta contiene clases que pertenecen al espacio de nombres (espacio de nombres), la carpeta se nombra de acuerdo con el espacio de nombres del espacio de nombres (espacio de nombres).

Caracteres permitidos para nombrar carpetas: letras latinas y un -signo menos.

Archivos

Todos los archivos relacionados con el proyecto se nombran en minúsculas con separación de palabras usando el símbolo -(menos).

Si el archivo es un archivo de clase, se nombra de acuerdo con el nombre de la clase.

Convenciones de nomenclatura para espacios de nombres, clases, métodos y variables

Todos los nombres deben ser significativos y hablar (no requieren explicación adicional).

Espacios de nombres

. , .

PascalCase. PascalCase .

Trait. Interface. Abstract.

camelCase. camelCase , .

:

2. , ,
   (isPostRequest, getRequestType, parseSchemaElement, renderPageWithSetupsAndTeardowns)
5. boolean is, has can

camelCase. camelCase , .

UPPER_CASE_SNAKE_CASE. UPPER_CASE_SNAKE_CASE , .

:

1. 
   

2. , ,

   
   

3. 
   

4. . Map ($typesMap, $statesMap), .. .

   
   

5. , (unpaidProject)

   
   

6. , , (userIsAdmin, messageIsSend, figureCanBePainted, projectName)

   
   

7. , ,

   
   

   :

   
   

   $object->expire_at
   $object->setExpireAt($date);
   $object->getExpireAt();

   
   

   :

   
   

   $object->expiration_date;
   $object->setExpirationDate($date);
   $object->getExpirationDate();

   
   

8. boolean is, has can

   
   

9. 
   

   :

   
   

   if ($project->isInvalid()) {
       // ...
   }
   if ($project->isNotValid()) {
       // ...
   }
   if ($accessManager->isAccessDenied()) {
       // ...
   }

   
   

   :

   
   

   if (!$project->isValid()) {
       // ...
   }
   if (!$accessManager->isAccessAllowed()) {
       // ...
   }
   if ($accessManager->canAccess()) {
       // ...
   }

   
   

10. ( 8 ), : , ), (userHasRoleAdmin, statusIsActive)

    
    

(namespace), ( ). (use).
{...}. .

.

:

1. .
3. / — .

.

, .

.

.

class InterfaceType {

    private $property = 'myProp';

    public function getProperty():string {
        return $this->property;
    }    
}

(return) , .

, () .

:

 if (IS_REGISTRATOR() && (($params.status === 'W' || $params.status === 'D' || $params.status === 'A') && $params.remark && (($params.subres_level == 0 && ($user_info->selected_title->tid == $params.boss || $user_info->selected_title->tid == $doc_signer_tid || !$params.usertid) || $params.subres_level > 0 && $user_info->selected_title->tid == $params.usertid))) { ... }

:

$docIsInWorkAcceptOrDraft = ...;
$bossHasSignerPriviledge = ...;
$userCanSign = ...;

if ($docIsInWorkAcceptOrDraft && $bossHasSignerPriviledge && $userCanSign) {
  // ...
}

( ""). , , .

, PHPDoc. - .

//, /*...*/.

, , .

, , declare(strict_types=1);

/ null. 0 .

function sendEmail(string $title, string $message = null, string $date = null): void {
    // ...
}

//    
$object->sendEmail('Title', null, '2017-01-01');

//    
$object->sendEmail('Title', '', '2017-01-01');

, ( — ).

. array_key_exists, isset. . .

. , :

3. . \n, \r, \t ..

, (: type). PHPDoc. , c check validate, .

private. , protected. , public.

null, Null object, , (: ).

json — return true, return ['success' => ['message' => '.....']] ['error' => ['message' => '.....']]. message , .

.

. . , .

boolean . boolean (===), .

:

if ($user) {
    // ...
}
if ($request->postData('amount') == 100) {
    // ...
}
if (!$request->postData('amount')) {
    // ...
}

:

if ($user === null) { // $user   object
    // ...
}
if ((int)$request->postData('amount') === 100) {
    // ...
}
if ($booking->comment === '') {
    // ...
} 

Cuando se usan los operadores AND y OR al mismo tiempo en una expresión condicional, es necesario dar prioridad a los corchetes.