diff options
34 files changed, 168 insertions, 0 deletions
diff --git a/examples/signon-script.php b/examples/signon-script.php index 52777a0743..db98c73247 100644 --- a/examples/signon-script.php +++ b/examples/signon-script.php @@ -18,6 +18,7 @@ * It can optionally use configured username as parameter. * * @param string $user + * * @return array */ function get_login_credentials($user) diff --git a/libraries/Theme.class.php b/libraries/Theme.class.php index 15fedeb580..89e2f2105d 100644 --- a/libraries/Theme.class.php +++ b/libraries/Theme.class.php @@ -112,6 +112,7 @@ class PMA_Theme * @static * @access public * @param string $folder path to theme + * * @return object PMA_Theme */ static public function load($folder) @@ -213,6 +214,7 @@ class PMA_Theme * * @access public * @param string $version version to compare to + * * @return boolean */ function checkVersion($version) @@ -287,6 +289,7 @@ class PMA_Theme * * @access public * @param string $type left, right or print + * * @return bool */ function loadCss(&$type) diff --git a/libraries/Theme_Manager.class.php b/libraries/Theme_Manager.class.php index fe3add14f2..ddc241ddb4 100644 --- a/libraries/Theme_Manager.class.php +++ b/libraries/Theme_Manager.class.php @@ -59,6 +59,7 @@ class PMA_Theme_Manager * sets path to folder containing the themes * * @param string $path path to themes folder + * * @return boolean success */ function setThemesPath($path) @@ -217,6 +218,7 @@ class PMA_Theme_Manager /** * @private * @param string $folder + * * @return boolean */ private function _checkThemeFolder($folder) @@ -277,6 +279,7 @@ class PMA_Theme_Manager * checks if given theme name is a known theme * * @param string $theme name fo theme to check for + * * @return bool */ function checkTheme($theme) @@ -292,6 +295,7 @@ class PMA_Theme_Manager * returns HTML selectbox, with or without form enclosed * * @param boolean $form whether enclosed by from tags or not + * * @return string */ function getHtmlSelectBox($form = true) @@ -372,6 +376,7 @@ class PMA_Theme_Manager * prints css data * * @param string $type + * * @return bool */ function printCss($type) diff --git a/libraries/Tracker.class.php b/libraries/Tracker.class.php index eee5ffd6a4..5724f6e52a 100644 --- a/libraries/Tracker.class.php +++ b/libraries/Tracker.class.php @@ -955,6 +955,7 @@ class PMA_Tracker * Converts int<>string for Drizzle, does nothing for MySQL * * @param int|string $tracking_set + * * @return int|string */ static private function transformTrackingSet($tracking_set) diff --git a/libraries/auth/swekey/swekey.php b/libraries/auth/swekey/swekey.php index 02f14500a3..0f49732101 100644 --- a/libraries/auth/swekey/swekey.php +++ b/libraries/auth/swekey/swekey.php @@ -183,6 +183,7 @@ function Swekey_GetLastResult() * * @param url The url to get * @param response_code The response code + * * @return The body of the response or "" in case of error * @access private */ @@ -422,6 +423,7 @@ function Swekey_GetFastRndToken() * @param id The id of the swekey * @param rt The random token used to generate the otp * @param otp The otp generated by the swekey + * * @return true or false * @access public */ @@ -458,6 +460,7 @@ define("SWEKEY_STATUS_NOTPLUGGED", 200); // This key is not plugged in the compu * Return the text corresponding to the integer status of a key * * @param status The status + * * @return The text corresponding to the status * @access public */ @@ -495,7 +498,9 @@ function Swekey_GetStatusStr($status) * If your web site requires a key to login you should check that the key * is still valid (has not been lost or stolen) before requiring it. * A key can be authenticated only if its status is SWEKEY_STATUS_OK + * * @param id The id of the swekey + * * @return The status of the swekey * @access public */ diff --git a/libraries/config/ConfigFile.class.php b/libraries/config/ConfigFile.class.php index 3ae365b7a7..e21a927dc8 100644 --- a/libraries/config/ConfigFile.class.php +++ b/libraries/config/ConfigFile.class.php @@ -296,6 +296,7 @@ class ConfigFile * * @param string $path * @param mixed $default + * * @return mixed */ public function get($path, $default = null) @@ -310,6 +311,7 @@ class ConfigFile * * @param string $canonical_path * @param mixed $default + * * @return mixed */ public function getDefault($canonical_path, $default = null) @@ -323,6 +325,7 @@ class ConfigFile * * @param string $path * @param mixed $default + * * @return mixed */ public function getValue($path, $default = null) @@ -339,6 +342,7 @@ class ConfigFile * Returns canonical path * * @param string $path + * * @return string */ public function getCanonicalPath($path) @@ -351,6 +355,7 @@ class ConfigFile * * @param string $path * @param mixed $default + * * @return mixed */ public function getDbEntry($path, $default = null) @@ -386,6 +391,7 @@ class ConfigFile * Returns DSN of given server * * @param integer $server + * * @return string */ function getServerDSN($server) @@ -419,6 +425,7 @@ class ConfigFile * Returns server name * * @param int $id + * * @return string */ public function getServerName($id) diff --git a/libraries/config/Form.class.php b/libraries/config/Form.class.php index c63be204d3..0670e72f45 100644 --- a/libraries/config/Form.class.php +++ b/libraries/config/Form.class.php @@ -61,6 +61,7 @@ class Form * Returns type of given option * * @param string $option_name path or field name + * * @return string|null one of: boolean, integer, double, string, select, array */ public function getOptionType($option_name) @@ -75,6 +76,7 @@ class Form * Returns allowed values for select fields * * @param string $option_path + * * @return array */ public function getOptionValueList($option_path) diff --git a/libraries/config/FormDisplay.class.php b/libraries/config/FormDisplay.class.php index 5eb2d1cd25..d3a6107224 100644 --- a/libraries/config/FormDisplay.class.php +++ b/libraries/config/FormDisplay.class.php @@ -114,6 +114,7 @@ class FormDisplay * * @param bool $allow_partial_save allows for partial form saving on failed validation * @param bool $check_form_submit whether check for $_POST['submit_save'] + * * @return boolean */ public function process($allow_partial_save = true, $check_form_submit = true) @@ -438,6 +439,7 @@ class FormDisplay * * @param string $value * @param array $allowed + * * @return bool */ private function _validateSelect(&$value, array $allowed) @@ -466,6 +468,7 @@ class FormDisplay * * @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) */ public function save($forms, $allow_partial_save = true) @@ -634,6 +637,7 @@ class FormDisplay * Returns link to documentation * * @param string $path + * * @return string */ public function getDocLink($path) @@ -649,6 +653,7 @@ class FormDisplay * Returns link to wiki * * @param string $path + * * @return string */ public function getWikiLink($path) @@ -677,6 +682,7 @@ class FormDisplay * Changes path so it can be used in URLs * * @param string $path + * * @return string */ private function _getOptName($path) diff --git a/libraries/config/config_functions.lib.php b/libraries/config/config_functions.lib.php index 3555f0711a..124c0ee6f1 100644 --- a/libraries/config/config_functions.lib.php +++ b/libraries/config/config_functions.lib.php @@ -13,6 +13,7 @@ * * @param string $lang_key key in $GLOBALS WITHOUT 'strSetup' prefix * @param mixed $args,... arguments for sprintf + * * @return string */ function PMA_lang($lang_key, $args = null) @@ -36,6 +37,7 @@ function PMA_lang($lang_key, $args = null) * @param string $canonical_path * @param string $type 'name', 'desc' or 'cmt' * @param mixed $default + * * @return string */ function PMA_lang_name($canonical_path, $type = 'name', $default = 'key') diff --git a/libraries/config/validate.lib.php b/libraries/config/validate.lib.php index 0373bf9369..cce1da8f74 100644 --- a/libraries/config/validate.lib.php +++ b/libraries/config/validate.lib.php @@ -66,6 +66,7 @@ function PMA_config_get_validators() * @param string|array $validator_id * @param array $values * @param bool $isPostSource tells whether $values are directly from POST request + * * @return bool|array */ function PMA_config_validate($validator_id, &$values, $isPostSource) @@ -183,6 +184,7 @@ function test_php_errormsg($start = true) * @param string $user * @param string $pass * @param string $error_key + * * @return bool|array */ function test_db_connection($extension, $connect_type, $host, $port, $socket, $user, $pass = null, $error_key = 'Server') @@ -244,6 +246,7 @@ function test_db_connection($extension, $connect_type, $host, $port, $socket, $u * * @param string $path * @param array $values + * * @return array */ function validate_server($path, $values) @@ -278,6 +281,7 @@ function validate_server($path, $values) * * @param string $path * @param array $values + * * @return array */ function validate_pmadb($path, $values) @@ -318,6 +322,7 @@ function validate_pmadb($path, $values) * * @param string $path * @param array $values + * * @return array */ function validate_regex($path, $values) @@ -350,6 +355,7 @@ function validate_regex($path, $values) * * @param string $path * @param array $values + * * @return array */ function validate_trusted_proxies($path, $values) @@ -402,6 +408,7 @@ function validate_trusted_proxies($path, $values) * @param bool $allow_zero allow zero * @param int $max_value max allowed value * @param string $error_string error message key: $GLOBALS["strConfig$error_lang_key"] + * * @return string empty string if test is successful */ function test_number($path, $values, $allow_neg, $allow_zero, $max_value, $error_string) @@ -422,6 +429,7 @@ function test_number($path, $values, $allow_neg, $allow_zero, $max_value, $error * * @param string $path * @param array $values + * * @return array */ function validate_port_number($path, $values) @@ -434,6 +442,7 @@ function validate_port_number($path, $values) * * @param string $path * @param array $values + * * @return array */ function validate_positive_number($path, $values) @@ -446,6 +455,7 @@ function validate_positive_number($path, $values) * * @param string $path * @param array $values + * * @return array */ function validate_non_negative_number($path, $values) @@ -460,6 +470,7 @@ function validate_non_negative_number($path, $values) * @param string $path * @param array $values * @param string $regex + * * @return void */ function validate_by_regex($path, $values, $regex) @@ -474,6 +485,7 @@ function validate_by_regex($path, $values, $regex) * @param string $path * @param array $values * @param int $max_value + * * @return array */ function validate_upper_bound($path, $values, $max_value) diff --git a/libraries/dbi/drizzle-wrappers.lib.php b/libraries/dbi/drizzle-wrappers.lib.php index 093d09e9d9..3b2e554759 100644 --- a/libraries/dbi/drizzle-wrappers.lib.php +++ b/libraries/dbi/drizzle-wrappers.lib.php @@ -122,6 +122,7 @@ class PMA_Drizzle extends Drizzle * @param $password * @param $db * @param $options + * * @return PMA_DrizzleCon */ public function addTcp($host, $port, $user, $password, $db, $options) @@ -140,6 +141,7 @@ class PMA_Drizzle extends Drizzle * @param $password * @param $db * @param $options + * * @return PMA_DrizzleCon */ public function addUds($uds, $user, $password, $db, $options) @@ -188,6 +190,7 @@ class PMA_DrizzleCon * @param string $query * @param int $bufferMode PMA_Drizzle::BUFFER_RESULT, PMA_Drizzle::BUFFER_ROW * @param int $fetchMode PMA_Drizzle::FETCH_ASSOC, PMA_Drizzle::FETCH_NUM or PMA_Drizzle::FETCH_BOTH + * * @return PMA_DrizzleResult */ public function query($query, $bufferMode = PMA_Drizzle::BUFFER_RESULT, $fetchMode = PMA_Drizzle::FETCH_ASSOC) @@ -218,6 +221,7 @@ class PMA_DrizzleCon * * @param $method * @param $args + * * @return mixed */ public function __call($method, $args) @@ -375,6 +379,7 @@ class PMA_DrizzleResult * Fetches next for from this result set * * @param int $fetchMode fetch mode to use, if none given the default one is used + * * @return array|null */ public function fetchRow($fetchMode = null) @@ -403,6 +408,7 @@ class PMA_DrizzleResult * Adjusts the result pointer to an arbitrary row in buffered result * * @param $row_index + * * @return bool */ public function seek($row_index) diff --git a/libraries/dbi/drizzle.dbi.lib.php b/libraries/dbi/drizzle.dbi.lib.php index e47e15691b..d201f8cb4d 100644 --- a/libraries/dbi/drizzle.dbi.lib.php +++ b/libraries/dbi/drizzle.dbi.lib.php @@ -36,6 +36,7 @@ if (!defined('PMA_MYSQL_CLIENT_API')) { * @param string $password * @param string $db * @param int $options + * * @return PMA_DrizzleCon */ function PMA_DBI_real_connect($drizzle, $host, $port, $uds, $user, $password, $db = null, $options = DRIZZLE_CON_NONE) @@ -57,6 +58,7 @@ function PMA_DBI_real_connect($drizzle, $host, $port, $uds, $user, $password, $d * @param bool $is_controluser * @param array $server host/port/socket * @param bool $auxiliary_connection (when true, don't go back to login if connection fails) + * * @return mixed false on error or a mysqli object on success */ function PMA_DBI_connect($user, $password, $is_controluser = false, $server = null, $auxiliary_connection = false) @@ -136,6 +138,7 @@ function PMA_DBI_connect($user, $password, $is_controluser = false, $server = nu * * @param string $dbname database name to select * @param PMA_DrizzleCom $link connection object + * * @return bool */ function PMA_DBI_select_db($dbname, $link = null) @@ -156,6 +159,7 @@ function PMA_DBI_select_db($dbname, $link = null) * @param string $query query to execute * @param PMA_DrizzleCon $link connection object * @param int $options + * * @return PMA_DrizzleResult */ function PMA_DBI_real_query($query, $link, $options) @@ -171,6 +175,7 @@ function PMA_DBI_real_query($query, $link, $options) * returns array of rows with associative and numeric keys from $result * * @param PMA_DrizzleResult $result Drizzle result object + * * @return array */ function PMA_DBI_fetch_array($result) @@ -182,6 +187,7 @@ function PMA_DBI_fetch_array($result) * returns array of rows with associative keys from $result * * @param PMA_DrizzleResult $result Drizzle result object + * * @return array */ function PMA_DBI_fetch_assoc($result) @@ -193,6 +199,7 @@ function PMA_DBI_fetch_assoc($result) * returns array of rows with numeric keys from $result * * @param PMA_DrizzleResult $result Drizzle result object + * * @return array */ function PMA_DBI_fetch_row($result) @@ -205,6 +212,7 @@ function PMA_DBI_fetch_row($result) * * @param PMA_DrizzleResult $result Drizzle result object * @param int $offset + * * @return boolean true on success, false on failure */ function PMA_DBI_data_seek($result, $offset) @@ -254,7 +262,9 @@ function PMA_DBI_next_result() /** * Returns a string representing the type of connection used + * * @param PMA_DrizzleCon $link connection object + * * @return string type of connection used */ function PMA_DBI_get_host_info($link = null) @@ -275,7 +285,9 @@ function PMA_DBI_get_host_info($link = null) /** * Returns the version of the Drizzle protocol used + * * @param PMA_DrizzleCon $link connection object + * * @return int version of the Drizzle protocol used */ function PMA_DBI_get_proto_info($link = null) @@ -304,6 +316,7 @@ function PMA_DBI_get_client_info() * returns last error message or false if no errors occured * * @param PMA_DrizzleCon $link connection object + * * @return string|bool $error or false */ function PMA_DBI_getError($link = null) @@ -344,6 +357,7 @@ function PMA_DBI_getError($link = null) * returns the number of rows returned by last query * * @param PMA_DrizzleResult $result Drizzle result object + * * @return string|int */ function PMA_DBI_num_rows($result) @@ -360,6 +374,7 @@ function PMA_DBI_num_rows($result) * returns last inserted auto_increment id for given $link or $GLOBALS['userlink'] * * @param PMA_DrizzleCon $link connection object + * * @return string|int */ function PMA_DBI_insert_id($link = null) @@ -388,6 +403,7 @@ function PMA_DBI_insert_id($link = null) * * @param PMA_DrizzleResult $link connection object * @param bool $get_from_cache + * * @return string|int */ function PMA_DBI_affected_rows($link = null, $get_from_cache = true) @@ -410,6 +426,7 @@ function PMA_DBI_affected_rows($link = null, $get_from_cache = true) * returns metainfo for fields in $result * * @param PMA_DrizzleResult $result Drizzle result object + * * @return array meta info for fields in $result */ function PMA_DBI_get_fields_meta($result) @@ -501,6 +518,7 @@ function PMA_DBI_get_fields_meta($result) * return number of fields in given $result * * @param PMA_DrizzleResult $result Drizzle result object + * * @return int field count */ function PMA_DBI_num_fields($result) @@ -513,6 +531,7 @@ function PMA_DBI_num_fields($result) * * @param PMA_DrizzleResult $result Drizzle result object * @param int $i field + * * @return int length of field */ function PMA_DBI_field_len($result, $i) @@ -526,6 +545,7 @@ function PMA_DBI_field_len($result, $i) * * @param PMA_DrizzleResult $result Drizzle result object * @param int $i field + * * @return string name of $i. field in $result */ function PMA_DBI_field_name($result, $i) @@ -539,6 +559,7 @@ function PMA_DBI_field_name($result, $i) * * @param PMA_DrizzleResult $result Drizzle result object * @param int $i field + * * @return string field flags */ function PMA_DBI_field_flags($result, $i) diff --git a/libraries/dbi/mysql.dbi.lib.php b/libraries/dbi/mysql.dbi.lib.php index 29a507b5f1..f7c1e713df 100644 --- a/libraries/dbi/mysql.dbi.lib.php +++ b/libraries/dbi/mysql.dbi.lib.php @@ -29,6 +29,7 @@ if (! defined('PMA_MYSQL_CLIENT_API')) { * @param string $password * @param int $client_flags * @param bool $persistent + * * @return mixed false on error or a mysql connection resource on success */ function PMA_DBI_real_connect($server, $user, $password, $client_flags, $persistent = false) @@ -60,6 +61,7 @@ function PMA_DBI_real_connect($server, $user, $password, $client_flags, $persist * @param bool $is_controluser * @param array $server host/port/socket/persistent * @param bool $auxiliary_connection (when true, don't go back to login if connection fails) + * * @return mixed false on error or a mysqli object on success */ function PMA_DBI_connect($user, $password, $is_controluser = false, $server = null, $auxiliary_connection = false) @@ -139,6 +141,7 @@ function PMA_DBI_connect($user, $password, $is_controluser = false, $server = nu * * @param string $dbname name of db to select * @param resource $link mysql link resource + * * @return bool */ function PMA_DBI_select_db($dbname, $link = null) @@ -159,6 +162,7 @@ function PMA_DBI_select_db($dbname, $link = null) * @param string $query query to run * @param resource $link mysql link resource * @param int $options query options + * * @return mixed */ function PMA_DBI_real_query($query, $link, $options) @@ -176,6 +180,7 @@ function PMA_DBI_real_query($query, $link, $options) * returns array of rows with associative and numeric keys from $result * * @param resource $result result MySQL result + * * @return array */ function PMA_DBI_fetch_array($result) @@ -187,6 +192,7 @@ function PMA_DBI_fetch_array($result) * returns array of rows with associative keys from $result * * @param resource $result MySQL result + * * @return array */ function PMA_DBI_fetch_assoc($result) @@ -198,6 +204,7 @@ function PMA_DBI_fetch_assoc($result) * returns array of rows with numeric keys from $result * * @param resource $result MySQL result + * * @return array */ function PMA_DBI_fetch_row($result) @@ -210,6 +217,7 @@ function PMA_DBI_fetch_row($result) * * @param $result * @param $offset + * * @return bool true on success, false on failure */ function PMA_DBI_data_seek($result, $offset) @@ -261,6 +269,7 @@ function PMA_DBI_next_result() * Returns a string representing the type of connection used * * @param resource $link mysql link + * * @return string type of connection used */ function PMA_DBI_get_host_info($link = null) @@ -279,6 +288,7 @@ function PMA_DBI_get_host_info($link = null) * Returns the version of the MySQL protocol used * * @param resource $link mysql link + * * @return int version of the MySQL protocol used */ function PMA_DBI_get_proto_info($link = null) @@ -307,6 +317,7 @@ function PMA_DBI_get_client_info() * returns last error message or false if no errors occured * * @param resource $link mysql link + * * @return string|bool $error or false */ function PMA_DBI_getError($link = null) @@ -348,6 +359,7 @@ function PMA_DBI_getError($link = null) * returns the number of rows returned by last query * * @param resource $result MySQL result + * * @return string|int */ function PMA_DBI_num_rows($result) @@ -363,6 +375,7 @@ function PMA_DBI_num_rows($result) * returns last inserted auto_increment id for given $link or $GLOBALS['userlink'] * * @param resource $link the mysql object + * * @return string|int */ function PMA_DBI_insert_id($link = null) @@ -387,6 +400,7 @@ function PMA_DBI_insert_id($link = null) * * @param resource $link the mysql object * @param bool $get_from_cache + * * @return string|int */ function PMA_DBI_affected_rows($link = null, $get_from_cache = true) @@ -411,6 +425,7 @@ function PMA_DBI_affected_rows($link = null, $get_from_cache = true) * * @todo add missing keys like in mysqli_query (decimals) * @param resource $result MySQL result + * * @return array meta info for fields in $result */ function PMA_DBI_get_fields_meta($result) @@ -431,6 +446,7 @@ function PMA_DBI_get_fields_meta($result) * return number of fields in given $result * * @param resource $result MySQL result + * * @return int field count */ function PMA_DBI_num_fields($result) @@ -443,6 +459,7 @@ function PMA_DBI_num_fields($result) * * @param resource $result MySQL result * @param int $i field + * * @return int length of field */ function PMA_DBI_field_len($result, $i) @@ -455,6 +472,7 @@ function PMA_DBI_field_len($result, $i) * * @param resource $result MySQL result * @param int $i field + * * @return string name of $i. field in $result */ function PMA_DBI_field_name($result, $i) @@ -467,6 +485,7 @@ function PMA_DBI_field_name($result, $i) * * @param resource $result MySQL result * @param int $i field + * * @return string field flags */ function PMA_DBI_field_flags($result, $i) diff --git a/libraries/export/codegen.php b/libraries/export/codegen.php index f04d1ed920..abaa422262 100644 --- a/libraries/export/codegen.php +++ b/libraries/export/codegen.php @@ -74,6 +74,7 @@ if (isset($plugin_list)) { * Outputs database header * * @param string $db Database name + * * @return bool Whether it succeeded * * @access public @@ -87,6 +88,7 @@ if (isset($plugin_list)) { * Outputs database footer * * @param string $db Database name + * * @return bool Whether it succeeded * * @access public @@ -100,6 +102,7 @@ if (isset($plugin_list)) { * Outputs CREATE DATABASE statement * * @param string $db Database name + * * @return bool Whether it succeeded * * @access public @@ -117,6 +120,7 @@ if (isset($plugin_list)) { * @param string $crlf the end of line sequence * @param string $error_url the url to go back in case of error * @param string $sql_query SQL query for obtaining data + * * @return bool Whether it succeeded * * @access public diff --git a/libraries/export/csv.php b/libraries/export/csv.php index 122bf4879c..0d5aea2953 100644 --- a/libraries/export/csv.php +++ b/libraries/export/csv.php @@ -99,6 +99,7 @@ if (isset($plugin_list)) { * Outputs database header * * @param string $db Database name + * * @return bool Whether it succeeded * * @access public @@ -112,6 +113,7 @@ if (isset($plugin_list)) { * Outputs database footer * * @param string $db Database name + * * @return bool Whether it succeeded * * @access public @@ -125,6 +127,7 @@ if (isset($plugin_list)) { * Outputs CREATE DATABASE statement * * @param string $db Database name + * * @return bool Whether it succeeded * * @access public @@ -142,6 +145,7 @@ if (isset($plugin_list)) { * @param string $crlf the end of line sequence * @param string $error_url the url to go back in case of error * @param string $sql_query SQL query for obtaining data + * * @return bool Whether it succeeded * * @access public diff --git a/libraries/export/htmlword.php b/libraries/export/htmlword.php index d42f1123c4..c6c1484f84 100644 --- a/libraries/export/htmlword.php +++ b/libraries/export/htmlword.php @@ -74,6 +74,7 @@ if (isset($plugin_list)) { * Outputs database header * * @param string $db Database name + * * @return bool Whether it succeeded * * @access public @@ -87,6 +88,7 @@ if (isset($plugin_list)) { * Outputs database footer * * @param string $db Database name + * * @return bool Whether it succeeded * * @access public @@ -100,6 +102,7 @@ if (isset($plugin_list)) { * Outputs CREATE DATABASE statement * * @param string $db Database name + * * @return bool Whether it succeeded * * @access public @@ -117,6 +120,7 @@ if (isset($plugin_list)) { * @param string $crlf the end of line sequence * @param string $error_url the url to go back in case of error * @param string $sql_query SQL query for obtaining data + * * @return bool Whether it succeeded * * @access public @@ -384,6 +388,7 @@ if (isset($plugin_list)) { * * @param string $db database name * @param string $table table name + * * @return string Formatted triggers list * * @access public @@ -430,6 +435,7 @@ if (isset($plugin_list)) { * @param bool $dates whether to include creation/update/check dates * @param string $export_mode 'create_table', 'triggers', 'create_view', 'stand_in' * @param string $export_type 'server', 'database', 'table' + * * @return bool Whether it succeeded * * @access public diff --git a/libraries/export/json.php b/libraries/export/json.php index 8fdc4bb87f..d2d511f621 100644 --- a/libraries/export/json.php +++ b/libraries/export/json.php @@ -68,6 +68,7 @@ if (isset($plugin_list)) { * Outputs database header * * @param string $db Database name + * * @return bool Whether it succeeded * * @access public @@ -82,6 +83,7 @@ if (isset($plugin_list)) { * Outputs database footer * * @param string $db Database name + * * @return bool Whether it succeeded * * @access public @@ -95,6 +97,7 @@ if (isset($plugin_list)) { * Outputs CREATE DATABASE statement * * @param string $db Database name + * * @return bool Whether it succeeded * * @access public @@ -112,6 +115,7 @@ if (isset($plugin_list)) { * @param string $crlf the end of line sequence * @param string $error_url the url to go back in case of error * @param string $sql_query SQL query for obtaining data + * * @return bool Whether it succeeded * * @access public diff --git a/libraries/export/ods.php b/libraries/export/ods.php index 54abd5d6b4..b4aa1d8bc6 100644 --- a/libraries/export/ods.php +++ b/libraries/export/ods.php @@ -105,6 +105,7 @@ if (isset($plugin_list)) { * Outputs database header * * @param string $db Database name + * * @return bool Whether it succeeded * * @access public @@ -118,6 +119,7 @@ if (isset($plugin_list)) { * Outputs database footer * * @param string $db Database name + * * @return bool Whether it succeeded * * @access public @@ -131,6 +133,7 @@ if (isset($plugin_list)) { * Outputs CREATE DATABASE statement * * @param string $db Database name + * * @return bool Whether it succeeded * * @access public @@ -148,6 +151,7 @@ if (isset($plugin_list)) { * @param string $crlf the end of line sequence * @param string $error_url the url to go back in case of error * @param string $sql_query SQL query for obtaining data + * * @return bool Whether it succeeded * * @access public diff --git a/libraries/export/php_array.php b/libraries/export/php_array.php index 6555a00b7e..bba12d7149 100644 --- a/libraries/export/php_array.php +++ b/libraries/export/php_array.php @@ -69,6 +69,7 @@ if (isset($plugin_list)) { * Outputs database header * * @param string $db Database name + * * @return bool Whether it succeeded * * @access public @@ -83,6 +84,7 @@ if (isset($plugin_list)) { * Outputs database footer * * @param string $db Database name + * * @return bool Whether it succeeded * * @access public @@ -96,6 +98,7 @@ if (isset($plugin_list)) { * Outputs CREATE DATABASE statement * * @param string $db Database name + * * @return bool Whether it succeeded * * @access public @@ -113,6 +116,7 @@ if (isset($plugin_list)) { * @param string $crlf the end of line sequence * @param string $error_url the url to go back in case of error * @param string $sql_query SQL query for obtaining data + * * @return bool Whether it succeeded * * @access public diff --git a/libraries/export/texytext.php b/libraries/export/texytext.php index 0d834c9669..0017a96bf1 100644 --- a/libraries/export/texytext.php +++ b/libraries/export/texytext.php @@ -60,6 +60,7 @@ if (isset($plugin_list)) { * Outputs database header * * @param string $db Database name + * * @return bool Whether it succeeded * * @access public @@ -73,6 +74,7 @@ if (isset($plugin_list)) { * Outputs database footer * * @param string $db Database name + * * @return bool Whether it succeeded * * @access public @@ -86,6 +88,7 @@ if (isset($plugin_list)) { * Outputs CREATE DATABASE statement * * @param string $db Database name + * * @return bool Whether it succeeded * * @access public @@ -103,6 +106,7 @@ if (isset($plugin_list)) { * @param string $crlf the end of line sequence * @param string $error_url the url to go back in case of error * @param string $sql_query SQL query for obtaining data + * * @return bool Whether it succeeded * * @access public @@ -380,6 +384,7 @@ if (isset($plugin_list)) { * * @param string $db database name * @param string $table table name + * * @return string Formatted triggers list * * @access public @@ -425,6 +430,7 @@ if (isset($plugin_list)) { * @param bool $dates whether to include creation/update/check dates * @param string $export_mode 'create_table', 'triggers', 'create_view', 'stand_in' * @param string $export_type 'server', 'database', 'table' + * * @return bool Whether it succeeded * * @access public diff --git a/libraries/export/xml.php b/libraries/export/xml.php index ca2331fe2e..b6321fa0ac 100644 --- a/libraries/export/xml.php +++ b/libraries/export/xml.php @@ -280,6 +280,7 @@ if (isset($plugin_list)) { * Outputs database header * * @param string $db Database name + * * @return bool Whether it succeeded * * @access public @@ -304,6 +305,7 @@ if (isset($plugin_list)) { * Outputs database footer * * @param string $db Database name + * * @return bool Whether it succeeded * * @access public @@ -323,6 +325,7 @@ if (isset($plugin_list)) { * Outputs CREATE DATABASE statement * * @param string $db Database name + * * @return bool Whether it succeeded * * @access public @@ -340,6 +343,7 @@ if (isset($plugin_list)) { * @param string $crlf the end of line sequence * @param string $error_url the url to go back in case of error * @param string $sql_query SQL query for obtaining data + * * @return bool Whether it succeeded * * @access public diff --git a/libraries/export/yaml.php b/libraries/export/yaml.php index 60ca7b45f8..ebf1a88ef2 100644 --- a/libraries/export/yaml.php +++ b/libraries/export/yaml.php @@ -65,6 +65,7 @@ if (isset($plugin_list)) { * Outputs database header * * @param string $db Database name + * * @return bool Whether it succeeded * * @access public @@ -78,6 +79,7 @@ if (isset($plugin_list)) { * Outputs database footer * * @param string $db Database name + * * @return bool Whether it succeeded * * @access public @@ -91,6 +93,7 @@ if (isset($plugin_list)) { * Outputs CREATE DATABASE statement * * @param string $db Database name + * * @return bool Whether it succeeded * * @access public @@ -108,6 +111,7 @@ if (isset($plugin_list)) { * @param string $crlf the end of line sequence * @param string $error_url the url to go back in case of error * @param string $sql_query SQL query for obtaining data + * * @return bool Whether it succeeded * * @access public diff --git a/libraries/import.lib.php b/libraries/import.lib.php index d23633e61e..3971497182 100644 --- a/libraries/import.lib.php +++ b/libraries/import.lib.php @@ -343,6 +343,7 @@ function PMA_importGetNextChunk($size = 32768) * @access public * * @param int $num + * * @return string The column's "Excel" name */ function PMA_getColumnAlphaName($num) diff --git a/libraries/import/upload/apc.php b/libraries/import/upload/apc.php index 97c8963a5e..6efdea8697 100644 --- a/libraries/import/upload/apc.php +++ b/libraries/import/upload/apc.php @@ -17,6 +17,7 @@ $ID_KEY = 'APC_UPLOAD_PROGRESS'; * This is implementation for APC extension. * * @param string $id + * * @return array|null */ function PMA_getUploadStatus($id) diff --git a/libraries/import/upload/session.php b/libraries/import/upload/session.php index e6ee0dc8e3..29d61a8368 100644 --- a/libraries/import/upload/session.php +++ b/libraries/import/upload/session.php @@ -16,6 +16,7 @@ $ID_KEY = ini_get('session.upload_progress.name'); * This is implementation for session.upload_progress in PHP 5.4+. * * @param string $id + * * @return array|null */ function PMA_getUploadStatus($id) diff --git a/libraries/import/upload/uploadprogress.php b/libraries/import/upload/uploadprogress.php index 086b1c9173..e5035475e3 100644 --- a/libraries/import/upload/uploadprogress.php +++ b/libraries/import/upload/uploadprogress.php @@ -16,6 +16,7 @@ $ID_KEY = "UPLOAD_IDENTIFIER"; * This is implementation for uploadprogress extension. * * @param string $id + * * @return array|null */ function PMA_getUploadStatus($id) diff --git a/libraries/string.lib.php b/libraries/string.lib.php index 2a316a1733..b62eb7e860 100644 --- a/libraries/string.lib.php +++ b/libraries/string.lib.php @@ -41,6 +41,7 @@ if (@extension_loaded('ctype')) { * @param string string to check for * @param integer the character to check for * @param integer starting position in the string + * * @return boolean whether the character is escaped or not */ function PMA_STR_charIsEscaped($string, $pos, $start = 0) @@ -72,6 +73,7 @@ function PMA_STR_charIsEscaped($string, $pos, $start = 0) * @param integer number to check for * @param integer lower bound * @param integer upper bound + * * @return boolean whether the number is in the range or not */ function PMA_STR_numberInRangeInclusive($num, $lower, $upper) @@ -84,6 +86,7 @@ function PMA_STR_numberInRangeInclusive($num, $lower, $upper) * * @param string character to check for * @param boolean whether the dot character is valid or not + * * @return boolean whether the character is an SQL identifier or not */ function PMA_STR_isSqlIdentifier($c, $dot_is_valid = false) diff --git a/libraries/string_mb.lib.php b/libraries/string_mb.lib.php index f5bad7ba56..7166d9e191 100644 --- a/libraries/string_mb.lib.php +++ b/libraries/string_mb.lib.php @@ -20,6 +20,7 @@ if (! defined('PHPMYADMIN')) { * Returns length of string depending on current charset. * * @param string string to count + * * @return int string length */ function PMA_strlen($string) @@ -33,6 +34,7 @@ function PMA_strlen($string) * @param string $string string to count * @param int $start start of substring * @param int $length length of substring + * * @return string */ function PMA_substr($string, $start, $length = 2147483647) @@ -46,6 +48,7 @@ function PMA_substr($string, $start, $length = 2147483647) * @param string $haystack * @param string $needle * @param int $offset + * * @return integer position of $needle in $haystack or false */ function PMA_strpos($haystack, $needle, $offset = 0) @@ -57,6 +60,7 @@ function PMA_strpos($haystack, $needle, $offset = 0) * Make a string lowercase * * @param string $string + * * @return string */ function PMA_strtolower($string) diff --git a/libraries/string_native.lib.php b/libraries/string_native.lib.php index 8f8ac2291f..3a8b0bf380 100644 --- a/libraries/string_native.lib.php +++ b/libraries/string_native.lib.php @@ -20,6 +20,7 @@ if (! defined('PHPMYADMIN')) { * Returns length of string depending on current charset. * * @param string string to count + * * @return int string length */ function PMA_strlen($string) @@ -33,6 +34,7 @@ function PMA_strlen($string) * @param string $string string to count * @param int $start start of substring * @param int $length length of substring + * * @return string */ function PMA_substr($string, $start, $length = 2147483647) @@ -46,6 +48,7 @@ function PMA_substr($string, $start, $length = 2147483647) * @param string $haystack * @param string $needle * @param int $offset + * * @return integer position of $needle in $haystack or false */ function PMA_strpos($haystack, $needle, $offset = 0) @@ -57,6 +60,7 @@ function PMA_strpos($haystack, $needle, $offset = 0) * Make a string lowercase * * @param string $string + * * @return string */ function PMA_strtolower($string) diff --git a/libraries/string_type_ctype.lib.php b/libraries/string_type_ctype.lib.php index af804b2aec..96b21d5348 100644 --- a/libraries/string_type_ctype.lib.php +++ b/libraries/string_type_ctype.lib.php @@ -20,6 +20,7 @@ if (! defined('PHPMYADMIN')) { * Checks if a character is an alphanumeric one * * @param string character to check for + * * @return boolean whether the character is an alphanumeric one or not */ function PMA_STR_isAlnum($c) @@ -31,6 +32,7 @@ function PMA_STR_isAlnum($c) * Checks if a character is an alphabetic one * * @param string character to check for + * * @return boolean whether the character is an alphabetic one or not */ function PMA_STR_isAlpha($c) @@ -42,6 +44,7 @@ function PMA_STR_isAlpha($c) * Checks if a character is a digit * * @param string character to check for + * * @return boolean whether the character is a digit or not */ function PMA_STR_isDigit($c) @@ -53,6 +56,7 @@ function PMA_STR_isDigit($c) * Checks if a character is an upper alphabetic one * * @param string character to check for + * * @return boolean whether the character is an upper alphabetic one or not */ function PMA_STR_isUpper($c) @@ -65,6 +69,7 @@ function PMA_STR_isUpper($c) * Checks if a character is a lower alphabetic one * * @param string character to check for + * * @return boolean whether the character is a lower alphabetic one or not */ function PMA_STR_isLower($c) @@ -76,6 +81,7 @@ function PMA_STR_isLower($c) * Checks if a character is a space one * * @param string character to check for + * * @return boolean whether the character is a space one or not */ function PMA_STR_isSpace($c) @@ -87,6 +93,7 @@ function PMA_STR_isSpace($c) * Checks if a character is an hexadecimal digit * * @param string character to check for + * * @return boolean whether the character is an hexadecimal digit or not */ function PMA_STR_isHexDigit($c) diff --git a/libraries/string_type_native.lib.php b/libraries/string_type_native.lib.php index e6569cef60..0b6b364af7 100644 --- a/libraries/string_type_native.lib.php +++ b/libraries/string_type_native.lib.php @@ -20,6 +20,7 @@ if (! defined('PHPMYADMIN')) { * Checks if a character is an alphanumeric one * * @param string character to check for + * * @return boolean whether the character is an alphanumeric one or not */ function PMA_STR_isAlnum($c) @@ -31,6 +32,7 @@ function PMA_STR_isAlnum($c) * Checks if a character is an alphabetic one * * @param string character to check for + * * @return boolean whether the character is an alphabetic one or not */ function PMA_STR_isAlpha($c) @@ -42,6 +44,7 @@ function PMA_STR_isAlpha($c) * Checks if a character is a digit * * @param string character to check for + * * @return boolean whether the character is a digit or not */ function PMA_STR_isDigit($c) @@ -57,6 +60,7 @@ function PMA_STR_isDigit($c) * Checks if a character is an upper alphabetic one * * @param string character to check for + * * @return boolean whether the character is an upper alphabetic one or not */ function PMA_STR_isUpper($c) @@ -72,6 +76,7 @@ function PMA_STR_isUpper($c) * Checks if a character is a lower alphabetic one * * @param string character to check for + * * @return boolean whether the character is a lower alphabetic one or not */ function PMA_STR_isLower($c) @@ -87,6 +92,7 @@ function PMA_STR_isLower($c) * Checks if a character is a space one * * @param string character to check for + * * @return boolean whether the character is a space one or not */ function PMA_STR_isSpace($c) @@ -106,6 +112,7 @@ function PMA_STR_isSpace($c) * Checks if a character is an hexadecimal digit * * @param string character to check for + * * @return boolean whether the character is an hexadecimal digit or not */ function PMA_STR_isHexDigit($c) diff --git a/setup/lib/ConfigGenerator.class.php b/setup/lib/ConfigGenerator.class.php index b45b33f318..4db2f7385c 100644 --- a/setup/lib/ConfigGenerator.class.php +++ b/setup/lib/ConfigGenerator.class.php @@ -83,6 +83,7 @@ class ConfigGenerator * @param string $var_name * @param mixed $var_value * @param string $crlf + * * @return string */ private static function _getVarExport($var_name, $var_value, $crlf) @@ -108,6 +109,7 @@ class ConfigGenerator * Check whether $array is a continuous 0-based array * * @param array $array + * * @return boolean */ private static function _isZeroBasedArray(array $array) @@ -125,6 +127,7 @@ class ConfigGenerator * * @param array $array * @param string $crlf + * * @return string */ private static function _exportZeroBasedArray(array $array, $crlf) diff --git a/setup/lib/index.lib.php b/setup/lib/index.lib.php index ebda5fb59e..1bdf22a40d 100644 --- a/setup/lib/index.lib.php +++ b/setup/lib/index.lib.php @@ -198,6 +198,7 @@ function PMA_version_check() * Calculates numerical equivalent of phpMyAdmin version string * * @param string $version + * * @return mixed false on failure, integer on success */ function version_to_int($version) diff --git a/user_password.php b/user_password.php index 332f5974fa..f1b632c889 100644 --- a/user_password.php +++ b/user_password.php @@ -70,6 +70,7 @@ require './libraries/footer.inc.php'; * * @param array $change_password_message * @param string $sql_query + * * @return void */ function PMA_getChangePassMessage($change_password_message, $sql_query = '') @@ -115,6 +116,7 @@ function PMA_setChangePasswordMsg() * @param string $password * @param string $message * @param array $change_password_message + * * @return void */ function PMA_changePassword($password, $message, $change_password_message) @@ -152,6 +154,7 @@ function PMA_changePassHashingFunction() * @param array $_url_params * @param string $sql_query * @param string $hashing_function + * * @return void */ function PMA_ChangePassUrlParamsAndSubmitQuery($password, $_url_params, $sql_query, $hashing_function) @@ -167,6 +170,7 @@ function PMA_ChangePassUrlParamsAndSubmitQuery($password, $_url_params, $sql_que * * @param array $_url_params * @param string $password + * * @return array $_url_params */ function PMA_changePassAuthType($_url_params, $password) @@ -194,6 +198,7 @@ function PMA_changePassAuthType($_url_params, $password) * @param string $message * @param string $sql_query * @param array $_url_params + * * @return void */ function PMA_changePassDisplayPage($message, $sql_query, $_url_params) |