library/HTMLPurifier/AttrDef/Integer.php

   1 <?php
   2
   3 require_once 'HTMLPurifier/AttrDef.php';
   4
   5 /**
   6  * Validates an integer.
   7  * @note While this class was modeled off the CSS definition, no currently
   8  *       allowed CSS uses this type.  The properties that do are: widows,
   9  *       orphans, z-index, counter-increment, counter-reset.  Some of the
  10  *       HTML attributes, however, find use for a non-negative version of this.
  11  */
  12 class HTMLPurifier_AttrDef_Integer extends HTMLPurifier_AttrDef
  13 {
  14
  15     /**
  16      * Bool indicating whether or not negative values are allowed
  17      */
  18     var $negative = true;
  19
  20     /**
  21      * Bool indicating whether or not zero is allowed
  22      */
  23     var $zero = true;
  24
  25     /**
  26      * Bool indicating whether or not positive values are allowed
  27      */
  28     var $positive = true;
  29
  30     /**
  31      * @param $negative Bool indicating whether or not negative values are allowed
  32      * @param $zero Bool indicating whether or not zero is allowed
  33      * @param $positive Bool indicating whether or not positive values are allowed
  34      */
  35     function HTMLPurifier_AttrDef_Integer(
  36         $negative = true, $zero = true, $positive = true
  37     ) {
  38         $this->negative = $negative;
  39         $this->zero     = $zero;
  40         $this->positive = $positive;
  41     }
  42
  43     function validate($integer, $config, &$context) {
  44
  45         $integer = $this->parseCDATA($integer);
  46         if ($integer === '') return false;
  47
  48         // we could possibly simply typecast it to integer, but there are
  49         // certain fringe cases that must not return an integer.
  50
  51         // clip leading sign
  52         if ( $this->negative && $integer[0] === '-' ) {
  53             $digits = substr($integer, 1);
  54             if ($digits === '0') $integer = '0'; // rm minus sign for zero
  55         } elseif( $this->positive && $integer[0] === '+' ) {
  56             $digits = $integer = substr($integer, 1); // rm unnecessary plus
  57         } else {
  58             $digits = $integer;
  59         }
  60
  61         // test if it's numeric
  62         if (!ctype_digit($digits)) return false;
  63
  64         // perform scope tests
  65         if (!$this->zero     && $integer == 0) return false;
  66         if (!$this->positive && $integer > 0) return false;
  67         if (!$this->negative && $integer < 0) return false;
  68
  69         return $integer;
  70
  71     }
  72
  73 }
  74