Создание Фрэймворка на PHP5 – Часть 2

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

MVC

В первой части данного урока мы создали каталог с именем controllers для того, чтобы хранить в нём всю бизнес логику нашего приложения. Однако, если быть до конца честным, это не самое лучшее место, где можно хранить всю бизнес логику. На самом деле, для этих целей больше подойдёт каталог model. Разделение работы с базой данных и основной логики упрощает понимание кода и одновременно делает наш фрэймворк более мощным и расширяемым.

Так что же такое MVC? MVC - это шаблон проектирования (такой же как Singleton и Registry, которые мы рассмотрели в первой части). Это аббревиатура от Model View Controller. Главная цель MVC заключается в разделении бизнес логики и пользовательского интерфейса друг от друга. Теперь пришло самое время немного изменить структуру нашего проекта и создать каталог “models”. В моделях будет содержаться вся бизнес логика, а контроллеры будут взаимодействовать с ней и пользователем (допустим обрабатывать введённые данные). Метод __autoload изменять не нужно.

Обработчик для работы с БД

Многие сайты, которые написаны на PHP, также работают с различными системами базами данных, самая популярная из них - это MySQL. Если мы будет хранить всё, что связано с БД в одном месте, то (в теории) мы с лёгкостью можем сменить используемую технологию. Также мы сможем упростить некоторые задачи, такие как вставка, редактирование и удаление записей из базы.

Итак, что же будет делать наш обработчик:

  • Управление подключениями к базе данных
  • Попытка абстрагироваться от самой базы данных
  • Кэшировать запросы для многократного использования
  • Упростить основные операции взаимодействия с базой

Теперь давайте взглянем на код.

<?php

class database {

    /**
     * Массив для множества подключений.
     * Используется редко, но бывает очень необходим
     */
    private $connections = array();

    /**
     * Сообщает БД, какое подключение использовать
     * setActiveConnection($id) для изменения
     */
    private $activeConnection = 0;

    /**
     * Кэш для запросов
     */
    private $queryCache = array();

    /**
     * Кэш для сформированных данных
     */
    private $dataCache = array();

    /**
     * Запись последнего запроса
     */
    private $last;

    public function __construct()
    {

    }

    /**
     * Создание нового подключения
     * @param String называние хоста
     * @param String пользователь
     * @param String пароль
     * @param String имя базы данных
     * @return int id нового подключения
     */
    public function newConnection( $host, $user, $password, $database )
    {
        $this->connections[] = new mysqli( $host, $user, $password, $database );
        $connection_id = count( $this->connections )-1;
        if( mysqli_connect_errno() )
        {
            trigger_error('Error connecting to host. '.$this->connections[$connection_id]->error, E_USER_ERROR);
        }   

        return $connection_id;
    }

    /**
     * Закрытие активного подключения
     * @return void
     */
    public function closeConnection()
    {
        $this->connections[$this->activeConnection]->close();
    }

    /**
     * Переключение между активными подключениями
     * @param int новый id
     * @return void
     */
    public function setActiveConnection( int $new )
    {
        $this->activeConnection = $new;
    }

    /**
     * Запись запроса в кэш для дальнейшего использования
     * @param String строка запроса
     * @return кэш
     */
    public function cacheQuery( $queryStr )
    {
        if( !$result = $this->connections[$this->activeConnection]->query( $queryStr ) )
        {
            trigger_error('Error executing and caching query: '.$this->connections[$this->activeConnection]->error, E_USER_ERROR);
            return -1;
        }
        else
        {
            $this->queryCache[] = $result;
            return count($this->queryCache)-1;
        }
    }

    /**
     * Достать набор строк из кэша
     * @param int указатель на кэш
     * @return int количество строк
     */
    public function numRowsFromCache( $cache_id )
    {
        return $this->queryCache[$cache_id]->num_rows;
    }

    /**
     * Получить данные из кэша
     * @param int указатель на кэш
     * @return array строка
     */
    public function resultsFromCache( $cache_id )
    {
        return $this->queryCache[$cache_id]->fetch_array(MYSQLI_ASSOC);
    }

    /**
     * Записать данные в кэш
     * @param array данные
     * @return int указатель на данные в кэше
     */
    public function cacheData( $data )
    {
        $this->dataCache[] = $data;
        return count( $this->dataCache )-1;
    }

    /**
     * Достаём данные из кэша
     * @param int указатель
     * @return array данные
     */
    public function dataFromCache( $cache_id )
    {
        return $this->dataCache[$cache_id];
    }

    /**
     * Удалить данные из базы
     * @param String таблица
     * @param String условие удаления
     * @param int количество строк для удаления
     * @return void
     */
    public function deleteRecords( $table, $condition, $limit )
    {
        $limit = ( $limit == '' ) ? '' : ' LIMIT ' . $limit;
        $delete = "DELETE FROM {$table} WHERE {$condition} {$limit}";
        $this->executeQuery( $delete );
    }

    /**
     * Обновление записей
     * @param String название таблицы
     * @param array значения в виде field => value
     * @param String условие
     * @return bool
     */
    public function updateRecords( $table, $changes, $condition )
    {
        $update = "UPDATE " . $table . " SET ";
        foreach( $changes as $field => $value )
        {
            $update .= "`" . $field . "`='{$value}',";
        }

        $update = substr($update, 0, -1);
        if( $condition != '' )
        {
            $update .= "WHERE " . $condition;
        }

        $this->executeQuery( $update );

        return true;

    }

    /**
     * Вставка в базу
     * @param String название таблицы
     * @param array данные в виде field => value
     * @return bool
     */
    public function insertRecords( $table, $data )
    {
        $fields  = "";
        $values = "";

        foreach ($data as $f => $v)
        {

            $fields  .= "`$f`,";
            $values .= ( is_numeric( $v ) && ( intval( $v ) == $v ) ) ? $v."," : "'$v',";

        }

        $fields = substr($fields, 0, -1);
        $values = substr($values, 0, -1);

        $insert = "INSERT INTO $table ({$fields}) VALUES({$values})";
        $this->executeQuery( $insert );
        return true;
    }

    /**
     * Выполнение запроса
     * @param String запрос
     * @return void
     */
    public function executeQuery( $queryStr )
    {
        if( !$result = $this->connections[$this->activeConnection]->query( $queryStr ) )
        {
            trigger_error('Error executing query: '.$this->connections[$this->activeConnection]->error, E_USER_ERROR);
        }
        else
        {
            $this->last = $result;
        }

    }

    /**
     * Получить строки из последнего выполненного запроса (исключая закэшированные)
     * @return array
     */
    public function getRows()
    {
        return $this->last->fetch_array(MYSQLI_ASSOC);
    }

    /**
     * Извлечение числа полученных строк прошлого запроса
     * @return int число строк
     */
    public function affectedRows()
    {
        return $this->$this->connections[$this->activeConnection]->affected_rows;
    }

    /**
     * Фильтрация данных
     * @param String данные на фильтрацию
     * @return String отфильтрованные данные 
     */
    public function sanitizeData( $data )
    {
        return $this->connections[$this->activeConnection]->real_escape_string( $data );
    }

    /**
     * Деконструкция объекта
     * закрытие всех подключений
     */
    public function __deconstruct()
    {
        foreach( $this->connections as $connection )
        {
            $connection->close();
        }
    }
}
?>

Перед тем как перейти к более подробному описанию, я должен признаться, что функционал данного обработчика довольно-таки прост. Мы полностью абстрагировались от выполнения запросов напрямую. И это круто!

Методы для удаления, обновления и вставки новых записей позволят нам более простым способом решать некоторые задачи (к тому же, их функционал всегда можно расширить). Все что нам нужно - это только передать название таблицы, массив с данными, число для лимита и условие. Запросы также можно кэшировать, чтобы использовать их в дальнейшем. Рассмотрим пример использования.

// вставка записи
$registry->getObject('db')->insertRecords( 'testTable', array('name'=>'Michael' ) );
// обновление записи
$registry->getObject('db')->updateRecords( 'testTable', array('name'=>'MichaelP' ), 'ID=2' );
// удаление записи
$registry->getObject('db')->deleteRecords( 'testTable', "name='MichaelP'", 5 );

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

// создаём второе подключение (представим, что одно у нас уже есть)
$newConnection = $registry->getObject('db')->newConnection('localhost', 'root', 'password', 'secondDB');
// удаляем из первой базы
$registry->getObject('db')->deleteRecords( 'testTable', "name='MichaelP'", 5 );
// меняем подключение
$registry->getObject('db')->setActiveConnection( $newConnection );
// удаляем из второй базы
$registry->getObject('db')->deleteRecords( 'testTable', "name='MichaelP'", 5 );
// снова меняем подключение
$registry->getObject('db')->setActiveConnection( 0 );

Как и что можно добавить в этот класс?

  • Полную абстракцию
  • Применить наследование. Создать для каждой технологии баз данных свой отдельный интерфейс.
  • Хранить ID подключения на ряду с закэшированным запросом
  • Улучшить фильтрацию данных (согласно каким-то критериям)

Менеджер шаблонов

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

Для того чтобы не усложнять нашу задачу, мы организуем работу так, чтобы менеджер шаблонов мог управлять объектом страницы.

<?php

// устранение доступа напрямую
if ( ! defined( 'PCAFW' ) )
{
    echo 'This file can only be called via the main index.php file, and not directly';
    exit();
}

/**
 * Класс менеджера шаблонов
 */
class template {

    private $page;

    public function __construct()
    {
        include( APP_PATH . '/PCARegistry/objects/page.class.php');
        $this->page = new Page();

    }

    /**
     * Добавляем шаблон на страницу
     * @param String $tag тег где будет вставлен шаблон {hello}
     * @param String $bit путь или имя к файлу с шаблоном
     * @return void
     */
    public function addTemplateBit( $tag, $bit )
    {
        if( strpos( $bit, 'skins/' ) === false )
        {
            $bit = 'skins/' . PCARegistry::getSetting('skin') . '/templates/' . $bit;
        }
        $this->page->addTemplateBit( $tag, $bit );
    }

    /**
     * Вставка шаблонов на страницу
     * Происходит обновление контента страницы
     * @return void
     */
    private function replaceBits()
    {
        $bits = $this->page->getBits();
        foreach( $bits as $tag => $template )
        {
            $templateContent = file_get_contents( $bit );
            $newContent = str_replace( '{' . $tag . '}', $templateContent, $this->page->getContent() );
            $this->page->setContent( $newContent );
        }
    }

    /**
     * Замена тегов на контент
     * @return void
     */
    private function replaceTags()
    {
        $tags = $this->page->getTags();

        foreach( $tags as $tag => $data )
        {
            if( is_array( $data ) )
            {

                if( $data[0] == 'SQL' )
                {
                    $this->replaceDBTags( $tag, $data[1] );
                }
                elseif( $data[0] == 'DATA' )
                {
                    $this->replaceDataTags( $tag, $data[1] );
                }
            }
            else
            {
                $newContent = str_replace( '{' . $tag . '}', $data, $this->page->getContent() );
                $this->page->setContent( $newContent );
            }
        }
    }

    /**
     * Замена контента на странице данными из БД
     * @param String $tag тег области замены
     * @param int $cacheId ID закэшированного запроса
     * @return void
     */
    private function replaceDBTags( $tag, $cacheId )
    {
        $block = '';
        $blockOld = $this->page->getBlock( $tag );

        while ($tags = PCARegistry::getObject('db')->resultsFromCache( $cacheId ) )
        {
            $blockNew = $blockOld;
            foreach ($tags as $ntag => $data)
            {
                $blockNew = str_replace("{" . $ntag . "}", $data, $blockNew);
            }
            $block .= $blockNew;
        }
        $pageContent = $this->page->getContent();
        $newContent = str_replace( '<!-- START ' . $tag . ' -->' . $blockOld . '<!-- END ' . $tag . ' -->', $block, $pageContent );
        $this->page->setContent( $newContent );
    }

    /**
     * Замена контента страницы данными из кэша 
     * @param String $tag тег области замены
     * @param int $cacheId ID закэшированных данных
     * @return void
     */
    private function replaceDataTags( $tag, $cacheId )
    {
        $block = $this->page->getBlock( $tag );
        $blockOld = $block;
        while ($tags = PCARegistry::getObject('db')->dataFromCache( $cacheId ) )
        {
            foreach ($tags as $tag => $data)
            {
                $blockNew = $blockOld;
                $blockNew = str_replace("{" . $tag . "}", $data, $blockNew);
            }
            $block .= $blockNew;
        }
        $pageContent = $this->page->getContent();
        $newContent = str_replace( $blockOld, $block, $pageContent );
        $this->page->setContent( $newContent );
    }

    /**
     * Получить объект страницы
     * @return Object
     */
    public function getPage()
    {
        return $this->page;
    }

    /**
     * Отобразить содержание страницы в зависимости от числа шаблонов
     * @return void
     */
    public function buildFromTemplates()
    {
        $bits = func_get_args();
        $content = "";
        foreach( $bits as $bit )
        {

            if( strpos( $bit, 'skins/' ) === false )
            {
                $bit = 'skins/' . PCARegistry::getSetting('skin') . '/templates/' . $bit;
            }
            if( file_exists( $bit ) == true )
            {
                $content .= file_get_contents( $bit );
            }

        }
        $this->page->setContent( $content );
    }

    /**
     * Сконвертировать массив с данными в теги
     * @param array данные
     * @param string префикс
     * @return void
     */
    public function dataToTags( $data, $prefix )
    {
        foreach( $data as $key => $content )
        {
            $this->page->addTag( $key.$prefix, $content);
        }
    }

    public function parseTitle()
    {
        $newContent = str_replace('<title>', '<title>'. $page->getTitle(), $this->page->getContent() );
        $this->page->setContent( $newContent );
    }

    /**
     * Формируем страницу
     * @return void
     */
    public function parseOutput()
    {
        $this->replaceBits();
        $this->replaceTags();
        $this->parseTitle();
    }

}
?>

Данный класс создаёт объект страницы в зависимости от шаблона. Объект страницы содержит контент и информацию, которая необходима для создания HTML страницы. Затем мы используем метод buildFromTemplate(‘templatefile.tpl.php’, ‘templatefile2.tpl.php’) для получения начального содержания нашей страницы. Данный метод принимает целый набор названий шаблонов и производит последовательную обработку.

Управляет содержанием страницы, помогая объекту страницы вести учёт данных, которые будут заменены, а также применение новых шаблонов, которые добавляются при помощи (addTemplateBit(‘userbar’,'usertoolsbar.tpl.php’)).

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

Объект страницы

Объект страницы управляется менеджером шаблонов и предназначен для всей информации о странице. Разделение этих объектов упрощает их использование, что опять же открывает нам возможность расширять функциональность данных классов.

<?php

/**
 * Это объект страницы
 * Предназначен для добавления какой-то новой функциональности
 * К примеру, добавления пароля, специальных файлов css/js, и т.д.
 */
class page {

    private $css = array();
    private $js = array();
    private $bodyTag = '';
    private $bodyTagInsert = '';

    // будующая функциональность
    private $authorised = true;
    private $password = '';

    // элементы страницы
    private $title = '';
    private $tags = array();
    private $postParseTags = array();
    private $bits = array();
    private $content = "";

    /**
     * Конструктор...
     */
    function __construct() { }

    public function getTitle()
    {
        return $this->title;
    }

    public function setPassword( $password )
    {
        $this->password = $password;
    } 

    public function setTitle( $title )
    {
        $this->title = $title;
    }

    public function setContent( $content )
    {
        $this->content = $content;
    }

    public function addTag( $key, $data )
    {
        $this->tags[$key] = $data;
    }

    public function getTags()
    {
        return $this->tags;
    }

    public function addPPTag( $key, $data )
    {
        $this->postParseTags[$key] = $data;
    }

    /**
     * Получить все теги после первого анализа
     * @return array
     */
    public function getPPTags()
    {
        return $this->postParseTags;
    }

    /**
     * Добавления шаблона, но не содержания
     * @param String куда добавить шаблон
     * @param String имя файла с шаблоном
     * @return void
     */
    public function addTemplateBit( $tag, $bit )
    {
        $this->bits[ $tag ] = $bit;
    }

    /**
     * Получает шаблоны присутствующие на странице
     * @return array массив тегов
     */
    public function getBits()
    {
        return $this->bits;
    }

    /**
     *Получить фрагмент содержимого страницы
     * @param String блок ( <!-- START tag --> block <!-- END tag --> )
     * @return String контент блока
     */
    public function getBlock( $tag )
    {
        preg_match ('#<!-- START '. $tag . ' -->(.+?)<!-- END '. $tag . ' -->#si', $this->content, $tor);

        $tor = str_replace ('<!-- START '. $tag . ' -->', "", $tor[0]);
        $tor = str_replace ('<!-- END '  . $tag . ' -->', "", $tor);

        return $tor;
    }

    public function getContent()
    {
        return $this->content;
    }

}
?>

Загрузка объектов

Теперь самое время сообщить нашему фрэймворку о новой функциональности, которую мы только что написали. Я создал специальный метод для объекта PCARegistry с именем loadCoreObjects, который загружает объекты. Это необходимо для того, чтобы мы могли иметь доступ к объектам из файла index.php.

public function storeCoreObjects()
{
    $this->storeObject('database', 'db' );
    $this->storeObject('template', 'template' );
}

Какие-то данные

Для того чтобы продемонстрировать работу нашего фрэймворка, нам необходимо создать базу данных и таблицу. Сейчас нам подойдёт самая простая структура: ID, имя, email.

Честно говоря, нам нужно всего несколько строк из таблицы!

Шаблон на скорую руку

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

<html>
<head>
    <title> Powered by PCA Framework</title>
</head>
<body>
<h1>Our Members</h1>
<p>Below is a list of our members:</p>
<ul>
<!-- START members -->
<li>{name} {email}</li>
<!-- END members -->
</ul>
</body>
</html>

START и END - это блок (он будет выбираться при помощи метода getBlock()). Как раз в этом месте менеджер шаблона будет вставлять данные из базы.

Используем фрэймворк

Теперь соберём всё вместе в нашем index.php:

require_once('PCARegistry/pcaregistry.class.php');
$registry = PCARegistry::singleton();

$registry->storeCoreObjects();

$registry->getObject('db')->newConnection('localhost', 'root', '', 'pcaframework');

$registry->storeSetting('default', 'skin');

// подключаем шаблон
$registry->getObject('template')->buildFromTemplates('main.tpl.php');

// кэшируем запрос
$cache = $registry->getObject('db')->cacheQuery('SELECT * FROM members');

// добавляем тег
$registry->getObject('template')->getPage()->addTag('members', array('SQL', $cache) );

// назначаем заголовок страницы
$registry->getObject('template')->getPage()->setTitle('Our members');

// парсим и выводим
$registry->getObject('template')->parseOutput();
print $registry->getObject('template')->getPage()->getContent();

Если мы откроем этот файл в браузере, то увидим следующие результаты:

Грядёт третья часть…

В третьей части мы начнём создание небольшого приложения. Как раз там и посмотрим на то, как работают все эти классы более подробно. До встречи!

Источник: http://feedproxy.google.com/~r/ruseller/CdHX/~3/WC50K9eetBU/lessons.php

Читать комменты и комментировать

Добавить комментарий / отзыв



Защитный код
Обновить

Создание Фрэймворка на PHP5 – Часть 2 | | 2012-06-19 12:09:55 | | Статьи Web-мастеру | | В этом уроке мы продолжим работу над нашим фрэймворком и на этот раз приступим к реализации функционала, а именно менеджера шаблонов и обработчика для работы с базами данных. Эти два инструмента | РэдЛайн, создание сайта, заказать сайт, разработка сайтов, реклама в Интернете, продвижение, маркетинговые исследования, дизайн студия, веб дизайн, раскрутка сайта, создать сайт компании, сделать сайт, создание сайтов, изготовление сайта, обслуживание сайтов, изготовление сайтов, заказать интернет сайт, создать сайт, изготовить сайт, разработка сайта, web студия, создание веб сайта, поддержка сайта, сайт на заказ, сопровождение сайта, дизайн сайта, сайт под ключ, заказ сайта, реклама сайта, хостинг, регистрация доменов, хабаровск, краснодар, москва, комсомольск |
 
Поделиться с друзьями: