library/Zend/Validate/Alpha.php

   1 <?php
   2 /**
   3  * Zend Framework
   4  *
   5  * LICENSE
   6  *
   7  * This source file is subject to the new BSD license that is bundled
   8  * with this package in the file LICENSE.txt.
   9  * It is also available through the world-wide-web at this URL:
  10  * http://framework.zend.com/license/new-bsd
  11  * If you did not receive a copy of the license and are unable to
  12  * obtain it through the world-wide-web, please send an email
  13  * to license@zend.com so we can send you a copy immediately.
  14  *
  15  * @category   Zend
  16  * @package    Zend_Validate
  17  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  18  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  19  * @version    $Id: Alpha.php 16223 2009-06-21 20:04:53Z thomas $
  20  */
  21
  22 /**
  23  * @see Zend_Validate_Abstract
  24  */
  25 require_once 'Zend/Validate/Abstract.php';
  26
  27 /**
  28  * @category   Zend
  29  * @package    Zend_Validate
  30  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  31  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  32  */
  33 class Zend_Validate_Alpha extends Zend_Validate_Abstract
  34 {
  35     const INVALID      = 'alphaInvalid';
  36     const NOT_ALPHA    = 'notAlpha';
  37     const STRING_EMPTY = 'stringEmpty';
  38
  39     /**
  40      * Whether to allow white space characters; off by default
  41      *
  42      * @var boolean
  43      * @depreciated
  44      */
  45     public $allowWhiteSpace;
  46
  47     /**
  48      * Alphabetic filter used for validation
  49      *
  50      * @var Zend_Filter_Alpha
  51      */
  52     protected static $_filter = null;
  53
  54     /**
  55      * Validation failure message template definitions
  56      *
  57      * @var array
  58      */
  59     protected $_messageTemplates = array(
  60         self::INVALID      => "Invalid type given, value should be a string",
  61         self::NOT_ALPHA    => "'%value%' has not only alphabetic characters",
  62         self::STRING_EMPTY => "'%value%' is an empty string"
  63     );
  64
  65     /**
  66      * Sets default option values for this instance
  67      *
  68      * @param  boolean $allowWhiteSpace
  69      * @return void
  70      */
  71     public function __construct($allowWhiteSpace = false)
  72     {
  73         $this->allowWhiteSpace = (boolean) $allowWhiteSpace;
  74     }
  75
  76     /**
  77      * Returns the allowWhiteSpace option
  78      *
  79      * @return boolean
  80      */
  81     public function getAllowWhiteSpace()
  82     {
  83         return $this->allowWhiteSpace;
  84     }
  85
  86     /**
  87      * Sets the allowWhiteSpace option
  88      *
  89      * @param boolean $allowWhiteSpace
  90      * @return Zend_Filter_Alpha Provides a fluent interface
  91      */
  92     public function setAllowWhiteSpace($allowWhiteSpace)
  93     {
  94         $this->allowWhiteSpace = (boolean) $allowWhiteSpace;
  95         return $this;
  96     }
  97
  98     /**
  99      * Defined by Zend_Validate_Interface
 100      *
 101      * Returns true if and only if $value contains only alphabetic characters
 102      *
 103      * @param  string $value
 104      * @return boolean
 105      */
 106     public function isValid($value)
 107     {
 108         if (!is_string($value)) {
 109             $this->_error(self::INVALID);
 110             return false;
 111         }
 112
 113         $this->_setValue($value);
 114
 115         if ('' === $value) {
 116             $this->_error(self::STRING_EMPTY);
 117             return false;
 118         }
 119
 120         if (null === self::$_filter) {
 121             /**
 122              * @see Zend_Filter_Alpha
 123              */
 124             require_once 'Zend/Filter/Alpha.php';
 125             self::$_filter = new Zend_Filter_Alpha();
 126         }
 127
 128         self::$_filter->allowWhiteSpace = $this->allowWhiteSpace;
 129
 130         if ($value !== self::$_filter->filter($value)) {
 131             $this->_error(self::NOT_ALPHA);
 132             return false;
 133         }
 134
 135         return true;
 136     }
 137
 138 }