-
- ' . __('Database comment: ') + . '' . htmlspecialchars($comment) . ''; } // end if } diff --git a/libraries/Advisor.class.php b/libraries/Advisor.class.php index 29cb1483c0..b8764a5c6c 100644 --- a/libraries/Advisor.class.php +++ b/libraries/Advisor.class.php @@ -448,14 +448,14 @@ function ADVISOR_bytime($num, $precision) $per = ''; if ($num >= 1) { // per second $per = __('per second'); - } elseif ($num*60 >= 1) { // per minute - $num = $num*60; + } elseif ($num * 60 >= 1) { // per minute + $num = $num * 60; $per = __('per minute'); - } elseif ($num*60*60 >=1 ) { // per hour - $num = $num*60*60; + } elseif ($num * 60 * 60 >= 1 ) { // per hour + $num = $num * 60 * 60; $per = __('per hour'); } else { - $num = $num*60*60*24; + $num = $num * 60 * 60 * 24; $per = __('per day'); } diff --git a/libraries/Config.class.php b/libraries/Config.class.php index 3bbbe22eeb..3d62595996 100644 --- a/libraries/Config.class.php +++ b/libraries/Config.class.php @@ -692,9 +692,9 @@ class PMA_Config ) { // load required libraries include_once './libraries/user_preferences.lib.php'; - $prefs = PMA_load_userprefs(); + $prefs = PMA_loadUserprefs(); $_SESSION['cache'][$cache_key]['userprefs'] - = PMA_apply_userprefs($prefs['config_data']); + = PMA_applyUserprefs($prefs['config_data']); $_SESSION['cache'][$cache_key]['userprefs_mtime'] = $prefs['mtime']; $_SESSION['cache'][$cache_key]['userprefs_type'] = $prefs['type']; $_SESSION['cache'][$cache_key]['config_mtime'] = $config_mtime; @@ -834,7 +834,7 @@ class PMA_Config if ($default_value === null) { $default_value = PMA_arrayRead($cfg_path, $this->default); } - PMA_persist_option($cfg_path, $new_cfg_value, $default_value); + PMA_persistOption($cfg_path, $new_cfg_value, $default_value); } if ($prefs_type != 'db' && $cookie_name) { // fall back to cookies diff --git a/libraries/File.class.php b/libraries/File.class.php index 02b91746a1..c020446f60 100644 --- a/libraries/File.class.php +++ b/libraries/File.class.php @@ -81,7 +81,7 @@ class PMA_File * * @access public */ - function __construct($name = false) + public function __construct($name = false) { if ($name) { $this->setName($name); @@ -94,7 +94,7 @@ class PMA_File * @see PMA_File::cleanUp() * @access public */ - function __destruct() + public function __destruct() { $this->cleanUp(); } @@ -105,7 +105,7 @@ class PMA_File * @access public * @return boolean success */ - function cleanUp() + public function cleanUp() { if ($this->isTemp()) { return $this->delete(); @@ -120,7 +120,7 @@ class PMA_File * @access public * @return boolean success */ - function delete() + public function delete() { return unlink($this->getName()); } @@ -134,7 +134,7 @@ class PMA_File * @return boolean PMA_File::$_is_temp * @access public */ - function isTemp($is_temp = null) + public function isTemp($is_temp = null) { if (null !== $is_temp) { $this->_is_temp = (bool) $is_temp; @@ -151,7 +151,7 @@ class PMA_File * @return void * @access public */ - function setName($name) + public function setName($name) { $this->_name = trim($name); } @@ -168,7 +168,7 @@ class PMA_File * * @access public */ - function getContent($as_binary = true, $offset = 0, $length = null) + public function getContent($as_binary = true, $offset = 0, $length = null) { if (null === $this->_content) { if ($this->isUploaded() && ! $this->checkUploadedFile()) { @@ -206,7 +206,7 @@ class PMA_File * * @return bool */ - function isUploaded() + public function isUploaded() { return is_uploaded_file($this->getName()); } @@ -217,7 +217,7 @@ class PMA_File * @access public * @return string PMA_File::$_name */ - function getName() + public function getName() { return $this->_name; } @@ -230,7 +230,7 @@ class PMA_File * @return boolean success * @access public */ - function setUploadedFile($name) + public function setUploadedFile($name) { $this->setName($name); @@ -252,7 +252,7 @@ class PMA_File * @return boolean success * @access public */ - function setUploadedFromTblChangeRequest($key, $rownumber) + public function setUploadedFromTblChangeRequest($key, $rownumber) { if (! isset($_FILES['fields_upload']) || empty($_FILES['fields_upload']['name']['multi_edit'][$rownumber][$key]) @@ -327,7 +327,7 @@ class PMA_File * @access public * @static */ - function fetchUploadedFromTblChangeRequestMultiple($file, $rownumber, $key) + public function fetchUploadedFromTblChangeRequestMultiple($file, $rownumber, $key) { $new_file = array( 'name' => $file['name']['multi_edit'][$rownumber][$key], @@ -349,7 +349,7 @@ class PMA_File * @return boolean success * @access public */ - function setSelectedFromTblChangeRequest($key, $rownumber = null) + public function setSelectedFromTblChangeRequest($key, $rownumber = null) { if (! empty($_REQUEST['fields_uploadlocal']['multi_edit'][$rownumber][$key]) && is_string($_REQUEST['fields_uploadlocal']['multi_edit'][$rownumber][$key]) @@ -369,7 +369,7 @@ class PMA_File * @access public * @return string error message */ - function getError() + public function getError() { return $this->_error_message; } @@ -380,7 +380,7 @@ class PMA_File * @access public * @return boolean whether an error occured or not */ - function isError() + public function isError() { return ! empty($this->_error_message); } @@ -395,7 +395,7 @@ class PMA_File * @return boolean success * @access public */ - function checkTblChangeForm($key, $rownumber) + public function checkTblChangeForm($key, $rownumber) { if ($this->setUploadedFromTblChangeRequest($key, $rownumber)) { // well done ... @@ -419,7 +419,7 @@ class PMA_File * @return boolean success * @access public */ - function setLocalSelectedFile($name) + public function setLocalSelectedFile($name) { if (empty($GLOBALS['cfg']['UploadDir'])) { return false; @@ -443,7 +443,7 @@ class PMA_File * @access public * @return boolean whether the file is readable or not */ - function isReadable() + public function isReadable() { // suppress warnings from being displayed, but not from being logged // any file access outside of open_basedir will issue a warning @@ -462,7 +462,7 @@ class PMA_File * @access public * @return boolean whether uploaded fiel is fine or not */ - function checkUploadedFile() + public function checkUploadedFile() { if ($this->isReadable()) { return true; @@ -513,7 +513,7 @@ class PMA_File * @access protected * @return string MIME type of compression, none for none */ - function _detectCompression() + protected function detectCompression() { // suppress warnings from being displayed, but not from being logged // f.e. any file access outside of open_basedir will issue a warning @@ -562,7 +562,7 @@ class PMA_File * * @return void */ - function setDecompressContent($decompress) + public function setDecompressContent($decompress) { $this->_decompress = (bool) $decompress; } @@ -572,7 +572,7 @@ class PMA_File * * @return object file handle */ - function getHandle() + public function getHandle() { if (null === $this->_handle) { $this->open(); @@ -587,7 +587,7 @@ class PMA_File * * @return void */ - function setHandle($handle) + public function setHandle($handle) { $this->_handle = $handle; } @@ -598,7 +598,7 @@ class PMA_File * * @return void */ - function errorUnsupported() + public function errorUnsupported() { $this->_error_message = sprintf( __('You attempted to load file with unsupported compression (%s). Either support for it is not implemented or disabled by your configuration.'), @@ -611,7 +611,7 @@ class PMA_File * * @return bool */ - function open() + public function open() { if (! $this->_decompress) { $this->_handle = @fopen($this->getName(), 'r'); @@ -669,7 +669,7 @@ class PMA_File * * @return string character set of the file */ - function getCharset() + public function getCharset() { return $this->_charset; } @@ -681,7 +681,7 @@ class PMA_File * * @return void */ - function setCharset($charset) + public function setCharset($charset) { $this->_charset = $charset; } @@ -692,10 +692,10 @@ class PMA_File * @return string MIME type of compression, none for none * @access public */ - function getCompression() + public function getCompression() { if (null === $this->_compression) { - return $this->_detectCompression(); + return $this->detectCompression(); } return $this->_compression; @@ -709,7 +709,7 @@ class PMA_File * @return boolean * @todo this function is unused */ - function advanceFilePointer($length) + public function advanceFilePointer($length) { while ($length > 0) { $this->getNextChunk($length); @@ -726,7 +726,7 @@ class PMA_File * @return bool|string * @todo this function is unused */ - function getNextChunk($max_size = null) + public function getNextChunk($max_size = null) { if (null !== $max_size) { $size = min($max_size, $this->getChunkSize()); @@ -808,7 +808,7 @@ class PMA_File * * @return integer the offset */ - function getOffset() + public function getOffset() { return $this->_offset; } @@ -818,7 +818,7 @@ class PMA_File * * @return integer the chunk size */ - function getChunkSize() + public function getChunkSize() { return $this->_chunk_size; } @@ -830,7 +830,7 @@ class PMA_File * * @return void */ - function setChunkSize($chunk_size) + public function setChunkSize($chunk_size) { $this->_chunk_size = (int) $chunk_size; } @@ -840,7 +840,7 @@ class PMA_File * * @return integer the length of the file content */ - function getContentLength() + public function getContentLength() { return strlen($this->_content); } @@ -850,7 +850,7 @@ class PMA_File * * @return boolean whether the end of the file has been reached */ - function eof() + public function eof() { if ($this->getHandle()) { return feof($this->getHandle()); diff --git a/libraries/PDF.class.php b/libraries/PDF.class.php index cef7761bf5..66e05a300e 100644 --- a/libraries/PDF.class.php +++ b/libraries/PDF.class.php @@ -29,7 +29,16 @@ class PMA_PDF extends TCPDF /** * Constructs PDF and configures standard parameters. * + * @param string $orientation page orientation + * @param string $unit unit + * @param mixed $format the format used for pages + * @param boolean $unicode true means that the input text is unicode + * @param string $encoding charset encoding; default is UTF-8. + * @param boolean $diskcache if true reduce the RAM memory usage by caching + * temporary data on filesystem (slower). + * * @return void + * @access public */ public function __construct($orientation = 'P', $unit = 'mm', $format = 'A4', $unicode = true, $encoding = 'UTF-8', $diskcache = false @@ -65,6 +74,11 @@ class PMA_PDF extends TCPDF /** * Function to set alias which will be expanded on page rendering. + * + * @param string $name name of the alias + * @param string $value value of the alias + * + * @return void */ function SetAlias($name, $value) { @@ -73,6 +87,8 @@ class PMA_PDF extends TCPDF /** * Improved with alias expading. + * + * @return void */ function _putpages() { @@ -89,15 +105,23 @@ class PMA_PDF extends TCPDF * Displays an error message * * @param string $error_message the error mesage + * + * @return void */ function Error($error_message = '') { - PMA_Message::error(__('Error while creating PDF:') . ' ' . $error_message)->display(); + PMA_Message::error( + __('Error while creating PDF:') . ' ' . $error_message + )->display(); exit; } /** * Sends file as a download to user. + * + * @param string $filename file name + * + * @return void */ function Download($filename) { diff --git a/libraries/RecentTable.class.php b/libraries/RecentTable.class.php index 3fbc538a93..d83272a6a5 100644 --- a/libraries/RecentTable.class.php +++ b/libraries/RecentTable.class.php @@ -26,7 +26,7 @@ class PMA_RecentTable * @access private * @var string */ - private $_pma_table; + private $_pmaTable; /** * Reference to session variable containing recently used tables. @@ -48,14 +48,14 @@ class PMA_RecentTable if (strlen($GLOBALS['cfg']['Server']['pmadb']) && strlen($GLOBALS['cfg']['Server']['recent']) ) { - $this->_pma_table + $this->_pmaTable = PMA_Util::backquote($GLOBALS['cfg']['Server']['pmadb']) . "." . PMA_Util::backquote($GLOBALS['cfg']['Server']['recent']); } $server_id = $GLOBALS['server']; if (! isset($_SESSION['tmp_user_values']['recent_tables'][$server_id])) { $_SESSION['tmp_user_values']['recent_tables'][$server_id] - = isset($this->_pma_table) ? $this->getFromDb() : array(); + = isset($this->_pmaTable) ? $this->getFromDb() : array(); } $this->tables =& $_SESSION['tmp_user_values']['recent_tables'][$server_id]; } @@ -82,7 +82,7 @@ class PMA_RecentTable { // Read from phpMyAdmin database, if recent tables is not in session $sql_query - = " SELECT `tables` FROM " . $this->_pma_table . + = " SELECT `tables` FROM " . $this->_pmaTable . " WHERE `username` = '" . $GLOBALS['cfg']['Server']['user'] . "'"; $row = PMA_DBI_fetch_array(PMA_queryAsControlUser($sql_query)); @@ -102,7 +102,7 @@ class PMA_RecentTable { $username = $GLOBALS['cfg']['Server']['user']; $sql_query - = " REPLACE INTO " . $this->_pma_table . " (`username`, `tables`)" . + = " REPLACE INTO " . $this->_pmaTable . " (`username`, `tables`)" . " VALUES ('" . $username . "', '" . PMA_Util::sqlAddSlashes( json_encode($this->tables) @@ -144,7 +144,7 @@ class PMA_RecentTable public function getHtmlSelectOption() { // trim and save, in case where the configuration is changed - if ($this->trim() && isset($this->_pma_table)) { + if ($this->trim() && isset($this->_pmaTable)) { $this->saveToDb(); } @@ -201,7 +201,7 @@ class PMA_RecentTable array_unshift($this->tables, $table_arr); $this->tables = array_merge(array_unique($this->tables, SORT_REGULAR)); $this->trim(); - if (isset($this->_pma_table)) { + if (isset($this->_pmaTable)) { return $this->saveToDb(); } } diff --git a/libraries/config/FormDisplay.class.php b/libraries/config/FormDisplay.class.php index cb1442a8d1..333b88a584 100644 --- a/libraries/config/FormDisplay.class.php +++ b/libraries/config/FormDisplay.class.php @@ -45,46 +45,46 @@ class FormDisplay * Paths changed so that they can be used as HTML ids, indexed by paths * @var array */ - private $_translated_paths = array(); + private $_translatedPaths = array(); /** * Server paths change indexes so we define maps from current server * path to the first one, indexed by work path * @var array */ - private $_system_paths = array(); + private $_systemPaths = array(); /** * Language strings which will be sent to PMA_messages JS variable * Will be looked up in $GLOBALS: str{value} or strSetup{value} * @var array */ - private $_js_lang_strings = array(); + private $_jsLangStrings = array(); /** * Tells whether forms have been validated * @var bool */ - private $_is_validated = true; + private $_isValidated = true; /** * Dictionary with user preferences keys * @var array */ - private $_userprefs_keys; + private $_userprefsKeys; /** * Dictionary with disallowed user preferences keys * @var array */ - private $_userprefs_disallow; + private $_userprefsDisallow; /** * Constructor */ public function __construct() { - $this->_js_lang_strings = array( + $this->_jsLangStrings = array( 'error_nan_p' => __('Not a positive number'), 'error_nan_nneg' => __('Not a non-negative number'), 'error_incorrect_port' => __('Not a valid port number'), @@ -106,13 +106,13 @@ class FormDisplay public function registerForm($form_name, array $form, $server_id = null) { $this->_forms[$form_name] = new Form($form_name, $form, $server_id); - $this->_is_validated = false; + $this->_isValidated = false; foreach ($this->_forms[$form_name]->fields as $path) { $work_path = $server_id === null ? $path : str_replace('Servers/1/', "Servers/$server_id/", $path); - $this->_system_paths[$work_path] = $path; - $this->_translated_paths[$work_path] = str_replace('/', '-', $work_path); + $this->_systemPaths[$work_path] = $path; + $this->_translatedPaths[$work_path] = str_replace('/', '-', $work_path); } } @@ -145,7 +145,7 @@ class FormDisplay */ private function _validate() { - if ($this->_is_validated) { + if ($this->_isValidated) { return; } @@ -157,7 +157,7 @@ class FormDisplay $paths[] = $form->name; // collect values and paths foreach ($form->fields as $path) { - $work_path = array_search($path, $this->_system_paths); + $work_path = array_search($path, $this->_systemPaths); $values[$path] = $cf->getValue($work_path); $paths[] = $path; } @@ -170,7 +170,7 @@ class FormDisplay if (is_array($errors) && count($errors) > 0) { $this->_errors = array(); foreach ($errors as $path => $error_list) { - $work_path = array_search($path, $this->_system_paths); + $work_path = array_search($path, $this->_systemPaths); // field error if (!$work_path) { // form error, fix path @@ -179,7 +179,7 @@ class FormDisplay $this->_errors[$work_path] = $error_list; } } - $this->_is_validated = true; + $this->_isValidated = true; } /** @@ -242,12 +242,12 @@ class FormDisplay ); foreach ($form->fields as $field => $path) { - $work_path = array_search($path, $this->_system_paths); - $translated_path = $this->_translated_paths[$work_path]; + $work_path = array_search($path, $this->_systemPaths); + $translated_path = $this->_translatedPaths[$work_path]; // always true/false for user preferences display // otherwise null - $userprefs_allow = isset($this->_userprefs_keys[$path]) - ? !isset($this->_userprefs_disallow[$path]) + $userprefs_allow = isset($this->_userprefsKeys[$path]) + ? !isset($this->_userprefsDisallow[$path]) : null; // display input $this->_displayFieldInput( @@ -277,7 +277,7 @@ class FormDisplay if (!$js_lang_sent) { $js_lang_sent = true; $js_lang = array(); - foreach ($this->_js_lang_strings as $strName => $strValue) { + foreach ($this->_jsLangStrings as $strName => $strValue) { $js_lang[] = "'$strName': '" . PMA_jsFormat($strValue, false) . '\''; } $js[] = "$.extend(PMA_messages, {\n\t" . implode(",\n\t", $js_lang) . '})'; @@ -424,8 +424,8 @@ class FormDisplay } foreach ($this->_errors as $system_path => $error_list) { - if (isset($this->_system_paths[$system_path])) { - $path = $this->_system_paths[$system_path]; + if (isset($this->_systemPaths[$system_path])) { + $path = $this->_systemPaths[$system_path]; $name = PMA_lang_name($path); } else { $name = $GLOBALS["strConfigForm_$system_path"]; @@ -448,10 +448,10 @@ class FormDisplay $cf = ConfigFile::getInstance(); foreach (array_keys($this->_errors) as $work_path) { - if (!isset($this->_system_paths[$work_path])) { + if (!isset($this->_systemPaths[$work_path])) { continue; } - $canonical_path = $this->_system_paths[$work_path]; + $canonical_path = $this->_systemPaths[$work_path]; $cf->set($work_path, $cf->getDefault($canonical_path)); } } @@ -522,8 +522,8 @@ class FormDisplay : false; // grab POST values foreach ($form->fields as $field => $system_path) { - $work_path = array_search($system_path, $this->_system_paths); - $key = $this->_translated_paths[$work_path]; + $work_path = array_search($system_path, $this->_systemPaths); + $key = $this->_translatedPaths[$work_path]; $type = $form->getOptionType($field); // skip groups @@ -548,14 +548,14 @@ class FormDisplay // user preferences allow/disallow if ($is_setup_script - && isset($this->_userprefs_keys[$system_path]) + && isset($this->_userprefsKeys[$system_path]) ) { - if (isset($this->_userprefs_disallow[$system_path]) + if (isset($this->_userprefsDisallow[$system_path]) && isset($_POST[$key . '-userprefs-allow']) ) { - unset($this->_userprefs_disallow[$system_path]); + unset($this->_userprefsDisallow[$system_path]); } else if (!isset($_POST[$key . '-userprefs-allow'])) { - $this->_userprefs_disallow[$system_path] = true; + $this->_userprefsDisallow[$system_path] = true; } } @@ -649,7 +649,7 @@ class FormDisplay if ($is_setup_script) { $cf->set( 'UserprefsDisallow', - array_keys($this->_userprefs_disallow) + array_keys($this->_userprefsDisallow) ); } } @@ -735,13 +735,13 @@ class FormDisplay */ private function _loadUserprefsInfo() { - if ($this->_userprefs_keys === null) { - $this->_userprefs_keys = array_flip(PMA_read_userprefs_fieldnames()); + if ($this->_userprefsKeys === null) { + $this->_userprefsKeys = array_flip(PMA_readUserprefsFieldNames()); // read real config for user preferences display $userprefs_disallow = defined('PMA_SETUP') ? ConfigFile::getInstance()->get('UserprefsDisallow', array()) : $GLOBALS['cfg']['UserprefsDisallow']; - $this->_userprefs_disallow = array_flip($userprefs_disallow); + $this->_userprefsDisallow = array_flip($userprefs_disallow); } } diff --git a/libraries/plugins/export/ExportCodegen.class.php b/libraries/plugins/export/ExportCodegen.class.php index 87a75812a0..d0a2216a4c 100644 --- a/libraries/plugins/export/ExportCodegen.class.php +++ b/libraries/plugins/export/ExportCodegen.class.php @@ -18,7 +18,8 @@ require_once 'libraries/plugins/export/TableProperty.class.php'; /** * Handles the export for the CodeGen class * - * @package PhpMyAdmin-Export + * @package PhpMyAdmin-Export + * @subpackage CodeGen */ class ExportCodegen extends ExportPlugin { @@ -242,7 +243,7 @@ class ExportCodegen extends ExportPlugin private function _handleNHibernateCSBody($db, $table, $crlf) { $lines = array(); - + $result = PMA_DBI_query( sprintf( 'DESC %s.%s', PMA_Util::backquote($db), diff --git a/libraries/plugins/export/ExportCsv.class.php b/libraries/plugins/export/ExportCsv.class.php index 5c25503603..add779405a 100644 --- a/libraries/plugins/export/ExportCsv.class.php +++ b/libraries/plugins/export/ExportCsv.class.php @@ -16,8 +16,8 @@ require_once 'libraries/plugins/ExportPlugin.class.php'; /** * Handles the export for the CSV format * - * @todo add descriptions for all vars/methods - * @package PhpMyAdmin-Export + * @package PhpMyAdmin-Export + * @subpackage CSV */ class ExportCsv extends ExportPlugin { diff --git a/libraries/plugins/export/ExportExcel.class.php b/libraries/plugins/export/ExportExcel.class.php index 7217d6ded3..b8e8b020fc 100644 --- a/libraries/plugins/export/ExportExcel.class.php +++ b/libraries/plugins/export/ExportExcel.class.php @@ -16,7 +16,8 @@ require_once 'libraries/plugins/export/ExportCsv.class.php'; /** * Handles the export for the CSV-Excel format * - * @package PhpMyAdmin-Export + * @package PhpMyAdmin-Export + * @subpackage CSV-Excel */ class ExportExcel extends ExportCsv { diff --git a/libraries/plugins/export/ExportHtmlword.class.php b/libraries/plugins/export/ExportHtmlword.class.php index 55afa2afff..f6e5acbf78 100644 --- a/libraries/plugins/export/ExportHtmlword.class.php +++ b/libraries/plugins/export/ExportHtmlword.class.php @@ -16,7 +16,8 @@ require_once 'libraries/plugins/ExportPlugin.class.php'; /** * Handles the export for the HTML-Word format * - * @package PhpMyAdmin-Export + * @package PhpMyAdmin-Export + * @subpackage HTML-Word */ class ExportHtmlword extends ExportPlugin { diff --git a/libraries/plugins/export/ExportJson.class.php b/libraries/plugins/export/ExportJson.class.php index 1c41206973..299e248c02 100644 --- a/libraries/plugins/export/ExportJson.class.php +++ b/libraries/plugins/export/ExportJson.class.php @@ -16,7 +16,8 @@ require_once 'libraries/plugins/ExportPlugin.class.php'; /** * Handles the export for the JSON format * - * @package PhpMyAdmin-Export + * @package PhpMyAdmin-Export + * @subpackage JSON */ class ExportJson extends ExportPlugin { diff --git a/libraries/plugins/export/ExportLatex.class.php b/libraries/plugins/export/ExportLatex.class.php index 09b6f84bbc..66891b6d33 100644 --- a/libraries/plugins/export/ExportLatex.class.php +++ b/libraries/plugins/export/ExportLatex.class.php @@ -16,7 +16,8 @@ require_once 'libraries/plugins/ExportPlugin.class.php'; /** * Handles the export for the Latex format * - * @package PhpMyAdmin-Export + * @package PhpMyAdmin-Export + * @subpackage Latex */ class ExportLatex extends ExportPlugin { @@ -441,7 +442,7 @@ class ExportLatex extends ExportPlugin $dates = false ) { global $cfgRelation; - + /** * Get the unique keys in the table */ diff --git a/libraries/plugins/export/ExportMediawiki.class.php b/libraries/plugins/export/ExportMediawiki.class.php index 2ee4acf098..a0ef4244ec 100644 --- a/libraries/plugins/export/ExportMediawiki.class.php +++ b/libraries/plugins/export/ExportMediawiki.class.php @@ -16,7 +16,8 @@ require_once 'libraries/plugins/ExportPlugin.class.php'; /** * Handles the export for the MediaWiki class * - * @package PhpMyAdmin-Export + * @package PhpMyAdmin-Export + * @subpackage MediaWiki */ class ExportMediawiki extends ExportPlugin { diff --git a/libraries/plugins/export/ExportOds.class.php b/libraries/plugins/export/ExportOds.class.php index cfa7cbabee..4a18f0cd57 100644 --- a/libraries/plugins/export/ExportOds.class.php +++ b/libraries/plugins/export/ExportOds.class.php @@ -19,7 +19,8 @@ require_once 'libraries/opendocument.lib.php'; /** * Handles the export for the ODS class * - * @package PhpMyAdmin-Export + * @package PhpMyAdmin-Export + * @subpackage ODS */ class ExportOds extends ExportPlugin { diff --git a/libraries/plugins/export/ExportOdt.class.php b/libraries/plugins/export/ExportOdt.class.php index 26bda0c78c..ea3282c238 100644 --- a/libraries/plugins/export/ExportOdt.class.php +++ b/libraries/plugins/export/ExportOdt.class.php @@ -4,7 +4,7 @@ * Set of functions used to build OpenDocument Text dumps of tables * * @package PhpMyAdmin-Export - * @subpackage ODS + * @subpackage ODT */ if (! defined('PHPMYADMIN')) { exit; @@ -19,7 +19,8 @@ require_once 'libraries/opendocument.lib.php'; /** * Handles the export for the ODT class * - * @package PhpMyAdmin-Export + * @package PhpMyAdmin-Export + * @subpackage ODT */ class ExportOdt extends ExportPlugin { diff --git a/libraries/plugins/export/ExportPdf.class.php b/libraries/plugins/export/ExportPdf.class.php index ed40ca9ecc..ffabb96efa 100644 --- a/libraries/plugins/export/ExportPdf.class.php +++ b/libraries/plugins/export/ExportPdf.class.php @@ -18,7 +18,8 @@ require_once 'libraries/plugins/export/PMA_ExportPdf.class.php'; /** * Handles the export for the PDF class * - * @package PhpMyAdmin-Export + * @package PhpMyAdmin-Export + * @subpackage PDF */ class ExportPdf extends ExportPlugin { diff --git a/libraries/plugins/export/ExportPhparray.class.php b/libraries/plugins/export/ExportPhparray.class.php index 3208121262..cbe5e2c039 100644 --- a/libraries/plugins/export/ExportPhparray.class.php +++ b/libraries/plugins/export/ExportPhparray.class.php @@ -16,7 +16,8 @@ require_once 'libraries/plugins/ExportPlugin.class.php'; /** * Handles the export for the PHP Array class * - * @package PhpMyAdmin-Export + * @package PhpMyAdmin-Export + * @subpackage PHP */ class ExportPhparray extends ExportPlugin { diff --git a/libraries/plugins/export/ExportSql.class.php b/libraries/plugins/export/ExportSql.class.php index 6315c17ca6..ca17a2d617 100644 --- a/libraries/plugins/export/ExportSql.class.php +++ b/libraries/plugins/export/ExportSql.class.php @@ -16,8 +16,8 @@ require_once 'libraries/plugins/ExportPlugin.class.php'; /** * Handles the export for the SQL class * - * @todo add descriptions for all vars/methods - * @package PhpMyAdmin-Export + * @package PhpMyAdmin-Export + * @subpackage SQL */ class ExportSql extends ExportPlugin { diff --git a/libraries/plugins/export/ExportTexytext.class.php b/libraries/plugins/export/ExportTexytext.class.php index f005f827fd..3aa609c345 100644 --- a/libraries/plugins/export/ExportTexytext.class.php +++ b/libraries/plugins/export/ExportTexytext.class.php @@ -16,7 +16,8 @@ require_once 'libraries/plugins/ExportPlugin.class.php'; /** * Handles the export for the Texy! text class * - * @package PhpMyAdmin-Export + * @package PhpMyAdmin-Export + * @subpackage Texy!text */ class ExportTexytext extends ExportPlugin { diff --git a/libraries/plugins/export/ExportXml.class.php b/libraries/plugins/export/ExportXml.class.php index af0a91738b..f911d522cd 100644 --- a/libraries/plugins/export/ExportXml.class.php +++ b/libraries/plugins/export/ExportXml.class.php @@ -19,7 +19,8 @@ require_once 'libraries/plugins/ExportPlugin.class.php'; /** * Handles the export for the XML class * - * @package PhpMyAdmin-Export + * @package PhpMyAdmin-Export + * @subpackage XML */ class ExportXml extends ExportPlugin { diff --git a/libraries/plugins/export/ExportYaml.class.php b/libraries/plugins/export/ExportYaml.class.php index 7c2585139e..044daeee47 100644 --- a/libraries/plugins/export/ExportYaml.class.php +++ b/libraries/plugins/export/ExportYaml.class.php @@ -16,7 +16,8 @@ require_once 'libraries/plugins/ExportPlugin.class.php'; /** * Handles the export for the YAML format * - * @package PhpMyAdmin-Export + * @package PhpMyAdmin-Export + * @subpackage YAML */ class ExportYaml extends ExportPlugin { diff --git a/libraries/plugins/export/PMA_ExportPdf.class.php b/libraries/plugins/export/PMA_ExportPdf.class.php index f094f8deb3..54f85e2521 100644 --- a/libraries/plugins/export/PMA_ExportPdf.class.php +++ b/libraries/plugins/export/PMA_ExportPdf.class.php @@ -24,6 +24,16 @@ class PMA_ExportPdf extends PMA_PDF var $tablewidths; var $headerset; + /** + * Add page if needed. + * + * @param float $h cell height. Default value: 0 + * @param mixed $y starting y position, leave empty for current position + * @param boolean $addpage if true add a page, otherwise only return + * the true/false state + * + * @return boolean true in case of page break, false otherwise. + */ function checkPageBreak($h = 0, $y = '', $addpage = true) { if ($this->empty_string($y)) { @@ -68,6 +78,11 @@ class PMA_ExportPdf extends PMA_PDF return false; } + /** + * This method is used to render the page header. + * + * @return void + */ function Header() { global $maxY; @@ -139,7 +154,7 @@ class PMA_ExportPdf extends PMA_PDF $this->dataY = $maxY; } - function morepagestable($lineheight=8) + function morepagestable($lineheight = 8) { // some things to set and 'remember' $l = $this->lMargin; @@ -217,6 +232,13 @@ class PMA_ExportPdf extends PMA_PDF $this->page = $maxpage; } + /** + * Sets a set of attributes. + * + * @param array $attr array containing the attributes + * + * @return void + */ function setAttributes($attr = array()) { foreach ($attr as $key => $val) { @@ -224,6 +246,14 @@ class PMA_ExportPdf extends PMA_PDF } } + /** + * Defines the top margin. + * The method can be called before creating the first page. + * + * @param float $topMargin the margin + * + * @return void + */ function setTopMargin($topMargin) { $this->tMargin = $topMargin; diff --git a/libraries/plugins/export/TableProperty.class.php b/libraries/plugins/export/TableProperty.class.php index bc544a8774..a928a6c3d1 100644 --- a/libraries/plugins/export/TableProperty.class.php +++ b/libraries/plugins/export/TableProperty.class.php @@ -1,7 +1,7 @@ type; } - /** + /** * Tells whether the key is null or not - * + * * @return bool true if the key is not null, false otherwise */ function isNotNull() @@ -100,9 +101,9 @@ class TableProperty return $this->nullable == "NO" ? "true" : "false"; } - /** + /** * Tells whether the key is unique or not - * + * * @return bool true if the key is unique, false otherwise */ function isUnique() @@ -112,7 +113,7 @@ class TableProperty /** * Gets the .NET primitive type - * + * * @return string type */ function getDotNetPrimitiveType() @@ -146,7 +147,7 @@ class TableProperty /** * Gets the .NET object type - * + * * @return string type */ function getDotNetObjectType() @@ -195,7 +196,7 @@ class TableProperty /** * Tells whether the key is primary or not - * + * * @return bool true if the key is primary, false otherwise */ function isPK() @@ -205,7 +206,7 @@ class TableProperty /** * Formats a string for C# - * + * * @param string $text string to be formatted * * @return string formatted text @@ -222,7 +223,7 @@ class TableProperty /** * Formats a string for XML - * + * * @param string $text string to be formatted * * @return string formatted text @@ -244,7 +245,7 @@ class TableProperty /** * Formats a string - * + * * @param string $text string to be formatted * * @return string formatted text diff --git a/libraries/plugins/import/ImportCsv.class.php b/libraries/plugins/import/ImportCsv.class.php index fc202d45e7..c50f671dca 100644 --- a/libraries/plugins/import/ImportCsv.class.php +++ b/libraries/plugins/import/ImportCsv.class.php @@ -17,7 +17,8 @@ require_once 'libraries/plugins/ImportPlugin.class.php'; /** * Handles the import for the CSV format * - * @package PhpMyAdmin-Import + * @package PhpMyAdmin-Import + * @subpackage CSV */ class ImportCsv extends ImportPlugin { diff --git a/libraries/plugins/import/ImportLdi.class.php b/libraries/plugins/import/ImportLdi.class.php index fd236179b2..b38e74b052 100644 --- a/libraries/plugins/import/ImportLdi.class.php +++ b/libraries/plugins/import/ImportLdi.class.php @@ -22,7 +22,8 @@ if ($GLOBALS['plugin_param'] !== 'table') { /** * Handles the import for the CSV format using load data * - * @package PhpMyAdmin-Import + * @package PhpMyAdmin-Import + * @subpackage LDI */ class ImportLdi extends ImportPlugin { diff --git a/libraries/plugins/import/ImportMediawiki.class.php b/libraries/plugins/import/ImportMediawiki.class.php index 9a1500f0ac..767c966c1d 100644 --- a/libraries/plugins/import/ImportMediawiki.class.php +++ b/libraries/plugins/import/ImportMediawiki.class.php @@ -16,7 +16,8 @@ require_once 'libraries/plugins/ImportPlugin.class.php'; /** * Handles the import for the MediaWiki format * - * @package PhpMyAdmin-Import + * @package PhpMyAdmin-Import + * @subpackage MediaWiki */ class ImportMediawiki extends ImportPlugin { diff --git a/libraries/plugins/import/ImportOds.class.php b/libraries/plugins/import/ImportOds.class.php index 89da1e35f0..be54fc7a35 100644 --- a/libraries/plugins/import/ImportOds.class.php +++ b/libraries/plugins/import/ImportOds.class.php @@ -25,7 +25,8 @@ require_once 'libraries/plugins/ImportPlugin.class.php'; /** * Handles the import for the ODS format * - * @package PhpMyAdmin-Import + * @package PhpMyAdmin-Import + * @subpackage ODS */ class ImportOds extends ImportPlugin { diff --git a/libraries/plugins/import/ImportShp.class.php b/libraries/plugins/import/ImportShp.class.php index 0ec378242a..9f0c15b390 100644 --- a/libraries/plugins/import/ImportShp.class.php +++ b/libraries/plugins/import/ImportShp.class.php @@ -25,7 +25,8 @@ require_once 'libraries/plugins/import/ShapeRecord.class.php'; /** * Handles the import for ESRI Shape files * - * @package PhpMyAdmin-Import + * @package PhpMyAdmin-Import + * @subpackage ESRI_Shape */ class ImportShp extends ImportPlugin { diff --git a/libraries/plugins/import/ImportSql.class.php b/libraries/plugins/import/ImportSql.class.php index 46e3007b01..146485a231 100644 --- a/libraries/plugins/import/ImportSql.class.php +++ b/libraries/plugins/import/ImportSql.class.php @@ -16,7 +16,8 @@ require_once 'libraries/plugins/ImportPlugin.class.php'; /** * Handles the import for the SQL format * - * @package PhpMyAdmin-Import + * @package PhpMyAdmin-Import + * @subpackage SQL */ class ImportSql extends ImportPlugin { diff --git a/libraries/plugins/import/ImportXml.class.php b/libraries/plugins/import/ImportXml.class.php index f3199a28b1..9c0e999592 100644 --- a/libraries/plugins/import/ImportXml.class.php +++ b/libraries/plugins/import/ImportXml.class.php @@ -25,7 +25,8 @@ require_once 'libraries/plugins/ImportPlugin.class.php'; /** * Handles the import for the XML format * - * @package PhpMyAdmin-Import + * @package PhpMyAdmin-Import + * @subpackage XML */ class ImportXml extends ImportPlugin { diff --git a/libraries/plugins/transformations/Application_Octetstream_Download.class.php b/libraries/plugins/transformations/Application_Octetstream_Download.class.php index aa5019a93c..069eda719b 100644 --- a/libraries/plugins/transformations/Application_Octetstream_Download.class.php +++ b/libraries/plugins/transformations/Application_Octetstream_Download.class.php @@ -15,7 +15,8 @@ require_once 'abstract/DownloadTransformationsPlugin.class.php'; /** * Handles the download transformation for application octetstream * - * @package PhpMyAdmin + * @package PhpMyAdmin-Transformations + * @subpackage Download */ class Application_Octetstream_Download extends DownloadTransformationsPlugin { diff --git a/libraries/plugins/transformations/Application_Octetstream_Hex.class.php b/libraries/plugins/transformations/Application_Octetstream_Hex.class.php index e6d6c2af7b..f6f4297460 100644 --- a/libraries/plugins/transformations/Application_Octetstream_Hex.class.php +++ b/libraries/plugins/transformations/Application_Octetstream_Hex.class.php @@ -16,7 +16,8 @@ require_once 'abstract/HexTransformationsPlugin.class.php'; /** * Handles the hex transformation for application octetstream * - * @package PhpMyAdmin + * @package PhpMyAdmin-Transformations + * @subpackage Hex */ class Application_Octetstream_Hex extends HexTransformationsPlugin { diff --git a/libraries/plugins/transformations/Image_JPEG_Inline.class.php b/libraries/plugins/transformations/Image_JPEG_Inline.class.php index 8b09df6cfd..501205a945 100644 --- a/libraries/plugins/transformations/Image_JPEG_Inline.class.php +++ b/libraries/plugins/transformations/Image_JPEG_Inline.class.php @@ -16,7 +16,8 @@ require_once 'abstract/InlineTransformationsPlugin.class.php'; /** * Handles the inline transformation for image jpeg * - * @package PhpMyAdmin + * @package PhpMyAdmin-Transformations + * @subpackage Inline */ class Image_JPEG_Inline extends InlineTransformationsPlugin { diff --git a/libraries/plugins/transformations/Image_JPEG_Link.class.php b/libraries/plugins/transformations/Image_JPEG_Link.class.php index e55348a690..ca3c1d18ea 100644 --- a/libraries/plugins/transformations/Image_JPEG_Link.class.php +++ b/libraries/plugins/transformations/Image_JPEG_Link.class.php @@ -16,7 +16,8 @@ require_once 'abstract/ImageLinkTransformationsPlugin.class.php'; /** * Handles the link transformation for image jpeg * - * @package PhpMyAdmin + * @package PhpMyAdmin-Transformations + * @subpackage Link */ class Image_JPEG_Link extends ImageLinkTransformationsPlugin { diff --git a/libraries/plugins/transformations/Image_PNG_Inline.class.php b/libraries/plugins/transformations/Image_PNG_Inline.class.php index 2fac38c809..40b709d87a 100644 --- a/libraries/plugins/transformations/Image_PNG_Inline.class.php +++ b/libraries/plugins/transformations/Image_PNG_Inline.class.php @@ -16,7 +16,8 @@ require_once 'abstract/InlineTransformationsPlugin.class.php'; /** * Handles the inline transformation for image png * - * @package PhpMyAdmin + * @package PhpMyAdmin-Transformations + * @subpackage Inline */ class Image_PNG_Inline extends InlineTransformationsPlugin { diff --git a/libraries/plugins/transformations/Text_Plain_Append.class.php b/libraries/plugins/transformations/Text_Plain_Append.class.php index 8bdf529fdd..567c2cc608 100644 --- a/libraries/plugins/transformations/Text_Plain_Append.class.php +++ b/libraries/plugins/transformations/Text_Plain_Append.class.php @@ -17,7 +17,8 @@ require_once 'abstract/AppendTransformationsPlugin.class.php'; * Handles the append transformation for text plain. * Has one option: the text to be appended (default '') * - * @package PhpMyAdmin + * @package PhpMyAdmin-Transformations + * @subpackage Append */ class Text_Plain_Append extends AppendTransformationsPlugin { diff --git a/libraries/plugins/transformations/Text_Plain_Dateformat.class.php b/libraries/plugins/transformations/Text_Plain_Dateformat.class.php index 234ecdb36d..70db98aef7 100644 --- a/libraries/plugins/transformations/Text_Plain_Dateformat.class.php +++ b/libraries/plugins/transformations/Text_Plain_Dateformat.class.php @@ -16,7 +16,8 @@ require_once 'abstract/DateFormatTransformationsPlugin.class.php'; /** * Handles the date format transformation for text plain * - * @package PhpMyAdmin + * @package PhpMyAdmin-Transformations + * @subpackage DateFormat */ class Text_Plain_Dateformat extends DateFormatTransformationsPlugin { diff --git a/libraries/plugins/transformations/Text_Plain_External.class.php b/libraries/plugins/transformations/Text_Plain_External.class.php index 11d7bb7744..18da613183 100644 --- a/libraries/plugins/transformations/Text_Plain_External.class.php +++ b/libraries/plugins/transformations/Text_Plain_External.class.php @@ -16,7 +16,8 @@ require_once 'abstract/ExternalTransformationsPlugin.class.php'; /** * Handles the external transformation for text plain * - * @package PhpMyAdmin + * @package PhpMyAdmin-Transformations + * @subpackage External */ class Text_Plain_External extends ExternalTransformationsPlugin { diff --git a/libraries/plugins/transformations/Text_Plain_Formatted.class.php b/libraries/plugins/transformations/Text_Plain_Formatted.class.php index 83bb8dca0f..3942a93e32 100644 --- a/libraries/plugins/transformations/Text_Plain_Formatted.class.php +++ b/libraries/plugins/transformations/Text_Plain_Formatted.class.php @@ -16,7 +16,8 @@ require_once 'abstract/FormattedTransformationsPlugin.class.php'; /** * Handles the formatted transformation for text plain * - * @package PhpMyAdmin + * @package PhpMyAdmin-Transformations + * @subpackage Formatted */ class Text_Plain_Formatted extends FormattedTransformationsPlugin { diff --git a/libraries/plugins/transformations/Text_Plain_Imagelink.class.php b/libraries/plugins/transformations/Text_Plain_Imagelink.class.php index e56f59faf6..670e52e8d7 100644 --- a/libraries/plugins/transformations/Text_Plain_Imagelink.class.php +++ b/libraries/plugins/transformations/Text_Plain_Imagelink.class.php @@ -16,7 +16,8 @@ require_once 'abstract/TextImageLinkTransformationsPlugin.class.php'; /** * Handles the image link transformation for text plain * - * @package PhpMyAdmin + * @package PhpMyAdmin-Transformations + * @subpackage ImageLink */ class Text_Plain_Imagelink extends TextImageLinkTransformationsPlugin { diff --git a/libraries/plugins/transformations/Text_Plain_Link.class.php b/libraries/plugins/transformations/Text_Plain_Link.class.php index 06731da123..d1b17d5ec8 100644 --- a/libraries/plugins/transformations/Text_Plain_Link.class.php +++ b/libraries/plugins/transformations/Text_Plain_Link.class.php @@ -16,7 +16,8 @@ require_once 'abstract/TextLinkTransformationsPlugin.class.php'; /** * Handles the link transformation for text plain * - * @package PhpMyAdmin + * @package PhpMyAdmin-Transformations + * @subpackage Link */ class Text_Plain_Link extends TextLinkTransformationsPlugin { diff --git a/libraries/plugins/transformations/Text_Plain_Longtoipv4.class.php b/libraries/plugins/transformations/Text_Plain_Longtoipv4.class.php index 7f2004db99..9f58a45eb3 100644 --- a/libraries/plugins/transformations/Text_Plain_Longtoipv4.class.php +++ b/libraries/plugins/transformations/Text_Plain_Longtoipv4.class.php @@ -16,7 +16,8 @@ require_once 'abstract/LongToIPv4TransformationsPlugin.class.php'; /** * Handles the long to ipv4 transformation for text plain * - * @package PhpMyAdmin + * @package PhpMyAdmin-Transformations + * @subpackage LongToIPv4 */ class Text_Plain_Longtoipv4 extends LongToIPv4TransformationsPlugin { diff --git a/libraries/plugins/transformations/Text_Plain_Sql.class.php b/libraries/plugins/transformations/Text_Plain_Sql.class.php index 952d4fe7f6..1987ba9144 100644 --- a/libraries/plugins/transformations/Text_Plain_Sql.class.php +++ b/libraries/plugins/transformations/Text_Plain_Sql.class.php @@ -16,7 +16,8 @@ require_once 'abstract/SQLTransformationsPlugin.class.php'; /** * Handles the sql transformation for text plain * - * @package PhpMyAdmin + * @package PhpMyAdmin-Transformations + * @subpackage SQL */ class Text_Plain_Sql extends SQLTransformationsPlugin { diff --git a/libraries/plugins/transformations/Text_Plain_Substring.class.php b/libraries/plugins/transformations/Text_Plain_Substring.class.php index fc0ab02412..051ae51cd3 100644 --- a/libraries/plugins/transformations/Text_Plain_Substring.class.php +++ b/libraries/plugins/transformations/Text_Plain_Substring.class.php @@ -16,7 +16,8 @@ require_once 'abstract/SubstringTransformationsPlugin.class.php'; /** * Handles the substring transformation for text plain * - * @package PhpMyAdmin + * @package PhpMyAdmin-Transformations + * @subpackage Substring */ class Text_Plain_Substring extends SubstringTransformationsPlugin { diff --git a/libraries/plugins/transformations/abstract/AppendTransformationsPlugin.class.php b/libraries/plugins/transformations/abstract/AppendTransformationsPlugin.class.php index 08582e49c9..0fc3b4de77 100644 --- a/libraries/plugins/transformations/abstract/AppendTransformationsPlugin.class.php +++ b/libraries/plugins/transformations/abstract/AppendTransformationsPlugin.class.php @@ -16,7 +16,8 @@ require_once 'libraries/plugins/TransformationsPlugin.class.php'; /** * Provides common methods for all of the append transformations plugins. * - * @package PhpMyAdmin + * @package PhpMyAdmin-Transformations + * @subpackage Append */ abstract class AppendTransformationsPlugin extends TransformationsPlugin { diff --git a/libraries/rte/rte_events.lib.php b/libraries/rte/rte_events.lib.php index 2309720261..7d4ce6cf37 100644 --- a/libraries/rte/rte_events.lib.php +++ b/libraries/rte/rte_events.lib.php @@ -121,8 +121,8 @@ function PMA_EVN_handleEditor() ) . '