Строим свою CMS на PHP и MySQL. Часть 3

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

1. Клиентская часть

Сначала создадим файл index.php, который будет содержать скрипт клиентской части, то есть выводить страницы в браузере пользователя. Копируем ниже приведенный код и сохраняем файл в корневом каталоге нашей CMS cms.

<?php
 
require( "config.php" );
$action = isset( $_GET['action'] ) ? $_GET['action'] : "";
 
switch ( $action ) {
  case 'archive':
    archive();
    break;
  case 'viewArticle':
    viewArticle();
    break;
  default:
    homepage();
}
 
 
function archive() {
  $results = array();
  $data = Article::getList();
  $results['articles'] = $data['results'];
  $results['totalRows'] = $data['totalRows'];
  $results['pageTitle'] = "Article Archive | Widget News";
  require( TEMPLATE_PATH . "/archive.php" );
}
 
function viewArticle() {
  if ( !isset($_GET["articleId"]) || !$_GET["articleId"] ) {
    homepage();
    return;
  }
 
  $results = array();
  $results['article'] = Article::getById( (int)$_GET["articleId"] );
  $results['pageTitle'] = $results['article']->title . " | Widget News";
  require( TEMPLATE_PATH . "/viewArticle.php" );
}
 
function homepage() {
  $results = array();
  $data = Article::getList( HOMEPAGE_NUM_ARTICLES );
  $results['articles'] = $data['results'];
  $results['totalRows'] = $data['totalRows'];
  $results['pageTitle'] = "Widget News";
  require( TEMPLATE_PATH . "/homepage.php" );
}
 
?>

Разберем код скрипта подробно.

1. Включаем файл конфигурации

   Первая строка кода включает файл config.php, и все установки приложения становятся доступны в скрипте. Мы используем функцию require(), а не  include(), так как  require() генерирует ошибку в случае отсутствия подключаемого файла.

   Notice that we use (int) to cast the value of the articleID query parameter to an integer. This is a good security measure, as it prevents anything other than integers from being passed to our code.

2. Получаем параметр action

   Сохраняем параметр $_GET['action'] в переменной $action, чтобы можно было использовать значение далее в скрипте. Но прежде проверяем наличие значения $_GET['action'] с помощью функции isset(). Если его нет, устанавливаем для переменной $action пустую строку ("").

   Проверять значения, поставляемые пользователем ( такие как строки, значения из форм, куки), на наличие перед использованием - хорошая практика программирования.  Так не только ограничивается количество дырок в системе безопасности, но и предотвращает вывод предупреждения "undefined index" при выполнении скрипта.

3. Определяем действие для выполнения

   Блок switch проверяет параметр action в URL для определения нужного действия (вывести архив, просмотреть статью). Если параметр action отсутствует в URL, то скрипт выводит главную страницу.

4. archive()

   Данная функция выводит список всех статей в базе данных. Для этого используется метод getList() класса Article . Функция сохраняет результат и заголовок страницы в ассоциированном массиве $results, и шаблон может вывести его на странице. В завершении включается шаблон для вывода страницы. (Мы рассмотрим шаблоны в другом уроке нашей серии.)

5. viewArticle()

   Данная функция выводит страницу одной статьи. Она получает ID статьи для вывода из параметра URL articleId, затем вызывает метод класса Article  getById() для получения объекта статьи, который сохраняется в массиве $results для использования в шаблоне. (Если нет параметра articleId или статья не может быть найдена, то функция просто выводит главную страницу.)

   Обратите внимание, что мы используем преобразование типов (int) для явного приведения параметра запроса articleId к целому типу. Такое действие предотвращает передачу отличных от чисел значений в наш код.

6. homepage()

   Последняя функция homepage()выводит главную страницу сайта, на которой содержится список из нескольких статей, количество которых указано в парметре конфигурации HOMEPAGE_NUM_ARTICLES  (по умолчанию 5 ). Функция очень похожа на функцию archive()  за исключением передачи параметра HOMEPAGE_NUM_ARTICLES методу getList() для ограничения количества возвращаемых статей.

2. Серверная часть

Скрипт серверной части несколько сложнее, чем index.php, так как в нем реализованы функции администрирования для нашей CMS. Хотя основная структура похожа на index.php.

Создаем файл admin.php в том же каталоге, что и файл index.php. И копируем в него код:

<?php

require( "config.php" );
session_start();
$action = isset( $_GET['action'] ) ? $_GET['action'] : "";
$username = isset( $_SESSION['username'] ) ? $_SESSION['username'] : "";

if ( $action != "login" && $action != "logout" && !$username ) {
  login();
  exit;
}

switch ( $action ) {
  case 'login':
    login();
    break;
  case 'logout':
    logout();
    break;
  case 'newArticle':
    newArticle();
    break;
  case 'editArticle':
    editArticle();
    break;
  case 'deleteArticle':
    deleteArticle();
    break;
  default:
    listArticles();
}


function login() {

  $results = array();
  $results['pageTitle'] = "Admin Login | Widget News";

  if ( isset( $_POST['login'] ) ) {

    // Пользователь получает форму входа: попытка авторизировать пользователя

    if ( $_POST['username'] == ADMIN_USERNAME && $_POST['password'] == ADMIN_PASSWORD ) {

      // Вход прошел успешно: создаем сессию и перенаправляем на страницу администратора
      $_SESSION['username'] = ADMIN_USERNAME;
      header( "Location: admin.php" );

    } else {

      // Ошибка входа: выводим сообщение об ошибке для пользователя
      $results['errorMessage'] = "Incorrect username or password. Please try again.";
      require( TEMPLATE_PATH . "/admin/loginForm.php" );
    }

  } else {

    // Пользователь еще не получил форму: выводим форму
    require( TEMPLATE_PATH . "/admin/loginForm.php" );
  }

}


function logout() {
  unset( $_SESSION['username'] );
  header( "Location: admin.php" );
}


function newArticle() {

  $results = array();
  $results['pageTitle'] = "New Article";
  $results['formAction'] = "newArticle";

  if ( isset( $_POST['saveChanges'] ) ) {

    // Пользователь получает форму редактирования статьи: сохраняем новую статью
    $article = new Article;
    $article->storeFormValues( $_POST );
    $article->insert();
    header( "Location: admin.php?status=changesSaved" );

  } elseif ( isset( $_POST['cancel'] ) ) {

    // Пользователь сбросид результаты редактирования: возвращаемся к списку статей
    header( "Location: admin.php" );
  } else {

    // Пользователь еще не получил форму редактирования: выводим форму
    $results['article'] = new Article;
    require( TEMPLATE_PATH . "/admin/editArticle.php" );
  }

}


function editArticle() {

  $results = array();
  $results['pageTitle'] = "Edit Article";
  $results['formAction'] = "editArticle";

  if ( isset( $_POST['saveChanges'] ) ) {

    // Пользователь получил форму редактирования статьи: сохраняем изменения

    if ( !$article = Article::getById( (int)$_POST['articleId'] ) ) {
      header( "Location: admin.php?error=articleNotFound" );
      return;
    }

    $article->storeFormValues( $_POST );
    $article->update();
    header( "Location: admin.php?status=changesSaved" );

  } elseif ( isset( $_POST['cancel'] ) ) {

    // Пользователь отказался от результатов редактирования: возвращаемся к списку статей
    header( "Location: admin.php" );
  } else {

    // Пользвоатель еще не получил форму редактирования: выводим форму
    $results['article'] = Article::getById( (int)$_GET['articleId'] );
    require( TEMPLATE_PATH . "/admin/editArticle.php" );
  }

}


function deleteArticle() {

  if ( !$article = Article::getById( (int)$_GET['articleId'] ) ) {
    header( "Location: admin.php?error=articleNotFound" );
    return;
  }

  $article->delete();
  header( "Location: admin.php?status=articleDeleted" );
}


function listArticles() {
  $results = array();
  $data = Article::getList();
  $results['articles'] = $data['results'];
  $results['totalRows'] = $data['totalRows'];
  $results['pageTitle'] = "All Articles";

  if ( isset( $_GET['error'] ) ) {
    if ( $_GET['error'] == "articleNotFound" ) $results['errorMessage'] = "Error: Article not found.";
  }

  if ( isset( $_GET['status'] ) ) {
    if ( $_GET['status'] == "changesSaved" ) $results['statusMessage'] = "Your changes have been saved.";
    if ( $_GET['status'] == "articleDeleted" ) $results['statusMessage'] = "Article deleted.";
  }

  require( TEMPLATE_PATH . "/admin/listArticles.php" );
}

?>

Рассмотрим интересные места нашего скрипта:

1. Старт сессии пользователя

   В начале скрипта мы вызываем функцию session_start(). Данная функция PHP запускает новую сессию пользователя, которая позволяет нам контролировать регистрацию пользователя в системе.  Если сессия для пользователя уже имеется, то PHP автоматически возобновит ее и будет использовать.

   Так как для сессии требуется работа с куки, и куки пересылаются в браузер перед содержанием, то следует вызывать session_start() в начале скрипта, до отправки любого содержания.

2. Получаем параметр action и переменную сессии username

   Затем мы сохраняем параметр $_GET['action'] в переменной $action, а переменную сессии $_SESSION['username'] в $username, чтобы затем использовать данные значения в скрипте. Перед сохранение осуществляем проверку с помощью функции isset(). Если значение не существует, устанавливаем в соответствующей переменной пустую строку ("").

3. Проверяем, зарегистрирован ли пользователь

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

4. Определяем действие для выполнения

   Блок switch работает так же как и в index.php: производится вызов соответствующей функции на основании значения параметра URL action. По умолчанию выводится список статей.

5. login()

   Функция вызывается, когда нужно произвести регистрацию пользователя в системе.

   Если пользователь отправил форму регистрации (что проверяется по параметру формы login ), то функция сопоставляет введенные имя и пароль со значениями параметров конфигурации ADMIN_USERNAME и ADMIN_PASSWORD. Если они соответствуют, то мы устанавливаем ключ сессии username в значение имени администратора, а затем перенаправляем обратно скрипту admin.php, который выводит список статей. Если пароль и имя пользователя неверные, то будет выведена форма регистрации с сообщением об ошибке.

   Если пользователь еще не отправил форму регистрации, то просто выводим ее.

6. logout()

   Данная функция вызывается, когда пользователь выходит из системы. Здесь просто удаляется ключ сессии username и производится перенаправление обратно в admin.php.

7. newArticle()

   Данная функция позволяет пользователю создавать новую статью. Если пользователь уже отправил форму для новой статьи, то функция создает новый объект Article, сохраняет данные формы в объекте с помощью вызова функции storeFormValues(), вставляет статью в базу данных с помощью функции insert() и перенаправляет обратно на список статей, выводя сообщение об успешном завершении операции.

   Если пользователь не отправил форму для новой статьи, то функция создает новый пустой объект  Article без значений, затем использует шаблон editArticle.php для вывода формы редактирования статьи для только что созданного объекта.

8. editArticle()

   Данная функция похожа на newArticle(), за исключением того, что пользователю предоставляется возможность редактировать статью. Когда пользователь сохраняет изменения, функция получает существующую статью с помощью getById(), записывает новые значения в объекте Article, затем сохраняет измененный объект с помощью функции update(). (Если статья не найдена в базе данных, функция выведет сообщение об ошибке.)

   Когда выводится форма редактирования статьи, функция использует метод getById() для загрузки текущих значений в поля формы.

   Скрипт использует один и тот же шаблон (editArticle.php) и для создания новой статьи и для редактирования имеющейся. То есть нужно создавать только одну форму HTML. Параметр formAction используется для определения операции со статьей.

9. deleteArticle()

   Когда пользователь удаляет статью, данная функция сначала получает ее (если статьи нет в базе данных, то выводится сообщение об ошибке), а затем вызывает метод delete() для удаления данных из базы. После завершения операции функция перенаправляет пользователя на страницу со списком статей и выводит сообщение о удалении.

10. listArticles()

    Последняя функция функция в скрипте admin.php выводит список статей в CMS. Используется метод getList() класса Article для получения всех статей. Затем применяем шаблон listArticles.php для вывода списка. Кроме того, функция проверяет параметры запроса URL error и status, чтобы вывести сообщения об ошибке и состоянии системы, если нужно.

В следующем уроке мы создадим шаблоны для клиентской и серверной части.