Building Your First PHP Application: Part # 2

План

Цель серии уроков создать простое приложение, которое позволяет пользователям регистрироваться, входить, выходить и менять настройки. Класс, который будет содержать всю информации о пользователе будет называться User и он будет определен в файле User.class.php. Класс, который будет отвечать за вход\выход будет называться UserTools (UserTools.class.php).

Немного про именование классов

Правильным тоном является называть файлы с описанием класса таким же именем как и сам класс. Таким образом легко определить цель каждого файла в папке с классами.

Также обычно в конце названия файла класса добавляют .class или .inc. Таким образом мы четко определяем предназначение файла и можем с помощью .htaccess ограничить доступ к этим файлам.

Класс Пользователей (User.class.php)

Этот класс будет определять каждого пользователя. С ростом данного приложения определение "Пользователь" может существенно измениться. К счастью, ООП программирование позволяет легко добавлять дополнительные атрибуты пользователей.

Конструктор

В этом классе мы будем использовать конструктор - это функция, которая автоматически вызывается при создании очередной копии класса. Это позволяет нам автоматически публиковать некоторые атрибуты после создания проекта. В этом классе конструктор будет брать единственный аргумент: ассоциативный массив, который содержит один ряд из таблицы users нашей БД.

<?php
//User.class.php

require_once 'DB.class.php';

class User {
public $id;
public $username;
public $hashedPassword;
public $email;
public $joinDate;

//Конструктор вызывается при создании нового объекта
//Takes an associative array with the DB row as an argument.
function __construct($data) {
$this->id = (isset($data['id'])) ? $data['id'] : "";
$this->username = (isset($data['username'])) ? $data['username'] : "";
$this->hashedPassword = (isset($data['password'])) ? $data['password'] : "";
$this->email = (isset($data['email'])) ? $data['email'] : "";
$this->joinDate = (isset($data['join_date'])) ? $data['join_date'] : "";
}

public function save($isNewUser = false) {
//create a new database object.
$db = new DB();

//if the user is already registered and we're
//just updating their info.
if(!$isNewUser) {
//set the data array
$data = array(
"username" => "'$this->username'",
"password" => "'$this->hashedPassword'",
"email" => "'$this->email'"
);

//update the row in the database
$db->update($data, 'users', 'id = '.$this->id);
}else {
//if the user is being registered for the first time.
$data = array(
"username" => "'$this->username'",
"password" => "'$this->hashedPassword'",
"email" => "'$this->email'",
"join_date" => "'".date("Y-m-d H:i:s",time())."'"
);
$this->id = $db->insert($data, 'users');
$this->joinDate = time();
}
return true;
}
}
?>

Code

<?php

//User.class.php



require_once 'DB.class.php';



class User {

public $id;

public $username;

public $hashedPassword;

public $email;

public $joinDate;



//Конструктор вызывается при создании нового объекта

//Takes an associative array with the DB row as an argument.

function __construct($data) {

$this->id = (isset($data['id'])) ? $data['id'] : "";

$this->username = (isset($data['username'])) ? $data['username'] : "";

$this->hashedPassword = (isset($data['password'])) ? $data['password'] : "";

$this->email = (isset($data['email'])) ? $data['email'] : "";

$this->joinDate = (isset($data['join_date'])) ? $data['join_date'] : "";

}



public function save($isNewUser = false) {

//create a new database object.

$db = new DB();



//if the user is already registered and we're

//just updating their info.

if(!$isNewUser) {

//set the data array

$data = array(

"username" => "'$this->username'",

"password" => "'$this->hashedPassword'",

"email" => "'$this->email'"

);



//update the row in the database

$db->update($data, 'users', 'id = '.$this->id);

}else {

//if the user is being registered for the first time.

$data = array(

"username" => "'$this->username'",

"password" => "'$this->hashedPassword'",

"email" => "'$this->email'",

"join_date" => "'".date("Y-m-d H:i:s",time())."'"

);

$this->id = $db->insert($data, 'users');

$this->joinDate = time();

}

return true;

}

}

?>

Объяснение

Первая часть кода, вне зоны класса, обеспечивает подключение класса в БД (поскольку в классе User есть функция, которая требует этот класс).

Вместо переменных класса “protected” (использовались в 1-м уроке) мы определяем их как “public”. Это означает, что любой код вне класса имеет доступ к этим переменным при работе с объектом User.

Конструктор берет массив, в котором колонки в таблице являются ключами. Мы задаем переменную класса используя $this->variablename. В примере данного класса, мы прежде всего проверяем существует ли значение определенного ключа. Если да, тогда мы приравниваем переменную класса к этому значению. В противном случае - пустая строка. Код использует краткую форму записи оборота if:

$value = (3 == 4) ? "A" : "B";

Code

$value = (3 == 4) ? "A" : "B";

В данном примере мы проверяем равняется ли 3 четырем! Если да - тогда $value = “A”, нет - $value = “B”. В нашем примере результат $value = “B”.

Сохраняем Информацию о Пользователях в БД

Функция сохранения используется для внесения изменений в таблицу БД с текущими значениями в объекте User. Эта функция использует класс БД, который мы создали в первом уроке. Используя переменные класса, устанавливается массив $data. Если данные о пользователе сохраняются впервые, тогда $isNewUser передается как $true (по умолчанию false). Если $isNewUser = $true, тогда вызывается функция insert() класса DB. В противном случае вызывается функция update(). В обоих случаях информация от объекта user будет сохранена в БД.

Класс UserTools.class.php

Этот класс будет содержать функции, которые имеют отношение к пользователям: login(), logout(), checkUsernameExists() и get(). Но с расширением данного приложения, Вы можете добавить еще множество других.

<?php

//UserTools.class.php
require_once 'User.class.php';
require_once 'DB.class.php';

class UserTools {

//Log the user in. First checks to see if the
//username and password match a row in the database.
//If it is successful, set the session variables
//and store the user object within.
public function login($username, $password)

{

$hashedPassword = md5($password);
$result = mysql_query("SELECT * FROM users WHERE username = '$username' AND
password = '$hashedPassword'");
if(mysql_num_rows($result) == 1)
{
$_SESSION["user"] = serialize(new User(mysql_fetch_assoc($result)));
$_SESSION["login_time"] = time();
$_SESSION["logged_in"] = 1;
return true;
}else{
return false;
}
}

//Log the user out. Destroy the session variables.
public function logout() {
unset($_SESSION['user']);
unset($_SESSION['login_time']);
unset($_SESSION['logged_in']);
session_destroy();
}
//Check to see if a username exists.
//This is called during registration to make sure all user names are unique.
public function checkUsernameExists($username) {
$result = mysql_query("select id from users where username='$username'");
if(mysql_num_rows($result) == 0)
{
return false;
}else{
return true;
}

}

//get a user
//returns a User object. Takes the users id as an input
public function get($id)
{
$db = new DB();
$result = $db->select('users', "id = $id");
return new User($result);
}
}

?>

Code

<?php



//UserTools.class.php

require_once 'User.class.php';

require_once 'DB.class.php';



class UserTools {



//Log the user in. First checks to see if the

//username and password match a row in the database.

//If it is successful, set the session variables

//and store the user object within.

public function login($username, $password)



{



$hashedPassword = md5($password);

$result = mysql_query("SELECT * FROM users WHERE username = '$username' AND

password = '$hashedPassword'");

if(mysql_num_rows($result) == 1)

{

$_SESSION["user"] = serialize(new User(mysql_fetch_assoc($result)));

$_SESSION["login_time"] = time();

$_SESSION["logged_in"] = 1;

return true;

}else{

return false;

}

}



//Log the user out. Destroy the session variables.

public function logout() {

unset($_SESSION['user']);

unset($_SESSION['login_time']);

unset($_SESSION['logged_in']);

session_destroy();

}

//Check to see if a username exists.

//This is called during registration to make sure all user names are unique.

public function checkUsernameExists($username) {

$result = mysql_query("select id from users where username='$username'");

if(mysql_num_rows($result) == 0)

{

return false;

}else{

return true;

}



}



//get a user

//returns a User object. Takes the users id as an input

public function get($id)

{

$db = new DB();

$result = $db->select('users', "id = $id");

return new User($result);

}

}



?>

Функция login()

Функция login() понятна по названию. Она берет аргументы пользователя $username и $password и проверяет их соответствие. Если все совпадает, создает объект User со всей информацией и сохраняет его в сессии. Обратите внимание, что мы только используем функцию PHP serialize(). Она создает сохраненный вариант объекта, который можно легко отменить с помощью unserialize(). Также время логина будет сохранено. Это может использоваться в дальнейшем для предоставления пользователям информации о длительности пребывания на сайте.

Вы также можете заметить, что мы выставляем $_SESSION['logged_in'] на 1. Это позволяет нам легко проверить на каждой странице залогинен ли пользователь. Достаточно проверить только эту переменную.

Функция logout()

Также простая функция. Функция PHP unset() очищает переменные в памяти, в то время как session_destroy() удалит сессию.

Функция checkUsernameExists()

Кто знает английский легко поймет функцию. Она просто запрашивает БД, использован ли подобный логин или нет.

Функция get()

Эта функция берет уникальный id пользователя и делает запрос к БД с помощью класса DB, а именно функции select(). Она возьмет ассоциативный массив с рядом информации о пользователе и создаст новый объект User, передавая массив конструктору.

Где можно это использовать? К примеру, если Вы создадите страницу, которая должна отображать специфические профили пользователей, Вам необходимо будет динамически брать эту информацию. Вот так Вы можете это сделать: (допустим УРЛ http://www.website.com/profile.php?userID=3)

//note: you will have to open up a database connection first.
//see Part 1 for further information on doing so.
//You'll also have to make sure that you've included the class files.

$tools = new UserTools();
$user = $tools->get($_REQUEST['userID']);
echo "Username: ".$user->username."";
echo "Joined On: ".$user->joinDate."";

Code

//note: you will have to open up a database connection first.

//see Part 1 for further information on doing so.

//You'll also have to make sure that you've included the class files.



$tools = new UserTools();

$user = $tools->get($_REQUEST['userID']);

echo "Username: ".$user->username."";

echo "Joined On: ".$user->joinDate."";

Последний штрих серверной части: global.inc.php

global.inc.php необходим для каждой страницы сайта. Почему? Таким образом мы разместим все обычные операции, которые нам понадобятся на странице. К примеру, мы начнем session_start(). Соединение с БД также откроется.

<?php
require_once 'classes/User.class.php';
require_once 'classes/UserTools.class.php';
require_once 'classes/DB.class.php';

//connect to the database
$db = new DB();
$db->connect();

//initialize UserTools object
$userTools = new UserTools();
//start the session

session_start();

//refresh session variables if logged in
if(isset($_SESSION['logged_in'])) {
$user = unserialize($_SESSION['user']);
$_SESSION['user'] = serialize($userTools->get($user->id));
}
?>

Code

<?php

require_once 'classes/User.class.php';

require_once 'classes/UserTools.class.php';

require_once 'classes/DB.class.php';



//connect to the database

$db = new DB();

$db->connect();



//initialize UserTools object

$userTools = new UserTools();

//start the session



session_start();



//refresh session variables if logged in

if(isset($_SESSION['logged_in'])) {

$user = unserialize($_SESSION['user']);

$_SESSION['user'] = serialize($userTools->get($user->id));

}

?>

Что он делает?

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

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

Далее мы проверяем залогинен ли юзер. Если да - мы обновим $_SESSION['user'], чтобы отображать самую последнюю информацию о юзере. К примеру, если пользователь меняет свой емейл, в сессии будет храниться еще старый. Но с помощью авто обновления такого не случится.

На этом вторая часть подошла к концу!