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: ABSTView

Source Location: /databases/ABSTView.class.php

Class Overview








Author(s):






        
          
      

Version:


    
  
  • 0.1.53
    • 




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:






MySQLView

	

















Class Details



[line 39]





Tags:





  

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

  

    version:  0.1.53
  

  

    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

  

  

    license:  GNU Lesser General Public License
  










[ Top ]







Class Variables



	
	

	
$custom_field_arr = array()

	
[line 68]

  This stores the additionally fields for the result list of the query.





Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$error_callback =  null

	
[line 76]

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





Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      function
    

      

	



	
[ Top ]


	
	

	
$join = 

	
[line 54]

  Array for carrying the joins included in this view.





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$last_query =  "&lt;empty&gt;"

	
[line 61]

  The last stored databasequery.





Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$name = 

	
[line 47]

  The name of this view.





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]










Class Methods




  

	
	
constructor ABSTView [line 88]

	

    

    

		ABSTView ABSTView(
)
    

    


	
		Fake-Constructor





Tags:





  

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

  

    version:  1.0
  

  

    since:  0.1.3
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method addCustomField [line 199]

	

    

    

		void addCustomField(
string
$string)
    

    


	
		This can be use to add a field to the definition of the result list of the  query.





Tags:





  

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

  

    version:  1.0
  

  

    since:  0.1.5
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $string  
        
      

        

    


        
[ Top ]

  

  

	
	
method addJoin [line 214]

	

    

    

		void addJoin(

&$obj_ref, Join
$obj_ref)
    

    


	
		Adds a join's reference to this view's object.





Tags:





  

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

  

    version:  1.0
  

  

    since:  0.1.2
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        Join  
        $obj_ref  
        return   void
      

          

          
        &$obj_ref  
        
      

        

    


        
[ Top ]

  

  

	
	
method getDatasetsWithFields [line 245]

	

    

    

		array getDatasetsWithFields(
[array
$fields = ""], [string
$where = ""])
    

    


	
		Returns the datasets as an two dimensional array if the query could be  execute. The first dimension carries the datasets. The second dimension  carries the fields's values of the result list.

Usage:           getDatasetsWithFields( $fieldnamesArr, $where );





Tags:





  

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

  

    version:  1.0
  

  

    since:  0.1.4
  

  

    access:  public
  









	
Overridden in child classes as:

		

	
MySQLView::getDatasetsWithFields()

		
Returns the datasets as an two dimensional array if the query could be  execute. The first dimension carries the datasets. The second dimension  carries the fields's values of the result list.

	

	

	
        
Parameters:

    

    

          

        array  
        $fields  
        Is a blind parameter whithout any funktion.
      

          

        string  
        $where  
        The where clause of the query.
      

        

    


        
[ Top ]

  

  

	
	
method getLastQuery [line 163]

	

    

    

		string getLastQuery(
)
    

    


	
		Returns the last stored database query.





Tags:





  

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

  

    version:  1.0
  

  

    since:  0.1.2
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getName [line 149]

	

    

    

		string getName(
)
    

    


	
		Returns the name of this view.





Tags:





  

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

  

    version:  1.0
  

  

    since:  0.1.0
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getResourceID [line 259]

	

    

    

		object &getResourceID(
)
    

    


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





Tags:





  

    version:  1.0
  

  

    since:  0.1.53
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method setCustomFields [line 178]

	

    

    

		void setCustomFields(
array
$array)
    

    


	
		Sets additionally fields to the definition of the result list of the query.





Tags:





  

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

  

    version:  1.0
  

  

    since:  0.1.5
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        array  
        $array  
        
      

        

    


        
[ Top ]

  

  

	
	
method setErrorCallback [line 109]

	

    

    

		void setErrorCallback(
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.52
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $function_name_str  
        
      

        

    


        
[ Top ]

  

  

	
	
method __constructor [line 124]

	

    

    

		ABSTView __constructor(
string
$name)
    

    


	
		Constructor





Tags:





  

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

  

    version:  1.0
  

  

    since:  0.1.0
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $name  
        
      

        

    


        
[ Top ]

  






        

		    

		    Documentation generated on Thu, 05 Jun 2008 19:10:03 +0200 by phpDocumentor 1.4.1