diff --git a/adminer/call.inc.php b/adminer/call.inc.php index e43241de..67b0eab5 100644 --- a/adminer/call.inc.php +++ b/adminer/call.inc.php @@ -92,7 +92,7 @@ if ($in) {
result = $result; @@ -359,7 +359,7 @@ if (!defined('Adminer\DRIVER')) { /** Escape database identifier - * @param string + * @param string $idf * @return string */ function idf_escape($idf) { @@ -367,7 +367,7 @@ if (!defined('Adminer\DRIVER')) { } /** Get escaped table name - * @param string + * @param string $idf * @return string */ function table($idf) { @@ -375,7 +375,7 @@ if (!defined('Adminer\DRIVER')) { } /** Connect to the database - * @param array{string, string, string} [$server, $username, $password] + * @param array{string, string, string} $credentials [$server, $username, $password] * @return string|Db string for error */ function connect($credentials) { @@ -396,7 +396,7 @@ if (!defined('Adminer\DRIVER')) { } /** Get cached list of databases - * @param bool + * @param bool $flush * @return list*/ function get_databases($flush) { @@ -413,11 +413,11 @@ if (!defined('Adminer\DRIVER')) { } /** Formulate SQL query with limit - * @param string everything after SELECT - * @param string including WHERE - * @param int - * @param int - * @param string + * @param string $query everything after SELECT + * @param string $where including WHERE + * @param int $limit + * @param int $offset + * @param string $separator * @return string */ function limit($query, $where, $limit, $offset = 0, $separator = " ") { @@ -425,10 +425,10 @@ if (!defined('Adminer\DRIVER')) { } /** Formulate SQL modification query with limit 1 - * @param string - * @param string everything after UPDATE or DELETE - * @param string - * @param string + * @param string $table + * @param string $query everything after UPDATE or DELETE + * @param string $where + * @param string $separator * @return string */ function limit1($table, $query, $where, $separator = "\n") { @@ -436,8 +436,8 @@ if (!defined('Adminer\DRIVER')) { } /** Get database collation - * @param string - * @param string[][] result of collations() + * @param string $db + * @param string[][] $collations result of collations() * @return string */ function db_collation($db, $collations) { @@ -467,7 +467,7 @@ if (!defined('Adminer\DRIVER')) { } /** Count tables in all databases - * @param list + * @param list $databases * @return int[] [$db => $tables] */ function count_tables($databases) { @@ -479,8 +479,8 @@ if (!defined('Adminer\DRIVER')) { } /** Get table status - * @param string - * @param bool return only "Name", "Engine" and "Comment" fields + * @param string $name + * @param bool $fast return only "Name", "Engine" and "Comment" fields * @return TableStatus[] */ function table_status($name = "", $fast = false) { @@ -509,7 +509,7 @@ if (!defined('Adminer\DRIVER')) { } /** Find out whether the identifier is view - * @param TableStatus + * @param TableStatus $table_status * @return bool */ function is_view($table_status) { @@ -517,7 +517,7 @@ if (!defined('Adminer\DRIVER')) { } /** Check if table supports foreign keys - * @param TableStatus result of table_status1() + * @param TableStatus $table_status result of table_status1() * @return bool */ function fk_support($table_status) { @@ -525,7 +525,7 @@ if (!defined('Adminer\DRIVER')) { } /** Get information about fields - * @param string + * @param string $table * @return Field[] */ function fields($table) { @@ -580,8 +580,8 @@ if (!defined('Adminer\DRIVER')) { } /** Get table indexes - * @param string - * @param ?Db + * @param string $table + * @param ?Db $connection2 * @return Index[] */ function indexes($table, $connection2 = null) { @@ -597,7 +597,7 @@ if (!defined('Adminer\DRIVER')) { } /** Get foreign keys in table - * @param string + * @param string $table * @return ForeignKey[] */ function foreign_keys($table) { @@ -629,7 +629,7 @@ if (!defined('Adminer\DRIVER')) { } /** Get view SELECT - * @param string + * @param string $name * @return array{select:string} */ function view($name) { @@ -656,7 +656,7 @@ if (!defined('Adminer\DRIVER')) { } /** Find out if database is information_schema - * @param string + * @param string $db * @return bool */ function information_schema($db) { @@ -673,8 +673,8 @@ if (!defined('Adminer\DRIVER')) { } /** Create database - * @param string - * @param string + * @param string $db + * @param string $collation * @return Result */ function create_database($db, $collation) { @@ -682,7 +682,7 @@ if (!defined('Adminer\DRIVER')) { } /** Drop databases - * @param list + * @param list $databases * @return bool */ function drop_databases($databases) { @@ -693,8 +693,8 @@ if (!defined('Adminer\DRIVER')) { } /** Rename database from DB - * @param string new name - * @param string + * @param string $name new name + * @param string $collation * @return bool */ function rename_database($name, $collation) { @@ -736,15 +736,15 @@ if (!defined('Adminer\DRIVER')) { } /** Run commands to create or alter table - * @param string "" to create - * @param string new name - * @param list , string}> of [$orig, $process_field, $after] - * @param string[] - * @param string - * @param string - * @param string - * @param string number - * @param string + * @param string $table "" to create + * @param string $name new name + * @param list , string}> $fields of [$orig, $process_field, $after] + * @param string[] $foreign + * @param string $comment + * @param string $engine + * @param string $collation + * @param string $auto_increment number + * @param string $partitioning * @return Result|bool */ function alter_table($table, $name, $fields, $foreign, $comment, $engine, $collation, $auto_increment, $partitioning) { @@ -782,8 +782,8 @@ if (!defined('Adminer\DRIVER')) { } /** Run commands to alter indexes - * @param string escaped table name - * @param list }> of ["index type", "name", ["column definition", ...]] or ["index type", "name", "DROP"] + * @param string $table escaped table name + * @param list }> $alter of ["index type", "name", ["column definition", ...]] or ["index type", "name", "DROP"] * @return Result|bool */ function alter_indexes($table, $alter) { @@ -798,7 +798,7 @@ if (!defined('Adminer\DRIVER')) { } /** Run commands to truncate tables - * @param list + * @param list $tables * @return bool */ function truncate_tables($tables) { @@ -806,7 +806,7 @@ if (!defined('Adminer\DRIVER')) { } /** Drop views - * @param list + * @param list $views * @return Result|bool */ function drop_views($views) { @@ -814,7 +814,7 @@ if (!defined('Adminer\DRIVER')) { } /** Drop tables - * @param list + * @param list $tables * @return Result|bool */ function drop_tables($tables) { @@ -822,9 +822,9 @@ if (!defined('Adminer\DRIVER')) { } /** Move tables to other schema - * @param list - * @param list - * @param string + * @param list $tables + * @param list $views + * @param string $target * @return bool */ function move_tables($tables, $views, $target) { @@ -852,9 +852,9 @@ if (!defined('Adminer\DRIVER')) { } /** Copy tables to other schema - * @param list - * @param list - * @param string + * @param list $tables + * @param list $views + * @param string $target * @return bool */ function copy_tables($tables, $views, $target) { @@ -889,8 +889,8 @@ if (!defined('Adminer\DRIVER')) { } /** Get information about trigger - * @param string trigger name - * @param string + * @param string $name trigger name + * @param string $table * @return Trigger */ function trigger($name, $table) { @@ -902,7 +902,7 @@ if (!defined('Adminer\DRIVER')) { } /** Get defined triggers - * @param string + * @param string $table * @return array{string, string}[] */ function triggers($table) { @@ -925,8 +925,8 @@ if (!defined('Adminer\DRIVER')) { } /** Get information about stored routine - * @param string - * @param 'FUNCTION'|'PROCEDURE' + * @param string $name + * @param 'FUNCTION'|'PROCEDURE' $type * @return Routine */ function routine($name, $type) { @@ -978,8 +978,8 @@ if (!defined('Adminer\DRIVER')) { } /** Get routine signature - * @param string - * @param Routine result of routine() + * @param string $name + * @param Routine $row result of routine() * @return string */ function routine_id($name, $row) { @@ -987,7 +987,7 @@ if (!defined('Adminer\DRIVER')) { } /** Get last auto increment ID - * @param Result or true + * @param Result $result or true * @return string */ function last_id($result) { @@ -995,8 +995,8 @@ if (!defined('Adminer\DRIVER')) { } /** Explain select - * @param Db - * @param string + * @param Db $connection + * @param string $query * @return Result */ function explain($connection, $query) { @@ -1004,8 +1004,8 @@ if (!defined('Adminer\DRIVER')) { } /** Get approximate number of rows - * @param TableStatus - * @param list + * @param TableStatus $table_status + * @param list $where * @return numeric-string|null null if approximate number can't be retrieved */ function found_rows($table_status, $where) { @@ -1013,9 +1013,9 @@ if (!defined('Adminer\DRIVER')) { } /** Get SQL command to create table - * @param string - * @param bool - * @param string + * @param string $table + * @param bool $auto_increment + * @param string $style * @return string */ function create_sql($table, $auto_increment, $style) { @@ -1027,7 +1027,7 @@ if (!defined('Adminer\DRIVER')) { } /** Get SQL command to truncate table - * @param string + * @param string $table * @return string */ function truncate_sql($table) { @@ -1035,7 +1035,7 @@ if (!defined('Adminer\DRIVER')) { } /** Get SQL command to change database - * @param string + * @param string $database * @return string */ function use_sql($database) { @@ -1043,7 +1043,7 @@ if (!defined('Adminer\DRIVER')) { } /** Get SQL commands to create triggers - * @param string + * @param string $table * @return string */ function trigger_sql($table) { @@ -1076,7 +1076,7 @@ if (!defined('Adminer\DRIVER')) { } /** Convert field in select and edit - * @param Field one element from fields() + * @param Field $field one element from fields() * @return string|void */ function convert_field($field) { @@ -1092,8 +1092,8 @@ if (!defined('Adminer\DRIVER')) { } /** Convert value in edit after applying functions back - * @param Field one element from fields() - * @param string SQL expression + * @param Field $field one element from fields() + * @param string $return SQL expression * @return string */ function unconvert_field($field, $return) { @@ -1111,7 +1111,7 @@ if (!defined('Adminer\DRIVER')) { } /** Check whether a feature is supported - * @param literal-string "check|comment|copy|database|descidx|drop_col|dump|event|indexes|kill|materializedview|partitioning|privileges|procedure|processlist|routine|scheme|sequence|status|table|trigger|type|variables|view|view_trigger" + * @param literal-string $feature "check|comment|copy|database|descidx|drop_col|dump|event|indexes|kill|materializedview|partitioning|privileges|procedure|processlist|routine|scheme|sequence|status|table|trigger|type|variables|view|view_trigger" * @return bool */ function support($feature) { @@ -1119,7 +1119,7 @@ if (!defined('Adminer\DRIVER')) { } /** Kill a process - * @param numeric-string + * @param numeric-string $val * @return Result|bool */ function kill_process($val) { @@ -1150,7 +1150,7 @@ if (!defined('Adminer\DRIVER')) { } /** Get values of user defined type - * @param int + * @param int $id * @return string */ function type_values($id) { @@ -1172,8 +1172,8 @@ if (!defined('Adminer\DRIVER')) { } /** Set current schema - * @param string - * @param Db + * @param string $schema + * @param Db $connection2 * @return bool */ function set_schema($schema, $connection2 = null) { diff --git a/adminer/drivers/sqlite.inc.php b/adminer/drivers/sqlite.inc.php index 0deb5107..54211c27 100644 --- a/adminer/drivers/sqlite.inc.php +++ b/adminer/drivers/sqlite.inc.php @@ -452,15 +452,15 @@ if (isset($_GET["sqlite"])) { } /** Recreate table - * @param string original name - * @param string new name - * @param list > [process_field()], empty to preserve - * @param string[] [$original => idf_escape($new_column)], empty to preserve - * @param string[] [format_foreign_key()], empty to preserve - * @param int set auto_increment to this value, 0 to preserve - * @param list
|'DROP'}> [[$type, $name, $columns]], empty to preserve - * @param string CHECK constraint to drop - * @param string CHECK constraint to add + * @param string $table original name + * @param string $name new name + * @param list > $fields [process_field()], empty to preserve + * @param string[] $originals [$original => idf_escape($new_column)], empty to preserve + * @param string[] $foreign [format_foreign_key()], empty to preserve + * @param int $auto_increment set auto_increment to this value, 0 to preserve + * @param list
|'DROP'}> $indexes [[$type, $name, $columns]], empty to preserve + * @param string $drop_check CHECK constraint to drop + * @param string $add_check CHECK constraint to add * @return bool */ function recreate_table($table, $name, $fields, $originals, $foreign, $auto_increment = 0, $indexes = array(), $drop_check = "", $add_check = "") { diff --git a/adminer/include/adminer.inc.php b/adminer/include/adminer.inc.php index 2db9148a..d9c1800b 100644 --- a/adminer/include/adminer.inc.php +++ b/adminer/include/adminer.inc.php @@ -28,7 +28,7 @@ class Adminer { } /** Get key used for permanent login - * @param bool + * @param bool $create * @return string cryptic string which gets combined with password or false in case of an error */ function permanentLogin($create = false) { @@ -43,7 +43,7 @@ class Adminer { } /** Get server name displayed in breadcrumbs - * @param string + * @param string $server * @return string HTML code or null */ function serverName($server) { @@ -59,7 +59,7 @@ class Adminer { } /** Get cached list of databases - * @param bool + * @param bool $flush * @return list */ function databases($flush = true) { @@ -94,7 +94,7 @@ class Adminer { } /** Print HTML code inside - * @param bool dark CSS: false to disable, true to force, null to base on user preferences + * @param bool $dark dark CSS: false to disable, true to force, null to base on user preferences * @return bool true to link favicon.ico */ function head($dark = null) { @@ -137,9 +137,9 @@ class Adminer { } /** Get login form field - * @param string - * @param string HTML - * @param string HTML + * @param string $name + * @param string $heading HTML + * @param string $value HTML * @return string */ function loginFormField($name, $heading, $value) { @@ -147,8 +147,8 @@ class Adminer { } /** Authorize the user - * @param string - * @param string + * @param string $login + * @param string $password * @return mixed true for success, string for error message, false for unknown error */ function login($login, $password) { @@ -159,7 +159,7 @@ class Adminer { } /** Table caption used in navigation and headings - * @param TableStatus result of table_status1() + * @param TableStatus $tableStatus result of table_status1() * @return string HTML code, "" to ignore table */ function tableName($tableStatus) { @@ -167,8 +167,8 @@ class Adminer { } /** Field caption used in select and edit - * @param Field single field returned from fields() - * @param int order of column in select + * @param Field $field single field returned from fields() + * @param int $order order of column in select * @return string HTML code, "" to ignore field */ function fieldName($field, $order = 0) { @@ -178,8 +178,8 @@ class Adminer { } /** Print links after select heading - * @param TableStatus result of table_status1() - * @param string new item options, NULL for no new item + * @param TableStatus $tableStatus result of table_status1() + * @param string $set new item options, NULL for no new item * @return void */ function selectLinks($tableStatus, $set = "") { @@ -210,7 +210,7 @@ class Adminer { } /** Get foreign keys for table - * @param string + * @param string $table * @return ForeignKey[] same format as foreign_keys() */ function foreignKeys($table) { @@ -218,8 +218,8 @@ class Adminer { } /** Find backward keys for table - * @param string - * @param string + * @param string $table + * @param string $tableName * @return BackwardKey[] */ function backwardKeys($table, $tableName) { @@ -227,17 +227,17 @@ class Adminer { } /** Print backward keys for row - * @param BackwardKey[] result of $this->backwardKeys() - * @param string[] + * @param BackwardKey[] $backwardKeys result of $this->backwardKeys() + * @param string[] $row * @return void */ function backwardKeysPrint($backwardKeys, $row) { } /** Query printed in select before execution - * @param string query to be executed - * @param float start time of the query - * @param bool + * @param string $query query to be executed + * @param float $start start time of the query + * @param bool $failed * @return string */ function selectQuery($query, $start, $failed = false) { @@ -256,7 +256,7 @@ class Adminer { } /** Query printed in SQL command before execution - * @param string query to be executed + * @param string $query query to be executed * @return string escaped query to be printed */ function sqlCommandQuery($query) { @@ -270,7 +270,7 @@ class Adminer { } /** Description of a row in a table - * @param string + * @param string $table * @return string SQL expression, empty string for no description */ function rowDescription($table) { @@ -278,8 +278,8 @@ class Adminer { } /** Get descriptions of selected data - * @param list all data to print - * @param ForeignKey[] + * @param list $rows all data to print + * @param ForeignKey[] $foreignKeys * @return list */ function rowDescriptions($rows, $foreignKeys) { @@ -287,18 +287,18 @@ class Adminer { } /** Get a link to use in select table - * @param string raw value of the field - * @param Field single field returned from fields() + * @param string $val raw value of the field + * @param Field $field single field returned from fields() * @return string|void null to create the default link */ function selectLink($val, $field) { } /** Value printed in select table - * @param string HTML-escaped value to print - * @param string link to foreign key - * @param Field single field returned from fields() - * @param string original value before applying editVal() and escaping + * @param string $val HTML-escaped value to print + * @param string $link link to foreign key + * @param Field $field single field returned from fields() + * @param string $original original value before applying editVal() and escaping * @return string */ function selectVal($val, $link, $field, $original) { @@ -314,8 +314,8 @@ class Adminer { } /** Value conversion used in select and edit - * @param string - * @param Field single field returned from fields() + * @param string $val + * @param Field $field single field returned from fields() * @return string */ function editVal($val, $field) { @@ -323,8 +323,8 @@ class Adminer { } /** Print table structure in tabular format - * @param Field[] data about individual fields - * @param TableStatus + * @param Field[] $fields data about individual fields + * @param TableStatus $tableStatus * @return void */ function tableStructurePrint($fields, $tableStatus = null) { @@ -355,7 +355,7 @@ class Adminer { } /** Print list of indexes on table in tabular format - * @param Index[] data about all indexes on a table + * @param Index[] $indexes data about all indexes on a table * @return void */ function tableIndexesPrint($indexes) { @@ -375,8 +375,8 @@ class Adminer { } /** Print columns box in select - * @param list result of selectColumnsProcess()[0] - * @param string[] selectable columns + * @param list $select result of selectColumnsProcess()[0] + * @param string[] $columns selectable columns * @return void */ function selectColumnsPrint($select, $columns) { @@ -402,9 +402,9 @@ class Adminer { } /** Print search box in select - * @param list result of selectSearchProcess() - * @param string[] selectable columns - * @param Index[] + * @param list $where result of selectSearchProcess() + * @param string[] $columns selectable columns + * @param Index[] $indexes * @return void */ function selectSearchPrint($where, $columns, $indexes) { @@ -438,9 +438,9 @@ class Adminer { } /** Print order box in select - * @param list result of selectOrderProcess() - * @param string[] selectable columns - * @param Index[] + * @param list $order result of selectOrderProcess() + * @param string[] $columns selectable columns + * @param Index[] $indexes * @return void */ function selectOrderPrint($order, $columns, $indexes) { @@ -459,7 +459,7 @@ class Adminer { } /** Print limit box in select - * @param string result of selectLimitProcess() + * @param string $limit result of selectLimitProcess() * @return void */ function selectLimitPrint($limit) { @@ -470,7 +470,7 @@ class Adminer { } /** Print text length box in select - * @param string result of selectLengthProcess() + * @param string $text_length result of selectLengthProcess() * @return void */ function selectLengthPrint($text_length) { @@ -482,7 +482,7 @@ class Adminer { } /** Print action box in select - * @param Index[] + * @param Index[] $indexes * @return void */ function selectActionPrint($indexes) { @@ -523,16 +523,16 @@ class Adminer { } /** Print extra text in the end of a select form - * @param string[] fields holding e-mails - * @param string[] selectable columns + * @param string[] $emailFields fields holding e-mails + * @param string[] $columns selectable columns * @return void */ function selectEmailPrint($emailFields, $columns) { } /** Process columns box in select - * @param string[] selectable columns - * @param Index[] + * @param string[] $columns selectable columns + * @param Index[] $indexes * @return list > [[select_expressions], [group_expressions]] */ function selectColumnsProcess($columns, $indexes) { @@ -551,8 +551,8 @@ class Adminer { } /** Process search box in select - * @param Field[] - * @param Index[] + * @param Field[] $fields + * @param Index[] $indexes * @return list
expressions to join by AND */ function selectSearchProcess($fields, $indexes) { @@ -605,8 +605,8 @@ class Adminer { } /** Process order box in select - * @param Field[] - * @param Index[] + * @param Field[] $fields + * @param Index[] $indexes * @return list expressions to join by comma */ function selectOrderProcess($fields, $indexes) { @@ -636,8 +636,8 @@ class Adminer { } /** Process extras in select form - * @param string[] AND conditions - * @param ForeignKey[] + * @param string[] $where AND conditions + * @param ForeignKey[] $foreignKeys * @return bool true if processed, false to process other parts of form */ function selectEmailProcess($where, $foreignKeys) { @@ -645,12 +645,12 @@ class Adminer { } /** Build SQL query used in select - * @param list result of selectColumnsProcess()[0] - * @param list result of selectSearchProcess() - * @param list result of selectColumnsProcess()[1] - * @param list result of selectOrderProcess() - * @param int result of selectLimitProcess() - * @param int index of page starting at zero + * @param list $select result of selectColumnsProcess()[0] + * @param list $where result of selectSearchProcess() + * @param list $group result of selectColumnsProcess()[1] + * @param list $order result of selectOrderProcess() + * @param int $limit result of selectLimitProcess() + * @param int $page index of page starting at zero * @return string empty string to use default query */ function selectQueryBuild($select, $where, $group, $order, $limit, $page) { @@ -658,9 +658,9 @@ class Adminer { } /** Query printed after execution in the message - * @param string executed query - * @param string elapsed time - * @param bool + * @param string $query executed query + * @param string $time elapsed time + * @param bool $failed * @return string */ function messageQuery($query, $time, $failed = false) { @@ -689,17 +689,17 @@ class Adminer { } /** Print before edit form - * @param string - * @param Field[] - * @param mixed - * @param bool + * @param string $table + * @param Field[] $fields + * @param mixed $row + * @param bool $update * @return void */ function editRowPrint($table, $fields, $row, $update) { } /** Functions displayed in edit form - * @param Field single field from fields() + * @param Field $field single field from fields() * @return list */ function editFunctions($field) { @@ -725,10 +725,10 @@ class Adminer { } /** Get options to display edit field - * @param string table name - * @param Field single field from fields() - * @param string attributes to use inside the tag - * @param string + * @param string $table table name + * @param Field $field single field from fields() + * @param string $attrs attributes to use inside the tag + * @param string $value * @return string custom input field or empty string for default */ function editInput($table, $field, $attrs, $value) { @@ -742,9 +742,9 @@ class Adminer { } /** Get hint for edit field - * @param string table name - * @param Field single field from fields() - * @param string + * @param string $table table name + * @param Field $field single field from fields() + * @param string $value * @return string */ function editHint($table, $field, $value) { @@ -752,9 +752,9 @@ class Adminer { } /** Process sent input - * @param Field single field from fields() - * @param string - * @param string + * @param Field $field single field from fields() + * @param string $value + * @param string $function * @return string expression to use in a query */ function processInput($field, $value, $function = "") { @@ -798,16 +798,16 @@ class Adminer { } /** Export database structure - * @param string + * @param string $db * @return void prints data */ function dumpDatabase($db) { } /** Export table structure - * @param string - * @param string - * @param int 0 table, 1 view, 2 temporary view table + * @param string $table + * @param string $style + * @param int $is_view 0 table, 1 view, 2 temporary view table * @return void prints data */ function dumpTable($table, $style, $is_view = 0) { @@ -840,9 +840,9 @@ class Adminer { } /** Export table data - * @param string - * @param string - * @param string + * @param string $table + * @param string $style + * @param string $query * @return void prints data */ function dumpData($table, $style, $query) { @@ -934,7 +934,7 @@ class Adminer { } /** Set export filename - * @param string + * @param string $identifier * @return string filename without extension */ function dumpFilename($identifier) { @@ -942,8 +942,8 @@ class Adminer { } /** Send headers for export - * @param string - * @param bool + * @param string $identifier + * @param bool $multi_table * @return string extension */ function dumpHeaders($identifier, $multi_table = false) { @@ -991,7 +991,7 @@ class Adminer { } /** Print navigation after Adminer title - * @param string can be "auth" if there is no database connection, "db" if there is no database selected, "ns" with invalid schema + * @param string $missing can be "auth" if there is no database connection, "db" if there is no database selected, "ns" with invalid schema * @return void */ function navigation($missing) { @@ -1052,7 +1052,7 @@ class Adminer { } /** Set up syntax highlight for code and