Важное уточнение: нижеследующие соглашения используются в разрабатываемом фреймворке CPF.

Название классов и методов

Примеры наименований классов

Название класса контроллера

Не правильно:

class rights
class appControllerBackendRights

Правильно:

class App_Controller_Backend_Rights extends App_Controller_Base_Backend

Читать как: описание класса контроллера Rights находится в файле app/controller/backend/rights.php

Название класса модели

Правильно:

class App_Model_Group extends App_Model_Base_Model

Читать как: описание класса модели Group находится в файле app/model/group.php

Общий пример наименования метода

Не правильно:

function itemsbyinvoice()		// непонятно назначение функции и необходимы разделители между словами
function itemsByInvoice()		// непонятно назначение функции и используется формат CamelCase
function getitemsbyinvoice()		// Уже лучше!  Но, отсутствуют разделители
function getItemsByInvoice()		// формат CamelCase
function get_items_by_invoice_from_array()	// длинное название

Правильно:

function get_items_by_invoice()	// название несет описательный характер, используются разделители между словами, и все слова с начинаются с нижнего регистра

Методы в CPF контроллере

Публичные методы (public) - actions

Не правильно:

public function view()	// отсутсвтие префикса action_
public function _add()	// отсутсвтие префикса action_ и название функции начинается с символа нижнего подчеркивания
function edit()	// отсутсвтие префикса action_ и отсутствует описание public

Правильно:

public function action_view()
public function action_add()
public function action_edit()

Приватные методы (private, protected)

Не правильно:

private function assign_data()	// отсутсвтие символа нижнего подчеркивания перед названием метода
function _is_valid()	// отсутствует описание private или protected

Правильно:

private function _assign_data()
protected function _is_valid()