Простая CMS. Часть 2. Создание класса Articles

Учебный проект "Простой сайт (CMS) на PHP, SQL (mysql) + HTML/CSS -- Пример создания". Часть 2. Создание класса Articles для работы с базой данных.

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

В нашей папке cms создаем каталог classes. В папке classes создаем новый файл с именем Article.php и копируем в него следующий код:
001
002

003
/**
004
* Класс для обработки статей
005
*/
006

007
class Article
008
{
009
// Свойства
010

011
/**
012
* @var int ID статей из базы данных
013
*/
014
public $id = null;
015

016
/**
017
* @var int Дата первой публикации статьи
018
*/
019
public $publicationDate = null;
020

021
/**
022
* @var string Полное название статьи
023
*/
024
public $title = null;
025

026
/**
027
* @var string Краткое описание статьи
028
*/
029
public $summary = null;
030

031
/**
032
* @var string HTML содержание статьи
033
*/
034
public $content = null;
035

036

037
/**
038
* Устанавливаем свойства с помощью значений в заданном массиве
039
*
040
* @param assoc Значения свойств
041
*/
042

043
public function __construct( $data=array() ) {
044
if ( isset( $data['id'] ) ) $this->id = (int) $data['id'];
045
if ( isset( $data['publicationDate'] ) ) $this->publicationDate = (int) $data['publicationDate'];
046
if ( isset( $data['title'] ) ) $this->title = preg_replace ( "/[^\.\,\-\_\'\"\@\?\!\:\$ a-zA-Z0-9()]/", "", $data['title'] );
047
if ( isset( $data['summary'] ) ) $this->summary = preg_replace ( "/[^\.\,\-\_\'\"\@\?\!\:\$ a-zA-Z0-9()]/", "", $data['summary'] );
048
if ( isset( $data['content'] ) ) $this->content = $data['content'];
049
}
050

051

052
/**
053
* Устанавливаем свойств с помощью значений формы редактирования записи в заданном массиве
054
*
055
* @param assoc Значения записи формы
056
*/
057

058
public function storeFormValues ( $params ) {
059

060
// Сохраняем все параметры
061
$this->__construct( $params );
062

063
// Разбираем и сохраняем дату публикации
064
if ( isset($params['publicationDate']) ) {
065
$publicationDate = explode ( '-', $params['publicationDate'] );
066

067
if ( count($publicationDate) == 3 ) {
068
list ( $y, $m, $d ) = $publicationDate;
069
$this->publicationDate = mktime ( 0, 0, 0, $m, $d, $y );
070
}
071
}
072
}
073

074

075
/**
076
* Возвращаем объект статьи соответствующий заданному ID статьи
077
*
078
* @param int ID статьи
079
* @return Article|false Объект статьи или false, если запись не найдена или возникли проблемы
080
*/
081

082
public static function getById( $id ) {
083
$conn = new PDO( DB_DSN, DB_USERNAME, DB_PASSWORD );
084
$sql = "SELECT *, UNIX_TIMESTAMP(publicationDate) AS publicationDate FROM articles WHERE id = :id";
085
$st = $conn->prepare( $sql );
086
$st->bindValue( ":id", $id, PDO::PARAM_INT );
087
$st->execute();
088
$row = $st->fetch();
089
$conn = null;
090
if ( $row ) return new Article( $row );
091
}
092

093

094
/**
095
* Возвращает все (или диапазон) объектов статей в базе данных
096
*
097
* @param int Optional Количество строк (по умолчанию все)
098
* @param string Optional Столбец по которому производится сортировка статей (по умолчанию "publicationDate DESC")
099
* @return Array|false Двух элементный массив: results => массив, список объектов статей; totalRows => общее количество статей
100
*/
101

102
public static function getList( $numRows=1000000, $order="publicationDate DESC" ) {
103
$conn = new PDO( DB_DSN, DB_USERNAME, DB_PASSWORD );
104
$sql = "SELECT SQL_CALC_FOUND_ROWS *, UNIX_TIMESTAMP(publicationDate) AS publicationDate FROM articles
105
ORDER BY " . mysql_escape_string($order) . " LIMIT :numRows";
106

107
$st = $conn->prepare( $sql );
108
$st->bindValue( ":numRows", $numRows, PDO::PARAM_INT );
109
$st->execute();
110
$list = array();
111

112
while ( $row = $st->fetch() ) {
113
$article = new Article( $row );
114
$list[] = $article;
115
}
116

117
// Получаем общее количество статей, которые соответствуют критерию
118
$sql = "SELECT FOUND_ROWS() AS totalRows";
119
$totalRows = $conn->query( $sql )->fetch();
120
$conn = null;
121
return ( array ( "results" => $list, "totalRows" => $totalRows[0] ) );
122
}
123

124

125
/**
126
* Вставляем текущий объект статьи в базу данных, устанавливаем его свойства.
127
*/
128

129
public function insert() {
130

131
// Есть у объекта статьи ID?
132
if ( !is_null( $this->id ) ) trigger_error ( "Article::insert(): Attempt to insert an Article object that already has its ID property set (to $this->id).", E_USER_ERROR );
133

134
// Вставляем статью
135
$conn = new PDO( DB_DSN, DB_USERNAME, DB_PASSWORD );
136
$sql = "INSERT INTO articles ( publicationDate, title, summary, content ) VALUES ( FROM_UNIXTIME(:publicationDate), :title, :summary, :content )";
137
$st = $conn->prepare ( $sql );
138
$st->bindValue( ":publicationDate", $this->publicationDate, PDO::PARAM_INT );
139
$st->bindValue( ":title", $this->title, PDO::PARAM_STR );
140
$st->bindValue( ":summary", $this->summary, PDO::PARAM_STR );
141
$st->bindValue( ":content", $this->content, PDO::PARAM_STR );
142
$st->execute();
143
$this->id = $conn->lastInsertId();
144
$conn = null;
145
}
146

147

148
/**
149
* Обновляем текущий объект статьи в базе данных
150
*/
151

152
public function update() {
153

154
// Есть ли у объекта статьи ID?
155
if ( is_null( $this->id ) ) trigger_error ( "Article::update(): Attempt to update an Article object that does not have its ID property set.", E_USER_ERROR );
156

157
// Обновляем статью
158
$conn = new PDO( DB_DSN, DB_USERNAME, DB_PASSWORD );
159
$sql = "UPDATE articles SET publicationDate=FROM_UNIXTIME(:publicationDate), title=:title, summary=:summary, content=:content WHERE id = :id";
160
$st = $conn->prepare ( $sql );
161
$st->bindValue( ":publicationDate", $this->publicationDate, PDO::PARAM_INT );
162
$st->bindValue( ":title", $this->title, PDO::PARAM_STR );
163
$st->bindValue( ":summary", $this->summary, PDO::PARAM_STR );
164
$st->bindValue( ":content", $this->content, PDO::PARAM_STR );
165
$st->bindValue( ":id", $this->id, PDO::PARAM_INT );
166
$st->execute();
167
$conn = null;
168
}
169

170

171
/**
172
* Удаляем текущий объект статьи из базы данных
173
*/
174

175
public function delete() {
176

177
// Есть ли у объекта статьи ID?
178
if ( is_null( $this->id ) ) trigger_error ( "Article::delete(): Attempt to delete an Article object that does not have its ID property set.", E_USER_ERROR );
179

180
// Удаляем статью
181
$conn = new PDO( DB_DSN, DB_USERNAME, DB_PASSWORD );
182
$st = $conn->prepare ( "DELETE FROM articles WHERE id = :id LIMIT 1" );
183
$st->bindValue( ":id", $this->id, PDO::PARAM_INT );
184
$st->execute();
185
$conn = null;
186
}
187

188
}
189

190
?>

Файл получается достаточно длинным, но код очень простой. Разберем его подробно:

1. Определение класса и его свойства

Сначала определим класс Article:
1
class Article
2
{

Все, что следует за данным строками до закрывающей фигурной скобки в конце файла содержит код нашего класса Article.

После определения класса мы объявляем свойства класса : $id, $publicationDate и так далее. Каждый объект Article, который мы создаем, будет хранить данные в объявленных свойствах. Обратите внимание, что имена свойств соответствуют именам полей в таблице articles.

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

2. Конструктор

Затем мы создаем методы класса. Это функции, которые привязаны к классу и к объекту, создаваемому из класса. Наш основной код вызывает методы для манипулирования данными в объекте Article.

Первый метод, __construct(), является конструктором. Это специальный метод, который автоматически вызывается системой PHP каждый раз, когда создается новый объект Article. Наш конструктор получает необязательный массив $data, в котором содержатся данные для свойств нового объекта. Затем мы присваиваем данные свойствам в теле конструктора. Таким образом, получается удобный способ для создания и инициализации объекта в одно действие.

$this->propertyName означает: "Свойство объекта this с именем "$propertyName".

Обратите внимание, что метод фильтрует данные, прежде чем присвоить их свойствам. Свойства id и publicationDate приводятся к типу int с помощью (int), так данные значения должны быть типа int. Свойства title и summary фильтруются с помощью регулярных выражений, так как в них допускает наличие символов из определенного набора. С точки зрения безопасности фильтрация данных ввода - отличная практика. Пропускаем только допустимые значения и символы.

Однако, мы не фильтруем свойство content. Почему? Вероятно, администратор захочет использовать более широкий диапазон символов в содержании статьи - например, разметку HTML. Если мы ограничим диапазон доступных символов в содержании, то снизим полезность нашей системы для администратора.

Обычно, такие места могут оказаться дырой в системе безопасности, так как пользователь может вставить вредный код JavaScript или материалы с ошибками в содержание статьи. Однако, так как мы полагаем. что единственной персоной, которой доступно редактирование содержание, будет администратор системы, располагающий безграничным доверием, то вопрос с уязвимостью содержания остается за рамками нашего внимания. Если вы имеете дело с генерируем пользователями содержанием, например, комментариями или записями форума, то следует быть более осторожным и допускать только "безопасный" код HTML к использованию. Отличным инструментом для решения таких задач является HTML Purifier, который анализирует ввод кода HTML и удаляет все потенциальные угрозы.

Безопасность кода PHP выходит за рамки наших уроков. Вам следует посвятить определенное время для изучения данного вопроса.

3. storeFormValues()

Следующий метод storeFormValues()похож на конструктор в том, что он сохраняет полученный массив данных в свойствах объекта. Основное отличие заключается в том, что storeFormValues() может обрабатывать данные в формате, который используется в формах New Article (Новая статья) и Edit Article (Редактировать статью) (мы создадим их позже). В частности, он может обрабатывать дату публикации в формате YYYY-MM-DD, конвертировать ее в формат времени UNIX, который отлично подходит для хранения в объекте.

Формат времени UNIX представляет собой целое значение, которое содержит количество секунд от полуночи 1 января 1970 до искомой даты. Датой в таком формате легко оперировать, и ее удобно хранить.

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

Все члены (то есть свойства и методы) нашего класса Article имеют ключевое слово public перед определением, что означает доступность кода вне класса. Также можно создавать частные члены (директива private) (их можно использовать только в классе) и защищенные члены (директива protected) (которые можно использовать в классе и его подклассах).

4. getById()

Теперь перейдем к методам, реализующим доступ к базе данных MySQL. Первый из них - getById(). Он принимает в качестве аргумента ID статьи ($id) и возвращает запись с указанным ID из таблицы articles, сохраняя данные в новом объекте Article.

Обычно, когда вы вызываете метод, сначала нужно создать объект, а затем вызвать метод, принадлежащий объекту. Но, так как getById() возвращает новый объект Article, будет полезно вызывать его напрямую, а не через существующий объект. Иначе придется создавать новый объект-заглушку каждый раз, когда нужно вызвать метод и получить статью.

Для разрешения вызова метода без объекта мы добавляем декларацию static к определению метода. Таким образом разрешается вызов метода непосредственно без определения объекта.
1
public static function getById( $id ) {

Метод использует PDO для соединения с базой данных, получает запись статьи с помощью запроса SQL SELECT и сохраняет данные в новом объекте Article, который возвращается в вызывающий код. PDO — PHP Data Objects —объектно-ориентированная библиотека, встроенная в PHP, которая облегчает связь скриптов PHP с базами данных.

Разберем метод подробнее:

Соединение с базой данных
1
$conn = new PDO( DB_DSN, DB_USERNAME, DB_PASSWORD );

Здесь выполняется соединение с базой данных MySQL с помощью данных из файла config.php. Дескриптор соединения сохраняется в переменной $conn. Данный дескриптор используется в остальном коде для обмена данных с базой.

Получаем запись статьи
1
$sql = "SELECT *, UNIX_TIMESTAMP(publicationDate) AS publicationDate FROM articles WHERE id = :id";
2
$st = $conn->prepare( $sql );
3
$st->bindValue( ":id", $id, PDO::PARAM_INT );
4
$st->execute();
5
$row = $st->fetch();

Выражение SELECT возвращает все поля (*) из записи в таблице articles, которые соответствуют заданному полю id. Значение поля publicationDate возвращается в формате времени UNIX, вместо формата для дат MySQL, что упрощает процесс сохранения в нашем объекте.

Вместо того, чтобы помещать наш параметр $id непосредственно в строку SELECT, что увеличивает риск нарушения системы безопасности, мы используем :id. Такой параметр известен как placeholder (указатель места размещения). Далее мы вызываем метод PDO для привязывания значение $id к указателю места размещения.

Сразу после сохранения выражения SELECT в строке, мы подготавливаем его с помощью функции $conn->prepare(), сохраняя полученный дескриптор в переменной $st.

Подготовка выражения используется для работы со многими базами данных. Она позволяет выполнять запросы быстрее и безопаснее.

Затем мы привязываем значение переменной $id ( ID нужной статьи) к указателю места размещения :id с помощью вызова метода bindValue().

И вызываем метод execute() для выполнения запроса. После чего используем метод fetch() для перемещения полученной записи в ассоциированный массив с именами полей и соответствующими значениями, который хранится в переменной $row.

Закрываем соединение
1
$conn = null;

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

Возвращаем объект Article
1
if ( $row ) return new Article( $row );
2
}

Последним действием в нашем методе является создание объекта Article, который будет содержать запись из базы данных, и возвращение его вызывающему коду. Сначала проверяем наличие данных в переменной $row после вызова метода fetch(). Если данные есть, создаем новый объект Article передавая переменную ему $row. Будет вызван конструктор класса, который наполнит объект данными из массива $row. Затем возвращаем готовый объект и работа метода завершена.

5. getList()

Следующий метод getList() во многом похож на метод getById(). Основное отличие заключается в том, что метод getList() возвращает несколько статей сразу. Его используют, когда нужно вывести список статей для пользователя или администратора.

getList() принимает 2 аргумента:

$numRows
Максимальное количество получаемых статей. По умолчанию установлено значение 1,000,000 (то есть, практически все статьи). Данный параметр позволяет нам получать только первые 5 статей для главной страницы.
$order
Порядок сортировки получаемых статей. По умолчанию используется параметр "publicationDate DESC", который означает "сортировка по дате публикации, новые статьи первые".

Большая часть кода метода похожа на код метода getById(). Посмотрим на несколько строк:
1
$sql = "SELECT SQL_CALC_FOUND_ROWS *, UNIX_TIMESTAMP(publicationDate) AS publicationDate FROM articles
2
ORDER BY " . mysql_escape_string($order) . " LIMIT :numRows";

Здесь запрос немного сложнее. Обратите внимание, что здесь не используется выражение WHERE, так как мы хотим получить все статьи, а не одну с заданным ID.

Также добавлено выражение ORDER BY для сортировки возвращаемых записей в определенном порядке. Используется выражение LIMIT с параметром $numRows (как указатель места размещения) для ограничения количества получаемых записей.

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

Вместо передачи значения переменной $order в запрос через указатель места размещения, мы передаем его прямо в строку запроса, вызывая функцию mysql_escape_string(), чтобы отбросить любые специальные символы (для безопасности). Если использовать указатель места размещения, то PDO поместит кавычки (') вокруг строки (например, ORDER BY 'publicationDate DESC'), что является ошибкой синтаксиса.
1
$list = array();
2

3
while ( $row = $st->fetch() ) {
4
$article = new Article( $row );
5
$list[] = $article;
6
}

Так как мы возвращаем несколько строк, нужно создать массив $list для размещения соответствующих объектов Article. Затем используем цикл while для получения следующей строки через fetch(), создаем новый объект Article, сохраняем строку в объекте и добавляем объект к массиву $list. Когда строк не останется, метод fetch() вернет false, и цикл остановится.
1
// Теперь получаем общее число статей, которые соответствуют критерию
2
$sql = "SELECT FOUND_ROWS() AS totalRows";
3
$totalRows = $conn->query( $sql )->fetch();
4
$conn = null;
5
return ( array ( "results" => $list, "totalRows" => $totalRows[0] ) );

В завершении мы выполняем запрос, который использует функцию MySQL FOUND_ROWS() для получения количества возвращаемых строк, вычисленного в предыдущей команде SQL_CALC_FOUND_ROWS. В этот раз используем метод PDO query(), который позволяет быстро выполнить запрос, если нет указателей места замещения. Мы вызываем метод fetch() для получения результата. Затем возвращаем оба значения - список объектов Article ($list) и общее количество строк - как ассоциированный массив.

6. insert()

Оставшиеся методы в нашем классе Article работают с добавлением, изменением и удалением записей статей в базе данных.

insert() добавляет новую статью в таблицу articles, используя значения из текущего объекта Article:

Сначала метод проверяет, что объект не имеет установленного свойства $id. Если у объекта есть ID, то, вероятно, статья уже имеется в базе данных и ее добавлять не нужно.
Затем метод выполняет запрос SQL INSERT для вставки записи в таблицу articles, используя указатели места замещения для передачи значений свойств в базу данных. Обратите внимание, что мы используем функцию MySQL FROM_UNIXTIME() для конвертации даты публикации в формат MySQL.
После выполнения запроса, метод возвращает ID новой статьи с помощью функции PDO lastInsertId() и сохраняет значение в свойстве $id. Мы установили в таблице articles для поля id свойство auto_increment, поэтому MySQL генерирует уникальное значение ID для каждой новой записи.

Обратите внимание, что мы используем PDO::PARAM_INT при привязке целых значений к указателям места замещения, и PDO::PARAM_STR при привязке строк. Таким образом, PDO может правильно обрабатывать значения.

7. update ()

Данный метод похож на метод insert(), за исключением того, что здесь происходит обновление записи в базе данных вместо создания новой записи.

Сначала проверяем наличие ID у объекта, так как обновить можно только запись с известным ID. Затем используем выражение SQL UPDATE для обновления полей записи. Обратите внимание на передачу ID объекта в выражение UPDATE, так как мы знаем, какую запись надо обновить.

8. delete ()

Метод delete() использует выражение SQL DELETE для удаления из таблицы articles статьи, которая хранится в объекте. Для идентификации записи задействуем свойство $id объекта. Для безопасности мы добавили LIMIT 1 к запросу, чтобы ограничиться удалением только одной записи.

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