1
0
mirror of https://github.com/vrana/adminer.git synced 2025-08-07 15:16:44 +02:00

Doc-comment: Improve array @param

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

View File

@@ -87,7 +87,7 @@ function checkbox($name, $value, $checked, $label = "", $onclick = "", $class =
}
/** Generate list of HTML options
* @param array array of strings or arrays (creates optgroup)
* @param string[]|string[][] array of strings or arrays (creates optgroup)
* @param mixed
* @param bool always use array keys for value="", otherwise only string keys are used
* @return string
@@ -116,7 +116,7 @@ function optionlist($options, $selected = null, $use_keys = false) {
/** Generate HTML <select>
* @param string
* @param array
* @param string[]
* @param string
* @param string
* @param string
@@ -132,7 +132,7 @@ function html_select($name, $options, $value = "", $onchange = "", $labelled_by
/** Generate HTML radio list
* @param string
* @param array
* @param string[]
* @param string
* @return string
*/
@@ -198,7 +198,7 @@ function pagination($page, $current) {
/** Print hidden fields
* @param array
* @param array
* @param list<string>
* @param string
* @return bool
*/
@@ -426,7 +426,7 @@ function on_help($command, $side = 0) {
/** Print edit data form
* @param string
* @param array
* @param array[]
* @param mixed
* @param bool
* @return null