Inheritance diagram for MDB2_Driver_Manager_Common:

Collaboration diagram for MDB2_Driver_Manager_Common:

Public Member Functions
	getFieldDeclarationList ($fields)
	Get declaration of a number of field in bulk.
	_fixSequenceName ($sqn, $check=false)
	Removes any formatting in an sequence name using the 'seqname_format' option.
	_fixIndexName ($idx)
	Removes any formatting in an index name using the 'idxname_format' option.
	createDatabase ($database)
	create a new database
	dropDatabase ($database)
	drop an existing database
	_getCreateTableQuery ($name, $fields, $options=array())
	Create a basic SQL query for a new table creation.
	_getTemporaryTableQuery ()
	A method to return the required SQL string that fits between CREATE ...
	createTable ($name, $fields, $options=array())
	create a new table
	dropTable ($name)
	drop an existing table
	alterTable ($name, $changes, $check)
	alter an existing table
	listDatabases ()
	list all databases
	listUsers ()
	list all users
	listViews ($database=null)
	list all views in the current database
	listTableViews ($table)
	list the views in the database that reference a given table
	listTableTriggers ($table=null)
	list all triggers in the database that reference a given table
	listFunctions ()
	list all functions in the current database
	listTables ($database=null)
	list all tables in the current database
	listTableFields ($table)
	list all fields in a table in the current database
	createIndex ($table, $name, $definition)
	Get the stucture of a field into an array.
	dropIndex ($table, $name)
	drop existing index
	listTableIndexes ($table)
	list all indexes in a table
	createConstraint ($table, $name, $definition)
	create a constraint on a table
	dropConstraint ($table, $name, $primary=false)
	drop existing constraint
	listTableConstraints ($table)
	list all constraints in a table
	createSequence ($seq_name, $start=1)
	create sequence
	dropSequence ($name)
	drop existing sequence
	listSequences ($database=null)
	list all sequences in the current database
Public Member Functions inherited from MDB2_Module_Common
	__construct ($db_index)
	Constructor.
	MDB2_Module_Common ($db_index)
	PHP 4 Constructor.
&	getDBInstance ()
	Get the instance of MDB2 associated with the module instance.

Additional Inherited Members
Data Fields inherited from MDB2_Module_Common
	$db_index

Detailed Description

Definition at line 61 of file Common.php.

Member Function Documentation

MDB2_Driver_Manager_Common::_fixIndexName ( $idx )

Removes any formatting in an index name using the 'idxname_format' option.

Parameters

string $idx string that containts name of anl index

Returns: string name of the index with possible formatting removed protected

Definition at line 144 of file Common.php.

References MDB2_Module_Common\getDBInstance(), and PEAR\isError().

Referenced by MDB2_Driver_Manager_pgsql\listTableConstraints(), MDB2_Driver_Manager_mysqli\listTableConstraints(), MDB2_Driver_Manager_mysql\listTableConstraints(), MDB2_Driver_Manager_pgsql\listTableIndexes(), MDB2_Driver_Manager_mysqli\listTableIndexes(), and MDB2_Driver_Manager_mysql\listTableIndexes().

    {
        $db =& $this->getDBInstance();
        if (PEAR::isError($db)) {
            return $db;
        }
        $idx_pattern = '/^'.preg_replace('/%s/', '([a-z0-9_]+)', $db->options['idxname_format']).'$/i';
        $idx_name = preg_replace($idx_pattern, '\\1', $idx);
        if ($idx_name && !strcasecmp($idx, $db->getIndexName($idx_name))) {
            return $idx_name;
        }
        return $idx;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

MDB2_Driver_Manager_Common::_fixSequenceName	(	$sqn,
		$check = `false`
	)

Removes any formatting in an sequence name using the 'seqname_format' option.

Parameters

string	$sqn	string that containts name of a potential sequence
bool	$check	if only formatted sequences should be returned

Returns: string name of the sequence with possible formatting removed protected

Definition at line 116 of file Common.php.

References MDB2_Module_Common\getDBInstance(), and PEAR\isError().

Referenced by MDB2_Driver_Manager_pgsql\listSequences(), MDB2_Driver_Manager_mysql\listSequences(), MDB2_Driver_Manager_mysqli\listSequences(), MDB2_Driver_Manager_mysqli\listTables(), and MDB2_Driver_Manager_mysql\listTables().

    {
        $db =& $this->getDBInstance();
        if (PEAR::isError($db)) {
            return $db;
        }
        $seq_pattern = '/^'.preg_replace('/%s/', '([a-z0-9_]+)', $db->options['seqname_format']).'$/i';
        $seq_name = preg_replace($seq_pattern, '\\1', $sqn);
        if ($seq_name && !strcasecmp($sqn, $db->getSequenceName($seq_name))) {
            return $seq_name;
        }
        if ($check) {
            return false;
        }
        return $sqn;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

MDB2_Driver_Manager_Common::_getCreateTableQuery	(	$name,
		$fields,
		$options = `array()`
	)

Create a basic SQL query for a new table creation.

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
array	$options	An associative array of table options

Returns: mixed string (the SQL query) on success, a MDB2 error on failure

See Also: createTable()

Definition at line 212 of file Common.php.

References $result, _getTemporaryTableQuery(), MDB2_Module_Common\getDBInstance(), getFieldDeclarationList(), PEAR\isError(), and MDB2_ERROR_CANNOT_CREATE.

Referenced by MDB2_Driver_Manager_mysql\createTable(), MDB2_Driver_Manager_mysqli\createTable(), and createTable().

    {
        $db =& $this->getDBInstance();
        if (PEAR::isError($db)) {
            return $db;
        }
        if (!$name) {
            return $db->raiseError(MDB2_ERROR_CANNOT_CREATE, null, null,
                'no valid table name specified', __FUNCTION__);
        }
        if (empty($fields)) {
            return $db->raiseError(MDB2_ERROR_CANNOT_CREATE, null, null,
                'no fields specified for table "'.$name.'"', __FUNCTION__);
        }
        $query_fields = $this->getFieldDeclarationList($fields);
        if (PEAR::isError($query_fields)) {
            return $query_fields;
        }
        if (!empty($options['primary'])) {
            $query_fields.= ', PRIMARY KEY ('.implode(', ', array_keys($options['primary'])).')';
        }
        $name = $db->quoteIdentifier($name, true);
        $result = 'CREATE ';
        if (!empty($options['temporary'])) {
            $result .= $this->_getTemporaryTableQuery();
        }
        $result .= " TABLE $name ($query_fields)";
        return $result;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

MDB2_Driver_Manager_Common::_getTemporaryTableQuery ( )

A method to return the required SQL string that fits between CREATE ...

TABLE to create the table as a temporary table.

Should be overridden in driver classes to return the correct string for the specific database type.

The default is to return the string "TEMPORARY" - this will result in a SQL error for any database that does not support temporary tables, or that requires a different SQL command from "CREATE TEMPORARY TABLE".

Returns: string The string required to be placed between "CREATE" and "TABLE" to generate a temporary table, if possible.

Reimplemented in MDB2_Driver_Manager_oci8.

Definition at line 261 of file Common.php.

Referenced by _getCreateTableQuery().

    {
        return 'TEMPORARY';
    }

Here is the caller graph for this function:

MDB2_Driver_Manager_Common::alterTable	(	$name,
		$changes,
		$check
	)

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 MDB2 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 MDB2 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', ), ) ) )

Parameters

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. public

Returns: mixed MDB2_OK on success, a MDB2 error on failure

Reimplemented in MDB2_Driver_Manager_oci8, MDB2_Driver_Manager_mysql, MDB2_Driver_Manager_mysqli, and MDB2_Driver_Manager_pgsql.

Definition at line 428 of file Common.php.

References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.

    {
        $db =& $this->getDBInstance();
        if (PEAR::isError($db)) {
            return $db;
        }
        return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
            'method not implemented', __FUNCTION__);
    }

Here is the call graph for this function:

MDB2_Driver_Manager_Common::createConstraint	(	$table,
		$name,
		$definition
	)

create a constraint on a table

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() ) )

Returns: mixed MDB2_OK on success, a MDB2 error on failure public

Reimplemented in MDB2_Driver_Manager_mysql, and MDB2_Driver_Manager_mysqli.

Definition at line 729 of file Common.php.

References $query, MDB2_Module_Common\getDBInstance(), and PEAR\isError().

Referenced by MDB2_Driver_Manager_oci8\_makeAutoincrement().

    {
        $db =& $this->getDBInstance();
        if (PEAR::isError($db)) {
            return $db;
        }
        $table = $db->quoteIdentifier($table, true);
        $name = $db->quoteIdentifier($db->getIndexName($name), true);
        $query = "ALTER TABLE $table ADD CONSTRAINT $name";
        if (!empty($definition['primary'])) {
            $query.= ' PRIMARY KEY';
        } elseif (!empty($definition['unique'])) {
            $query.= ' UNIQUE';
        }
        $fields = array();
        foreach (array_keys($definition['fields']) as $field) {
            $fields[] = $db->quoteIdentifier($field, true);
        }
        $query .= ' ('. implode(', ', $fields) . ')';
        return $db->exec($query);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

MDB2_Driver_Manager_Common::createDatabase ( $database )

create a new database

Parameters

string $name name of the database that should be created

Returns: mixed MDB2_OK on success, a MDB2 error on failure public

Reimplemented in MDB2_Driver_Manager_mysql, MDB2_Driver_Manager_mysqli, MDB2_Driver_Manager_oci8, and MDB2_Driver_Manager_pgsql.

Definition at line 169 of file Common.php.

References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.

    {
        $db =& $this->getDBInstance();
        if (PEAR::isError($db)) {
            return $db;
        }
        return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
            'method not implemented', __FUNCTION__);
    }

Here is the call graph for this function:

MDB2_Driver_Manager_Common::createIndex	(	$table,
		$name,
		$definition
	)

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() ) )

Returns: mixed MDB2_OK on success, a MDB2 error on failure public

Reimplemented in MDB2_Driver_Manager_mysql, and MDB2_Driver_Manager_mysqli.

Definition at line 643 of file Common.php.

References $query, MDB2_Module_Common\getDBInstance(), and PEAR\isError().

    {
        $db =& $this->getDBInstance();
        if (PEAR::isError($db)) {
            return $db;
        }
        $table = $db->quoteIdentifier($table, true);
        $name = $db->quoteIdentifier($db->getIndexName($name), true);
        $query = "CREATE INDEX $name ON $table";
        $fields = array();
        foreach (array_keys($definition['fields']) as $field) {
            $fields[] = $db->quoteIdentifier($field, true);
        }
        $query .= ' ('. implode(', ', $fields) . ')';
        return $db->exec($query);
    }

Here is the call graph for this function:

MDB2_Driver_Manager_Common::createSequence	(	$seq_name,
		$start = `1`
	)

create sequence

Parameters

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

Returns: mixed MDB2_OK on success, a MDB2 error on failure public

Reimplemented in MDB2_Driver_Manager_oci8, and MDB2_Driver_Manager_pgsql.

Definition at line 807 of file Common.php.

References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.

    {
        $db =& $this->getDBInstance();
        if (PEAR::isError($db)) {
            return $db;
        }
        return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
            'method not implemented', __FUNCTION__);
    }

Here is the call graph for this function:

MDB2_Driver_Manager_Common::createTable	(	$name,
		$fields,
		$options = `array()`
	)

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. array( 'id' => array( 'type' => 'integer', 'unsigned' => 1 'notnull' => 1 'default' => 0 ), 'name' => array( 'type' => 'text', 'length' => 12 ), 'password' => array( 'type' => 'text', 'length' => 12 ) );
array	$options	An associative array of table options: array( 'comment' => 'Foo', 'temporary' => true\|false, );

Returns: mixed MDB2_OK on success, a MDB2 error on failure public

Reimplemented in MDB2_Driver_Manager_oci8, MDB2_Driver_Manager_mysql, and MDB2_Driver_Manager_mysqli.

Definition at line 301 of file Common.php.

References $query, _getCreateTableQuery(), MDB2_Module_Common\getDBInstance(), and PEAR\isError().

    {
        $query = $this->_getCreateTableQuery($name, $fields, $options);
        if (PEAR::isError($query)) {
            return $query;
        }
        $db =& $this->getDBInstance();
        if (PEAR::isError($db)) {
            return $db;
        }
        return $db->exec($query);
    }

Here is the call graph for this function:

MDB2_Driver_Manager_Common::dropConstraint	(	$table,
		$name,
		$primary = `false`
	)

drop existing constraint

Parameters

string	$table	name of table that should be used in method
string	$name	name of the constraint to be dropped
string	$primary	hint if the constraint is primary

Returns: mixed MDB2_OK on success, a MDB2 error on failure public

Reimplemented in MDB2_Driver_Manager_mysql, and MDB2_Driver_Manager_mysqli.

Definition at line 763 of file Common.php.

References MDB2_Module_Common\getDBInstance(), and PEAR\isError().

    {
        $db =& $this->getDBInstance();
        if (PEAR::isError($db)) {
            return $db;
        }
        $table = $db->quoteIdentifier($table, true);
        $name = $db->quoteIdentifier($db->getIndexName($name), true);
        return $db->exec("ALTER TABLE $table DROP CONSTRAINT $name");
    }

Here is the call graph for this function:

MDB2_Driver_Manager_Common::dropDatabase ( $database )

drop an existing database

Parameters

string $name name of the database that should be dropped

Returns: mixed MDB2_OK on success, a MDB2 error on failure public

Reimplemented in MDB2_Driver_Manager_oci8, MDB2_Driver_Manager_mysql, MDB2_Driver_Manager_mysqli, and MDB2_Driver_Manager_pgsql.

Definition at line 190 of file Common.php.

References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.

    {
        $db =& $this->getDBInstance();
        if (PEAR::isError($db)) {
            return $db;
        }
        return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
            'method not implemented', __FUNCTION__);
    }

Here is the call graph for this function:

MDB2_Driver_Manager_Common::dropIndex	(	$table,
		$name
	)

drop existing index

Parameters

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

Returns: mixed MDB2_OK on success, a MDB2 error on failure public

Reimplemented in MDB2_Driver_Manager_mysql, and MDB2_Driver_Manager_mysqli.

Definition at line 672 of file Common.php.

References MDB2_Module_Common\getDBInstance(), and PEAR\isError().

    {
        $db =& $this->getDBInstance();
        if (PEAR::isError($db)) {
            return $db;
        }
        $name = $db->quoteIdentifier($db->getIndexName($name), true);
        return $db->exec("DROP INDEX $name");
    }

Here is the call graph for this function:

MDB2_Driver_Manager_Common::dropSequence ( $name )

drop existing sequence

Parameters

string $seq_name name of the sequence to be dropped

Returns: mixed MDB2_OK on success, a MDB2 error on failure public

Reimplemented in MDB2_Driver_Manager_mysqli, MDB2_Driver_Manager_mysql, MDB2_Driver_Manager_oci8, and MDB2_Driver_Manager_pgsql.

Definition at line 828 of file Common.php.

References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.

    {
        $db =& $this->getDBInstance();
        if (PEAR::isError($db)) {
            return $db;
        }
        return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
            'method not implemented', __FUNCTION__);
    }

Here is the call graph for this function:

MDB2_Driver_Manager_Common::dropTable ( $name )

drop an existing table

Parameters

string $name name of the table that should be dropped

Returns: mixed MDB2_OK on success, a MDB2 error on failure public

Reimplemented in MDB2_Driver_Manager_oci8.

Definition at line 324 of file Common.php.

References MDB2_Module_Common\getDBInstance(), and PEAR\isError().

    {
        $db =& $this->getDBInstance();
        if (PEAR::isError($db)) {
            return $db;
        }
        $name = $db->quoteIdentifier($name, true);
        return $db->exec("DROP TABLE $name");
    }

Here is the call graph for this function:

MDB2_Driver_Manager_Common::getFieldDeclarationList ( $fields )

Get declaration of a number of field in bulk.

Parameters

array $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.

Returns: mixed string on success, a MDB2 error on failure public

Definition at line 84 of file Common.php.

References $query, MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_NEED_MORE_DATA.

Referenced by _getCreateTableQuery().

    {
        $db =& $this->getDBInstance();
        if (PEAR::isError($db)) {
            return $db;
        }
        if (!is_array($fields) || empty($fields)) {
            return $db->raiseError(MDB2_ERROR_NEED_MORE_DATA, null, null,
                'missing any fields', __FUNCTION__);
        }
        foreach ($fields as $field_name => $field) {
            $query = $db->getDeclaration($field['type'], $field_name, $field);
            if (PEAR::isError($query)) {
                return $query;
            }
            $query_fields[] = $query;
        }
        return implode(', ', $query_fields);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

MDB2_Driver_Manager_Common::listDatabases ( )

list all databases

Returns: mixed array of database names on success, a MDB2 error on failure public

Reimplemented in MDB2_Driver_Manager_oci8, MDB2_Driver_Manager_mysql, MDB2_Driver_Manager_mysqli, and MDB2_Driver_Manager_pgsql.

Definition at line 448 of file Common.php.

References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.

    {
        $db =& $this->getDBInstance();
        if (PEAR::isError($db)) {
            return $db;
        }
        return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
            'method not implementedd', __FUNCTION__);
    }

Here is the call graph for this function:

MDB2_Driver_Manager_Common::listFunctions ( )

list all functions in the current database

Returns: mixed array of function names on success, a MDB2 error on failure public

Reimplemented in MDB2_Driver_Manager_oci8, MDB2_Driver_Manager_mysql, MDB2_Driver_Manager_mysqli, and MDB2_Driver_Manager_pgsql.

Definition at line 553 of file Common.php.

References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.

    {
        $db =& $this->getDBInstance();
        if (PEAR::isError($db)) {
            return $db;
        }
        return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
            'method not implemented', __FUNCTION__);
    }

Here is the call graph for this function:

MDB2_Driver_Manager_Common::listSequences ( $database = null )

list all sequences in the current database

Parameters

string database, the current is default NB: not all the drivers can get the sequence names from a database other than the current one

Returns: mixed array of sequence names on success, a MDB2 error on failure public

Reimplemented in MDB2_Driver_Manager_mysqli, and MDB2_Driver_Manager_mysql.

Definition at line 851 of file Common.php.

References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.

    {
        $db =& $this->getDBInstance();
        if (PEAR::isError($db)) {
            return $db;
        }
        return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
            'method not implemented', __FUNCTION__);
    }

Here is the call graph for this function:

MDB2_Driver_Manager_Common::listTableConstraints ( $table )

list all constraints in a table

Parameters

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

Returns: mixed array of constraint names on success, a MDB2 error on failure public

Reimplemented in MDB2_Driver_Manager_mysql, MDB2_Driver_Manager_mysqli, MDB2_Driver_Manager_oci8, and MDB2_Driver_Manager_pgsql.

Definition at line 785 of file Common.php.

References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.

    {
        $db =& $this->getDBInstance();
        if (PEAR::isError($db)) {
            return $db;
        }
        return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
            'method not implemented', __FUNCTION__);
    }

Here is the call graph for this function:

MDB2_Driver_Manager_Common::listTableFields ( $table )

list all fields in a table in the current database

Parameters

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

Returns: mixed array of field names on success, a MDB2 error on failure public

Reimplemented in MDB2_Driver_Manager_oci8, MDB2_Driver_Manager_mysql, MDB2_Driver_Manager_mysqli, and MDB2_Driver_Manager_pgsql.

Definition at line 597 of file Common.php.

References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.

    {
        $db =& $this->getDBInstance();
        if (PEAR::isError($db)) {
            return $db;
        }
        return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
            'method not implemented', __FUNCTION__);
    }

Here is the call graph for this function:

MDB2_Driver_Manager_Common::listTableIndexes ( $table )

list all indexes in a table

Parameters

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

Returns: mixed array of index names on success, a MDB2 error on failure public

Reimplemented in MDB2_Driver_Manager_oci8, MDB2_Driver_Manager_mysql, MDB2_Driver_Manager_mysqli, and MDB2_Driver_Manager_pgsql.

Definition at line 693 of file Common.php.

References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.

    {
        $db =& $this->getDBInstance();
        if (PEAR::isError($db)) {
            return $db;
        }
        return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
            'method not implemented', __FUNCTION__);
    }

Here is the call graph for this function:

MDB2_Driver_Manager_Common::listTables ( $database = null )

list all tables in the current database

Parameters

string database, the current is default. NB: not all the drivers can get the table names from a database other than the current one

Returns: mixed array of table names on success, a MDB2 error on failure public

Reimplemented in MDB2_Driver_Manager_mysql, and MDB2_Driver_Manager_mysqli.

Definition at line 576 of file Common.php.

References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.

    {
        $db =& $this->getDBInstance();
        if (PEAR::isError($db)) {
            return $db;
        }
        return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
            'method not implemented', __FUNCTION__);
    }

Here is the call graph for this function:

MDB2_Driver_Manager_Common::listTableTriggers ( $table = null )

list all triggers in the database that reference a given table

Parameters

string table for which all referenced triggers should be found

Returns: mixed array of trigger names on success, a MDB2 error on failure public

Reimplemented in MDB2_Driver_Manager_mysql, MDB2_Driver_Manager_mysqli, and MDB2_Driver_Manager_pgsql.

Definition at line 533 of file Common.php.

References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.

    {
        $db =& $this->getDBInstance();
        if (PEAR::isError($db)) {
            return $db;
        }
        return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
            'method not implemented', __FUNCTION__);
    }

Here is the call graph for this function:

MDB2_Driver_Manager_Common::listTableViews ( $table )

list the views in the database that reference a given table

Parameters

string table for which all referenced views should be found

Returns: mixed array of view names on success, a MDB2 error on failure public

Reimplemented in MDB2_Driver_Manager_pgsql.

Definition at line 512 of file Common.php.

References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.

    {
        $db =& $this->getDBInstance();
        if (PEAR::isError($db)) {
            return $db;
        }
        return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
            'method not implemented', __FUNCTION__);
    }

Here is the call graph for this function:

MDB2_Driver_Manager_Common::listUsers ( )

list all users

Returns: mixed array of user names on success, a MDB2 error on failure public

Reimplemented in MDB2_Driver_Manager_oci8, MDB2_Driver_Manager_mysql, MDB2_Driver_Manager_mysqli, and MDB2_Driver_Manager_pgsql.

Definition at line 468 of file Common.php.

References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.

    {
        $db =& $this->getDBInstance();
        if (PEAR::isError($db)) {
            return $db;
        }
        return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
            'method not implemented', __FUNCTION__);
    }

Here is the call graph for this function:

MDB2_Driver_Manager_Common::listViews ( $database = null )

list all views in the current database

Parameters

string database, the current is default NB: not all the drivers can get the view names from a database other than the current one

Returns: mixed array of view names on success, a MDB2 error on failure public

Reimplemented in MDB2_Driver_Manager_mysql, and MDB2_Driver_Manager_mysqli.

Definition at line 491 of file Common.php.

References MDB2_Module_Common\getDBInstance(), PEAR\isError(), and MDB2_ERROR_UNSUPPORTED.

    {
        $db =& $this->getDBInstance();
        if (PEAR::isError($db)) {
            return $db;
        }
        return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
            'method not implemented', __FUNCTION__);
    }

Here is the call graph for this function:

The documentation for this class was generated from the following file:

Services/PEAR/lib/MDB2/Driver/Manager/Common.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation