common.datasource
[ class tree: common.datasource ] [ index: common.datasource ] [ all elements ]
Packages:
default
common.cache
common.container
common.controller.flow
common.datasource
common.datastructure
common.helper.dsn
common.logger
common.logger.appender
common.logger.layout
common.reader
common.storage
common.validator
Mojavi
mvc.controller
package.loader


Files:
Datasource.class.php

Classes:
Datasource

Class: Datasource

Source Location: /datasource/Datasource.class.php

Class Overview




Base Datasource class




Author(s):


    
                      
  • Tyler Tompkins (ttompkins@mojavi.org)
    • 
      





            






Variables







Methods















Child classes:






SqliteDatasource

	
DatabaseDatasource serves as a base for database connections






PdoDatasource

	
PdoDatasource serves as a base for Pdo based database connections






MysqlDatasource

	
DatabaseDatasource serves as a base for database connections






FileDatasource

	
FileDatasource

















Class Details



[line 19]

Base Datasource class





Tags:





  

    abstract:  
  

  

    since:  4.0.0  $Id: Datasource.class.php 925 2005-11-30 22:23:21Z illusina $
  

  

    author:  Tyler Tompkins (ttompkins@mojavi.org)
  










[ Top ]







Class Variables



	
	

	
$contents =  null

	
[line 26]

  
  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$parameters = array()

	
[line 27]

  
  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$resource =  null

	
[line 25]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]










Class Methods



  

	
	
method close [line 39]

	

    

    

		bool close(
)
    

    


	
		Close the datasource





Tags:





  

    return:  True on success, false otherwise
  

  

    access:  public
  

  

    abstract:  
  

  

    since:  4.0.0
  

  

    author:  Tyler Tompkins (ttompkins@mojavi.org)
  









	
Overridden in child classes as:

		

	
SqliteDatasource::close()

		
Close the datasource

	

		

	
PdoDatasource::close()

		
Close the datasource

	

		

	
MysqlDatasource::close()

		
Close the datasource

	

		

	
FileDatasource::close()

		
Close the datasource

	

	


        
[ Top ]

  

  

	
	
method getContents [line 63]

	

    

    

		mixed &getContents(
)
    

    


	
		Retrieve the contents of the datasource





Tags:





  

    return:  String contents on success, false otherwise
  

  

    access:  public
  

  

    abstract:  
  

  

    since:  4.0.0
  

  

    author:  Tyler Tompkins (ttompkins@mojavi.org)
  









	
Overridden in child classes as:

		

	
SqliteDatasource::getContents()

		
Retrieve the contents of the datasource

	

		

	
PdoDatasource::getContents()

		
Retrieve the contents of the datasource

	

		

	
MysqlDatasource::getContents()

		
Retrieve the contents of the datasource

	

		

	
FileDatasource::getContents()

		
Retrieve the contents of the datasource

	

	


        
[ Top ]

  

  

	
	
method getParameters [line 108]

	

    

    

		array &getParameters(
)
    

    


	
		Retrieve the parameters that were used to initialize the datasource





Tags:





  

    return:  Initialization parameters
  

  

    access:  public
  

  

    abstract:  
  

  

    since:  4.0.0
  

  

    author:  Tyler Tompkins (ttompkins@mojavi.org)
  









	
Overridden in child classes as:

		

	
SqliteDatasource::getParameters()

		
Retrieve the parameters that were used to initialize the datasource

	

		

	
PdoDatasource::getParameters()

		
Retrieve the parameters that were used to initialize the datasource

	

		

	
MysqlDatasource::getParameters()

		
Retrieve the parameters that were used to initialize the datasource

	

		

	
FileDatasource::getParameters()

		
Retrieve the parameters that were used to initialize the datasource

	

	


        
[ Top ]

  

  

	
	
method getResource [line 51]

	

    

    

		mixed &getResource(
)
    

    


	
		Retrieve the datasource resource or link





Tags:





  

    return:  Resource contents on success, false otherwise
  

  

    access:  public
  

  

    abstract:  
  

  

    since:  4.0.0
  

  

    author:  Tyler Tompkins (ttompkins@mojavi.org)
  









	
Overridden in child classes as:

		

	
SqliteDatasource::getResource()

		
Retrieve the datasource resource or link

	

		

	
PdoDatasource::getResource()

		
Retrieve the datasource resource or link

	

		

	
MysqlDatasource::getResource()

		
Retrieve the datasource resource or link

	

		

	
FileDatasource::getResource()

		
Retrieve the datasource resource or link

	

	


        
[ Top ]

  

  

	
	
method isOpen [line 75]

	

    

    

		bool isOpen(
)
    

    


	
		Determine if the datasource is open or not





Tags:





  

    return:  True on open, false otherwise
  

  

    access:  public
  

  

    since:  4.0.0
  

  

    author:  Tyler Tompkins (ttompkins@mojavi.org)
  










        
[ Top ]

  

  

	
	
method open [line 96]

	

    

    

		bool open(
[array
&$parameters = array()])
    

    


	
		Open the datasource





Tags:





  

    return:  True on success
  

  

    access:  public
  

  

    abstract:  
  

  

    since:  4.0.0
  

  

    author:  Tyler Tompkins (ttompkins@mojavi.org)
  

  

    throws:  InitializationException if opening fails
  









	
Overridden in child classes as:

		

	
SqliteDatasource::open()

		
Open the datasource

	

		

	
PdoDatasource::open()

		
Open the datasource

	

		

	
MysqlDatasource::open()

		
Open the datasource

	

		

	
FileDatasource::open()

		
Open the datasource

	

	


        
Parameters:

    

    

          

        array  
        &$parameters  
        Parameters array
      

        

    


        
[ Top ]

  






        

		    

		    Documentation generated on Tue, 21 Feb 2006 02:29:42 +0900 by phpDocumentor 1.3.0RC5