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

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

◆ _fixIndexName()

MDB2_Driver_Manager_Common::_fixIndexName (   $idx)

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

Parameters
string$idxstring that containts name of anl index
Returns
string name of the index with possible formatting removed @access protected

Definition at line 144 of file Common.php.

145 {
146 $db =& $this->getDBInstance();
147 if (PEAR::isError($db)) {
148 return $db;
149 }
150
151 $idx_pattern = '/^'.preg_replace('/%s/', '([a-z0-9_]+)', $db->options['idxname_format']).'$/i';
152 $idx_name = preg_replace($idx_pattern, '\\1', $idx);
153 if ($idx_name && !strcasecmp($idx, $db->getIndexName($idx_name))) {
154 return $idx_name;
155 }
156 return $idx;
157 }
& getDBInstance()
Get the instance of MDB2 associated with the module instance.
Definition: MDB2.php:4206
isError($data, $code=null)
Tell whether a value is a PEAR error.
Definition: PEAR.php:279

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

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _fixSequenceName()

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

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

Parameters
string$sqnstring that containts name of a potential sequence
bool$checkif only formatted sequences should be returned
Returns
string name of the sequence with possible formatting removed @access protected

Definition at line 116 of file Common.php.

117 {
118 $db =& $this->getDBInstance();
119 if (PEAR::isError($db)) {
120 return $db;
121 }
122
123 $seq_pattern = '/^'.preg_replace('/%s/', '([a-z0-9_]+)', $db->options['seqname_format']).'$/i';
124 $seq_name = preg_replace($seq_pattern, '\\1', $sqn);
125 if ($seq_name && !strcasecmp($sqn, $db->getSequenceName($seq_name))) {
126 return $seq_name;
127 }
128 if ($check) {
129 return false;
130 }
131 return $sqn;
132 }

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

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _getCreateTableQuery()

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

Create a basic SQL query for a new table creation.

Parameters
string$nameName of the database that should be created
array$fieldsAssociative array that contains the definition of each field of the new table
array$optionsAn 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.

213 {
214 $db =& $this->getDBInstance();
215 if (PEAR::isError($db)) {
216 return $db;
217 }
218
219 if (!$name) {
220 return $db->raiseError(MDB2_ERROR_CANNOT_CREATE, null, null,
221 'no valid table name specified', __FUNCTION__);
222 }
223 if (empty($fields)) {
224 return $db->raiseError(MDB2_ERROR_CANNOT_CREATE, null, null,
225 'no fields specified for table "'.$name.'"', __FUNCTION__);
226 }
227 $query_fields = $this->getFieldDeclarationList($fields);
228 if (PEAR::isError($query_fields)) {
229 return $query_fields;
230 }
231 if (!empty($options['primary'])) {
232 $query_fields.= ', PRIMARY KEY ('.implode(', ', array_keys($options['primary'])).')';
233 }
234
235 $name = $db->quoteIdentifier($name, true);
236 $result = 'CREATE ';
237 if (!empty($options['temporary'])) {
239 }
240 $result .= " TABLE $name ($query_fields)";
241 return $result;
242 }
$result
const MDB2_ERROR_CANNOT_CREATE
Definition: MDB2.php:82
_getTemporaryTableQuery()
A method to return the required SQL string that fits between CREATE ... TABLE to create the table as ...
Definition: Common.php:261
getFieldDeclarationList($fields)
Get declaration of a number of field in bulk.
Definition: Common.php:84
if(!is_array($argv)) $options

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

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _getTemporaryTableQuery()

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.

262 {
263 return 'TEMPORARY';
264 }

Referenced by _getCreateTableQuery().

+ Here is the caller graph for this function:

◆ alterTable()

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

alter an existing table

Parameters
string$namename of the table that is intended to be changed.
array$changesassociative 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$checkindicates 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. @access public
Returns
mixed MDB2_OK on success, a MDB2 error on failure

Reimplemented in MDB2_Driver_Manager_mysql, MDB2_Driver_Manager_mysqli, MDB2_Driver_Manager_oci8, and MDB2_Driver_Manager_pgsql.

Definition at line 428 of file Common.php.

429 {
430 $db =& $this->getDBInstance();
431 if (PEAR::isError($db)) {
432 return $db;
433 }
434
435 return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
436 'method not implemented', __FUNCTION__);
437 }
const MDB2_ERROR_UNSUPPORTED
Definition: MDB2.php:73

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

+ Here is the call graph for this function:

◆ createConstraint()

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

create a constraint on a table

Parameters
string$tablename of the table on which the constraint is to be created
string$namename of the constraint to be created
array$definitionassociative 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 @access public

Reimplemented in MDB2_Driver_Manager_mysql, and MDB2_Driver_Manager_mysqli.

Definition at line 729 of file Common.php.

730 {
731 $db =& $this->getDBInstance();
732 if (PEAR::isError($db)) {
733 return $db;
734 }
735 $table = $db->quoteIdentifier($table, true);
736 $name = $db->quoteIdentifier($db->getIndexName($name), true);
737 $query = "ALTER TABLE $table ADD CONSTRAINT $name";
738 if (!empty($definition['primary'])) {
739 $query.= ' PRIMARY KEY';
740 } elseif (!empty($definition['unique'])) {
741 $query.= ' UNIQUE';
742 }
743 $fields = array();
744 foreach (array_keys($definition['fields']) as $field) {
745 $fields[] = $db->quoteIdentifier($field, true);
746 }
747 $query .= ' ('. implode(', ', $fields) . ')';
748 return $db->exec($query);
749 }

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

Referenced by MDB2_Driver_Manager_oci8\_makeAutoincrement().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ createDatabase()

MDB2_Driver_Manager_Common::createDatabase (   $database)

create a new database

Parameters
string$namename of the database that should be created
Returns
mixed MDB2_OK on success, a MDB2 error on failure @access 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.

170 {
171 $db =& $this->getDBInstance();
172 if (PEAR::isError($db)) {
173 return $db;
174 }
175
176 return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
177 'method not implemented', __FUNCTION__);
178 }

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

+ Here is the call graph for this function:

◆ createIndex()

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

Get the stucture of a field into an array.

Parameters
string$tablename of the table on which the index is to be created
string$namename of the index to be created
array$definitionassociative 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 @access public

Reimplemented in MDB2_Driver_Manager_mysql, and MDB2_Driver_Manager_mysqli.

Definition at line 643 of file Common.php.

644 {
645 $db =& $this->getDBInstance();
646 if (PEAR::isError($db)) {
647 return $db;
648 }
649
650 $table = $db->quoteIdentifier($table, true);
651 $name = $db->quoteIdentifier($db->getIndexName($name), true);
652 $query = "CREATE INDEX $name ON $table";
653 $fields = array();
654 foreach (array_keys($definition['fields']) as $field) {
655 $fields[] = $db->quoteIdentifier($field, true);
656 }
657 $query .= ' ('. implode(', ', $fields) . ')';
658 return $db->exec($query);
659 }

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

+ Here is the call graph for this function:

◆ createSequence()

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

create sequence

Parameters
string$seq_namename of the sequence to be created
string$startstart value of the sequence; default is 1
Returns
mixed MDB2_OK on success, a MDB2 error on failure @access public

Reimplemented in MDB2_Driver_Manager_oci8, and MDB2_Driver_Manager_pgsql.

Definition at line 807 of file Common.php.

808 {
809 $db =& $this->getDBInstance();
810 if (PEAR::isError($db)) {
811 return $db;
812 }
813
814 return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
815 'method not implemented', __FUNCTION__);
816 }

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

+ Here is the call graph for this function:

◆ createTable()

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

create a new table

Parameters
string$nameName of the database that should be created
array$fieldsAssociative 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$optionsAn associative array of table options: array( 'comment' => 'Foo', 'temporary' => true|false, );
Returns
mixed MDB2_OK on success, a MDB2 error on failure @access public

Reimplemented in MDB2_Driver_Manager_mysql, MDB2_Driver_Manager_mysqli, and MDB2_Driver_Manager_oci8.

Definition at line 301 of file Common.php.

302 {
303 $query = $this->_getCreateTableQuery($name, $fields, $options);
304 if (PEAR::isError($query)) {
305 return $query;
306 }
307 $db =& $this->getDBInstance();
308 if (PEAR::isError($db)) {
309 return $db;
310 }
311 return $db->exec($query);
312 }
_getCreateTableQuery($name, $fields, $options=array())
Create a basic SQL query for a new table creation.
Definition: Common.php:212

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

+ Here is the call graph for this function:

◆ dropConstraint()

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

drop existing constraint

Parameters
string$tablename of table that should be used in method
string$namename of the constraint to be dropped
string$primaryhint if the constraint is primary
Returns
mixed MDB2_OK on success, a MDB2 error on failure @access public

Reimplemented in MDB2_Driver_Manager_mysql, and MDB2_Driver_Manager_mysqli.

Definition at line 763 of file Common.php.

764 {
765 $db =& $this->getDBInstance();
766 if (PEAR::isError($db)) {
767 return $db;
768 }
769
770 $table = $db->quoteIdentifier($table, true);
771 $name = $db->quoteIdentifier($db->getIndexName($name), true);
772 return $db->exec("ALTER TABLE $table DROP CONSTRAINT $name");
773 }

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

+ Here is the call graph for this function:

◆ dropDatabase()

MDB2_Driver_Manager_Common::dropDatabase (   $database)

drop an existing database

Parameters
string$namename of the database that should be dropped
Returns
mixed MDB2_OK on success, a MDB2 error on failure @access public

Reimplemented in MDB2_Driver_Manager_mysql, MDB2_Driver_Manager_mysqli, MDB2_Driver_Manager_oci8, and MDB2_Driver_Manager_pgsql.

Definition at line 190 of file Common.php.

191 {
192 $db =& $this->getDBInstance();
193 if (PEAR::isError($db)) {
194 return $db;
195 }
196
197 return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
198 'method not implemented', __FUNCTION__);
199 }

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

+ Here is the call graph for this function:

◆ dropIndex()

MDB2_Driver_Manager_Common::dropIndex (   $table,
  $name 
)

drop existing index

Parameters
string$tablename of table that should be used in method
string$namename of the index to be dropped
Returns
mixed MDB2_OK on success, a MDB2 error on failure @access public

Reimplemented in MDB2_Driver_Manager_mysql, and MDB2_Driver_Manager_mysqli.

Definition at line 672 of file Common.php.

673 {
674 $db =& $this->getDBInstance();
675 if (PEAR::isError($db)) {
676 return $db;
677 }
678
679 $name = $db->quoteIdentifier($db->getIndexName($name), true);
680 return $db->exec("DROP INDEX $name");
681 }

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

+ Here is the call graph for this function:

◆ dropSequence()

MDB2_Driver_Manager_Common::dropSequence (   $name)

drop existing sequence

Parameters
string$seq_namename of the sequence to be dropped
Returns
mixed MDB2_OK on success, a MDB2 error on failure @access public

Reimplemented in MDB2_Driver_Manager_mysql, MDB2_Driver_Manager_mysqli, MDB2_Driver_Manager_oci8, and MDB2_Driver_Manager_pgsql.

Definition at line 828 of file Common.php.

829 {
830 $db =& $this->getDBInstance();
831 if (PEAR::isError($db)) {
832 return $db;
833 }
834
835 return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
836 'method not implemented', __FUNCTION__);
837 }

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

+ Here is the call graph for this function:

◆ dropTable()

MDB2_Driver_Manager_Common::dropTable (   $name)

drop an existing table

Parameters
string$namename of the table that should be dropped
Returns
mixed MDB2_OK on success, a MDB2 error on failure @access public

Reimplemented in MDB2_Driver_Manager_oci8.

Definition at line 324 of file Common.php.

325 {
326 $db =& $this->getDBInstance();
327 if (PEAR::isError($db)) {
328 return $db;
329 }
330
331 $name = $db->quoteIdentifier($name, true);
332 return $db->exec("DROP TABLE $name");
333 }

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

+ Here is the call graph for this function:

◆ getFieldDeclarationList()

MDB2_Driver_Manager_Common::getFieldDeclarationList (   $fields)

Get declaration of a number of field in bulk.

Parameters
array$fieldsa 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 @access public

Definition at line 84 of file Common.php.

85 {
86 $db =& $this->getDBInstance();
87 if (PEAR::isError($db)) {
88 return $db;
89 }
90
91 if (!is_array($fields) || empty($fields)) {
92 return $db->raiseError(MDB2_ERROR_NEED_MORE_DATA, null, null,
93 'missing any fields', __FUNCTION__);
94 }
95 foreach ($fields as $field_name => $field) {
96 $query = $db->getDeclaration($field['type'], $field_name, $field);
97 if (PEAR::isError($query)) {
98 return $query;
99 }
100 $query_fields[] = $query;
101 }
102 return implode(', ', $query_fields);
103 }
const MDB2_ERROR_NEED_MORE_DATA
Definition: MDB2.php:87

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

Referenced by _getCreateTableQuery().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ listDatabases()

MDB2_Driver_Manager_Common::listDatabases ( )

list all databases

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

Reimplemented in MDB2_Driver_Manager_mysql, MDB2_Driver_Manager_mysqli, MDB2_Driver_Manager_oci8, and MDB2_Driver_Manager_pgsql.

Definition at line 448 of file Common.php.

449 {
450 $db =& $this->getDBInstance();
451 if (PEAR::isError($db)) {
452 return $db;
453 }
454
455 return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
456 'method not implementedd', __FUNCTION__);
457 }

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

+ Here is the call graph for this function:

◆ listFunctions()

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 @access public

Reimplemented in MDB2_Driver_Manager_mysql, MDB2_Driver_Manager_mysqli, MDB2_Driver_Manager_oci8, and MDB2_Driver_Manager_pgsql.

Definition at line 553 of file Common.php.

554 {
555 $db =& $this->getDBInstance();
556 if (PEAR::isError($db)) {
557 return $db;
558 }
559
560 return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
561 'method not implemented', __FUNCTION__);
562 }

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

+ Here is the call graph for this function:

◆ listSequences()

MDB2_Driver_Manager_Common::listSequences (   $database = null)

list all sequences in the current database

Parameters
stringdatabase, 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 @access public

Reimplemented in MDB2_Driver_Manager_mysql, and MDB2_Driver_Manager_mysqli.

Definition at line 851 of file Common.php.

852 {
853 $db =& $this->getDBInstance();
854 if (PEAR::isError($db)) {
855 return $db;
856 }
857
858 return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
859 'method not implemented', __FUNCTION__);
860 }

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

+ Here is the call graph for this function:

◆ listTableConstraints()

MDB2_Driver_Manager_Common::listTableConstraints (   $table)

list all constraints in a table

Parameters
string$tablename of table that should be used in method
Returns
mixed array of constraint names on success, a MDB2 error on failure @access 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.

786 {
787 $db =& $this->getDBInstance();
788 if (PEAR::isError($db)) {
789 return $db;
790 }
791
792 return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
793 'method not implemented', __FUNCTION__);
794 }

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

+ Here is the call graph for this function:

◆ listTableFields()

MDB2_Driver_Manager_Common::listTableFields (   $table)

list all fields in a table in the current database

Parameters
string$tablename of table that should be used in method
Returns
mixed array of field names on success, a MDB2 error on failure @access public

Reimplemented in MDB2_Driver_Manager_mysql, MDB2_Driver_Manager_mysqli, MDB2_Driver_Manager_oci8, and MDB2_Driver_Manager_pgsql.

Definition at line 597 of file Common.php.

598 {
599 $db =& $this->getDBInstance();
600 if (PEAR::isError($db)) {
601 return $db;
602 }
603
604 return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
605 'method not implemented', __FUNCTION__);
606 }

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

+ Here is the call graph for this function:

◆ listTableIndexes()

MDB2_Driver_Manager_Common::listTableIndexes (   $table)

list all indexes in a table

Parameters
string$tablename of table that should be used in method
Returns
mixed array of index names on success, a MDB2 error on failure @access public

Reimplemented in MDB2_Driver_Manager_mysql, MDB2_Driver_Manager_mysqli, MDB2_Driver_Manager_oci8, and MDB2_Driver_Manager_pgsql.

Definition at line 693 of file Common.php.

694 {
695 $db =& $this->getDBInstance();
696 if (PEAR::isError($db)) {
697 return $db;
698 }
699
700 return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
701 'method not implemented', __FUNCTION__);
702 }

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

+ Here is the call graph for this function:

◆ listTables()

MDB2_Driver_Manager_Common::listTables (   $database = null)

list all tables in the current database

Parameters
stringdatabase, 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 @access public

Reimplemented in MDB2_Driver_Manager_mysql, and MDB2_Driver_Manager_mysqli.

Definition at line 576 of file Common.php.

577 {
578 $db =& $this->getDBInstance();
579 if (PEAR::isError($db)) {
580 return $db;
581 }
582
583 return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
584 'method not implemented', __FUNCTION__);
585 }

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

+ Here is the call graph for this function:

◆ listTableTriggers()

MDB2_Driver_Manager_Common::listTableTriggers (   $table = null)

list all triggers in the database that reference a given table

Parameters
stringtable for which all referenced triggers should be found
Returns
mixed array of trigger names on success, a MDB2 error on failure @access public

Reimplemented in MDB2_Driver_Manager_mysql, MDB2_Driver_Manager_mysqli, and MDB2_Driver_Manager_pgsql.

Definition at line 533 of file Common.php.

534 {
535 $db =& $this->getDBInstance();
536 if (PEAR::isError($db)) {
537 return $db;
538 }
539
540 return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
541 'method not implemented', __FUNCTION__);
542 }

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

+ Here is the call graph for this function:

◆ listTableViews()

MDB2_Driver_Manager_Common::listTableViews (   $table)

list the views in the database that reference a given table

Parameters
stringtable for which all referenced views should be found
Returns
mixed array of view names on success, a MDB2 error on failure @access public

Reimplemented in MDB2_Driver_Manager_pgsql.

Definition at line 512 of file Common.php.

513 {
514 $db =& $this->getDBInstance();
515 if (PEAR::isError($db)) {
516 return $db;
517 }
518
519 return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
520 'method not implemented', __FUNCTION__);
521 }

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

+ Here is the call graph for this function:

◆ listUsers()

MDB2_Driver_Manager_Common::listUsers ( )

list all users

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

Reimplemented in MDB2_Driver_Manager_mysql, MDB2_Driver_Manager_mysqli, MDB2_Driver_Manager_oci8, and MDB2_Driver_Manager_pgsql.

Definition at line 468 of file Common.php.

469 {
470 $db =& $this->getDBInstance();
471 if (PEAR::isError($db)) {
472 return $db;
473 }
474
475 return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
476 'method not implemented', __FUNCTION__);
477 }

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

+ Here is the call graph for this function:

◆ listViews()

MDB2_Driver_Manager_Common::listViews (   $database = null)

list all views in the current database

Parameters
stringdatabase, 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 @access public

Reimplemented in MDB2_Driver_Manager_mysql, and MDB2_Driver_Manager_mysqli.

Definition at line 491 of file Common.php.

492 {
493 $db =& $this->getDBInstance();
494 if (PEAR::isError($db)) {
495 return $db;
496 }
497
498 return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
499 'method not implemented', __FUNCTION__);
500 }

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

+ Here is the call graph for this function:

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