7.2 Соглашения об именах

1. Имена файлов

2. Классы

3. Интерфейсы

4. Функции и методы

5. Переменные

6. Константы

Имена файлов, как и имена папок, могут состоять только из латинских букв верхнего или нижнего регистра, чисел или знаков подчеркивания ("_"). Содержащие PHP-код файлы должны иметь расширение ".php".

Примеры правильных имен:

core.php
modules/news/controller/newsEditController.php

Если PHP-файл содержит класс, то его имя должно совпадать с именем этого класса.

В одном файле может быть определен только один класс.

Имена классов выбираются в зависимости от решаемых им задач. Старайтесь выбрать наиболее подходящее название, раскрывающее суть класса. Для этого можно использовать латинские буквы. Знак подчеркивания ("_") не рекомендуется. Обычно имя класса начинается со строчной буквы. Иерархия классов также отражается на их именах, каждый уровень отделяется заглавной буквой.

Примеры правильных имен:

newsDeleteController
httpRequest
adminMapper

Класс может быть определен как абстрактный (abstract class core) или как финальный (final class core). Подумайте прежде чем объявлять класс финальным.

Свойства класса должны быть определены как public, private, или protected. Использование var (который хоть и является алиасом public), для указания доступа к свойству не допускается.

Пример класса:

class funnyAction
{
    const SOME_CONSTANT = 'value';
    public $foo;
    protected $some;
    private $bar = 'Default value';
}

Интерфейсы именуются так же, как классы, но первая буква имени обязательно "i".

Примеры имен интерфейсов:

iRequest
iResponse
iResolver

Так как mzz использует объектно-ориентированный стиль программирования, то в коде должно быть минимальное число функций, поэтому желательно описать функцию как метод.

Имена функций и методов должны быть оформлены в соответствии с camelCase-нотацией.

Для имени функций или методов можно использовать латинские буквы. Имя функции, в отличие от имени метода, может содержать также знаки подчеркивания ("_"). Старайтесь выбрать наиболее подходящее название, раскрывающее суть функции.

Функции должны иметь префикс в виде имени пакета для того, чтобы избежать проблем с функциями из других пакетов. Первая буква в имени должна быть в нижнем регистре, каждая первая буква "слова" - в верхнем.

Примеры имен функций (аналогично для методов):

function setTitle()
{
    //...
}
 
function resolve()
{
    //...
}

Имена переменных могут содержать латинские буквы и в некоторых случаях, описанных ниже, знаки подчеркивания ("_").

Рекомендуется разделять слова в имени переменных, которые определены в функции (методе) или в глобальной видимости, знаком подчеркивания. Примеры правильных имен:

class sample
{
    public $originalVar = 'foo';
 
    public function __construct($simpleView)
    {
        $test_var = $this->originalVar;
    }
}
$sample_object = new Sample;

Константы могут содержать латинские буквы, числа и символы нижнего подчеркивания.

Имена констант должны быть в верхнем регистре.

Имена констант в классах подчиняются таким же правилам.