Согласны ли мои правила именования файлов / классов для codeigniter? - PullRequest
2 голосов
/ 28 июля 2011

Я начинаю новый проект и хочу, чтобы все было сделано правильно:

Контроллер:

имя файла: routemanagerdashboard.php имя класса: RouteManagerDashboard

Просмотров: имя файла: routemanagerdashboard_dashboard.php

Модель: имя файла: routemanagerdashboard_model

Ответы [ 2 ]

4 голосов
/ 28 июля 2011

Эти соглашения об именах прекрасно подходят. Хотя есть некоторые соглашения, которым вы должны следовать, то, что вы называете своими файлами / классами, в основном сводится к личным предпочтениям. После работы с CodeIgniter в течение нескольких лет я установил следующие соглашения об именах для своих файлов.

Контроллеры: companies.php (имя файла во множественном числе и имя класса)

Модели: company_model.php (единственное число, которому соответствует таблица)

Просмотры: companies / method_name.php (все представления для контроллера помещаются в папку для представлений в этом классе)

Я всегда делаю имена таблиц своей базы данных множественными и имею непосредственное отношение между моими моделями и таблицами. Контроллеры обычно имеют соответствующую таблицу и модель, но не всегда. Я также использую базовую модель , которая устраняет большую часть утомительной настройки новой модели для каждой таблицы, которая очень хорошо вписывается в эту настройку, и, вероятно, является большой причиной, по которой я довольно строго придерживаюсь этого.

2 голосов
/ 28 июля 2011

Это хорошо, но routemanagerdashboard кажется немного многословным, вы можете подумать о том, чтобы придумать что-то более короткое. Если вам нравится имя класса контроллера, но вы ненавидите длинные URL-адреса, вы всегда можете использовать route , чтобы обойти его.

Поскольку мы имеем дело с PHP, чувствительность к регистру не является проблемой, поэтому имя вашего класса контроллера в порядке, если оно соответствует символам в имени файла. Просто придерживайтесь строчных имен файлов.

Имя вашей модели использует общее соглашение CI, но помните, что при загрузке модели вы можете использовать второй параметр для псевдонима имени класса для более легкого использования. Пример:

$this->load->model('routemanagerdashboard_model', 'r_model');
$this->r_model->get_something(); // A little easier to work with

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

// file = /views/routemanager/dashboard.php
$this->load->view('routemanager/dashboard');

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

...