variables.txt

Именование переменных

    Общие положения
        Общая схема имени переменной выглядит следующим образом: префикс+ДополнительныйПрефикс+ИмяПеременной+Суффикс.
        Имена переменных содержат латинские буквы верхнего и нижнего регистров и начинаются с префикса, записаного в
        нижнем регистре, обозначающего тип данных значения этой переменной. Перечень префиксов, рекомендованых к
        использованию указан ниже. Дополнительный префикс конкретизирует значение переменной и выбирается из перечня
        указанных ниже рекоммендуемых дополнительных префиксов. Имя переменной состоит из одного или нескольких слов,
        описывающих смысловое значение этой переменной, и записывается горбатым регистром. Так как префиксы описывают
        тип значения переменной, ее имя описывает экземпляр данного типа в единственном числе. Суффикс дополняет имя
        переменной и конкретизирует ее смысловое значение. Перечень суффиксов, рекоммендованых к использованию указан
        ниже. Цифры в имени допускаются, но не рекомендуются. Знак нижнего подчеркивания в имени не используется.

    Префиксы
        Рекомендован к использованию следующий перечень префиксов:
            - a (array)     -   массив значение;
            - b (bool)      -   логическое значение;
            - e (entity)    -   объект типа Entity и наследуемые от него;
            - i (integer)   -   целочисленное значение;
            - f (float)     -   значение вещественного типа;
            - m (mapper)    -   объект типа Mapper и наследуемые от него;
            - n (number)    -   значение неопределеного цифрового типа, которое может принимать как целое, так и
                                вещественное значение. Требует проверки на значение типа при использовании.

            - o (object)    -   объект, типа отличного от Mapper и Entity;
            - s (string)    -   строковое значение;
            - x (miXed)     -   объект смешанного типа. Требует проверки на значение типа при использовании.

        Рекомендован к использованию следующий перечень дополнительных префиксов:
            - Min (minimum) -   минимальное значение;
            - Max (maximum) -   максимальное значение;
            - Current       -   текущее значение.

    Суффиксы
        В отличие от Дополнительных префиксов суффиксы конкретизируют семантическое значение имени переменной, а не ее
        значение. Рекомендован к использованию следующий перечень суффиксов:
            - First         -   первое значение из доступного списка;
            - Last          -   последнее значение из доступного списка;
            - Limit         -   предельное значение из доступного списка;
            - Tmp           -   временное значение;
            - New           -   новое (устанавливаемое) значение;
            - Old           -   старое (затираемое) значение;

    Исключения
        Существуют имена переменных, предназначенных для специального использования - исключения из указанных
        рекоммендаций:
            - i, j          -   итераторы для небольших циклов (цикл считается небольшим, если помещается полностью на
                                один экран и позволяет увидеть сразу все вхождения итераторов);
            - k, v          -   переменные цикла foreach ($aData as $k => $v);
            - key, value    -   переменные цикла foreach ($aData as $key => $value);
            - s             -   cериализованное представление данных;
            - data          -   переменная с данными в сеттере сущности, а также данные возвращаемые из методов маппера;
            - sql           -   в мапперах переменная, содержащая текст запроса – префикс «s» не используется.