class JD_Form_Decorator_Label extends Zend_Form_Decorator_Label
{
 public function getLabel()
 {
   $element = $this->getElement();
   $label = trim($element->getLabel());
   if ($element->isRequired()) {
     $label .= ' *';
   }
   $errors = $element->getMessages();
   if (empty($errors)) {
     $element->setLabel($label);
     return parent::getLabel();
   }
   $label .= '<br /><span style="color:red;font-size:0.8em">'
   . implode('<br />', $errors)
   . '</span>';
   $element->setLabel($label);
   return parent::getLabel();
 }
}

The name „Label“ corresponds to the settings for the ViewHelper in the decorators, and folder / name to the settings in the prefix path. Credits for this script, though, goes to Padraic Brady, where one can get a lot of good ideas of how to solve ZF problems 😉

Zend Framework comes with a lot of smart validators to use with Zend_Form. But with my goal in mind to create a page comment plugin for the relaunch of surfspot.de, I needed a validator to check if the user input contains foul language… no point in people abusing each other in the anonymity of the Internet 😉 The old version of the site uses a validator, comparing user input to a string of bad bad words I don´t want to see on my site, so I needed to make that one „Zend_Form“ compatible. Besides, over the years I added some of the most notorious spam words to the validator, so it acts as a low level spam filter as well… surfers just don´t need little blue pills to have some fun 😉

Anyway, create „JD/Form/Validator/Badwords.php“, and add the following lines:

class JD_Form_Validator_Badwords extends Zend_Validate_Abstract
{
 /**
 * Validation failure message key for when the value contains foul language
 */
 const BAD_WORDS = 'badWords';

 /**
 * Validation failure message template definitions
 *
 * @var array
 */
 protected $_messageTemplates = array(
   self::BAD_WORDS => "The text uses foul language"
 );

 /**
 * Badword array - change as required by your application
 */
 private $badwords = array('games', 'college', 'prewrcar', 'parrot', 'xx');

 /**
 * Defined by Zend_Validate_Interface
 *
 * Returns true if and only if $value does not contain bad words as defined by array
 *
 * @param  string $value
 * @return boolean
 */
 public function isValid($value)
 {
   $valueString = (string) $value;
   $this->_setValue($valueString);
   for($i=0; $i<count($this->badwords); $i++) {
     if(strstr(strtoupper($valueString), strtoupper($this->badwords[$i]))) {
       $this->_error();
       return false;
     }
   }
  return true;
 }
}

Whatever you personally consider „bad words“, add to the array, and rest assured that nobody can post those on your website. I omitted my selection out intentionally, but left some spam words in to show how it works. Make sure to add the f-word, and you can even add something like „<a href=“ to the array to avoid having links posted, but that subject will be in the „filter“ article up next.

The post No-MVC Zend Framework: Zend_Decorator and Zend_Validator appeared first on Jörg Drzycimski.

This articles is based on the first parts of the Star Rating series (which I still have to finish…), so it assumes you have managed to install ZF on your system, have your bootstrap.php up and running. Pls note: I changed the naming from „Mylib“ to „JD“… using my initials is easier because I can copy&paste my classes 😉 Just in case: here´s the bootstrap.php that you have to include, already with some new code:

<?php
// Define path to application directory
defined('APPLICATION_PATH')
 || define('APPLICATION_PATH', ($_SERVER['DOCUMENT_ROOT']));

// Define application environment
defined('APPLICATION_ENV')
 || define('APPLICATION_ENV', (getenv('APPLICATION_ENV') ? getenv('APPLICATION_ENV') : 'development'));

// Ensure library/ is on include_path
set_include_path(implode(PATH_SEPARATOR, array(
 realpath(APPLICATION_PATH . '/../library'),
 get_include_path(),
)));

/**
 * General PHP settings
 */
error_reporting(E_ALL|E_STRICT);
ini_set('display_errors', 1);
ini_set('default_charset', 'UTF-8');

/**
 * Autoloader
 */
require_once 'Zend/Loader/Autoloader.php';
$autoloader = Zend_Loader_Autoloader::getInstance();
// Register folder library/JD/ for own classes
$autoloader->registerNamespace('JD_');

/**
 * Load Zend Config from application.ini
 */
$config = new Zend_Config_Ini($_SERVER['DOCUMENT_ROOT'] . '/../library/JD/configs/application.ini', APPLICATION_ENV);
Zend_Registry::set('config', $config);

/**
 * Connect to default DB
 */
$db = Zend_Db::factory($config->database);
Zend_Db_Table::setDefaultAdapter($db);

/**
 * Get Zend View object (required for any view helpers, e.g. Form, Navigation)
 */
$view = new Zend_View;
$view->setEncoding('UTF-8');
$viewRenderer = new Zend_Controller_Action_Helper_ViewRenderer($view);
Zend_Controller_Action_HelperBroker::addHelper($viewRenderer);
// Doctype for Form Renderer
$doctypeHelper = new Zend_View_Helper_Doctype();
$doctypeHelper->doctype('XHTML1_TRANSITIONAL');

/**
 * Set default language for form errors etc
 */
$translate = new Zend_Translate('array', $_SERVER['DOCUMENT_ROOT'] . '/../library/JD/Languages/de.php', $config->language->default);
Zend_Form::setDefaultTranslator($translate);

In order to be able to use Zend_Form, you need to set the Zend_View, else it would not render it. The language part is optional, it´s a simple file replacing English error messages with (in this case) German ones. Refer to the ZF manual for language details.

The next part is to set some rendering options, A.K.A decorators. With most websites, I use YAML as a CSS framework, and ZF renders form elements into dt/dd tags (didn´t know anyone uses those anymore…). Anyway, re-decorating a form is a piece of cake. Create a subfolder „Form“ in your own „library“ subfolder (mine is „JD“ was „Mylib“), and create a form controller, named „Controller.php“.  If you´ve read the previous articles, you can guess the name of the class… JD_Form_Controller. Replace the „JD“ part with anything you like, according to your directory structure (e.g. „library/somename/Form/Controller“ translates to class name „somename_Form_Controller… just basic autoloading knowledge). Here´s what the controller looks like:

class JD_Form_Controller extends Zend_Form
{
 // COLUMNAR YFORM decorators

 // standard input type=text & textareas
 protected $_standardTextDecorator = array(
   'ViewHelper',
   array('Label', array('escape'=>false)),
   array('HtmlTag', array('tag'=>'div', 'class'=>'type-text')),
   // not used
   array('Description')
 );
 // standard input type=select
 protected $_standardSelectDecorator = array(
   'ViewHelper',
   array('Label', array('escape'=>false)),
   array('HtmlTag', array('tag'=>'div', 'class'=>'type-select')),
   // not used
   array('Description')
 );
 // standard checkbox type=checkbox
 protected $_standardCheckboxDecorator = array(
   'ViewHelper',
   array('Label', array('escape'=>false)),
   array('HtmlTag', array('tag'=>'div', 'class'=>'type-check')),
   // not used
   array('Description')
 );
 // special input type=captcha -> into type-text for styling
 protected $_standardCaptchaDecorator = array(
   'ViewHelper',
   array('Label', array('escape'=>false)),
   array('HtmlTag', array('tag'=>'div', 'class'=>'type-text')),
   // not used
   array('Description')
 );
 // standard input type=hidden w/out tags
 protected $_standardHiddenDecorator = array(
   'ViewHelper'
 );
 protected $_standardButtonDecorator = array(
   'ViewHelper',
   array('HtmlTag', array('class'=>'type-button'))
 );

 // Standard YFORM decorators
 protected $_leftTextDecorator = array(
   'ViewHelper',
   array('Label', array('escape'=>false)),
   array('HtmlTag', array('tag'=>'div', 'class'=>'type-textleft'))
 );
 protected $_fullTextDecorator = array(
   'ViewHelper',
   array('Label', array('escape'=>false)),
   array('HtmlTag', array('tag'=>'div', 'class'=>'type-textfull'))
 );
 protected $_leftCheckDecorator = array(
   'ViewHelper',
   array('Label', array('escape'=>false)),
   array('HtmlTag', array('tag'=>'div', 'class'=>'type-checkleft'))
 );
 protected $_leftButtonDecorator = array(
   'ViewHelper',
   array('HtmlTag', array('tag'=>'div', 'class'=>'type-buttonleft'))
 );

 /**
 * Class constructor
 *
 * @param array $options
 */
 public function __construct($options = null)
 {        
   // path setting for custom classes MUST ALWAYS be first!
   $this->addElementPrefixPath('JD_Form_Decorator','JD/Form/Decorator','decorator');
   $this->addElementPrefixPath('JD_Form_Validator','JD/Form/Validator','validate');
   $this->addElementPrefixPath('JD_Filter','JD/Filter','filter');
   parent::__construct($options);
   $this->setAttrib('class', 'yform columnar');
   $this->setDecorators(array(
     'FormElements',
     'Form'
   ));
 }    
}

This is a lot at once, but I already set everything up for decorators (defining them and adding the prefix path), validators (still to be defined, but prefixed) and filters (also not defined yet, but prefixed). By default, I use columnar forms on the website (label next to form field: all $_standard* decorators), but also have an option to use labels above their fields ($_left or $_full). E.g. the $_standardTextDecorator wraps an INPUT element, inluding the label, into a DIV with the class „type-text“, and wraps the label into a new decorator – one that appends an * to each required input field.

Next up: Zend_Decorator and Zend_Validator

The post No-MVC Zend Framework: Zend_Forms, Decorator, Validator and Filters appeared first on Jörg Drzycimski.