makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-28 22:28:51 +00:00
Code Issues Projects Releases Packages Wiki Activity

[ticket/13421] Inherit docs

Browse source 
PHPBB3-13421
This commit is contained in:
Joas Schilling 2014-11-22 02:11:21 +01:00
parent 10594779b9
commit 536bdf036b
1 changed files with 34 additions and 85 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

85
phpBB/phpbb/db/tools.php
View file

@ -371,9 +371,7 @@ class tools implements tools_interface
}
/**
* Gets a list of tables in the database.
*
* @return array Array of table names (all lower case)
* {@inheritDoc}
*/
function sql_list_tables()
{
@ -431,11 +429,7 @@ class tools implements tools_interface
}
/**
* Check if table exists
*
*
* @param string $table_name The table name to check for
* @return bool true if table exists, else false
* {@inheritDoc}
*/
function sql_table_exists($table_name)
{
@ -453,11 +447,7 @@ class tools implements tools_interface
}
/**
* Create SQL Table
*
* @param string $table_name The table name to create
* @param array $table_data Array containing table data.
* @return array Statements if $return_statements is true.
* {@inheritDoc}
*/
function sql_create_table($table_name, $table_data)
{
@ -679,26 +669,7 @@ class tools implements tools_interface
}
/**
* Handle passed database update array.
* Expected structure...
* Key being one of the following
* drop_tables: Drop tables
* add_tables: Add tables
* change_columns: Column changes (only type, not name)
* add_columns: Add columns to a table
* drop_keys: Dropping keys
* drop_columns: Removing/Dropping columns
* add_primary_keys: adding primary keys
* add_unique_index: adding an unique index
* add_index: adding an index (can be column:index_size if you need to provide size)
*
* The values are in this format:
* {TABLE NAME} => array(
* {COLUMN NAME} => array({COLUMN TYPE}, {DEFAULT VALUE}, {OPTIONAL VARIABLES}),
* {KEY/INDEX NAME} => array({COLUMN NAMES}),
* )
*
* For more information have a look at /develop/create_schema_files.php (only available through SVN)
* {@inheritDoc}
*/
function perform_schema_changes($schema_changes)
{
@ -1079,11 +1050,7 @@ class tools implements tools_interface
}
/**
* Gets a list of columns of a table.
*
* @param string $table_name Table name
*
* @return array Array of column names (all lower case)
* {@inheritDoc}
*/
function sql_list_columns($table_name)
{
@ -1173,12 +1140,7 @@ class tools implements tools_interface
}
/**
* Check whether a specified column exist in a table
*
* @param string $table_name Table to check
* @param string $column_name Column to check
*
* @return bool True if column exists, false otherwise
* {@inheritDoc}
*/
function sql_column_exists($table_name, $column_name)
{
@ -1188,12 +1150,7 @@ class tools implements tools_interface
}
/**
* Check if a specified index exists in table. Does not return PRIMARY KEY and UNIQUE indexes.
*
* @param string $table_name Table to check the index at
* @param string $index_name The index name to check
*
* @return bool True if index exists, else false
* {@inheritDoc}
*/
function sql_index_exists($table_name, $index_name)
{
@ -1285,12 +1242,7 @@ class tools implements tools_interface
}
/**
* Check if a specified index exists in table. Does not return PRIMARY KEY indexes.
*
* @param string $table_name Table to check the index at
* @param string $index_name The index name to check
*
* @return bool True if index exists, else false
* {@inheritDoc}
*/
function sql_unique_index_exists($table_name, $index_name)
{
@ -1684,7 +1636,7 @@ class tools implements tools_interface
}
/**
* Add new column
* {@inheritDoc}
*/
function sql_column_add($table_name, $column_name, $column_data, $inline = false)
{
@ -1802,7 +1754,7 @@ class tools implements tools_interface
}
/**
* Drop column
* {@inheritDoc}
*/
function sql_column_remove($table_name, $column_name, $inline = false)
{
@ -1931,7 +1883,7 @@ class tools implements tools_interface
}
/**
* Drop Index
* {@inheritDoc}
*/
function sql_index_drop($table_name, $index_name)
{
@ -1961,7 +1913,7 @@ class tools implements tools_interface
}
/**
* Drop Table
* {@inheritDoc}
*/
function sql_table_drop($table_name)
{
@ -2014,7 +1966,7 @@ class tools implements tools_interface
}
/**
* Add primary key
* {@inheritDoc}
*/
function sql_create_primary_key($table_name, $column, $inline = false)
{
@ -2098,7 +2050,7 @@ class tools implements tools_interface
}
/**
* Add unique index
* {@inheritDoc}
*/
function sql_create_unique_index($table_name, $index_name, $column)
{
@ -2135,7 +2087,7 @@ class tools implements tools_interface
}
/**
* Add index
* {@inheritDoc}
*/
function sql_create_index($table_name, $index_name, $column)
{
@ -2188,10 +2140,7 @@ class tools implements tools_interface
}
/**
* List all of the indices that belong to a table,
* does not count:
* * UNIQUE indices
* * PRIMARY keys
* {@inheritDoc}
*/
function sql_list_index($table_name)
{
@ -2287,7 +2236,7 @@ class tools implements tools_interface
}
/**
* Change column type (not name!)
* {@inheritDoc}
*/
function sql_column_change($table_name, $column_name, $column_data, $inline = false)
{