apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]
Packages:
DB_Table
Date


Classes:
DB_Table
   DB_Table_Manager

Class: DB_Table_Manager

Source Location: /DB_Table-1.3.0RC5/DB/Table/Manager.php

Class Overview




Mapping between DB_Table and MDB2 data types.















Methods
















Inherited Variables





Inherited Methods














Class Details



[line 188]

Mapping between DB_Table and MDB2 data types.




[ Top ]








Method Detail



	
	
alter   [line 563]

	

    

    

		bool|object True alter(
object
&$db, string
$table, mixed
$column_set, mixed
$index_set)
    

    


	
		Alter columns and indexes of a table based on DB_Table column and index  arrays.


    

  • Return: if altering was successful or a PEAR_Error on  failure.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        object  
        &$db  
        — 
        A PEAR DB/MDB2 object.
      

          

        string  
        $table  
        — 
        The table name to connect to in the database.
      

          

        mixed  
        $column_set  
        — 
        A DB_Table $this->col array.
      

          

        mixed  
        $index_set  
        — 
        A DB_Table $this->idx array.
      

        

    


        
[ Top ]

  

  
  
	
	
create   [line 213]

	

    

    

		mixed create(
object
&$db, string
$table, mixed
$column_set, mixed
$index_set)
    

    


	
		Create the table based on DB_Table column and index arrays.


    

  • Return: Boolean false if there was no attempt to create the  table, boolean true if the attempt succeeded, and a PEAR_Error if  the attempt failed.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        object  
        &$db  
        — 
        A PEAR DB/MDB2 object.
      

          

        string  
        $table  
        — 
        The table name to connect to in the database.
      

          

        mixed  
        $column_set  
        — 
        A DB_Table $this->col array.
      

          

        mixed  
        $index_set  
        — 
        A DB_Table $this->idx array.
      

        

    


        
[ Top ]

  

  
  
	
	
getDeclare   [line 854]

	

    

    

		string|object A getDeclare(
string
$phptype, string
$coltype, [int
$size = null], [int
$scope = null], [bool
$require = null], [string
$default = null])
    

    


	
		Get the column declaration string for a DB_Table column.


    

  • Return: declaration string on success, or a  PEAR_Error on failure.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $phptype  
        — 
        The DB/MDB2 phptype key.
      

          

        string  
        $coltype  
        — 
        The DB_Table column type.
      

          

        int  
        $size  
        — 
        The size for the column (needed for string and  decimal).
      

          

        int  
        $scope  
        — 
        The scope for the column (needed for decimal).
      

          

        bool  
        $require  
        — 
        True if the column should be NOT NULL, false  allowed to be NULL.
      

          

        string  
        $default  
        — 
        The SQL calculation for a default value.
      

        

    


        
[ Top ]

  

  
  
	
	
getDeclareForIndex   [line 1033]

	

    

    

		string getDeclareForIndex(
string
$phptype, string
$type, string
$idxname, string
$table, mixed
$cols)
    

    


	
		Get the index declaration string for a DB_Table index.


    

  • Return: A declaration string.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $phptype  
        — 
        The DB phptype key.
      

          

        string  
        $type  
        — 
        The index type.
      

          

        string  
        $idxname  
        — 
        The index name.
      

          

        string  
        $table  
        — 
        The table name.
      

          

        mixed  
        $cols  
        — 
        Array with the column names for the index.
      

        

    


        
[ Top ]

  

  
  
	
	
getDeclareMDB2   [line 952]

	

    

    

		string|object A getDeclareMDB2(
string
$coltype, [int
$size = null], [int
$scope = null], [bool
$require = null], [string
$default = null], 
&$max_scope, int
$max_scope)
    

    


	
		Get the column declaration string for a DB_Table column.


    

  • Return: MDB2 column definition array on success, or a  PEAR_Error on failure.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $coltype  
        — 
        The DB_Table column type.
      

          

        int  
        $size  
        — 
        The size for the column (needed for string and  decimal).
      

          

        int  
        $scope  
        — 
        The scope for the column (needed for decimal).
      

          

        bool  
        $require  
        — 
        True if the column should be NOT NULL, false  allowed to be NULL.
      

          

        string  
        $default  
        — 
        The SQL calculation for a default value.
      

          

        int  
        $max_scope  
        — 
        The maximal scope for all table column  (pass-by-reference).
      

          

          
        &$max_scope  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
tableExists   [line 810]

	

    

    

		bool|object True tableExists(
object
&$db, string
$table)
    

    


	
		Check whether a table exists.


    

  • Return: if the table exists, false if not, or a  PEAR_Error on failure.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        object  
        &$db  
        — 
        A PEAR DB/MDB2 object.
      

          

        string  
        $table  
        — 
        The table name that should be checked.
      

        

    


        
[ Top ]

  

  
  
	
	
verify   [line 431]

	

    

    

		mixed verify(
object
&$db, string
$table, mixed
$column_set, mixed
$index_set)
    

    


	
		Verify whether the table and columns exist, whether the columns  have the right type and whether the indexes exist.


    

  • Return: Boolean true if the verification was successful, and a  PEAR_Error if verification failed.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        object  
        &$db  
        — 
        A PEAR DB/MDB2 object.
      

          

        string  
        $table  
        — 
        The table name to connect to in the database.
      

          

        mixed  
        $column_set  
        — 
        A DB_Table $this->col array.
      

          

        mixed  
        $index_set  
        — 
        A DB_Table $this->idx array.
      

        

    


        
[ Top ]

  

  
  



        

		    

		    Documentation generated on Mon, 11 Mar 2019 14:39:29 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright ©  PHP Group 2004.