mirror/php-adminer
1
0
Fork 0
mirror of https://github.com/vrana/adminer.git synced 2025-08-08 15:47:00 +02:00
Code Issues Releases Wiki Activity

Doc-comment: Improve array @param

Browse Source 
This uses syntax from https://phpstan.org/writing-php-code/phpdoc-types#general-arrays.

int[] means an array of ints with arbitrary keys (usually strings)
list<string> means an array of strings with sequential integer keys starting at 0
list<string>[] means an arbitrary array of string lists
list<string[]> means list of arbitrary string arrays
string[][] means two dimensional array with arbitrary keys in both dimensions
array was left in the comments for https://phpstan.org/writing-php-code/phpdoc-types#array-shapes
This commit is contained in:
Jakub Vrana
2025-03-25 14:31:27 +01:00
parent 26aa48122f
commit 2ee325183b
17 changed files with 97 additions and 97 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
adminer/include/editing.inc.php
View File

@@ -143,7 +143,7 @@ function textarea($name, $value, $rows = 10, $cols = 80) {
/** Generate HTML <select> or <input> if $options are empty
* @param string
* @param array
* @param string[]
* @param string
* @param string
* @param string
@@ -178,10 +178,10 @@ function json_row($key, $val = null) {
/** Print table columns for type edit
* @param string
* @param array
* @param array
* @param array returned by referencable_primary()
* @param array extra types to prepend
* @param list<string>[]
* @param array[]
* @param array[] returned by referencable_primary()
* @param list<string> extra types to prepend
* @return null
*/
function edit_type($key, $field, $collations, $foreign_keys = array(), $extra_types = array()) {
@@ -317,10 +317,10 @@ function type_class($type) {
}
/** Print table interior for fields editing
* @param array
* @param array
* @param array[]
* @param list<string>[]
* @param string TABLE or PROCEDURE
* @param array returned by referencable_primary()
* @param array[] returned by referencable_primary()
* @return null
*/
function edit_fields($fields, $collations, $type = "TABLE", $foreign_keys = array()) {
@@ -382,7 +382,7 @@ function edit_fields($fields, $collations, $type = "TABLE", $foreign_keys = arra
}
/** Move fields up and down or add field
* @param array
* @param array[]
* @return bool
*/
function process_fields(&$fields) {
@@ -423,7 +423,7 @@ function process_fields(&$fields) {
}
/** Callback used in routine()
* @param array
* @param list<array>
* @return string
*/
function normalize_enum($match) {
@@ -432,7 +432,7 @@ function normalize_enum($match) {
/** Issue grant or revoke commands
* @param string GRANT or REVOKE
* @param array
* @param list<string>
* @param string
* @param string
* @return bool
@@ -502,7 +502,7 @@ function create_trigger($on, $row) {
/** Generate SQL query for creating routine
* @param string "PROCEDURE" or "FUNCTION"
* @param array result of routine()
* @param string[] result of routine()
* @return string
*/
function create_routine($routine, $row) {
@@ -587,7 +587,7 @@ function ini_bytes($ini) {
}
/** Create link to database documentation
* @param array JUSH => $path
* @param string[] JUSH => $path
* @param string HTML code
* @return string HTML code
*/