Source for file Source.php

Documentation is available at Source.php

  1. <?php
  2. /**
  3.  * This file contains the class XML_Query2XML_Data_Source.
  4.  *
  5.  * PHP version 5
  6.  *
  7.  * @category  XML
  8.  * @package   XML_Query2XML
  9.  * @author    Lukas Feiler <lukas.feiler@lukasfeiler.com>
  10.  * @copyright 2009 Lukas Feiler
  11.  * @license   http://www.gnu.org/copyleft/lesser.html  LGPL Version 2.1
  12.  * @version   CVS: $Id: Source.php 309898 2011-04-02 17:38:08Z lukasfeiler $
  13.  * @link      http://pear.php.net/package/XML_Query2XML
  14.  */
  15.  
  16. /**
  17.  * XML_Query2XML_Data_Source extends XML_Query2XML_Data.
  18.  */
  19. require_once 'XML/Query2XML/Data.php';
  20.  
  21. /**
  22.  * Abstract class extended by all Data Source Classes.
  23.  *
  24.  * @category  XML
  25.  * @package   XML_Query2XML
  26.  * @author    Lukas Feiler <lukas.feiler@lukasfeiler.com>
  27.  * @copyright 2009 Lukas Feiler
  28.  * @license   http://www.gnu.org/copyleft/lesser.html  LGPL Version 2.1
  29.  * @version   Release: 1.7.2
  30.  * @link      http://pear.php.net/package/XML_Query2XML
  31.  * @since     Release 1.7.1RC1
  32.  */
  33. abstract class XML_Query2XML_Data_Source extends XML_Query2XML_Data
  34. {
  35.     /**
  36.      * Returns the first pre-processor.
  37.      *
  38.      * As this is a Data Source Class, it has no pre-processors.
  39.      * Therefore $this will be returned.
  40.      *
  41.      * @return XML_Query2XML_Data_Source $this
  42.      */
  43.     public final function getFirstPreProcessor()
  44.     {
  45.         return $this;
  46.     }
  47.     
  48.     /**
  49.      * Replaces every occurence of an asterisk ('*') in the data source
  50.      * specification.
  51.      *
  52.      * @param string $columnName The name of the column that is to replace
  53.      *                            all occurences of '*'.`
  54.      *
  55.      * @return void 
  56.      */
  57.     public abstract function replaceAsterisks($columnName);
  58. }
  59. ?>

Documentation generated on Sun, 03 Apr 2011 13:13:11 +0200 by phpDocumentor 1.4.1