README.md

Стиль написания кода

Основное - единичные сущности и наборы

Объект:
$item

Запись (хэш, ассоциативный массив). Относящаяся к какой-либо сущности:
$itemData

Массив объектов:
$itemsList

Массив записей:
$itemsDataList

Карта сущностей [ID => сущность]:
$itemsHash

Карта с более точным указанием ключей и значений:
$itemIdToCodeHash

Идентификация сущностей

Числовой ID сущности:
$itemId

Строковой ID сущности:
$itemCode

Название сущности:
$itemName

Файлы

Объект файла:
$file

Путь к файлу:
$filePath

Объект конкретного файла:
$logsFile

Путь к конкретному файлу:
$logsFilePath

Строки

Строка:
$commentString

Строка с кодом html:
$commentHtml

Дата и время

Текущие дата и время в виде timestamp:
$nowTs = time();

Текущие дата и время в виде строки:
$nowString = strtotime('Y-m-d H:<br>i:<br>s', $nowTs);

Текущие дата и время в виде объекта:
$now = new \DateTime($nowTs);

Передача значений в функции

Функция, принимающая объект:
function foo ($item) {}

Функция, принимающая запись с данными сущности:
function foo ($data) {}

Функция, принимающая параметры/настройки, не относящиеся к какой-либо сущности:
function foo ($params) {}

Выборка сущностей через вызов функции

Выборка по ID осущности:
getItem($itemId);

Выборка по неопределённому указанию на сущность - в виде ID, символьного кода, объекта итд:
getItem($item);

Выборка по ID нескольких сущностей в виде массива:
getItemsList($itemIdsList);

Выборка по ID нескольких сущностей - в произвольном виде: число, массив, строка итд:

function getItemsList ($itemIds) {}

getItemsList(1);
getItemsList([1, 2, 3]);
getItemsList('1,2,3');

Функции-обработчики

Функция-обработчик:
function itemEditHandler ($data) {}

Предобработчик:
function onBeforeItemEditHandler ($data) {}

Постобработчик:
function onAfterItemEditHandler ($data) {}

CRUD

function create ($data) {}

function edit ($id, $data) {}

function delete ($id) {}

function deleteList ($idsList) {}

function get ($params) {}

function getList ($params) {}

Краткая запись

Результат, кратко:
$r = getStuffFromDatabase();

Переменная, использующаяся для обхода в цикле, кратко:

foreach ($itemsList as $e) {
	doSomething($e);
}

Переменные ключ-значение для обхода в цикле, кратко:

foreach ($params as $k => $v) {
	//...
}