Source for file number.php

Documentation is available at number.php

  1. <?php
  2. /**
  3.  * @package     FrameworkOnFramework
  4.  * @subpackage  model
  5.  * @copyright   Copyright (C) 2010 - 2012 Akeeba Ltd. All rights reserved.
  6.  * @license     GNU General Public License version 2 or later; see LICENSE.txt
  7.  */
  8. // Protect from unauthorized access
  9. defined('_JEXEC') or die;
  10.  
  11. /**
  12.  * FrameworkOnFramework model behavior class
  13.  *
  14.  * @package  FrameworkOnFramework
  15.  * @since    2.1
  16.  */
  17. class FOFModelFieldNumber extends FOFModelField
  18. {
  19.     /**
  20.      * The partial match is mapped to an exact match
  21.      *
  22.      * @param   mixed  $value  The value to compare to
  23.      *
  24.      * @return  string  The SQL where clause for this search
  25.      */
  26.     public function partial($value)
  27.     {
  28.         return $this->exact($value);
  29.     }
  30.  
  31.     /**
  32.      * Perform a between limits match. When $include is true
  33.      * the condition tested is:
  34.      * $from <= VALUE <= $to
  35.      * When $include is false the condition tested is:
  36.      * $from < VALUE < $to
  37.      *
  38.      * @param   mixed    $from     The lowest value to compare to
  39.      * @param   mixed    $to       The higherst value to compare to
  40.      * @param   boolean  $include  Should we include the boundaries in the search?
  41.      *
  42.      * @return  string  The SQL where clause for this search
  43.      */
  44.     public function between($from, $to, $include = true)
  45.     {
  46.         if ($this->isEmpty($from) || $this->isEmpty($to))
  47.         {
  48.             return '';
  49.         }
  50.  
  51.         $extra = '';
  52.  
  53.         if ($include)
  54.         {
  55.             $extra = '=';
  56.         }
  57.  
  58.         $sql = '((' . $this->getFieldName() . ' >' . $extra . ' ' . $from . ') AND ';
  59.         $sql .= '(' . $this->getFieldName() . ' <' . $extra . ' ' . $to . '))';
  60.  
  61.         return $sql;
  62.     }
  63.  
  64.     /**
  65.      * Perform an outside limits match. When $include is true
  66.      * the condition tested is:
  67.      * (VALUE <= $from) || (VALUE >= $to)
  68.      * When $include is false the condition tested is:
  69.      * (VALUE < $from) || (VALUE > $to)
  70.      *
  71.      * @param   mixed    $from     The lowest value of the excluded range
  72.      * @param   mixed    $to       The higherst value of the excluded range
  73.      * @param   boolean  $include  Should we include the boundaries in the search?
  74.      *
  75.      * @return  string  The SQL where clause for this search
  76.      */
  77.     public function outside($from, $to, $include = false)
  78.     {
  79.         if ($this->isEmpty($from) || $this->isEmpty($to))
  80.         {
  81.             return '';
  82.         }
  83.  
  84.         $extra = '';
  85.  
  86.         if ($include)
  87.         {
  88.             $extra = '=';
  89.         }
  90.  
  91.         $sql = '((' . $this->getFieldName() . ' <' . $extra . ' ' . $from . ') AND ';
  92.         $sql .= '(' . $this->getFieldName() . ' >' . $extra . ' ' . $to . '))';
  93.  
  94.         return $sql;
  95.     }
  96.  
  97.     /**
  98.      * Perform an interval match. It's similar to a 'between' match, but the
  99.      * from and to values are calculated based on $value and $interval:
  100.      * $value - $interval < VALUE < $value + $interval
  101.      *
  102.      * @param   integer|float $value     The center value of the search space
  103.      * @param   integer|float $interval  The width of the search space
  104.      * @param   boolean        $include   Should I include the boundaries in the search?
  105.      *
  106.      * @return  string  The SQL where clause
  107.      */
  108.     public function interval($value, $interval, $include = true)
  109.     {
  110.         if ($this->isEmpty($value))
  111.         {
  112.             return '';
  113.         }
  114.  
  115.         $from = $value - $interval;
  116.         $to = $value + $interval;
  117.  
  118.         $extra = '';
  119.  
  120.         if ($include)
  121.         {
  122.             $extra = '=';
  123.         }
  124.  
  125.         $sql = '((' . $this->getFieldName() . ' >' . $extra . ' ' . $from . ') AND ';
  126.         $sql .= '(' . $this->getFieldName() . ' <' . $extra . ' ' . $to . '))';
  127.  
  128.         return $sql;
  129.     }
  130. }

Documentation generated on Tue, 19 Nov 2013 15:09:40 +0100 by phpDocumentor 1.4.3