PhpMyObject
[ class tree: PhpMyObject ] [ index: PhpMyObject ] [ all elements ]
Packages:
PhpMyObject

Source for file PMO_Request.php

Documentation is available at PMO_Request.php

  1. <?php
  2. /**
  3.  * This file contains the PMO_Request interface.
  4.  *
  5.  * This file is part of the PhpMyObject project,
  6.  * an Object-Relational Mapping (ORM) system.
  7.  * 
  8.  * For questions, help, comments, discussion, etc., please join our
  9.  * forum at {@link http://www.developpez.net/forums/forumdisplay.php?f=770}
  10.  * or our mailing list at {@link http://groups.google.com/group/pmo-dev}.
  11.  *
  12.  * PhpMyObject is free software: you can redistribute it and/or modify
  13.  * it under the terms of the GNU General Public License as published by
  14.  * the Free Software Foundation, either version 3 of the License, or
  15.  * (at your option) any later version.
  16.  *
  17.  * This program is distributed in the hope that it will be useful,
  18.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.    See the
  20.  * GNU General Public License for more details.
  21.  *
  22.  * You should have received a copy of the GNU General Public License
  23.  * along with this program.  If not, see {@link http://www.gnu.org/licenses/}.
  24.  *
  25.  * @package        PhpMyObject
  26.  * @subpackage PMO_Core
  27.  * @author        Nicolas Boiteux <nicolas_boiteux@yahoo.fr>
  28.  * @link            http://pmo.developpez.com/
  29.  * @since        PhpMyObject v0.14
  30.  * @version        $Revision: $
  31.  * @copyright    Copyright (C) 2007-2008 Nicolas Boiteux
  32.  * @license        GPLv3 {@link http://www.gnu.org/licenses/gpl}
  33.  * @filesource
  34.  *
  35.  */ 
  36.  
  37. /**
  38.  * This interface defines the methods a class must implement
  39.  * to provide a working SQL request to the {@link PMO_MyController}
  40.  * class
  41.  * 
  42.  * @package        PhpMyObject
  43.  * @subpackage PMO_Core
  44.  * @see            PMO_MyRequest
  45.  */
  46. interface PMO_Request{
  47.  
  48.     /**
  49.      * the implementation must store the passed $field arguments
  50.      * in the {@link PMO_MyRequest::$field} property and return
  51.      * the object itself.
  52.      *
  53.      * @param string $field,... 
  54.      * @return object 
  55.      */
  56.     public function field($field);
  57.  
  58.     /**
  59.      * the implementation must store the passed $from arguments
  60.      * in the {@link PMO_MyRequest::$from} property and return
  61.      * the object itself.
  62.      *
  63.      * @param string $from,... 
  64.      * @return object 
  65.      */
  66.     public function from($from);
  67.     
  68.     /**
  69.      * the implementation must store the passed $where arguments
  70.      * in the {@link PMO_MyRequest::$where} property and return
  71.      * the object itself
  72.      *
  73.      * @param string $where,... 
  74.      * @return object 
  75.      */
  76.     public function where($where);
  77.     
  78.     /**
  79.      * the implementation must store the passed $order arguments
  80.      * in the {@link PMO_MyRequest::$order} property and return
  81.      * the object itself.
  82.      *
  83.      * @param string $order,... 
  84.      * @return object 
  85.      */
  86.     public function order($order);
  87.     
  88.     /**
  89.      * the implementation must store the passed $having arguments
  90.      * in the {@link PMO_MyRequest::$having} array and return
  91.      * the object itself.
  92.      *
  93.      * @param string $having,... 
  94.      * @return object 
  95.      */
  96.     public function having($having);
  97.     
  98.     /**
  99.      * the implementation must store the passed $limit argument
  100.      * in the {@link PMO_MyRequest::$limit} property.
  101.      *
  102.      * @param string|integer$limit 
  103.      * @return object 
  104.      *
  105.      */
  106.     public function limit($limit);
  107.  
  108.     /**
  109.      * the implementation must create the SQL query using
  110.      * the stored values.
  111.      *
  112.      * @see PMO_MyRequest::toString()
  113.      * @return string 
  114.      */
  115.     public function toString();
  116.     
  117.     /**
  118.      * the implementation must reset the object
  119.      */
  120.     public function reset();
  121. }
  122.  
  123. ?>
Documentation generated on Wed, 15 Oct 2008 09:18:07 -0400 by phpDocumentor 1.4.1