HTML_QuickForm2
[ class tree: HTML_QuickForm2 ] [ index: HTML_QuickForm2 ] [ all elements ]

Source for file MimeType.php

Documentation is available at MimeType.php

  1. <?php
  2. /**
  3.  * Rule checking that uploaded file is of the correct MIME type
  4.  *
  5.  * PHP version 5
  6.  *
  7.  * LICENSE:
  8.  *
  9.  * Copyright (c) 2006, 2007, Alexey Borzov <avb@php.net>,
  10.  *                           Bertrand Mansion <golgote@mamasam.com>
  11.  * All rights reserved.
  12.  *
  13.  * Redistribution and use in source and binary forms, with or without
  14.  * modification, are permitted provided that the following conditions
  15.  * are met:
  16.  *
  17.  *    * Redistributions of source code must retain the above copyright
  18.  *      notice, this list of conditions and the following disclaimer.
  19.  *    * Redistributions in binary form must reproduce the above copyright
  20.  *      notice, this list of conditions and the following disclaimer in the
  21.  *      documentation and/or other materials provided with the distribution.
  22.  *    * The names of the authors may not be used to endorse or promote products
  23.  *      derived from this software without specific prior written permission.
  24.  *
  25.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  26.  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  27.  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  28.  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  29.  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  30.  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  31.  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  32.  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  33.  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  34.  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  35.  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36.  *
  37.  * @category   HTML
  38.  * @package    HTML_QuickForm2
  39.  * @author     Alexey Borzov <avb@php.net>
  40.  * @author     Bertrand Mansion <golgote@mamasam.com>
  41.  * @license    http://opensource.org/licenses/bsd-license.php New BSD License
  42.  * @version    CVS: $Id: MimeType.php,v 1.1 2007/10/14 18:58:31 avb Exp $
  43.  * @link       http://pear.php.net/package/HTML_QuickForm2
  44.  */
  45.  
  46. /**
  47.  * Rule checking that uploaded file is of the correct MIME type
  48.  *
  49.  * The Rule needs one configuration parameter for its work: a string with a
  50.  * desired MIME type or array of such strings. The parameter may be passed to
  51.  * {@link HTML_QuickForm2_Rule::setOptions() setOptions()} or to
  52.  * {@link HTML_QuickForm2_Factory::registerRule()}. Parameter registered with the
  53.  * Factory overrides one set for the particular Rule instance via setOptions().
  54.  *
  55.  * The Rule considers missing file uploads (UPLOAD_ERR_NO_FILE) valid.
  56.  *  
  57.  * @category   HTML
  58.  * @package    HTML_QuickForm2
  59.  * @author     Alexey Borzov <avb@php.net>
  60.  * @author     Bertrand Mansion <golgote@mamasam.com>
  61.  * @version    Release: 0.2.0
  62.  */
  63. {
  64.    /**
  65.     * Validates the element's value
  66.     * 
  67.     * @return   bool    whether uploaded file's MIME type is correct
  68.     * @throws   HTML_QuickForm2_InvalidArgumentException if a bogus $registeredType
  69.     *            was passed to constructor or bogus MIME type(s) provided
  70.     */
  71.     protected function checkValue($value)
  72.     {
  73.         if (!empty($this->registeredType)) {
  74.             $mime HTML_QuickForm2_Factory::getRuleConfig($this->registeredType);
  75.         else {
  76.             $mime = null;
  77.         }
  78.         if (null === $mime{
  79.             $mime $this->getOptions();
  80.         }
  81.         if (0 == count($mime|| !is_string($mime&& !is_array($mime)) {
  82.             throw new HTML_QuickForm2_InvalidArgumentException(
  83.                 'MimeType Rule requires MIME type(s), ' .
  84.                 preg_replace('/\s+/'' 'var_export($mimetrue)) ' given'
  85.             );
  86.         }
  87.  
  88.         if (!isset($value['error']|| UPLOAD_ERR_NO_FILE == $value['error']{
  89.             return true;
  90.         }
  91.         return is_array($mime)in_array($value['type']$mime)
  92.                                 $value['type'== $mime;
  93.     }
  94.  
  95.  
  96.    /**
  97.     * Sets the element that will be validated by this rule
  98.     *
  99.     * @param    HTML_QuickForm2_Element_InputFile   File upload field to validate
  100.     * @throws   HTML_QuickForm2_InvalidArgumentException    if trying to use
  101.     *            this Rule on something that isn't a file upload field
  102.     */
  103.     public function setOwner(HTML_QuickForm2_Node $owner)
  104.     {
  105.         if (!$owner instanceof HTML_QuickForm2_Element_InputFile{
  106.             throw new HTML_QuickForm2_InvalidArgumentException(
  107.                 'MimeType Rule can only validate file upload fields, '.
  108.                 get_class($owner' given'
  109.             );
  110.         }
  111.         parent::setOwner($owner);
  112.     }
  113. }
  114. ?>

Documentation generated on Mon, 22 Oct 2007 12:30:20 -0400 by phpDocumentor 1.4.0. PEAR Logo Copyright © PHP Group 2004.