MDB2
[ class tree: MDB2 ] [ index: MDB2 ] [ all elements ]
Packages:
MDB2
apidoc


Classes:
MDB2
MDB2_Datatype_xxx
MDB2_Date
MDB2_Driver_Common
MDB2_Driver_Datatype_Common
MDB2_Driver_Function_Common
MDB2_Driver_Manager_Common
MDB2_Driver_Manager_xxx
MDB2_Driver_Reverse_Common
MDB2_Error
MDB2_Extended
MDB2_Iterator
MDB2_LOB
MDB2_Native_xxx
MDB2_Reverse_xxx
MDB2_xxx
MDB2
   MDB2_BufferedIterator
Files:
clitest.php
Common.php
Common.php
Common.php
Common.php
config.php
Console_TestListener.php
Date.php
Driver_Datatype_skeleton.php
Driver_Manager_skeleton.php
Driver_Native_skeleton.php
Driver_Reverse_skeleton.php
Driver_skeleton.php
example.php
Extended.php
HTML_TestListener.php
Iterator.php
LOB.php
MDB2.php
MDB2_api_testcase.php
MDB2_bugs_testcase.php
MDB2_Connect_Test.php
MDB2_function_testcase.php
MDB2_manager_testcase.php
MDB2_native_testcase.php
MDB2_reverse_testcase.php
MDB2_testcase.php
MDB2_usage_testcase.php
test.php
testchoose.php
testUtils.php

Class: MDB2_Driver_Manager_Common

Source Location: /MDB2-2.0.0RC3/MDB2/Driver/Manager/Common.php

Class Overview

MDB2_Module_Common
   |
   --MDB2_Driver_Manager_Common

Base class for the management modules that is extended by each MDB2 driver


Author(s):

Methods

Child classes:

MDB2_Driver_Manager_xxx
MDB2 Xxx driver for the management modules

Inherited Variables

Class: MDB2_Module_Common

MDB2_Module_Common::$db_index

Inherited Methods

Class: MDB2_Module_Common

MDB2_Module_Common::MDB2_Module_Common()
MDB2_Module_Common::getDBInstance()
get the instance of MDB2 associated with the module instance

Class Details

[line 61]
Base class for the management modules that is extended by each MDB2 driver


[ Top ]

Method Detail

alterTable   [line 371]

mixed alterTable( string $name, array $changes, boolean $check)

alter an existing table
  • Return: MDB2_OK on success, a MDB2 error on failure
  • Access: public

Overridden in child classes as:

MDB2_Driver_Manager_xxx::alterTable()
alter an existing table

Parameters:

string   $name   —   name of the table that is intended to be changed.
array   $changes   —   

associative array that contains the details of each type of change that is intended to be performed. The types of changes that are currently supported are defined as follows:

name

New name for the table.

add

Associative array with the names of fields to be added as indexes of the array. The value of each entry of the array should be set to another associative array with the properties of the fields to be added. The properties of the fields should be the same as defined by the Metabase parser.

remove

Associative array with the names of fields to be removed as indexes of the array. Currently the values assigned to each entry are ignored. An empty array should be used for future compatibility.

rename

Associative array with the names of fields to be renamed as indexes of the array. The value of each entry of the array should be set to another associative array with the entry named name with the new field name and the entry named Declaration that is expected to contain the portion of the field declaration already in DBMS specific SQL code as it is used in the CREATE TABLE statement.

change

Associative array with the names of the fields to be changed as indexes of the array. Keep in mind that if it is intended to change either the name of a field and any other properties, the change array entries should have the new names of the fields as array indexes.

The value of each entry of the array should be set to another associative array with the properties of the fields to that are meant to be changed as array entries. These entries should be assigned to the new values of the respective properties. The properties of the fields should be the same as defined by the Metabase parser.

Example array( 'name' => 'userlist', 'add' => array( 'quota' => array( 'type' => 'integer', 'unsigned' => 1 ) ), 'remove' => array( 'file_limit' => array(), 'time_limit' => array() ), 'change' => array( 'name' => array( 'length' => '20', 'definition' => array( 'type' => 'text', 'length' => 20, ), ) ), 'rename' => array( 'sex' => array( 'name' => 'gender', 'definition' => array( 'type' => 'text', 'length' => 1, 'default' => 'M', ), ) ) )
boolean   $check   —   indicates whether the function should just check if the DBMS driver can perform the requested table alterations if the value is true or actually perform them otherwise.

[ Top ]

createConstraint   [line 624]

mixed createConstraint( string $table, string $name, array $definition)

create a constraint on a table
  • Return: MDB2_OK on success, a MDB2 error on failure
  • Access: public

Parameters:

string   $table   —   name of the table on which the constraint is to be created
string   $name   —   name of the constraint to be created
array   $definition   —   

associative array that defines properties of the constraint to be created. Currently, only one property named FIELDS is supported. This property is also an associative with the names of the constraint fields as array constraints. Each entry of this array is set to another type of associative array that specifies properties of the constraint that are specific to each field.

Example array( 'fields' => array( 'user_name' => array(), 'last_login' => array() ) )

[ Top ]

createDatabase   [line 166]

mixed createDatabase( mixed $database, string $name)

create a new database
  • Return: MDB2_OK on success, a MDB2 error on failure
  • Access: public

Overridden in child classes as:

MDB2_Driver_Manager_xxx::createDatabase()
create a new database

Parameters:

string   $name   —   name of the database that should be created

[ Top ]

createIndex   [line 538]

mixed createIndex( string $table, string $name, array $definition)

get the stucture of a field into an array
  • Return: MDB2_OK on success, a MDB2 error on failure
  • Access: public

Overridden in child classes as:

MDB2_Driver_Manager_xxx::createIndex()
get the stucture of a field into an array

Parameters:

string   $table   —   name of the table on which the index is to be created
string   $name   —   name of the index to be created
array   $definition   —   

associative array that defines properties of the index to be created. Currently, only one property named FIELDS is supported. This property is also an associative with the names of the index fields as array indexes. Each entry of this array is set to another type of associative array that specifies properties of the index that are specific to each field.

Currently, only the sorting property is supported. It should be used to define the sorting direction of the index. It may be set to either ascending or descending.

Not all DBMS support index sorting direction configuration. The DBMS drivers of those that do not support it ignore this property. Use the function supports() to determine whether the DBMS driver can manage indexes.

Example array( 'fields' => array( 'user_name' => array( 'sorting' => 'ascending' ), 'last_login' => array() ) )

[ Top ]

createSequence   [line 701]

mixed createSequence( string $seq_name, [string $start = 1])

create sequence
  • Return: MDB2_OK on success, a MDB2 error on failure
  • Access: public

Overridden in child classes as:

MDB2_Driver_Manager_xxx::createSequence()
create sequence

Parameters:

string   $seq_name   —   name of the sequence to be created
string   $start   —   start value of the sequence; default is 1

[ Top ]

createTable   [line 231]

mixed createTable( string $name, array $fields)

create a new table
  • Return: MDB2_OK on success, a MDB2 error on failure
  • Access: public

Overridden in child classes as:

MDB2_Driver_Manager_xxx::createTable()
create a new table

Parameters:

string   $name   —   Name of the database that should be created
array   $fields   —   

Associative array that contains the definition of each field of the new table The indexes of the array entries are the names of the fields of the table an the array entry values are associative arrays like those that are meant to be passed with the field definitions to get[Type]Declaration() functions.

Example array(

'id' => array( 'type' => 'integer', 'unsigned' => 1 'notnull' => 1 'default' => 0 ), 'name' => array( 'type' => 'text', 'length' => 12 ), 'password' => array( 'type' => 'text', 'length' => 12 ) );

[ Top ]

dropConstraint   [line 657]

mixed dropConstraint( string $table, string $name)

drop existing constraint
  • Return: MDB2_OK on success, a MDB2 error on failure
  • Access: public

Parameters:

string   $table   —   name of table that should be used in method
string   $name   —   name of the constraint to be dropped

[ Top ]

dropDatabase   [line 187]

mixed dropDatabase( mixed $database, string $name)

drop an existing database
  • Return: MDB2_OK on success, a MDB2 error on failure
  • Access: public

Overridden in child classes as:

MDB2_Driver_Manager_xxx::dropDatabase()
drop an existing database

Parameters:

string   $name   —   name of the database that should be dropped

[ Top ]

dropIndex   [line 567]

mixed dropIndex( string $table, string $name)

drop existing index
  • Return: MDB2_OK on success, a MDB2 error on failure
  • Access: public

Overridden in child classes as:

MDB2_Driver_Manager_xxx::dropIndex()
drop existing index

Parameters:

string   $table   —   name of table that should be used in method
string   $name   —   name of the index to be dropped

[ Top ]

dropSequence   [line 722]

mixed dropSequence( mixed $name, string $seq_name)

drop existing sequence
  • Return: MDB2_OK on success, a MDB2 error on failure
  • Access: public

Overridden in child classes as:

MDB2_Driver_Manager_xxx::dropSequence()
drop existing sequence

Parameters:

string   $seq_name   —   name of the sequence to be dropped

[ Top ]

dropTable   [line 267]

mixed dropTable( string $name)

drop an existing table
  • Return: MDB2_OK on success, a MDB2 error on failure
  • Access: public

Parameters:

string   $name   —   name of the table that should be dropped

[ Top ]

getFieldDeclarationList   [line 85]

mixed getFieldDeclarationList( string $fields)

get declaration of a number of field in bulk
  • Return: string on success, a MDB2 error on failure
  • Access: public

Parameters:

string   $fields   —   

a multidimensional associative array. The first dimension determines the field name, while the second dimension is keyed with the name of the properties of the field being declared as array indexes. Currently, the types of supported field properties are as follows:

default Boolean value to be used as default for this field.

notnull Boolean flag that indicates whether this field is constrained to not be set to null.

[ Top ]

listDatabases   [line 391]

mixed listDatabases( )

list all databases
  • Return: data array on success, a MDB2 error on failure
  • Access: public

Overridden in child classes as:

MDB2_Driver_Manager_xxx::listDatabases()
list all databases

[ Top ]

listFunctions   [line 451]

mixed listFunctions( )

list all functions in the current database
  • Return: data array on success, a MDB2 error on failure
  • Access: public

[ Top ]

listSequences   [line 742]

mixed listSequences( )

list all sequences in the current database
  • Return: data array on success, a MDB2 error on failure
  • Access: public

Overridden in child classes as:

MDB2_Driver_Manager_xxx::listSequences()
list all sequences in the current database

[ Top ]

listTableConstraints   [line 679]

mixed listTableConstraints( string $table)

list all sonstraints in a table
  • Return: data array on success, a MDB2 error on failure
  • Access: public

Parameters:

string   $table   —   name of table that should be used in method

[ Top ]

listTableFields   [line 492]

mixed listTableFields( string $table)

list all fields in a tables in the current database
  • Return: data array on success, a MDB2 error on failure
  • Access: public

Overridden in child classes as:

MDB2_Driver_Manager_xxx::listTableFields()
list all fields in a tables in the current database

Parameters:

string   $table   —   name of table that should be used in method

[ Top ]

listTableIndexes   [line 588]

mixed listTableIndexes( string $table)

list all indexes in a table
  • Return: data array on success, a MDB2 error on failure
  • Access: public

Overridden in child classes as:

MDB2_Driver_Manager_xxx::listTableIndexes()
list all indexes in a table

Parameters:

string   $table   —   name of table that should be used in method

[ Top ]

listTables   [line 471]

mixed listTables( )

list all tables in the current database
  • Return: data array on success, a MDB2 error on failure
  • Access: public

Overridden in child classes as:

MDB2_Driver_Manager_xxx::listTables()
list all tables in the current database

[ Top ]

listUsers   [line 411]

mixed listUsers( )

list all users
  • Return: data array on success, a MDB2 error on failure
  • Access: public

Overridden in child classes as:

MDB2_Driver_Manager_xxx::listUsers()
list all users

[ Top ]

listViews   [line 431]

mixed listViews( )

list all views in the current database
  • Return: data array on success, a MDB2 error on failure
  • Access: public

[ Top ]

_isIndexName   [line 141]

mixed _isIndexName( string $idx)

Checks if the index name is valid and formats it
  • Return: name of the index if $idx is a name of a index, else false
  • Access: protected

Parameters:

string   $idx   —   string that containts name of a potential index

[ Top ]

_isSequenceName   [line 116]

mixed _isSequenceName( string $sqn)

Checks if the sequence name is valid and formats it
  • Return: name of the sequence if $sqn is a name of a sequence, else false
  • Access: protected

Parameters:

string   $sqn   —   string that containts name of a potential sequence

[ Top ]
Documentation generated on Fri, 30 Dec 2005 06:31:28 -0500 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.