databases
[ class tree: databases ] [ index: databases ] [ all elements ]
Packages:
core
communication
databases
data_structures
filesystem
forms
GilliGan
html
Services_JSON

Source for file ABSTDatabaseHost.class.php

Documentation is available at ABSTDatabaseHost.class.php

  1. <?php
  2. /**
  3.  * For including this file you have to define the constant "CLASSPATH".
  4.  * Because every include in the framework depends on the CLASSPATH definition.
  5.  * The CLASSPATH means the relative path to the folder that contains the
  6.  * framework GilliGan.
  7.  *
  8.  * @package databases
  9.  */
  10. if( !defined( "CLASSPATH" ) )
  11. {
  12.   echo "<h3>You have to define the constant CLASSPATH!</h3>\r\n";
  13.   echo "Example: define( 'CLASSPATH', '../path/to/classes/' );\r\n";
  14.   exit();
  15. }
  16.  
  17. /**
  18.  *
  19.  */
  20. require_once( CLASSPATH."settings.inc.php" );
  21. /**
  22.  *
  23.  */
  24. require_once( CLASSPATH."DebuggingSettings.inc.php" );
  25.  
  26. /**
  27.  * @abstract
  28.  * @package   databases
  29.  * @version   0.1.44
  30.  * @author    Daniel Plücken <daniel@debakel.net>
  31.  * @license   http://www.gnu.org/copyleft/lesser.html
  32.  *             GNU Lesser General Public License
  33.  * @copyright Copyright (C) 2004 Daniel Plücken <daniel@debakel.net>
  34.  *
  35.  *  This library is free software; you can redistribute it and/or
  36.  *  modify it under the terms of the GNU Lesser General Public
  37.  *  License as published by the Free Software Foundation; either
  38.  *  version 2.1 of the License.
  39.  *
  40.  *  This library is distributed in the hope that it will be useful,
  41.  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  42.  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  43.  *  GNU Lesser General Public License for more details.
  44.  *
  45.  *  You should have received a copy of the GNU Lesser General
  46.  *  Public License along with this library; if not, write to the
  47.  *  Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  48.  *  Boston, MA 02111-1307 USA
  49.  */
  50. class ABSTDatabaseHost
  51. {
  52.   /**
  53.    * The Name of the databasehost.
  54.    *
  55.    * @var    string $name 
  56.    * @access public
  57.    */
  58.   var $name;
  59.   /**
  60.    * The connection's port.
  61.    *
  62.    * @var    int    $port 
  63.    * @access public
  64.    */
  65.   var $port;
  66.   /**
  67.    * The username to log on the database server.
  68.    *
  69.    * @var    string $user 
  70.    * @access public
  71.    */
  72.   var $user;
  73.   /**
  74.    * The password to log on the database server.
  75.    *
  76.    * @var    string $password 
  77.    * @access public
  78.    */
  79.   var $password;
  80.   /**
  81.    * Carries the references to objects of databases.
  82.    *
  83.    * @var    array   $db 
  84.    * @access private
  85.    */
  86.   var $db;
  87.   /**
  88.    * @var    object $resID 
  89.    * @access public
  90.    */
  91.   var $resID;
  92.   /**
  93.    * The connection's state of the databasehost.
  94.    *
  95.    * @var    boolean $is_connected 
  96.    * @access private
  97.    */
  98.   var $is_connected = false;
  99.   /**
  100.    * Carries the name of a function which has to be invoked on a connection
  101.    * error.
  102.    *
  103.    * @access public
  104.    * @var    function $error_callback 
  105.    */
  106.   var $error_callback = null;
  107.  
  108.  
  109.  
  110.    /**
  111.     * Fake-Constructor
  112.     *
  113.     * @version 1.0
  114.     * @since   0.1.3
  115.     * @author  Daniel Plücken <daniel@debakel.net>
  116.     * @access  public
  117.     */
  118.   function ABSTDatabaseHost()
  119.   {
  120.     echo "<h3>This is an abstract class. "
  121.             ."You cannot get an instance of it!</h3>";
  122.     exit();
  123.   }
  124.  
  125.  
  126.  
  127.    /**
  128.     * Constructor.
  129.     * All parameter are optional.
  130.     *
  131.     * @version 1.0
  132.     * @since   0.1.3
  133.     * @author  Daniel Plücken <daniel@debakel.net>
  134.     * @access  public
  135.     * @param   string  $host     The host on which the database server runs.
  136.     * @param   string  $user     The user to log on the database host.
  137.     * @param   string  $password The password to log on the database host.
  138.     * @param   string  $port     The port on which should be the communication.
  139.     */
  140.   function __constructor(
  141.                            $host     = "localhost",
  142.                            $user     = "",
  143.                            $password = "",
  144.                            $port     = ""
  145.                         )
  146.   {
  147.     $this->name     = $host;
  148.     $this->user     = $user;
  149.     $this->password = $password;
  150.     $this->port     = $port;
  151.   }
  152.  
  153.  
  154.  
  155.   /**
  156.    * Sets the name of the function that should be invoked on a connection error.
  157.    * The function to call back has to have two parameter. The first parameter is
  158.    * for the error code. The second one contains the errordescription.
  159.    *
  160.    * @version 1.0
  161.    * @since   0.1.43
  162.    * @author  Daniel Plücken <daniel@debakel.net>
  163.    * @access  public
  164.    * @param   string $function_name_str 
  165.    * @return  void 
  166.    */
  167.   function setConnectionErrorCallback( $function_name_str )
  168.   { $this->error_callback = $function_name_str; }
  169.  
  170.  
  171.  
  172.   /**
  173.    * Sets the hostname.
  174.    *
  175.    * @version 1.0
  176.    * @since   0.1.0
  177.    * @author  Daniel Plücken <daniel@debakel.net>
  178.    * @access  public
  179.    * @param   string 
  180.    * @return  void 
  181.    */
  182.   function setHost( $string )
  183.   { $this->name = $string; }
  184.  
  185.  
  186.  
  187.   /**
  188.    * Sets the hostname. This method is an alias of the method setHost( $string ).
  189.    *
  190.    * @version 1.0
  191.    * @since   0.1.0
  192.    * @author  Daniel Plücken <daniel@debakel.net>
  193.    * @access  public
  194.    * @param   string $string 
  195.    * @return  void 
  196.    */
  197.   function setName( $string )
  198.   { $this->name = $string; }
  199.  
  200.  
  201.  
  202.   /**
  203.    * Specifies the port that should be used to connect to the host.
  204.    *
  205.    * @version 1.0
  206.    * @since   0.1.0
  207.    * @author  Daniel Plücken <daniel@debakel.net>
  208.    * @access  public
  209.    * @param   int    $int 
  210.    * @return  void 
  211.    */
  212.   function setPort( $int )
  213.   { $this->port = $int; }
  214.  
  215.  
  216.  
  217.   /**
  218.    * Specifies the user who should connect with to the host.
  219.    *
  220.    * @version 1.0
  221.    * @since   0.1.0
  222.    * @author  Daniel Plücken <daniel@debakel.net>
  223.    * @access  public
  224.    * @param   string $string 
  225.    * @return  void 
  226.    */
  227.   function setUser( $string )
  228.   {  $this->user = $string; }
  229.  
  230.  
  231.  
  232.   /**
  233.    * Sets the password that should be used to connect to the host.
  234.    *
  235.    * @version 1.0
  236.    * @since   0.1.0
  237.    * @author  Daniel Plücken <daniel@debakel.net>
  238.    * @access  public
  239.    * @param   string $string 
  240.    * @return  void 
  241.    */
  242.   function setPassword( $string )
  243.   {  $this->password = $string; }
  244.  
  245.  
  246.  
  247.   /**
  248.    * Adds a database's reference to this object of a database host.
  249.    *
  250.    * @version 1.1
  251.    * @since   0.1.0
  252.    * @author  Daniel Plücken <daniel@debakel.net>
  253.    * @access  public
  254.    * @param   object  $dbt_obj 
  255.    * @return  void 
  256.    */
  257.   function addDB( &$db_obj )
  258.   {
  259.     if(
  260.         !function_exists( "is_a" )
  261.      && (
  262.           get_class( $db_obj ) == "database"
  263.        || get_parent_class( $db_obj ) == "database"
  264.         )
  265.       )
  266.     {
  267.       $db_obj->setParent( $this );
  268.       $this->db[] = &$db_obj;
  269.     }
  270.     else
  271.     if(
  272.         function_exists( "is_a" )
  273.      && (
  274.           is_a( $db_obj, "Database" )
  275.        || is_subclass_of( $db_obj, "database" )
  276.         )
  277.       )
  278.     {
  279.       $db_obj->setParent( $this );
  280.       $this->db[] = &$db_obj;
  281.     }
  282.     else
  283.       die(
  284.            "<h3>The parameter does not refer to "
  285.               ."a valid object of a database!</h3>"
  286.          );
  287.   }
  288.  
  289.  
  290.  
  291.   /**
  292.    * Returns the hostname.
  293.    *
  294.    * @version 1.0
  295.    * @since   0.1.0
  296.    * @author  Daniel Plücken <daniel@debakel.net>
  297.    * @access  public
  298.    * @return  string 
  299.    */
  300.   function getHost()
  301.   { return $this->name; }
  302.  
  303.  
  304.  
  305.   /**
  306.    * Returns the hostname. This method is an alias of the method getHost().
  307.    *
  308.    * @version 1.0
  309.    * @since   0.1.0
  310.    * @author  Daniel Plücken <daniel@debakel.net>
  311.    * @access  public
  312.    * @return  string 
  313.    */
  314.   function getName()
  315.   { return $this->name; }
  316.  
  317.  
  318.  
  319.   /**
  320.    * Returns the specified port to use to connect to the host.
  321.    *
  322.    * @version 1.0
  323.    * @since   0.1.0
  324.    * @author  Daniel Plücken <daniel@debakel.net>
  325.    * @access  public
  326.    * @return  int 
  327.    */
  328.   function getPort()
  329.   { return $this->port; }
  330.  
  331.  
  332.  
  333.   /**
  334.    * Returns the specified user who should connect with to the host.
  335.    *
  336.    * @version 1.0
  337.    * @since   0.1.0
  338.    * @author  Daniel Plücken <daniel@debakel.net>
  339.    * @access  public
  340.    * @return  string 
  341.    */
  342.   function getUser()
  343.   { return $this->user; }
  344.  
  345.  
  346.  
  347.   /**
  348.    * Returns the given password which should be usedto connect to the host.
  349.    *
  350.    * @access  public
  351.    * @version 1.0
  352.    * @since   0.1.0
  353.    *
  354.    * @return  string 
  355.    */
  356.   function getPassword()
  357.   { return $this->password; }
  358.  
  359.  
  360.  
  361.   /**
  362.    * Returns the id of the connection resource to the database host.
  363.    *
  364.    * @access  public
  365.    * @version 1.0
  366.    * @since   0.1.44
  367.    *
  368.    * @return object 
  369.    */
  370.   function &getResourceID()
  371.   { return $this->resID; }
  372. } // End of class ABSTDatabaseHost
  373. ?>
Documentation generated on Thu, 05 Jun 2008 19:09:38 +0200 by phpDocumentor 1.4.1