Merge branch 'hotfix/1477'

weierophinney · weierophinney · commit 1d905b9af4f5 · 2015-05-07T12:27:03.000-05:00
Close zendframework#1477
diff --git a/docs/src/index.rst b/docs/src/index.rst
@@ -294,6 +294,7 @@ Programmer's Reference Guide of Zend Framework 2
    modules/zend.validator.validator-chains
    modules/zend.validator.writing-validators
    modules/zend.validator.messages
+   modules/zend.validator.timezone
    modules/zend.version
    modules/zend.view.quick-start
    modules/zend.view.renderer.php-renderer
@@ -962,6 +963,7 @@ Zend\\Validator
         * :doc:`modules/zend.validator.sitemap`
         * :doc:`modules/zend.validator.step`
         * :doc:`modules/zend.validator.string-length`
+        * :doc:`modules/zend.validator.timezone`
         * :doc:`modules/zend.validator.validator-chains`
         * :doc:`modules/zend.validator.writing-validators`
         * :doc:`modules/zend.validator.messages`
diff --git a/docs/src/modules/zend.validator.set.rst b/docs/src/modules/zend.validator.set.rst
@@ -38,6 +38,7 @@ Included Validators
 - :ref:`Sitemap <zend.validator.sitemap>`
 - :ref:`Step <zend.validator.step>`
 - :ref:`StringLength <zend.validator.stringlength>`
+- :ref:`Timezone <zend.validator.timezone>`
 
 .. _zend.validator.set.deprecated-validators:
 
diff --git a/docs/src/modules/zend.validator.timezone.rst b/docs/src/modules/zend.validator.timezone.rst
@@ -0,0 +1,41 @@
+.. _zend.validator.timezone:
+
+Timezone Validator
+==============
+
+``Zend\Validator\Timezone`` allows validating if an input string
+represents a timezone.
+
+Supported validation types for Zend\\Validator\\Timezone
+--------------------------------------------------------
+
+The ``Zend\Validator\Timezone`` validator is capable of validating the
+abbreviation (e.g. "ewt") as well as the location string (e.g.
+"America/Los\_Angeles"). These options are stored in the validator as
+``LOCATION``, ``ABBREVIATION``, and ``ALL`` class constants.
+
+Example Usage
+-------------
+
+The default validation type will check again abbreviations as well as
+the location string.
+
+.. code:: php
+
+    $validator = new Zend\Validator\Timezone();
+
+    $validator->isValid('America/Los_Angeles'); // returns true
+    $validator->isValid('ewt'); // returns true
+    $validator->isValid('Foobar');  // returns false
+
+To validate against only the location string you can set the type:
+
+.. code:: php
+
+    $validator = new Zend\Validator\Timezone();
+    $validator->setType(Zend\Validator\Timezone::LOCATION);
+
+    $validator->isValid('America/Los_Angeles'); // returns true
+    $validator->isValid('ewt'); // returns false
+    $validator->isValid('Foobar');  // returns false
+
