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

Source for file Initiator.php

Documentation is available at Initiator.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 */
  30. require_once('PHPLinq.php');
  31.  
  32. /** PHPLinq_ILinqProvider */
  33. require_once('PHPLinq/ILinqProvider.php');
  34.  
  35.  
  36. /**
  37.  * PHPLinq_Initiator
  38.  *
  39.  * @category   PHPLinq
  40.  * @package    PHPLinq
  41.  * @copyright  Copyright (c) 2008 - 2009 PHPLinq (http://www.codeplex.com/PHPLinq)
  42.  */
  43. class PHPLinq_Initiator {
  44.     /**
  45.      * Registered PHPLinq_ILinqProvider classes
  46.      *
  47.      * @var string[] 
  48.      */
  49.     private static $_registeredProviders = array();
  50.     
  51.     /**
  52.      * Register PHPLinq_ILinqProvider class
  53.      *
  54.      * @param string $class Class name implementing PHPLinq_ILinqProvider
  55.      * @param string $reference Path reference (for inclusion)
  56.      */
  57.     public static function registerProvider($class = null, $reference = null) {
  58.         if (!is_null($class) && $class != '') {
  59.             // Require code
  60.             if (is_null($reference) || $reference == '') {
  61.                 $reference = str_replace('_', '/', $class);
  62.                 $reference .= '.php';
  63.             }
  64.             require_once($reference);
  65.             
  66.             // Add registered PHPLinq_ILinqProvider
  67.             self::$_registeredProviders[] = $class;
  68.         }
  69.     }
  70.     
  71.     /**
  72.      * Default variable name
  73.      *
  74.      * @var string 
  75.      */
  76.     private $_from = '';
  77.     
  78.     /**
  79.      * Parent PHPLinq_ILinqProvider instance, used with join conditions
  80.      *
  81.      * @var PHPLinq_ILinqProvider 
  82.      */
  83.     private $_parentProvider = null;
  84.     
  85.     /**
  86.      * Create a new class instance
  87.      *
  88.      * @param string $name 
  89.      * @param PHPLinq_ILinqProvider $parentProvider Optional parent PHPLinq_ILinqProvider instance, used with join conditions
  90.      * @return PHPLinq_Initiator 
  91.      */
  92.     public function __construct($name, PHPLinq_ILinqProvider $parentProvider = null) {
  93.         $this->_from = $name;
  94.         $this->_parentProvider = $parentProvider;
  95.         return $this;
  96.     }
  97.     
  98.     /**
  99.      * Set source of data
  100.      *
  101.      * @param mixed $source 
  102.      * @return PHPLinq_ILinqProvider 
  103.      */
  104.     public function in($source) {
  105.         // Search correct provider
  106.         foreach (self::$_registeredProviders as $provider) {
  107.             if (call_user_func(array($provider, 'handles'), $source)) {
  108.                 $returnValue = new $provider($this->_from, $this->_parentProvider);
  109.                 return $returnValue->in($source);
  110.             }
  111.         }
  112.         
  113.         // No provider found...
  114.         throw new PHPLinq_Exception("No valid PHPLinq_ILinqProvider found for the specified data source.");
  115.     }
  116. }
Documentation generated on Tue, 27 Jan 2009 08:29:25 +0100 by phpDocumentor 1.4.1