Jun 24 2009 at 11:00

PHP: Валидация веб-форм с помощью спецификаций

Invite pending

Валидация веб-форм на PHP — тема довольно избитая. Об этом написана куча интересных и не очень статей. В этой статье я хочу ещё раз поднять эту тему, рассказав об идеи валидации форм на основе шаблона проектирования «Спецификация».

Шаблон «Спецификация»

Допустим, у нас есть множество объектов, каждый из которых мы хотим проверить на соответствие некоторому критерию. Согласно шаблону «Спецификация», для решения этой проблемы необходимо оформить заданный критерий (спецификацию) в виде объекта, снабжённого методом IsSatisfiedBy( $oSomeObject ), c помощью которого будет проводится проверка соответствия этому критерию (спецификации) объекта $oSomeObject. Другими словами, каждая спецификация должна реализовывать следующий интерфейс:

/** * Интерфейс спецификации */ interface ISpecification { /** * Проверка соответствия спецификации * * @param mixed $mObject * @return bool Флаг удовлетворённости */ public function IsSatisfiedBy( $mObject ); } * This source code was highlighted with Source Code Highlighter. Валидация форм Применение данного шаблона к валидации веб-форм требует некоторых правок. Точнее сказать, после предложенных ниже правок от шаблона в принципе мало что останется… но ведь на то, он и шаблон, что бы приспосабливать его под свои нужды :) Базовые спецификации Первым делом создадим набор базовых спецификаций, которые в дальнейшем будут использоваться для построения более сложных спецификаций. В нашем случае базовыми спецификациями будут: Существование поля (CFieldExistsSpecification) Заполненность поля (CFieldNotEmptySpecification) Поле больше либо равно (CGreaterOrEqualSpecification) Поле меньше либо равно (CLessOrEqualSpecification) Соответствие поля регулярному выражению (CRegexpMatchSpecification) Соответствие поля «белому листу» (CWhiteListMatchSpecification) Код такой спецификации будет примерно следующим: /** * Проверка соответствия поля регулярному выражению */ class CRegexpMatchSpecification implements ISpecification { private $_sFieldValue; function __construct( $sFieldValue ) { $this->_sFieldValue = $sFieldValue; } public function IsSatisfiedBy( $mData ) { if( !preg_match( $mData, $this->_sFieldValue ) ) throw new Exception('INVALID'); } } * This source code was highlighted with Source Code Highlighter. Как видно, эти спецификации не соответствуют шаблону в полной мере, так как их метод IsSatisfiedBy не возвращает флаг успеха, а бросает исключение в случае неудачи. Однако, я не случайно назвал эти спецификации «базовыми». На основе этих спецификаций мы сможем создать специализированные спецификации с удобным API, предусматривающим: Возможность настройки параметров спецификации Возможность получения кода ошибки Специализированные спецификации Опищем базовый класс для специализированных спецификаций: /** * Абстрактная спецификация */ abstract class CAbstractSpecification implements ISpecification { /** * Название поля * @var string */ protected $_sFieldName; /** * Значение поля * @var string */ protected $_sFieldValue; /** * Код ошибки * @var string */ protected $_sErrorCode; /** * Параметры спецификации * @var array */ protected $_aParam; /** * Конструктор * * @param string $sFieldName Имя поля * @param array $aParam Параметры спецификации */ function __construct( $sFieldName, array $aParam = array() ) { $this->_sFieldName = $sFieldName; $this->_aParam = $aParam; } /** * Проверка соответствия спецификации * * @param array $aData * @return bool */ public function IsSatisfiedBy( $aData ) { $bIsSatisfied = true; // Начало попытки пройти соответствие спецификации try { // Флаг необходимости поля $bRequired = ( isset( $this->_aParam['required'] ) ) ? $this->_aParam['required'] : true; // Поле должно быть заполнено if( $bRequired ) { $oSpecNotEmpty = new CFieldNotEmptySpecification( $this->_sFieldName ); $oSpecNotEmpty->IsSatisfiedBy( $aData ); } // Поле может быть пустым else { $oSpecExists = new CFieldExistsSpecification( $this->_sFieldName ); $oSpecExists->IsSatisfiedBy( $aData ); } // Сохраняем значение поля $this->_sFieldValue = $aData[ $this->_sFieldName ]; // В случае, если поле заполнено, проходим спецификацию if( !empty( $this->_sFieldValue ) ) $this->_Specify( $aData ); } // Обработка ошибок catch( Exception $ex ) { $this->_sErrorCode = $ex->getMessage(); $bIsSatisfied = false; } return $bIsSatisfied; } /** * Логика спецификации * * @param array $aData Данные для спецификации */ abstract protected function _Specify( $aData ); /** * Получение ошибки спецификации * * @return array */ public function GetError() { return array( 'FieldName' => $this->_sFieldName, 'ErrorCode' => $this->_sErrorCode ); } } // Конец класса CAbstractSpecification * This source code was highlighted with Source Code Highlighter. Теперь на основе бызовых спецификаций и созданного абстрактного класса мы без труда можем создавать спецификации для любого поля нашей формы. Рассмотрим для примера спецификацию имени пользователя: /** * Проверка имени */ class CNameSpecification extends CAbstractSpecification { protected function _Specify( $aData ) { $oSpecGreaterOrEqual = new CGreaterOrEqualSpecification( mb_strlen( $this->_sFieldValue ) ); $oSpecGreaterOrEqual->IsSatisfiedBy( FORM_NAME_SIZE_MIN ); $oSpecLessOrEqual = new CLessOrEqualSpecification( mb_strlen( $this->_sFieldValue ) ); $oSpecLessOrEqual->IsSatisfiedBy( FORM_NAME_SIZE_MAX ); $oSpecRegexpMatch = new CRegexpMatchSpecification( $this->_sFieldValue ); $oSpecRegexpMatch->IsSatisfiedBy( '/^[\p{L}]+$/i' ); } } * This source code was highlighted with Source Code Highlighter. Пример использования И так, наши спецификации готовы. Отныне для проверки данных с веб-формы нам достаточно создать необходимый набор спецификаций и проверить их на наличие ошибок. Выглядеть это будет следующим образом: // Создание спецификаций $aSpec = array(); // Общие поля $aSpec[] = new CNameSpecification( 'Name' ); $aSpec[] = new CNameSpecification( 'SurName' ); $aSpec[] = new CEmailSpecification( 'Email' ); $aSpec[] = new CPhoneSpecification( 'Phone' ); $aSpec[] = new CPhoneSpecification( 'PhoneAdd', array( 'required' => false ) ); $aSpec[] = new CRegionSpecification( 'Region', array( 'whiteList' => $aRegion ) ); $aSpec[] = new CZipCodeSpecification( 'ZipCode' ); $aSpec[] = new CAddressSpecification( 'Address' ); // Проверка спецификаций $aFormError = array(); foreach( $aSpec as $oSpecification ) { if( !$oSpecification->IsSatisfiedBy( $_POST ) ) { $aError = $oSpecification->GetError(); $aFormError[ $aError['FieldName'] ] = $aError; } } * This source code was highlighted with Source Code Highlighter. Конечно, тот же Zend_Form из ZF был бы гораздо удобней, но в случае работы без фреймворка (да, такое в наши дни бывает), вышеописанный подход значительно упрощает разработку веб-форм. _________ Текст подготовлен в ХабраРедакторе

Hubs:

Lumber room