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

Source for file MaxFileSize.php

Documentation is available at MaxFileSize.php

  1. <?php
  2. /**
  3.  * Rule checking that uploaded file size does not exceed the given limit
  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: MaxFileSize.php,v 1.2 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 size does not exceed the given limit
  48.  *
  49.  * The Rule needs one configuration parameter for its work: the size limit.
  50.  * This limit can be passed either to
  51.  * {@link HTML_QuickForm2_Rule::setOptions() setOptions()} or to
  52.  * {@link HTML_QuickForm2_Factory::registerRule()}. Limit registered with the
  53.  * Factory overrides one set for the particular Rule instance via setOptions().
  54.  *
  55.  * Note that if file upload failed due to upload_max_filesize php.ini setting
  56.  * or MAX_FILE_SIZE form field, then this rule won't even be called, due to
  57.  * File element's built-in validation setting the error message.
  58.  *
  59.  * The Rule considers missing file uploads (UPLOAD_ERR_NO_FILE) valid.
  60.  *  
  61.  * @category   HTML
  62.  * @package    HTML_QuickForm2
  63.  * @author     Alexey Borzov <avb@php.net>
  64.  * @author     Bertrand Mansion <golgote@mamasam.com>
  65.  * @version    Release: 0.2.0
  66.  */
  67. {
  68.    /**
  69.     * Validates the element's value
  70.     * 
  71.     * @return   bool    whether uploaded file's size is within given limit
  72.     * @throws   HTML_QuickForm2_InvalidArgumentException if a bogus $registeredType
  73.     *            was passed to constructor or a bogus size limit was provided
  74.     */
  75.     protected function checkValue($value)
  76.     {
  77.         if (!empty($this->registeredType)) {
  78.             $limit HTML_QuickForm2_Factory::getRuleConfig($this->registeredType);
  79.         else {
  80.             $limit = null;
  81.         }
  82.         if (null === $limit{
  83.             $limit $this->getOptions();
  84.         }
  85.         if (0 >= $limit{
  86.             throw new HTML_QuickForm2_InvalidArgumentException(
  87.                 'MaxFileSize Rule requires a positive size limit, ' .
  88.                 preg_replace('/\s+/'' 'var_export($limittrue)) ' given'
  89.             );
  90.         }
  91.  
  92.         if (!isset($value['error']|| UPLOAD_ERR_NO_FILE == $value['error']{
  93.             return true;
  94.         }
  95.         return ($limit >= @filesize($value['tmp_name']));
  96.     }
  97.  
  98.  
  99.    /**
  100.     * Sets the element that will be validated by this rule
  101.     *
  102.     * @param    HTML_QuickForm2_Element_InputFile   File upload field to validate
  103.     * @throws   HTML_QuickForm2_InvalidArgumentException    if trying to use
  104.     *            this Rule on something that isn't a file upload field
  105.     */
  106.     public function setOwner(HTML_QuickForm2_Node $owner)
  107.     {
  108.         if (!$owner instanceof HTML_QuickForm2_Element_InputFile{
  109.             throw new HTML_QuickForm2_InvalidArgumentException(
  110.                 'MaxFileSize Rule can only validate file upload fields, '.
  111.                 get_class($owner' given'
  112.             );
  113.         }
  114.         parent::setOwner($owner);
  115.     }
  116. }
  117. ?>

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