documentation/manual/en/module_specs/Zend_Validate-Alpha.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect2 id="zend.validate.set.alpha">
   4     <title>Alpha</title>
   5
   6     <para>
   7         <classname>Zend_Validate_Alpha</classname> allows you to validate if a given value contains
   8         only alphabetical characters. There is no length limitation for the input you want to
   9         validate. This validator is related to the <classname>Zend_Validate_Alnum</classname>
  10         validator with the exception that it does not accept digits.
  11     </para>
  12
  13     <sect3 id="zend.validate.set.alpha.options">
  14         <title>Supported options for Zend_Validate_Alpha</title>
  15
  16         <para>
  17             The following options are supported for <classname>Zend_Validate_Alpha</classname>:
  18         </para>
  19
  20         <itemizedlist>
  21             <listitem>
  22                 <para>
  23                     <emphasis><property>allowWhiteSpace</property></emphasis>: If whitespace
  24                     characters are allowed. This option defaults to <constant>FALSE</constant>
  25                 </para>
  26             </listitem>
  27         </itemizedlist>
  28     </sect3>
  29
  30     <sect3 id="zend.validate.set.alpha.basic">
  31         <title>Basic usage</title>
  32
  33         <para>
  34             A basic example is the following one:
  35         </para>
  36
  37         <programlisting language="php"><![CDATA[
  38 $validator = new Zend_Validate_Alpha();
  39 if ($validator->isValid('Abcd')) {
  40     // value contains only allowed chars
  41 } else {
  42     // false
  43 }
  44 ]]></programlisting>
  45     </sect3>
  46
  47     <sect3 id="zend.validate.set.alpha.whitespace">
  48         <title>Using whitespaces</title>
  49
  50         <para>
  51             Per default whitespaces are not accepted because they are not part of the alphabet.
  52             Still, there is a way to accept them as input. This allows to validate complete
  53             sentences or phrases.
  54         </para>
  55
  56         <para>
  57             To allow the usage of whitespaces you need to give the
  58             <property>allowWhiteSpace</property> option. This can be done while creating an instance
  59             of the validator, or afterwards by using <methodname>setAllowWhiteSpace()</methodname>.
  60             To get the actual state you can use <methodname>getAllowWhiteSpace()</methodname>.
  61         </para>
  62
  63         <programlisting language="php"><![CDATA[
  64 $validator = new Zend_Validate_Alpha(array('allowWhiteSpace' => true));
  65 if ($validator->isValid('Abcd and efg')) {
  66     // value contains only allowed chars
  67 } else {
  68     // false
  69 }
  70 ]]></programlisting>
  71     </sect3>
  72
  73     <sect3 id="zend.validate.set.alpha.languages">
  74         <title>Using different languages</title>
  75
  76         <para>
  77             When using <classname>Zend_Validate_Alpha</classname> then the language which the user
  78             sets within his browser will be used to set the allowed characters. This means when your
  79             user sets <emphasis>de</emphasis> for german then he can also enter characters like
  80             <emphasis>ä</emphasis>, <emphasis>ö</emphasis> and <emphasis>ü</emphasis> additionally
  81             to the characters from the english alphabet.
  82         </para>
  83
  84         <para>
  85             Which characters are allowed depends completly on the used language as every language
  86             defines it's own set of characters.
  87         </para>
  88
  89         <para>
  90             There are actually 3 languages which are not accepted in their own script. These
  91             languages are <emphasis>korean</emphasis>, <emphasis>japanese</emphasis> and
  92             <emphasis>chinese</emphasis> because this languages are using an alphabet where a
  93             single character is build by using multiple characters.
  94         </para>
  95
  96         <para>
  97             In the case you are using these languages, the input will only be validated by using
  98             the english alphabet.
  99         </para>
 100     </sect3>
 101 </sect2>
 102 <!--
 103 vim:se ts=4 sw=4 et:
 104 -->