• Home
• PMA
• libraries
• Util

PHP Class PMA\libraries\Util

ファイルを表示 Open project: phpmyadmin/phpmyadmin Class Usage Examples

Public Methods

Method	Description
addMicroseconds ( string $value ) : string	Add fractional seconds to time, datetime and timestamp strings.
asWKT ( string $data, boolean $includeSRID = false ) : string	Converts GIS data to Well Known Text format
backquote ( mixed $a_name, boolean $do_it = true ) : mixed	Adds backquotes on both sides of a database, table or field name.
backquoteCompat ( mixed $a_name, string $compatibility = 'MSSQL', boolean $do_it = true ) : mixed	Adds backquotes on both sides of a database, table or field name.
buildActionTitles ( ) : array	Build titles and icons for action links
cacheExists ( string $var ) : boolean	Verifies if something is cached in the session
cacheGet ( string $var, Closure $callback = null ) : mixed	Gets cached information from the session
cacheSet ( string $var, mixed $val = null ) : mixed	Caches information in the session
cacheUnset ( string $var ) : void	Removes cached information from the session
checkParameters ( string[] $params, boolean $request = true ) : void	Function added to avoid path disclosures.
clearUserCache ( ) : void	Clears cache content which needs to be refreshed on user change.
configureCurl ( resource $curl_handle ) : resource	Updates an existing curl as necessary
containsNonPrintableAscii ( string $value ) : integer	Verifies whether the value contains a non-printable character
convertBitDefaultValue ( string $bit_default_value ) : string	Converts a BIT type default value for example, b'010' becomes 010
createGISData ( string $gis_string ) : string	Generates GIS data based on the string passed.
currentUserHasPrivilege ( string $priv, mixed $db = null, mixed $tbl = null ) : boolean	Checks if the current user has a specific privilege and returns true if the user indeed has that privilege or false if (s)he doesn't. This function must only be used for features that are available since MySQL 5, because it relies on the INFORMATION_SCHEMA database to be present.
duplicateFirstNewline ( string $string ) : string	If the string starts with a \r\n pair (0x0d0a) add an extra \n
escapeMysqlWildcards ( string $name ) : string	Add slashes before "_" and "%" characters for using them in MySQL database, table and field names.
expandUserString ( string $string, array | string $escape = null, array $updates = [] ) : string	Formats user string, expanding @VARIABLES@, accepting strftime format string.
extractColumnSpec ( string $columnspec ) : array	Extracts the various parts from a column spec
extractValueFromFormattedSize ( string $formatted_size ) : integer	Returns the number of bytes when a formatted size is given
formatByteDown ( double | integer $value, integer $limes = 6, integer $comma ) : array	Formats $value to byte view
formatNumber ( double $value, integer $digits_left = 3, integer $digits_right, boolean $only_down = false, boolean $noTrailingZero = true ) : string	Formats $value to the given length and appends SI prefixes with a $length of 0 no truncation occurs, number is only formatted to the current locale
formatSql ( string $sqlQuery, boolean $truncate = false ) : string	format sql strings
generateHiddenMaxFileSize ( integer $max_size ) : string	Generates a hidden field which should indicate to the browser the maximum size for upload
getBrowseUploadFileBlock ( string $max_upload_size ) : String	Prepare the form used to browse anywhere on the local server for a file to import
getButton ( ) : String	Prepare HTML code for display button.
getButtonOrImage ( string $button_name, string $button_class, string $text, string $image, string $value = '' ) : string	Generate a button or image tag
getCharsetQueryPart ( string $collation, $override = false ) : string	Generate the charset query part
getClassForType ( string $type ) : string	Returns the proper class clause according to the column type
getCollateForIS ( ) : string	Provide COLLATE clause, if required, to perform case sensitive comparisons for queries on information_schema.
getCompressionMimeType ( resource $file ) : string	Reads the file, detects the compression MIME type, closes the file and returns the MIME type
getDbInfo ( string $db, string $sub_part ) : array	Gets the list of tables in the current db and information about these tables if possible
getDbLink ( string $database = null ) : string	returns html code for db link to default db page
getDefaultFunctionForField ( array $field, boolean $insert_mode ) : string	Returns default function for a particular column.
getDivForSliderEffect ( string $id = '', string $message = '' ) : string	Generates a slider effect (jQjuery) Takes care of generating the initial and the link controlling the slider; you have to generate the yourself after the sliding section.
getDocuLink ( string $page, string $anchor = '' ) : string	Returns link to documentation.
getDropdown ( string $select_name, array $choices, string $active_choice, string $id, string $class = '', string $placeholder = null ) : string	Generates and returns an HTML dropdown
getExternalBug ( string $functionality, string $component, string $minimum_version, string $bugref ) : String	Prepare a lightbulb hint explaining a known external bug that affects a functionality
getFKCheckbox ( ) : string	Get HTML for Foreign key check checkbox
getFirstOccurringRegularExpression ( array $regex_array, String $query ) : String	Get regular expression which occur first inside the given sql query.
getFormattedMaximumUploadSize ( integer $max_upload_size ) : string	Returns the formatted maximum size for an upload
getFunctionsForField ( array $field, boolean $insert_mode, $foreignData ) : string	Creates a dropdown box with MySQL functions for a particular column.
getGISDatatypes ( boolean $upper_case = false ) : string[]	Return GIS data types
getGISFunctions ( string $geom_type = null, boolean $binary = true, boolean $display = false ) : array	Returns the names and details of the functions that can be applied on geometry data types.
getHtmlTab ( array $tab, array $url_params = [] ) : string	returns a tab for tabbed navigation.
getHtmlTabs ( array $tabs, array $url_params, string $menu_id, boolean $resizable = false ) : string	returns html-code for a tab navigation
getIcon ( string $icon, string $alternate = '', boolean $force_text = false, boolean $menu_icon = false, string $control_param = 'ActionLinksMode' ) : string	Returns an HTML IMG tag for a particular icon from a theme, which may be an actual file or an icon from a sprite.
getImage ( string $image, string $alternate = '', array $attributes = [] ) : string	Returns an HTML IMG tag for a particular image from a theme, which may be an actual file or an icon from a sprite
getListNavigator ( integer $count, integer $pos, array $_url_params, string $script, string $frame, integer $max_count, string $name = 'pos', string[] $classes = [] ) : string	Prepare navigation for a list
getMenuTabList ( string $level = null ) : array	Return the list of tabs for the menu with corresponding names
getMessage ( Message | string $message, string $sql_query = null, string $type = 'notice' ) : string	Prepare the message and the query usually the message is the result of the query executed
getMySQLDocuURL ( string $link, string $anchor = '' ) : string	Get a URL link to the official MySQL documentation
getNavigationLink ( string $link, boolean $showText, string $text, boolean $showIcon, string $icon, string $linkId = '', boolean $disableAjax = false, string $linkTarget = '', array $classes = [] ) : string	Renders a single link for the top of the navigation panel
getRadioFields ( string $html_field_name, array $choices, string $checked_choice = '', boolean $line_break = true, boolean $escape_label = true, string $class = '', string $id_prefix = '' ) : string	Generates a set of radio HTML fields
getScriptNameForOption ( string $target, string $location ) : string	Get the script name corresponding to a plain English config word in order to append in links on navigation and main panel
getSelectUploadFileBlock ( ImportPlugin[] $import_list, string $uploaddir ) : String	Prepare the form used to select a file to import from the server upload directory
getServerType ( ) : string	Returns server type for current connection
getStartAndNumberOfRowsPanel ( string $sql_query ) : string	Function to get html for the start row and number of rows panel
getSupportedDatatypes ( boolean $html = false, string $selected = '' ) : mixed	This function processes the datatypes supported by the DB, as specified in Types->getColumns() and either returns an array (useful for quickly checking if a datatype is supported) or an HTML snippet that creates a drop-down list.
getTableList ( string $db, string $tables = null, integer $limit_offset, integer | boolean $limit_count = false ) : array	returns array with tables of given db with extended information and grouped
getTablesWhenOpen ( string $db, object $db_info_result ) : array	Gets the list of tables in the current db, taking into account that they might be "in use"
getTitleForTarget ( string $target ) : string	Get the action word corresponding to a script name in order to display it as a title in navigation panel
getUniqueCondition ( resource $handle, integer $fields_cnt, array $fields_meta, array $row, boolean $force_unique = false, string | boolean $restrict_to_table = false, array $analyzed_sql_results = null ) : array	Function to generate unique condition for specified row.
handleContext ( array $context ) : array	Returns information with regards to handling the http request
handleDisableFKCheckCleanup ( boolean $default_fk_check_value ) : void	Cleanup changes done for foreign key check
handleDisableFKCheckInit ( ) : boolean	Handle foreign key check request
httpRequest ( string $url, string $method, boolean $return_only_status = false, mixed $content = null, string $header = "" ) : mixed	Creates HTTP request
httpRequestCurl ( string $url, string $method, boolean $return_only_status = false, mixed $content = null, string $header = "" ) : mixed	Creates HTTP request using curl
httpRequestFopen ( string $url, string $method, boolean $return_only_status = false, mixed $content = null, string $header = "" ) : mixed	Creates HTTP request using file_get_contents
httpRequestReturn ( mixed $response, interger $http_status, boolean $return_only_status ) : mixed	Creates HTTP request using curl
isForeignKeyCheck ( ) : boolean	Is Foreign key check enabled?
isForeignKeySupported ( string $engine ) : boolean	Verifies if this table's engine supports foreign keys
isVirtualColumnsSupported ( ) : boolean	Returns whether the database server supports virtual columns
linkOrButton ( string $url, string $message, mixed $tag_params = [], boolean $new_form = true, boolean $strip_img = false, string $target = '', boolean $force_button = false ) : string	Displays a link, or a button if the link's URL is too large, to accommodate some browsers' limitations
listPHPExtensions ( ) : array	Returs list of used PHP extensions.
localisedDate ( integer $timestamp, string $format = '' ) : string	Writes localised date
mysqlDie ( string | boolean $server_msg = '', string $sql_query = '', boolean $is_modify_link = true, string $back_url = '', boolean $exit = true ) : string	Displays a MySQL error message in the main panel when $exit is true.
pageselector ( string $name, integer $rows, integer $pageNow = 1, integer $nbTotalPage = 1, integer $showAll = 200, integer $sliceStart = 5, integer $sliceEnd = 5, integer $percent = 20, integer $range = 10, string $prompt = '' ) : string	Generate a pagination selector for browsing resultsets
parseEnumSetValues ( string $definition, boolean $escapeHtml = true ) : array	Parses ENUM/SET values
printableBitValue ( integer $value, integer $length ) : string	Converts a bit value to printable format; in MySQL a BIT field can be from 1 to 64 bits so we need this function because in PHP, decbin() supports only 32 bits on 32-bit servers
processIndexData ( array $indexes ) : array	Process the index data.
profilingSupported ( ) : boolean	Verifies if current MySQL server supports profiling
requestString ( mixed $value ) : string	Converts given (request) paramter to string
showDocLink ( string $link, string $target = 'documentation', boolean $bbcode = false ) : string	Displays a link to the documentation as an icon
showDocu ( string $page, string $anchor = '', boolean $bbcode = false ) : string	Displays a link to the phpMyAdmin documentation
showHint ( string $message ) : string	Returns HTML code for a tooltip
showIcons ( string $value ) : boolean	Checks whether configuration value tells to show icons.
showMySQLDocu ( string $link, boolean $big_icon = false, string $anchor = '', boolean $just_open = false ) : string	Displays a link to the official MySQL documentation
showPHPDocu ( string $target ) : string	Displays a link to the PHP documentation
showText ( string $value ) : boolean	Checks whether configuration value tells to show text.
splitURLQuery ( string $url ) : array	Splits a URL string by parameter
timespanFormat ( integer $seconds ) : string	Returns a given timespan value in a readable format.
toggleButton ( string $action, string $select_name, array $options, string $callback ) : string	Creates an AJAX sliding toggle button (or and equivalent form when AJAX is disabled)
unQuote ( string $quoted_string, string $quote = null ) : string	removes quotes (',",`) from a quoted string
unescapeMysqlWildcards ( string $name ) : string	removes slashes before "_" and "%" characters Note: This function does not unescape backslashes!
unsupportedDatatypes ( ) : array	Returns a list of datatypes that are not (yet) handled by PMA.
userDir ( string $dir ) : string	replaces %u in given path with current user name
whichCrlf ( ) : string	Defines the value depending on the user OS.

Private Methods

Method	Description
_checkRowCount ( string $db, array $table ) : integer	Check the correct row count
_generateRowQueryOutput ( string $sqlQuery ) : string	Execute an EXPLAIN query and formats results similar to MySQL command line utility.

Method Details