From b71edb53806b7bb2867db6ab391a11a7e91ccade Mon Sep 17 00:00:00 2001 From: Crack Date: Sat, 17 Jul 2010 14:23:15 +0200 Subject: [PATCH] add missing @uses comments --- libraries/config/ConfigFile.class.php | 11 ++++++- libraries/config/Form.class.php | 6 ++++ libraries/config/FormDisplay.class.php | 45 ++++++++++++++++++++++++++ libraries/config/FormDisplay.tpl.php | 11 +++++++ 4 files changed, 72 insertions(+), 1 deletion(-) diff --git a/libraries/config/ConfigFile.class.php b/libraries/config/ConfigFile.class.php index b9357ad7a..2d3ff28d5 100644 --- a/libraries/config/ConfigFile.class.php +++ b/libraries/config/ConfigFile.class.php @@ -7,7 +7,8 @@ */ /** - * Config file management and generation class + * Config file management and generation class. + * Stores its data in $_SESSION * * @package phpMyAdmin */ @@ -57,6 +58,8 @@ class ConfigFile /** * Private constructor, use {@link getInstance()} + * + * @uses PMA_array_write() */ private function __construct() { @@ -144,6 +147,8 @@ class ConfigFile /** * Sets config value * + * @uses PMA_array_remove() + * @uses PMA_array_write() * @param string $path * @param mixed $value * @param string $canonical_path @@ -223,6 +228,7 @@ class ConfigFile /** * Returns config value or $default if it's not set * + * @uses PMA_array_read() * @param string $path * @param mixed $default * @return mixed @@ -237,6 +243,7 @@ class ConfigFile * exist in config.default.php ($cfg) and config.values.php * ($_cfg_db['_overrides']) * + * @uses PMA_array_read() * @param string $canonical_path * @param mixed $default * @return mixed @@ -250,6 +257,7 @@ class ConfigFile * Returns config value, if it's not set uses the default one; returns * $default if the path isn't set and doesn't contain a default value * + * @uses PMA_array_read() * @param string $path * @param mixed $default * @return mixed @@ -277,6 +285,7 @@ class ConfigFile /** * Returns config database entry for $path ($cfg_db in config_info.php) * + * @uses PMA_array_read() * @param string $path * @param mixed $default * @return mixed diff --git a/libraries/config/Form.class.php b/libraries/config/Form.class.php index bea1e5000..96fc48bd8 100644 --- a/libraries/config/Form.class.php +++ b/libraries/config/Form.class.php @@ -74,6 +74,8 @@ class Form /** * Returns allowed values for select fields * + * @uses ConfigFile::getDbEntry() + * @uses ConfigFile::getInstance() * @param string $option_path * @return array */ @@ -157,6 +159,10 @@ class Form /** * Reads fields' types to $this->fieldsTypes + * + * @uses ConfigFile::getDbEntry() + * @uses ConfigFile::getDefault() + * @uses ConfigFile::getInstance() */ protected function readTypes() { diff --git a/libraries/config/FormDisplay.class.php b/libraries/config/FormDisplay.class.php index c2837c892..7c77d0472 100644 --- a/libraries/config/FormDisplay.class.php +++ b/libraries/config/FormDisplay.class.php @@ -131,6 +131,10 @@ class FormDisplay /** * Runs validation for all registered forms + * + * @uses ConfigFile::getInstance() + * @uses ConfigFile::getValue() + * @uses PMA_config_validate() */ private function _validate() { @@ -175,6 +179,20 @@ class FormDisplay /** * Outputs HTML for forms * + * @uses ConfigFile::getInstance() + * @uses ConfigFile::get() + * @uses display_fieldset_bottom() + * @uses display_fieldset_top() + * @uses display_form_bottom() + * @uses display_form_top() + * @uses display_js() + * @uses display_tabs_bottom() + * @uses display_tabs_top() + * @uses js_validate() + * @uses PMA_config_get_validators() + * @uses PMA_jsFormat() + * @uses PMA_lang() + * @uses PMA_read_userprefs_fieldnames() * @param bool $tabbed_form * @param bool $show_restore_default whether show "restore default" button besides the input field */ @@ -271,6 +289,17 @@ class FormDisplay /** * Prepares data for input field display and outputs HTML code * + * @uses ConfigFile::get() + * @uses ConfigFile::getDefault() + * @uses ConfigFile::getInstance() + * @uses display_group_footer() + * @uses display_group_header() + * @uses display_input() + * @uses Form::getOptionType() + * @uses Form::getOptionValueList() + * @uses PMA_escapeJsString() + * @uses PMA_lang_desc() + * @uses PMA_lang_name() * @param Form $form * @param string $field field name as it appears in $form * @param string $system_path field path, eg. Servers/1/verbose @@ -381,6 +410,9 @@ class FormDisplay /** * Displays errors + * + * @uses display_errors() + * @uses PMA_lang_name() */ public function displayErrors() { @@ -402,6 +434,11 @@ class FormDisplay /** * Reverts erroneous fields to their default values + * + * @uses ConfigFile::getDefault() + * @uses ConfigFile::getInstance() + * @uses ConfigFile::set() + * */ public function fixErrors() { @@ -441,6 +478,14 @@ class FormDisplay /** * Validates and saves form data to session * + * @uses ConfigFile::get() + * @uses ConfigFile::getInstance() + * @uses ConfigFile::getServerCount() + * @uses ConfigFile::set() + * @uses Form::getOptionType() + * @uses Form::getOptionValueList() + * @uses PMA_lang_name() + * @uses PMA_read_userprefs_fieldnames() * @param array|string $forms array of form names * @param bool $allow_partial_save allows for partial form saving on failed validation * @return boolean true on success (no errors and all saved) diff --git a/libraries/config/FormDisplay.tpl.php b/libraries/config/FormDisplay.tpl.php index e202f0fbf..ed6e22297 100644 --- a/libraries/config/FormDisplay.tpl.php +++ b/libraries/config/FormDisplay.tpl.php @@ -9,6 +9,8 @@ /** * Displays top part of the form * + * @uses PMA_generate_common_hidden_inputs() + * @uses PMA_getHiddenFields() * @param string $action default: $_SERVER['REQUEST_URI'] * @param string $method 'post' or 'get' * @param array $hidden_fields array of form hidden fields (key: field name) @@ -108,6 +110,10 @@ function display_fieldset_top($title = '', $description = '', $errors = null, $a * o values_disabled - (array)list of disabled values (keys from values) * o wiki - (string) wiki link * + * @uses $GLOBALS['_FormDisplayGroup'] + * @uses $GLOBALS['cfg']['ThemePath'] + * @uses $_SESSION['PMA_Theme'] + * @uses display_group_footer() * @param string $path * @param string $name * @param string $description @@ -254,6 +260,8 @@ function display_input($path, $name, $description = '', $type, $value, $value_is /** * Display group header * + * @uses $GLOBALS['_FormDisplayGroup'] + * @uses display_group_footer() * @param string $header_text */ function display_group_header($header_text) @@ -282,6 +290,8 @@ function display_group_header($header_text) /** * Display group footer + * + * @uses $GLOBALS['_FormDisplayGroup'] */ function display_group_footer() { @@ -343,6 +353,7 @@ function display_form_bottom() /** * Appends JS validation code to $js_array * + * @uses PMA_escapeJsString() * @param string $field_id * @param string|array $validator * @param array $js_array