20 июн 2009 в 08:59

Создание мастера на PHP

Ожидает приглашения

Предисловие

Наверное каждый php-разработчик раз в жизни сталкивался с задачей создания какого-либо мастера — скрипта, проводящего пользователя через последовательность шагов, с целью получения от него некоторой информации. Самым популярным примером мастера пожалуй можно назвать процесс оформления заказа в интернет-магазине. В данной статье я хочу рассказать о своих наработках в данной области. Статья ни в коем случае не претендует на man по созданию мастеров, а лишь излагает мои наработки по данной теме.

Постановка задачи

Прежде всего разработку мастера, как и любого другого ПО, стоит начать с определения функционала, который он должен предоставлять. Для нашего мастера обозначим следующие критерии:

Возможность добавления произвольных шагов в мастер;
Контроль последовательности выполнения шагов;
Возможность прямого перехода к любому доступному шагу.

Требования к шагу мастера вытекают непосредственно из требований к самому мастеру. Шаг должен иметь возможность:

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

Реализация

Реализацию мастера начнём с описания класса шага как основной структурной единицы мастера. Ниже приведён код абстрактного класса шага, от которого должны наследоваться все шаги в нашем мастере:

/** * Шаг Мастера */ abstract class CMasterStep { /** * Данные из запроса клиента * @var array */ protected $_aData; /** * Настройки * @var array */ protected $_aParam; /** * Результаты работы * @var array */ protected $_aResult; /** * Конструктор шага * * @param array $aData Данные из запроса клиента * @param array $aParam Настройки * @param array $aResult Результаты работы */ function __construct( &$aData, $aParam, &$aResult ) { // Инициализация переменных $this->_aData = &$aData; $this->_aParam = $aParam; $this->_aResult = &$aResult; // Вызов метода инициализации $this->_Init(); } /** * Инициализация шага * * Метод предназначен для инициализации шага, выборки априорных * данных и так далее. Вызов метода происходит в конце конструктора * класса. Для того, что бы изменить поведение метода для какого-либо * класса, необходимо перегрузить этот метод в соответствующем классе */ protected function _Init() { } /** * Проверка завершённости шага * * Метод проверяет, пройден ли данный шаг на текущий момент * * @return bool */ abstract public function IsComplete(); /** * Подготовка данных для отображения шага * * Метод добавляет в массив результатов работы данные для шаблона * текущего шага */ abstract public function PrepareData(); /** * Проверка и сохранение данных шага * * Метод проверяет полученные от пользователя данные. В случае, * если данные корректны, метод сохраняет их и возвращает true. * В случае неудачи метод записывает в массив результатов работы * массив с ошибками ($_aResult['Error']) и возвращает false * * @return bool */ abstract public function Submit(); } // Конец класса "Шаг Мастера" * This source code was highlighted with Source Code Highlighter. Для реализации мастера создадим класс, с помощью которого мы сможем добавлять шаги, проверять доступность некоторого шага, отображать и обрабатывать указанный шаг. Так же класс мастера будет отвечать за хранение данных, полученных от пользователя (в качестве хранилища используется сессия, точнее «пространство имён» в сессии): /** * Мастер * * Суть работы мастера сводится к обработке данных, полученных от * пользователя и формированию массива результатов работы на основе * обработки данных шагами мастера. */ class CMaster { /** * Шаги мастера * @var array */ private $_aSteps; /** * Результат работы * @var array */ private $_aResult; /** * Пространство имён, для хранения данных в сессии */ const NameSpace = 'Master'; /** * Конструктор * * @param array $aResult Результат работы */ function __construct( &$aResult ) { $this->_aSteps = array(); $this->_aResult = &$aResult; } /** * Добавление шага в мастер * * @param integer $iStepNumber Номер шага * @param CSlMasterStep $oStep Объект шага */ public function AddStep( $iStepNumber, CMasterStep $oStep ) { $this->_aSteps[ $iStepNumber ] = $oStep; } /** * Получение количества шагов в мастере * * @return int */ public function GetStepsCount() { return sizeof( $this->_aSteps ); } /** * Сохранение данных в мастере * * @param string $sDataKey Ключ * @param mixed $mDataValue Значение */ public static function SetData( $sDataKey, $mDataValue ) { if( !isset( $_SESSION[ self::NameSpace ] ) ) $_SESSION[ self::NameSpace ] = array(); $_SESSION[ self::NameSpace ][ $sDataKey ] = $mDataValue; } /** * Получение данных из мастера * * @param string $sDataKey Ключ * @return mixed */ public static function GetData( $sDataKey ) { $mResult = null; if( isset( $_SESSION[ self::NameSpace ] ) && isset( $_SESSION[ self::NameSpace ][ $sDataKey ] ) ) $mResult = $_SESSION[ self::NameSpace ][ $sDataKey ]; return $mResult; } /** * Очистка мастера */ public static function Clear() { if( isset( $_SESSION[ self::NameSpace ] ) ) unset( $_SESSION[ self::NameSpace ] ); } /** * Проверка доступности шага * * Метод проверяет, доступен ли шаг с указанным номером. * По сути процесс сводится к перебору всех шагов начиная с нулевого * и проверки завершённости каждого из них. В случае когда заданный * шаг оказывается недоступным, возвращается номер первого незавершенного * шага по порядку * * @param integer $iTargetStep Номер шага * @return integer */ private function GetAvaibleStep( $iTargetStep ) { // Целевой шаг не должен превышать максимально доступный $iMaxStep = max( array_keys( $this->_aSteps ) ); if( $iTargetStep > $iMaxStep ) $iTargetStep = $iMaxStep; // Проверка завершённости предыдущих шагов for( $iStep = 0; $iStep < $iTargetStep; $iStep++ ) { if( !$this->_aSteps[ $iStep ]->IsComplete() ) break; } return $iStep; } /** * Отображение шага * * Метод подготавливает необходимые данные для шаблона шага, * вызвав метод PrepareData объекта соответствующего шага. * После этого в массиве результатов работы выставляется * переменная _aResult['Step'], указывающая, какой шаг должен * быть отображён * * @param integer $iStep Номер шага */ public function Show( $iStep ) { $iAvaibleStep = $this->GetAvaibleStep( $iStep ); $this->_aSteps[ $iAvaibleStep ]->PrepareData(); $this->_aResult['Step'] = $iAvaibleStep; } /** * Подтверждение шага * * Метод проверяет данные, переданные клиентом, для указанного * шага с помощью вызова метода Submit объекта соответствующего * шага. В качестве возвращаемого значения * выступает флаг успеха проверки параметров заданного шага. * * @param integer $iStep Номер шага * @return bool Флаг успеха */ public function Submit( $iStep ) { $bValid = false; $iAvaibleStep = $this->GetAvaibleStep( $iStep ); if( $iAvaibleStep == $iStep ) { if( $this->_aSteps[ $iStep ]->Submit() ) $bValid = true; } return $bValid; } /** * Обработчик запроса пользователя * * @param integer $iStep Номер шага * @param bool $bSubmit Флаг подтверждения * @return bool Флаг завершения работы мастера */ public function Process( $iStep, $bSubmit ) { $bIsComplete = false; // Подтверждение шага if( $bSubmit ) { // Подтверждение шага прошло удачно if( $this->Submit( $iStep ) ) { // Шаг не последний в мастере if( $iStep < max( array_keys( $this->_aSteps ) ) ) { $iStep += 1; } // Шаг последний в мастере else { $bIsComplete = true; } } } // Отображение шага $this->Show( $iStep ); return $bIsComplete; } } // Конец класса "Мастер заказа" * This source code was highlighted with Source Code Highlighter. Основа мастера готова. Конечно это не окончательный вариант, но для изложения общей концепции он вполне сгодится. Результат Продемонстрируем работу созданного мастера на… на первом, что пришло в голову — пошаговом получении имени и фамилии :) В реальной жизни такой мастер конечно же не имеет смысла, но для демонстрации его будет достаточно. Первым делом создадим два шага, отвечающих за получение имени и фамилии соответственно (я опишу только шаг получения имени, так как шаг получения фамилии принципиально ничем отличаться не будет): /** * Шаг: "Получение имени" */ class CMasterStepName extends CMasterStep { public function IsComplete() { return !is_null( CMaster::GetData( 'Name' ) ); } public function PrepareData() { $this->_aResult['Text'] = 'Введите имя'; $this->_aResult['Name'] = !empty( $this->_aData['Name'] ) ? $this->_aData['Name'] : ''; } public function Submit() { $this->_aResult['Error'] = array(); if( !empty( $this->_aData['Name'] ) CMaster::SetData( 'Name', $this->_aData['Name'] ); else $this->_aResult['Error']['Name'] = 'Empty'; return ( sizeof( $this->_aResult['Error'] ) == 0 ) ? true : false; } } // Конец класса CMasterStepName * This source code was highlighted with Source Code Highlighter. Теперь для работы мастера нам остаётся создать скрипт, где мы соберём все вышеописанное воедино: /* Подключение классов */ // Инициализация переменных $aParam = array(); $aResult = array(); // Обработка параметров $iStep = ( isset( $_GET['Step'] ) ) ? $_GET['Step'] : false; $bConfirm = ( !empty( $_GET['Confirm'] ) ) ? ($_GET['Confirm'] === 'true') : false; // Создание мастера $oMaster = new CSlMaster( $aResult ); $oMaster->AddStep( 0, new CMasterStepName( $_GET, $aParams, $aResult ) ); $oMaster->AddStep( 1, new CMasterStepSurName( $_GET, $aParams, $aResult ) ); // Обработка запроса пользователя $bIsComplete = $oMaster->Process( $iStep, $bConfirm ); // Просмотр результатов var_dump( $aResult ); * This source code was highlighted with Source Code Highlighter. Заключение Получившийся мастер конечно же не является идеальным. Если у Вас есть предложения по улучшению его структуры, я с большим интересом выслушаю Ваше мнение. _________ Текст подготовлен в ХабраРедакторе

Хабы:

Чулан

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

Точно не пройдут модерацию:

новости, анонсы и пресс-релизы;
материалы рекламного характера;
вакансии (для этого предназначена «Хабр Карьера»)
вопросы (используйте «Хабр Q&A»);
просьбы о помощи в решении задач;
жалобы на компании и предоставляемые услуги;
куски программного кода без подробных пояснений;
публикации, ранее опубликованные на других сайтах;
односложные материалы (пара абзацев или видеоролик);
статьи, слабо относящиеся к IT-тематике или не относящиеся к ней вовсе;
публикации, нарушающие правила сайта.

С большой вероятностью не пройдут модерацию (или будут отправлены на доработку):

материалы с низким (менее 75%) показателем уникального текста;
публикации без правильно расставленных знаков препинания, со смайликами, с обилием восклицательных знаков, неоправданным выделением слов и предложений;
плохо оформленные публикации (подробнее);