PHPLinq
[ class tree: PHPLinq ] [ index: PHPLinq ] [ all elements ]
Packages:
PHPLinq
PHPLinq_Adapter

Source for file OrderByExpression.php

Documentation is available at OrderByExpression.php

  1. <?php
  2. /**
  3.  * PHPLinq
  4.  *
  5.  * Copyright (c) 2008 - 2009 PHPLinq
  6.  *
  7.  * This library is free software; you can redistribute it and/or
  8.  * modify it under the terms of the GNU Lesser General Public
  9.  * License as published by the Free Software Foundation; either
  10.  * version 2.1 of the License, or (at your option) any later version.
  11.  * 
  12.  * This library is distributed in the hope that it will be useful,
  13.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15.  * Lesser General Public License for more details.
  16.  * 
  17.  * You should have received a copy of the GNU Lesser General Public
  18.  * License along with this library; if not, write to the Free Software
  19.  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  20.  *
  21.  * @category   PHPLinq
  22.  * @package    PHPLinq
  23.  * @copyright  Copyright (c) 2008 - 2009 PHPLinq (http://www.codeplex.com/PHPLinq)
  24.  * @license    http://www.gnu.org/licenses/lgpl.txt    LGPL
  25.  * @version    0.4.0, 2009-01-27
  26.  */
  27.  
  28.  
  29. /** PHPLinq_Function */
  30. require_once('PHPLinq/Function.php');
  31.  
  32. /** PHPLinq_OrderByExpression */
  33. require_once('PHPLinq/Expression.php');
  34.  
  35.  
  36. /**
  37.  * PHPLinq_OrderByExpression
  38.  *
  39.  * @category   PHPLinq
  40.  * @package    PHPLinq
  41.  * @copyright  Copyright (c) 2008 - 2009 PHPLinq (http://www.codeplex.com/PHPLinq)
  42.  */
  43. class PHPLinq_OrderByExpression extends PHPLinq_Expression {
  44.     /**
  45.      * Internal function reference
  46.      *
  47.      * @var PHPLinq_Function 
  48.      */
  49.     private $_functionReference;
  50.     
  51.     /**
  52.      * Default name
  53.      * 
  54.      * @var string 
  55.      */
  56.     private $_defaultName = null;
  57.     
  58.     /**
  59.      * Internal expression reference
  60.      * 
  61.      * @var PHPLinq_Expression 
  62.      */
  63.     private $_expression = null;
  64.     
  65.     /**
  66.      * Descending?
  67.      *
  68.      * @var bool 
  69.      */
  70.     private $_descending = false;
  71.     
  72.     /**
  73.      * Construct expression
  74.      *
  75.      * @param     string     $expression        Expression to create
  76.      * @param     string     $defaultName    Default name in expression
  77.      * @param      bool    $descending        Descending order?
  78.      * @param      string     $comparer        Comparer function
  79.      */
  80.     public function __construct($expression, $defaultName = '', $descending = false, $comparer = null) {
  81.         // Default name
  82.         $this->_defaultName = $defaultName;
  83.         
  84.         // Internal expression
  85.         $this->_expression = new PHPLinq_Expression($expression, $defaultName);
  86.         
  87.         // Comparer function set?
  88.         if (is_null($comparer)) {
  89.             $comparer = 'strcmp';
  90.         }
  91.         
  92.         // Descending?
  93.         if ($descending) {
  94.             $comparer = '-1 * ' . $comparer;
  95.         }
  96.         $this->_descending = $descending;
  97.         
  98.         // Compile comparer function
  99.         //     Check http://www.php.net/manual/nl/function.create-function.php#14322 for this chr(0).'$f' approach...
  100.         $f = substr($this->_expression->getFunctionReference(), 1); 
  101.         $this->_functionReference = new PHPLinq_Function(
  102.                 $defaultName . 'A, ' . $defaultName . 'B',
  103.                 "return $comparer(
  104.                     call_user_func(chr(0).'$f', {$defaultName}A),
  105.                     call_user_func(chr(0).'$f', {$defaultName}B)
  106.                 );"
  107.         );    
  108.     }
  109.     
  110.     /**
  111.      * Execute expression
  112.      * 
  113.      * @param     mixed    $value    Value to use as expression parameter
  114.      * @return     mixed            Expression result
  115.      */
  116.     public function execute($value) {
  117.         // Unused...
  118.         return $value;
  119.     }
  120.     
  121.     /**
  122.      * Get default name
  123.      *
  124.      * @return string 
  125.      */
  126.     public function getDefaultName() {
  127.         return $this->_defaultName;
  128.     }
  129.     
  130.     /**
  131.      * Get function
  132.      *
  133.      * @return PHPLinq_Function 
  134.      */
  135.     public function getFunction() {
  136.         return $this->_functionReference;
  137.     }
  138.     
  139.     /**
  140.      * Get function reference
  141.      *
  142.      * @return mixed 
  143.      */
  144.     public function getFunctionReference() {
  145.         return $this->_functionReference->getFunctionReference();
  146.     }
  147.     
  148.     /**
  149.      * Get expression
  150.      *
  151.      * @return PHPLinq_Expression 
  152.      */
  153.     public function getExpression() {
  154.         return $this->_expression;
  155.     }
  156.     
  157.     /**
  158.      * Descending?
  159.      *
  160.      * @return boolean 
  161.      */
  162.     public function isDescending() {
  163.         return $this->_descending;
  164.     }
  165. }
Documentation generated on Tue, 27 Jan 2009 08:29:37 +0100 by phpDocumentor 1.4.1