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

Doc-comments: Add param names

This commit is contained in:
Jakub Vrana
2025-03-28 07:06:34 +01:00
parent 3bde36b68e
commit 911f3b71b7
37 changed files with 548 additions and 548 deletions

View File

@@ -10,7 +10,7 @@ class AdminerDatabaseHide {
protected $disabled;
/**
* @param list<string> case insensitive database names in values
* @param list<string> $disabled case insensitive database names in values
*/
function __construct($disabled) {
$this->disabled = array_map('strtolower', $disabled);

View File

@@ -10,7 +10,7 @@ class AdminerDesigns {
protected $designs;
/**
* @param list<string> URL in key, name in value
* @param list<string> $designs URL in key, name in value
*/
function __construct($designs) {
$this->designs = $designs;

View File

@@ -14,7 +14,7 @@ if (isset($_GET["elastic"])) {
/**
* @param string $path
* @param array|null $content
* @param ?array $content
* @param string $method
* @return array|false
*/
@@ -54,7 +54,7 @@ if (isset($_GET["elastic"])) {
/** Perform query relative to actual selected DB
* @param string $path
* @param array|null $content
* @param ?array $content
* @param string $method
* @return array|false
*/
@@ -531,7 +531,7 @@ if (isset($_GET["elastic"])) {
}
/** Alter type
* @param array
* @param array $table
* @return mixed
*/
function alter_table($table, $name, $fields, $foreign, $comment, $engine, $collation, $auto_increment, $partitioning) {
@@ -552,7 +552,7 @@ if (isset($_GET["elastic"])) {
}
/** Drop types
* @param list<string>
* @param list<string> $tables
* @return bool
*/
function drop_tables($tables) {

View File

@@ -12,8 +12,8 @@ class AdminerEditCalendar {
protected $prepend, $langPath;
/**
* @param string text to append before first calendar usage
* @param string path to language file, %s stands for language code
* @param string $prepend text to append before first calendar usage
* @param string $langPath path to language file, %s stands for language code
*/
function __construct($prepend = null, $langPath = "jquery-ui/i18n/jquery.ui.datepicker-%s.js") {
$this->prepend = $prepend;

View File

@@ -10,11 +10,11 @@ class AdminerEmailTable {
protected $table, $id, $title, $subject, $message;
/**
* @param string quoted table name
* @param string quoted column name
* @param string quoted column name
* @param string quoted column name
* @param string quoted column name
* @param string $table quoted table name
* @param string $id quoted column name
* @param string $title quoted column name
* @param string $subject quoted column name
* @param string $message quoted column name
*/
function __construct($table = "email", $id = "id", $title = "subject", $subject = "subject", $message = "message") {
$this->table = $table;

View File

@@ -11,9 +11,9 @@ class AdminerFileUpload {
protected $uploadPath, $displayPath, $extensions;
/**
* @param string prefix for uploading data (create writable subdirectory for each table containing uploadable fields)
* @param string prefix for displaying data, null stands for $uploadPath
* @param string regular expression with allowed file extensions
* @param string $uploadPath prefix for uploading data (create writable subdirectory for each table containing uploadable fields)
* @param string $displayPath prefix for displaying data, null stands for $uploadPath
* @param string $extensions regular expression with allowed file extensions
*/
function __construct($uploadPath = "../static/data/", $displayPath = null, $extensions = "[a-zA-Z0-9]+") {
$this->uploadPath = $uploadPath;

View File

@@ -10,7 +10,7 @@ class AdminerFrames {
protected $sameOrigin;
/**
* @param bool allow running from the same origin only
* @param bool $sameOrigin allow running from the same origin only
*/
function __construct($sameOrigin = false) {
$this->sameOrigin = $sameOrigin;

View File

@@ -10,8 +10,8 @@ class AdminerLoginIp {
protected $ips, $forwarded_for;
/** Set allowed IP addresses
* @param list<string> IP address prefixes
* @param list<string> X-Forwarded-For prefixes if IP address matches, empty array means anything
* @param list<string> $ips IP address prefixes
* @param list<string> $forwarded_for X-Forwarded-For prefixes if IP address matches, empty array means anything
*/
function __construct($ips, $forwarded_for = array()) {
$this->ips = $ips;

View File

@@ -10,7 +10,7 @@ class AdminerLoginOtp {
protected $secret;
/**
* @param string decoded secret, e.g. base64_decode("SECRET")
* @param string $secret decoded secret, e.g. base64_decode("SECRET")
*/
function __construct($secret) {
$this->secret = $secret;

View File

@@ -10,7 +10,7 @@ class AdminerLoginPasswordLess {
protected $password_hash;
/** Set allowed password
* @param string result of password_hash
* @param string $password_hash result of password_hash
*/
function __construct($password_hash) {
$this->password_hash = $password_hash;

View File

@@ -10,7 +10,7 @@ class AdminerLoginServers {
protected $servers;
/** Set supported servers
* @param array{server:string, driver:string}[] [$description => ["server" => , "driver" => "server|pgsql|sqlite|..."]]
* @param array{server:string, driver:string}[] $servers [$description => ["server" => , "driver" => "server|pgsql|sqlite|..."]]
*/
function __construct($servers) {
$this->servers = $servers;

View File

@@ -10,7 +10,7 @@ class AdminerLoginSsl {
protected $ssl;
/**
* @param array
* @param array $ssl
* MySQL: ["key" => filename, "cert" => filename, "ca" => filename, "verify" => bool]
* PostgresSQL: ["mode" => sslmode] (https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNECT-SSLMODE)
* MSSQL: ["Encrypt" => true, "TrustServerCertificate" => true] (https://learn.microsoft.com/en-us/sql/connect/php/connection-options)

View File

@@ -19,7 +19,7 @@ class AdminerLoginTable {
protected $database;
/** Set database of login table
* @param string
* @param string $database
*/
function __construct($database) {
$this->database = $database;

View File

@@ -10,7 +10,7 @@ class AdminerMasterSlave {
private $masters = array();
/**
* @param string[] [$slave => $master]
* @param string[] $masters [$slave => $master]
*/
function __construct($masters) {
$this->masters = $masters;

View File

@@ -10,8 +10,8 @@ class AdminerSlugify {
protected $from, $to;
/**
* @param string find these characters ...
* @param string ... and replace them by these
* @param string $from find these characters ...
* @param string $to ... and replace them by these
*/
function __construct($from = 'áčďéěíňóřšťúůýž', $to = 'acdeeinorstuuyz') {
$this->from = $from;

View File

@@ -14,8 +14,8 @@ class AdminerSqlGemini {
private $model;
/**
* @param string Get API key at: https://aistudio.google.com/apikey
* @param string Available models: https://ai.google.dev/gemini-api/docs/models#available-models
* @param string $apiKey Get API key at: https://aistudio.google.com/apikey
* @param string $model Available models: https://ai.google.dev/gemini-api/docs/models#available-models
*/
function __construct($apiKey, $model = "gemini-2.0-flash") {
$this->apiKey = $apiKey;

View File

@@ -10,7 +10,7 @@ class AdminerSqlLog {
protected $filename;
/**
* @param string defaults to "$database.sql"
* @param string $filename defaults to "$database.sql"
*/
function __construct($filename = "") {
$this->filename = $filename;

View File

@@ -9,7 +9,7 @@
class AdminerTableIndexesStructure {
/** Print table structure in tabular format
* @param Index[] data about all indexes on a table
* @param Index[] $indexes data about all indexes on a table
* @return bool
*/
function tableIndexesPrint($indexes) {

View File

@@ -9,7 +9,7 @@
class AdminerTableStructure {
/** Print table structure in tabular format
* @param Field[] data about individual fields
* @param Field[] $fields data about individual fields
* @return bool
*/
function tableStructurePrint($fields, $tableStatus = null) {

View File

@@ -11,7 +11,7 @@ class AdminerTinymce {
protected $path;
/**
* @param string
* @param string $path
*/
function __construct($path = "tiny_mce/tiny_mce.js") {
$this->path = $path;