Bug Tracker: создание страниц (часть шестая)

16 марта, 2009
bug_tracker_logo_part6

Мы продолжаем разработку собственной системы отслеживания ошибок. И сегодня подробно рассмотрим создание страниц нашего приложения.

В предыдущих частях мы определились с типами страниц. Напомню, их всего два: страницы с общим перечнем багов (главная и страницы категорий) и страницы отдельных багов с комментариями.

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

Количество записей на одной странице мы задаем в файле конфигурации (application\config\config.php).

  1. $config['bugs_per_page'] = 5;

Получить значение этого параметра можно так:

  1. $this->config->item('bugs_per_page');

Теперь определимся с названиями методов контроллера и структурой URL.

По-умолчанию, URL в CodeIgniter имеют такой вид:

sitename.domen/index.php/имя_контроллера/имя_метода/параметр1/параметр2/…

Контроллер у нас будет называться bugtracker, а метод, показывающий страницы с багами – page. В результате получим URL с такой структурой:

…/bugtracker/page/номер_записи

В последнем сегменте адреса указываем номер первой записи на текущей странице. Кстати, это не id бага в базе данных, это его индекс в массиве с результатами поиска по БД.

Создаём контроллер (application\controllers\bugtracker.php)

  1. class BugTracker extends Controller {
  2.  
  3.     //настройки отображения списка багов
  4.     private $listConf = array(
  5.         'commentOpen'=>'<li class="depth-{depth}">'
  6.     );
  7.  
  8.     function BugTracker() {
  9.         parent::Controller();
  10.  
  11.         $this->load->model('mbug');
  12.         $this->load->model('mcategory');
  13.         $this->load->model('mcomment');
  14.         $this->load->library('Table2Tree');
  15.         $this->load->library('session');
  16.         $this->load->helper('form');
  17.     }
  18.  
  19.     function index() {
  20.         $this->page();
  21.     }
  22.    
  23.     function page($firstBug = 0) {
  24.     …
  25.     }
  26. }

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

1) index – вызывается CodeIgniter’ом если имя метода явно не указано в URL;

2) page($firstBug = 0) – показывает записи о багах начиная с $firstBug.

Т.к. на главной странице у нас будет отображаться список багов начиная с первого, то из метода index мы просто вызываем page без параметров.

Теперь подробно рассмотрим метод page.

  1. function page($firstBug = 0) {
  2.     if (!is_integer((int)$firstBug)) {
  3.         $firstBug = 0;
  4.     }
  5.    
  6.     //сохраняем адрес этой страницы в сессии
  7.     $this->session->set_userdata(array('prev_page'=>current_url()));
  8.    
  9.     $pageData['title'] = 'Bug Tracker';
  10.  
  11.     //настраиваем разбивку на страницы
  12.     $this->load->library('pagination');
  13.     $pconf['base_url'] = $this->config->item('base_url').'bugtracker/page';
  14.     $pconf['total_rows'] = $this->mbug->getBugsCount();
  15.     $pconf['per_page'] = $this->config->item('bugs_per_page');
  16.    
  17.     $this->pagination->initialize($pconf);
  18.     $pageData['paginationLinks'] = $this->pagination->create_links();
  19.  
  20.     //загружаем общий список ошибок и комментариев к ним
  21.     $bugs = $this->mbug->getAllBugs($firstBug, $this->config->item('bugs_per_page'));
  22.    
  23.     if ($bugs !== false) {
  24.         $bugsTree = $this->table2tree->getTree($bugs, $firstBug, $this->config->item('bugs_per_page'));
  25.        
  26.         $pageData['bugsList'] = $this->table2tree->getHTMLList($bugsTree, $this->listConf);
  27.        
  28.     }
  29.  
  30.     $pageData['categories'] = $this->mcategory->getAllCategories();
  31.    
  32.     $this->load->view('header', $pageData);
  33.     $this->load->view('categories');
  34.     //размещаем форму отправки сообщений о багах
  35.     $this->load->view('addbugform');
  36.     $this->load->view('allbugs');
  37.     $this->load->view('footer');
  38. }

Его работу можно разделить на следующие этапы.

1) Проверяем параметр и сохраняем адрес текущей страницы в сессии (зачем это нужно я расскажу немного позже).

2) Настраиваем разбивку на страницы (строки 11-18). Для этого загружаем библиотеку pagination, передаём ей массив с параметрами и создаем ссылки. В качестве параметров мы указываем: общее количество записей (получаем с помощью метода getBugsCount()), количество записей, которые нужно показать на странице (читаем из конфига) и первую часть URL ссылок (к нему последним параметром библиотека будет добавлять номер первой записи на очередной странице).

Т.е. если мы показываем по 5 записей на странице, библиотека создаст такие URL:
.../bugtracker/page/
.../bugtracker/page/5
.../bugtracker/page/10
…

После этого мы загружаем список багов для данной страницы (строка 21). Запрос, который формирует этот список мы рассматривали в прошлый раз.

3) С помощью библиотеки table2tree мы преобразуем таблицу с данными о багах в HTML список (строки 23-28).

4) Загружаем список категорий (строка 30). Он используется для создания навигации по баг трекеру.

5) Показываем страницы (строки 32-37). Для этого загружаем представления и передаем им параметры.

Подробно рассматривать все представления смысла я не вижу. В любом случае оформлением я не занимался, поэтому, скорее всего, их придется немного изменить. Например, добавить CSS классы. Но на принцип работы и передаваемые данные это влиять не будет.

Поэтому сейчас я просто приведу краткое описание всех представлений. Все они находятся в папке (application\views):

header.php – формирует заголовок страницы, загружает JavaScript и CSS файлы;
categories.php – формирует список с перечнем категорий (используется для навигации);
addbugform.php – форма добавления записи о найденном баге;
allbugs.php – показывает список багов и строку со ссылками на другие страницы;
footer.php – «хвостовик» страницы.

Создание страницы выбранной категории.

Приводить код этого метода я не буду, т.к. он практически полностью повторяет метод page. Тем не менее, есть несколько нюансов на которых стоит остановиться.

Во-первых, метод контроллера, создающий страницу отдельной категории, называется category и принимает 2 параметра: название категории и номер первой записи на странице.

Т.е. URL имеет такой вид:

…/bugtracker/category/имя_категоии/номер_записи

Во-вторых, при настройке библиотеки pagination необходимо явно указать в каком сегменте URL находится номер первой записи (по-умолчанию, это значение равно 3).

  1. $pconf['uri_segment'] = 4;

В третьих, список багов получаем с помощью метода getBugsByCategory (модель mbugs). В прошлый раз мы рассматривали SQL запрос, который возвращает список багов для указанной категории.

Остальной код полностью повторяет метод page.

Создание страницы отдельного бага (метод bug).

  1. function bug($id = 1) {
  2.     if (!is_integer((int)$id) || (int)$id <= 0) {
  3.         redirect('bugtracker/index');
  4.         return;
  5.     }
  6.    
  7.     //сохраняем адрес этой страницы в сессии
  8.     $this->session->set_userdata(array('prev_page'=>current_url()));
  9.    
  10.     //ищем указанный баг
  11.     $bug = $this->mbug->getBug($id);
  12.     if ($bug !== false) {
  13.         $bugTree = $this->table2tree->getTree($bug);
  14.        
  15.         $pageData['bugList'] = $this->table2tree->getHTMLList($bugTree, $this->listConf);
  16.         $pageData['bug_id'] = $bugTree[0]['id'];
  17.     }
  18.    
  19.     $pageData['categories'] = $this->mcategory->getAllCategories();
  20.    
  21.     $this->load->view('header', $pageData);
  22.     $this->load->view('categories');
  23.     $this->load->view('onebug');
  24.     $this->load->view('addcommentform');
  25.     $this->load->view('footer');
  26. }

Этот метод очень похож на предыдущие. Но есть несколько существенных различий.

1) Здесь мы не используем библиотеку pagination. В ней просто нет смысла. На странице отображается запись только об одном баге и все комментарии к нему.

2) Данные бага загружаем с помощью метода getHTMLList (строка 15). Кстати, для создания дерева комментариев мы используем собственную библиотеку table2tree. Её методы getTree и getHTMLList автоматически определяют есть ли в исходных данных комментарии и глубину их вложенности.

3) Вместо формы добавления бага вставляем форму добавления комментария (строка 24).

На этом мы закончим эту часть.
В следующий раз рассмотрим добавление записей и комментариев.

До встречи!

Понравилась статья? Подписывайтесь на продолжение rss link !

Или на мой твиттер twitter link

]]>

Добавьте эту страницу в google.com bobrdobr.ru del.icio.us technorati.com linkstore.ru news2.ru rumarkz.ru memori.ru moemesto.ru

]]>

Опубликовано в CSS, CodeIgniter, HTML, MySQL, PHP, Web разработка Комментарии (12) »

]]>

Комментарии (12)

Вы можете отслеживать обсуждение записи с помощью RSS 2.0 rss link

Вы также можете оставить комментарий, или трекбек с Вашего сайта.

]]>
  1. Big_Shark
    16 марта 2009 в 10:54

    я бы объедение "Создание страницы выбранной категории." и Главной страницы

    Ответить
    • Владимир
      16 марта 2009 в 18:42

      Можно, но код при этом немного усложняется и URL'ы будут выглядеть хуже. Т.к. придется передавать тип страницы в одном из параметров и анализировать его.

      Ответить
  2. AmdY
    19 марта 2009 в 2:45

    Маленький хинт,
    $config['bugs_per_page'] = 5;
    $this->config->item('bugs_per_page');
    $pageData['title'] = 'Bug Tracker'; и т.д.
    это не хорошо, очепятка в индексе может привести к скрытой ошибке, советую всегда использовать константы.
    $config[BUGS_PER_PAGE] = 5;
    $this->config->item(BUGS_PER_PAGE);
    $pageData[TITLE] = 'Bug Tracker';

    Ответить
    • Владимир
      19 марта 2009 в 19:05

      Т.е. предварительно объявить все эти константы?
      define("BUGS_PER_PAGE", "bugs_per_page");

      Большое спасибо за этот совет. Иногда почему-то не обращаешь внимание на очевидные вещи :)

      И кроме опечаток есть еще одно преимущество вашего метода. В Eclipse работает автодополнение для констант (в большинстве других IDE тоже будет работать).

      Ответить
    • Big_Shark
      20 марта 2009 в 4:28

      а по мне так это бред

      Ответить
      • Владимир
        20 марта 2009 в 18:08

        Почему? Скорость ввода увеличивается и механических ошибок будет меньше. Особенно если данные из конфига часто приходится "вручную" читать.

        Ответить
        • Big_Shark
          21 марта 2009 в 2:46

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

          Скорость ввода увеличивается и механических ошибок будет меньше.
          Скорость ввода и увеличивается не на много так как нужно все define вначале объявить.

          Особенно если данные из конфига часто приходится "вручную" читать.

          Я обычно подгружаю конфиг файл для данного контролера(модуля) и его содержимое сохраняю в переменной $this->cfg=array();
          И я не имею понятия какие там переменные есть и с какими названиями мне главное чтобы те которые я использовал небыли заменены.

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

        • Владимир
          21 марта 2009 в 19:21

          В массивах огромный плюс это генерация ключей которой я обычно и пользуюсь.

          В этом случае, конечно, никакого смысла в константах нет.
          Но если ключей <10 и созданы они не автоматически, то можно и константы использовать.

          Я бы хотел посмотреть на реальное предложения

          Честно говоря, не знаю таких ;)

  3. Олег
    25 марта 2009 в 10:49

    Я не совсем понял сам процесс работы.

    Ответить
  4. Олег
    3 апреля 2009 в 14:17

    Было бы еще неплохо в каждой статье цикла выкладывать полный pack исходников. Тогда можно будет легко отследить прогрее.

    Или же воспользоваться например SVN от Google Code) У тебя же не проприетарный баг трекер будет :) , и версию для конкретного урока складывать в tags.

    Ответить
    • Владимир
      3 апреля 2009 в 17:08

      Нет, баг трекер, конечно, не проприетарный ;)
      Но исходники я выкладываю только для более-менее работающих вариантов. Например, на данный момент последние исходники выложены здесь.
      Баг трекер работает, но пока без AJAX.

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

      Ответить
]]>

Оставить комментарий

* - обязательные для заполнения поля

]]>