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


Tutorials/Manuals:
Package-level: Files:
ABSTDatabaseHost.class.php
ABSTDatabaseTable.class.php
ABSTView.class.php
Database.class.php
Join.class.php

subpackage mysql
MySQLDatabase.class.php
MySQLDatabaseHost.class.php
MySQLDatabaseTable.class.php
MySQLView.class.php
MySQL_constants.inc.php

Classes:
ABSTDatabaseHost
ABSTDatabaseTable
ABSTView
Database
Join
mysql
   MySQLDatabase
   MySQLDatabaseHost
   MySQLDatabaseTable
   MySQLView

Class: ABSTDatabaseHost

Source Location: /databases/ABSTDatabaseHost.class.php

Class Overview








Author(s):






        
          
          

Version:


    
  
  • 0.1.44
    • 




Copyright:


    
  
  • Copyright (C) 2004 Daniel Plücken <daniel@debakel.net>
    This library is free software; you can redistribute it and/or  modify it under the terms of the GNU Lesser General Public  License as published by the Free Software Foundation; either  version 2.1 of the License.
    This library is distributed in the hope that it will be useful,  but WITHOUT ANY WARRANTY; without even the implied warranty of  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the  GNU Lesser General Public License for more details.
    You should have received a copy of the GNU Lesser General  Public License along with this library; if not, write to the  Free Software Foundation, Inc., 59 Temple Place, Suite 330,  Boston, MA 02111-1307 USA
    • 


        




Variables







Methods















Child classes:






MySQLDatabaseHost

	

















Class Details



[line 50]





Tags:





  

    author:  Daniel Plücken <daniel@debakel.net>
  

  

    version:  0.1.44
  

  

    copyright:  
Copyright (C) 2004 Daniel Plücken <daniel@debakel.net>
This library is free software; you can redistribute it and/or  modify it under the terms of the GNU Lesser General Public  License as published by the Free Software Foundation; either  version 2.1 of the License.
This library is distributed in the hope that it will be useful,  but WITHOUT ANY WARRANTY; without even the implied warranty of  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the  GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General  Public License along with this library; if not, write to the  Free Software Foundation, Inc., 59 Temple Place, Suite 330,  Boston, MA 02111-1307 USA

  

  

    abstract:  
  

  

    license:  GNU Lesser General Public License
  










[ Top ]







Class Variables



	
	

	
$db = 

	
[line 86]

  Carries the references to objects of databases.





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$error_callback =  null

	
[line 106]

  Carries the name of a function which has to be invoked on a connection  error.





Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      function
    

      

	



	
[ Top ]


	
	

	
$is_connected =  false

	
[line 98]

  The connection's state of the databasehost.





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$name = 

	
[line 58]

  The Name of the databasehost.





Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$password = 

	
[line 79]

  The password to log on the database server.





Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$port = 

	
[line 65]

  The connection's port.





Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
$resID = 

	
[line 91]

  



Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      object
    

      

	



	
[ Top ]


	
	

	
$user = 

	
[line 72]

  The username to log on the database server.





Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]










Class Methods




  

	
	
constructor ABSTDatabaseHost [line 118]

	

    

    

		ABSTDatabaseHost ABSTDatabaseHost(
)
    

    


	
		Fake-Constructor





Tags:





  

    author:  Daniel Plücken <daniel@debakel.net>
  

  

    version:  1.0
  

  

    since:  0.1.3
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method addDB [line 257]

	

    

    

		void addDB(

&$db_obj, object
$dbt_obj)
    

    


	
		Adds a database's reference to this object of a database host.





Tags:





  

    author:  Daniel Plücken <daniel@debakel.net>
  

  

    version:  1.1
  

  

    since:  0.1.0
  

  

    access:  public
  









	
Overridden in child classes as:

		

	
MySQLDatabaseHost::addDB()

		
Adds a databasetable's reference to this object of a database.

	

	

	
        
Parameters:

    

    

          

        object  
        $dbt_obj  
        
      

          

          
        &$db_obj  
        
      

        

    


        
[ Top ]

  

  

	
	
method getHost [line 300]

	

    

    

		string getHost(
)
    

    


	
		Returns the hostname.





Tags:





  

    author:  Daniel Plücken <daniel@debakel.net>
  

  

    version:  1.0
  

  

    since:  0.1.0
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getName [line 314]

	

    

    

		string getName(
)
    

    


	
		Returns the hostname. This method is an alias of the method getHost().





Tags:





  

    author:  Daniel Plücken <daniel@debakel.net>
  

  

    version:  1.0
  

  

    since:  0.1.0
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getPassword [line 356]

	

    

    

		string getPassword(
)
    

    


	
		Returns the given password which should be usedto connect to the host.





Tags:





  

    version:  1.0
  

  

    since:  0.1.0
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getPort [line 328]

	

    

    

		int getPort(
)
    

    


	
		Returns the specified port to use to connect to the host.





Tags:





  

    author:  Daniel Plücken <daniel@debakel.net>
  

  

    version:  1.0
  

  

    since:  0.1.0
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getResourceID [line 370]

	

    

    

		object &getResourceID(
)
    

    


	
		Returns the id of the connection resource to the database host.





Tags:





  

    version:  1.0
  

  

    since:  0.1.44
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getUser [line 342]

	

    

    

		string getUser(
)
    

    


	
		Returns the specified user who should connect with to the host.





Tags:





  

    author:  Daniel Plücken <daniel@debakel.net>
  

  

    version:  1.0
  

  

    since:  0.1.0
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method setConnectionErrorCallback [line 167]

	

    

    

		void setConnectionErrorCallback(
string
$function_name_str)
    

    


	
		Sets the name of the function that should be invoked on a connection error.

The function to call back has to have two parameter. The first parameter is  for the error code. The second one contains the errordescription.





Tags:





  

    author:  Daniel Plücken <daniel@debakel.net>
  

  

    version:  1.0
  

  

    since:  0.1.43
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $function_name_str  
        
      

        

    


        
[ Top ]

  

  

	
	
method setHost [line 182]

	

    

    

		void setHost(
string
$string)
    

    


	
		Sets the hostname.





Tags:





  

    author:  Daniel Plücken <daniel@debakel.net>
  

  

    version:  1.0
  

  

    since:  0.1.0
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $string  
        
      

        

    


        
[ Top ]

  

  

	
	
method setName [line 197]

	

    

    

		void setName(
string
$string)
    

    


	
		Sets the hostname. This method is an alias of the method setHost( $string ).





Tags:





  

    author:  Daniel Plücken <daniel@debakel.net>
  

  

    version:  1.0
  

  

    since:  0.1.0
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $string  
        
      

        

    


        
[ Top ]

  

  

	
	
method setPassword [line 242]

	

    

    

		void setPassword(
string
$string)
    

    


	
		Sets the password that should be used to connect to the host.





Tags:





  

    author:  Daniel Plücken <daniel@debakel.net>
  

  

    version:  1.0
  

  

    since:  0.1.0
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $string  
        
      

        

    


        
[ Top ]

  

  

	
	
method setPort [line 212]

	

    

    

		void setPort(
int
$int)
    

    


	
		Specifies the port that should be used to connect to the host.





Tags:





  

    author:  Daniel Plücken <daniel@debakel.net>
  

  

    version:  1.0
  

  

    since:  0.1.0
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $int  
        
      

        

    


        
[ Top ]

  

  

	
	
method setUser [line 227]

	

    

    

		void setUser(
string
$string)
    

    


	
		Specifies the user who should connect with to the host.





Tags:





  

    author:  Daniel Plücken <daniel@debakel.net>
  

  

    version:  1.0
  

  

    since:  0.1.0
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $string  
        
      

        

    


        
[ Top ]

  

  

	
	
method __constructor [line 140]

	

    

    

		void __constructor(
[string
$host = "localhost"], [string
$user = ""], [string
$password = ""], [string
$port = ""])
    

    


	
		Constructor.

All parameter are optional.





Tags:





  

    author:  Daniel Plücken <daniel@debakel.net>
  

  

    version:  1.0
  

  

    since:  0.1.3
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $host  
        The host on which the database server runs.
      

          

        string  
        $user  
        The user to log on the database host.
      

          

        string  
        $password  
        The password to log on the database host.
      

          

        string  
        $port  
        The port on which should be the communication.
      

        

    


        
[ Top ]

  






        

		    

		    Documentation generated on Thu, 05 Jun 2008 19:09:38 +0200 by phpDocumentor 1.4.1