Global

Members

$after_field_item

Source:

$allTr

Source:

$curr_row

Source:

$curr_row

Source:

$editArea

Source:

$last_checkbox

Source:

$last_row

Source:

$retval

Source:

$td

Source:

$this_anchor

Source:

$thisField

Source:

$thisField

Source:

ajaxMessageCount :int

Number of AJAX messages shown since page load

Source:
Type:

array

Source:

array

Source:

array

Source:

array

Source:

(private) array,

Source:

bool

Source:

bool

Source:

bool

Source:

bool

Source:

(private) bool,

Source:

bool,

Source:

(private) bool,

Source:

button_options

Source:

button_options

Source:

button_options

Source:

buttonOptions

Source:

ChartType

Chart type enumerations

Source:

columnCount

Source:

ColumnType

Column type enumeration

Source:

Console

Console object

Source:

curr_column_name

Source:

curr_last_row

Source:

curr_last_row_index

Source:

curr_last_row_index_string

Source:

curr_row

Source:

curr_rows

Source:

curr_table_name

Source:

curr_table_name

Source:

curr_table_name

Source:

currValue

Source:

DataTable

The data table contains column information and data for the chart.

Source:

defaultValues :Object

defaultValues Default values for the Settings data.

Source:
Type:

dismissable

Source:

ErrorReport

This Object uses the library TraceKit to generate the backtrace of the error but since we are using webpack and the development and production mode have different url leading to cross origin query, the error report cannot be generated in development mode with context. The context will be null in deveopment mode.

Source:
See:
  • TraceKit url checking implemented to avoid Cross Origin https://github.com/csnover/TraceKit/blob/d38d48765f089309e4f4c7a1baacd96dd0534187/tracekit.js#L445
  • TraceKit How context of the error is being gennerated https://github.com/csnover/TraceKit/blob/d38d48765f089309e4f4c7a1baacd96dd0534187/tracekit.js#L499 Due to usage of webpack, the production output is creating backtrace context containing single line only and that single line is the complete generated webpack bundle in the uglify mode.

fieldName

Source:
See:
  • getFieldName()

fieldName

Source:
See:
  • getFieldName()

fieldName

Source:
See:
  • getFieldName()

fullSqlQuery

Source:

fulltext_indexes

Source:

fullWhereClause

Source:

function

Source:

(constant) GlobalVariables :hash

GlobalVariables Global variables to bee used inside for PMA like doc template, theme etc

Source:
Type:

hash

Source:

hash

Source:

indexes

Source:

int

Source:

int

Source:

int

Source:

int

Source:

(private) int,

Source:

is_view

Source:

isNull

Source:

isNull

Source:

isUnique

Source:

(constant) JqueryValidations :hash

JqueryValidations Contains the hash for replacing the default jQuery validation with language specific validations.

Source:
Type:

last_click_checked

True if last click is to check a row.

Source:

last_clicked_row

Zero-based index of last clicked row. Used to handle the shift + click event in the code above.

Source:

last_shift_clicked_row

Zero-based index of last shift clicked row.

Source:

methods

Public API

Source:

MicroHistory

An implementation of a client-side page cache. This object also uses the cache to provide a simple microhistory, that is the ability to use the back and forward buttons in the browser

Source:

(constant) mysql_doc_keyword

Definition of links to MySQL documentation.

Source:

new_last_row_id

Source:

new_last_row_index

Source:

Number

Source:

object

Source:

object

Source:

(private) object

Source:

object

Source:

object

Source:

Object

Source:

Object

Source:

Object

Source:

Object

Source:

Object

Source:

Object

Source:

object

Source:

object

Source:

object

Source:

object

Source:

object

Source:

object

Source:

object

Source:

(private) object,

Source:

(private) object,

Source:

(private) object,

Source:

(private) object,

Source:

(private) object,

Source:

(private) object,

Source:

PMA_commonActions

Holds common parameters such as server, db, table, etc

The content for this is normally loaded from Header.php or Response.php and executed by ajax.js

Source:

(constant) PMA_Messages :hash

Messages Contains the message string to be used inside PMA.

Source:
Type:

postParams

Source:

postParams

Source:

postParams

Source:

postParams

Source:

primary_indexes

Source:

processList

Instance is exported to ensure that every time the import will have the instance only and not the class itself

Source:

question

Source:

question

Source:

question

Source:

question

Source:

question

Source:

question

Source:

question

Source:

question

Source:

question

Source:

random_server_id

for server_replication.php

Source:

relationalDisplay

Source:

relationCurrValue

Source:

relationFields

Source:

relationKeyOrDisplayColumn

Source:

relFieldsList

Source:

ResizeHandler

Source:

rows

Source:

Rows

Source:

RTE

Source:

selected_dbs

Source:

self_closing

Source:

SetUrlHash

URL hash management module. Allows direct bookmarking and microhistory.

Source:

spatial_indexes

Source:

sql_autocomplete_in_progress

"inputRead" event handler for CodeMirror SQL query editors for autocompletion

Source:

sqlQuery

Source:

string

Source:

string

Source:

string

Source:

(private) string,

Source:

table_body

Source:

tables_table

Source:

target_rows

Source:

the_form

Source:

the_form

Source:

the_form

Source:

the_form

Source:

this_name

Source:

thisFieldParams

Source:

thisFieldParams

Source:

(constant) timePicker :hash

TimePicker Contains the strings for time and date.

Source:
Type:

transformationFields

Source:

transformFields

Source:

transformFieldsList

Source:

unique_indexes

Source:

validate :Object

validate Validations for the settings input fields.

Source:
Type:

whereClause

Source:

Methods

_keydown()

Mousedown event handler for bind to input Shortcut is Ctrl+Enter key or just ENTER, depending on console's configuration.

Source:
Returns:

void

_mousedown()

Mousedown event handler for bind to resizer

Source:
Returns:

void

_mousemove()

Mousemove event handler for bind to resizer

Source:
Returns:

void

_mouseup()

Mouseup event handler for bind to resizer

Source:
Returns:

void

addDateTimePicker()

Add a date/time picker to each element that needs it (only when jquery-ui-timepicker-addon.js is loaded)

Source:

addUserPreferenceFiles()

Method to add user preference files.

Source:
Returns:

void

aliasSelectHandler(event)

Handler for Database/table alias select

Source:
Parameters:
Name Type Description
event

object the event object
Returns:

void

append(string, string)

Used for log new message

Source:
Parameters:
Name Type Description
string

msgString Message to show
string

msgType Message type
Returns:

appendQuery(queryData, string)

Used for log new query

Source:
Parameters:
Name Type Description
queryData
string

state Message state
Returns:

BaseChart(elementId)

Abstract representation of charts that operates on DataTable where,

  • First column provides index to the data.

  • Each subsequent columns are of type ColumnType.NUMBER and represents a data series.
Line chart, area chart, bar chart, column chart are typical examples.

Source:
Parameters:
Name Type Description
elementId

id of the div element the chart is drawn in

bindCodeMirrorToInlineEditor()

Binds the CodeMirror to the text area used to inline edit a query.

Source:

blur()

Used for blur input

Source:
Returns:

void

browseForeignDialog(object)

Handles browse foreign values modal dialog

Source:
Parameters:
Name Type Description
object

$this_a reference to the browse foreign value link

changePluginOpts() → {void}

Toggles the hiding and showing of each plugin's options according to the currently selected plugin from the dropdown list

Source:
Returns:
Type:
void

Chart(elementId)

Abstract chart which defines the contract for charts

Source:
Parameters:
Name Type Description
elementId

id of the div element the chart is drawn in

ChartFactory()

Abstract chart factory which defines the contract for chart factories

Source:

checkAddUser() → {boolean}

Validates the "add a user" form

Source:
Returns:
Type:
boolean

whether the form is validated or not

checkFieldDefault(field, type)

Checks whether field has its default value

Source:
Parameters:
Name Type Description
field Element
type String
Returns:

boolean

checkForCheckbox()

To check whether insert section is ignored or not

Source:

checkIndexName(string)

Ensures indexes names are valid according to their type and, for a primary key, lock index name to 'PRIMARY'

Source:
Parameters:
Name Type Description
string

form_id Variable which parses the form name as the input
Returns:

boolean false if there is no index form, true else

checkIndexType()

Hides/shows the inputs and submits appropriately depending on whether the index type chosen is 'SPATIAL' or not.

Source:

checkNewCode()

This object handles ajax requests for pages. It also handles the reloading of the main menu and scripts.

Source:

(private) checkPassword($the_form) → {bool}

Validates the password field in a form

Source:
See:
  • PMA_Messages.strPasswordEmpty
  • PMA_Messages.strPasswordNotSame
Parameters:
Name Type Description
$the_form Object

The form to be validated
Returns:
Type:
bool

checkPasswordStrength(value, meterObj, meterObjectLabel, username) → {void}

Function to check the password strength

Source:
Parameters:
Name Type Description
value string

Passworrd string
meterObj object

jQuery object to show strength in meter
meterObjectLabel object

jQuery object to show text of password strnegth
username string

Username string
Returns:
Type:
void

checkSqlQuery(theForm)

Displays an error message if the user submitted the sql query form with no sql query, else checks for "DROP/DELETE/ALTER" statements

Source:
See:
  • confirmQuery()
Parameters:
Name Type Description
theForm

object the form
Returns:

boolean always false

clear(string)

Used for clear the input

Source:
Parameters:
Name Type Description
string

target, default target is console input
Returns:

void

clear()

Used for clear the messages

Source:
Returns:

void

collapse(object)

Event handler for collapsing the panel

Source:
Parameters:
Name Type Description
object

e Event data (contains a reference to resizeHandler)
Returns:

void

collapseTreeNode($expandElem)

Collapses a node in navigation tree.

Source:
Parameters:
Name Type Description
$expandElem

expander
Returns:

void

configGet(key, cached) → {object}

Gets a configuration value. A configuration value will be searched in browser's local storage first and if not found, a call to the server will be made.

If value should not be cached and the up-to-date configuration value from right from the server is required, the third parameter should be false.

Source:
Parameters:
Name Type Description
key string

Configuration key.
cached boolean

Configuration type.
Returns:
Type:
object

Configuration value.

configSet(key, value, onlyLocal) → {void}

Sets a configuration value.

A configuration value may be set in both browser's local storage and remotely in server's configuration table.

If the only_local argument is true, the value is store is stored only in browser's local storage and may be lost if the user resets his browser's settings.

NOTE: Depending on server's configuration, the configuration table may be or not persistent.

Source:
Parameters:
Name Type Description
key string

Configuration key.
value object

Configuration value.
onlyLocal boolean

Configuration type.
Returns:
Type:
void

Displays a confirmation box before submitting a "DROP/DELETE/ALTER" query. This function is called while clicking links

Source:
Parameters:
Name Type Description
theLink

object the link
theSqlQuery

object the sql query to submit
Returns:

boolean whether to run the query or not

confirmQuery(theForm1, sqlQuery1)

Confirms a "DROP/DELETE/ALTER" query before submitting it if required. This function is called by the 'checkSqlQuery()' js function.

Source:
See:
  • checkSqlQuery()
Parameters:
Name Type Description
theForm1

object the form
sqlQuery1

string the sql query string
Returns:

boolean whether to run the query or not

createAliasModal(event)

Handler for Alias dialog box

Source:
Parameters:
Name Type Description
event

object the event object
Returns:

void

createPrintAndBackButtons()

Create print and back buttons in preview page

Source:

createTemplate(name)

Create a template with selected options

Source:
Parameters:
Name Type Description
name

name of the template

daysInFebruary()

javascript DateTime format validation. its used to prevent adding default (0000-00-00 00:00:00) to database when user enter wrong values Start of validation part

Source:

deleteTemplate(id)

Delete a template

Source:
Parameters:
Name Type Description
id

ID of the template to delete

disableDumpSomeRowsSubOptions()

Disables the "Dump some row(s)" sub-options

Source:

displayErrors(error_list)

Displays errors for given form fields

WARNING: created DOM elements must be identical with the ones made by PhpMyAdmin\Config\FormDisplayTemplate::displayInput()!

Source:
Parameters:
Name Type Description
error_list Object

list of errors in the form {field id: error array}

displayPasswordGenerateButton() → {void}

for PhpMyAdmin\Display\ChangePassword libraries/user_password.php

Source:
Returns:
Type:
void

editVariable(link, $saveLink, $cancelLink) → {void}

Allows the user to edit a server variable

Source:
Parameters:
Name Type Description
link Element

Edit button element
$saveLink Element

Save button element
$cancelLink Element

Cancel button element
Returns:
Type:
void

emptyCheckTheField(object, string)

Check if a form's element is empty. An element containing only spaces is also considered empty

Source:
Parameters:
Name Type Description
object

the form
string

the name of the form field to put the focus on
Returns:

boolean whether the form field is empty or not

enableDumpSomeRowsSubOptions()

Enables the "Dump some row(s)" sub-options

Source:

escapeHtml(unsafe) → {string}

Source:
Parameters:
Name Type Description
unsafe string

Unsafe html which needs to be escaped
Returns:
Type:
string

HTML escaping

escapeJsString(unsafe) → {string}

Source:
Parameters:
Name Type Description
unsafe string

Unsafe javascript
Returns:
Type:
string

execute()

Used for send text to PMA_console.execute()

Source:
Returns:

void

expandTreeNode($expandElem, callback)

Expands a node in navigation tree.

Source:
Parameters:
Name Type Description
$expandElem

expander
callback

callback function
Returns:

void

filterVariables(textFilter, alertFilter, categoryFilter, text)

Filters the status variables by name/category/alert in the variables tab

Source:
Parameters:
Name Type Description
textFilter Object

Regular expression for filtering text
alertFilter boolean

For filtering alert variables
categoryFilter string
text string

Text based filtering

focus()

Used for set focus to input

Source:
Returns:

void

getAllValues()

Returns values for all fields in fieldsets

Source:

getDropdownValues($dropdown)

Retrieves and populates dropdowns to the left based on the selected value

Source:
Parameters:
Name Type Description
$dropdown

the dropdown whose value got changed

getFieldName($table_results, $this_field)

Get the field name for the current field. Required to construct the query for grid editing

Source:
Parameters:
Name Type Description
$table_results

enclosing results table
$this_field

jQuery object that points to the current field's tr

getFieldType(field) → {string}

Returns field type

Source:
Parameters:
Name Type Description
field Element
Returns:
Type:
string

getFieldValidators(field_id, onKeyUpOnly)

Returns validation functions associated with form field

Source:
Parameters:
Name Type Description
field_id String

form field id
onKeyUpOnly boolean

see validateField
Returns:

array of [function, parameters to be passed to function]

getFieldValue(field, field_type)

Gets field value

Will return one of: o String - if type is 'text' o boolean - if type is 'checkbox' o Array of values - if type is 'select'

Source:
Parameters:
Name Type Description
field Element
field_type String

returned by #getFieldType

getForeignKeyCheckboxLoader()

Get checkbox for foreign key checks

Source:
Returns:

string

getHistory(int)

Used for getting a perticular history query

Source:
Parameters:
Name Type Description
int

nthLast get nth query message from latest, i.e 1st is last
Returns:

string message

getIdPrefix(element)

Returns element's id prefix

Source:
Parameters:
Name Type Description
element Element

getIndexPage()

Method to find the first loading page. Possible values index.php?target=fileName.php fileName.php

Source:
Returns:

void

getPos(int)

Returns the horizontal position of the mouse, relative to the outer side of the navigation panel

Source:
Parameters:
Name Type Description
int

pos Navigation width in pixels
Returns:

void

getSymbol(int)

Returns the HTML code for the arrow symbol used in the collapser

Source:
Parameters:
Name Type Description
int

width The width of the panel
Returns:

string

getTemplateData()

Return template data as a json object

Source:
Returns:

template data

getText(target) → {string}

Used for getting the text of input

Source:
Parameters:
Name Type Description
target string
Returns:
Type:
string

init()

Method to initialise loading of files on first page

Source:
Returns:

void

initialize()

Used for console messages initialize

Source:
Returns:

void

initialize()

Used for console bookmarks initialize message events are already binded by PMA_consoleMsg._msgEventBinds

Source:
Returns:

void

initialize()

Used for console resizer initialize

Source:
Returns:

void

initTableSorter(tabid) → {void}

Source:
Parameters:
Name Type Description
tabid string

Table id for chart drawing
Returns:
Type:
void

insertQuery()

Create quick sql statements.

Source:

insertValueQuery()

Inserts multiple fields.

Source:

isStorageSupported(type)

checks whether browser supports web storage

Source:
Parameters:
Name Type Description
type

the type of storage i.e. localStorage or sessionStorage
Returns:

bool

JQPlotAreaChart(elementId)

JQPlot area chart

Source:
Parameters:
Name Type Description
elementId

id of the div element the chart is drawn in

JQPlotBarChart(elementId)

JQPlot bar chart

Source:
Parameters:
Name Type Description
elementId

id of the div element the chart is drawn in

JQPlotChart(elementId)

Abstract JQplot chart

Source:
Parameters:
Name Type Description
elementId

id of the div element the chart is drawn in

JQPlotChartFactory()

Chart factory that returns JQPlotCharts

Source:

JQPlotColumnChart(elementId)

JQPlot column chart

Source:
Parameters:
Name Type Description
elementId

id of the div element the chart is drawn in

JQPlotLineChart(elementId)

JQPlot line chart

Source:
Parameters:
Name Type Description
elementId

id of the div element the chart is drawn in

JQPlotPieChart(elementId)

JQPlot pie chart

Source:
Parameters:
Name Type Description
elementId

id of the div element the chart is drawn in

JQPlotScatterChart(elementId)

JQPlot scatter chart

Source:
Parameters:
Name Type Description
elementId

id of the div element the chart is drawn in

JQPlotSplineChart(elementId)

JQPlot spline chart

Source:
Parameters:
Name Type Description
elementId

id of the div element the chart is drawn in

JQPlotTimelineChart(elementId)

JQPlot timeline chart

Source:
Parameters:
Name Type Description
elementId

id of the div element the chart is drawn in

loadChildNodes(isNode, $expandElem, callback)

Loads child items of a node and executes a given callback

Source:
Parameters:
Name Type Description
isNode
$expandElem

expander
callback

callback function
Returns:

void

loadCommonFiles()

Method to load Common files required for all the pages.

Source:
Returns:

void

loadTemplate(id)

Loads a template

Source:
Parameters:
Name Type Description
id

ID of the template to load

loafIndexFiles()

Method to load page related files.

Source:
Returns:

void

makeProfilingChartInline Function for creating profiling chart on clicking profiling checkbox()

Source:
Returns:

void

markField(field)

Marks field depending on its value (system default or custom)

Source:
Parameters:
Name Type Description
field Element

matchFile(fname) → {void}

Toggles the hiding and showing of each plugin's options and sets the selected value in the plugin dropdown list according to the format of the selected file

Source:
Parameters:
Name Type Description
fname string

Name of the file
Returns:
Type:
void

Handles the resizing of a menu according to the available screen width

Uses themes/original/css/resizable-menu.css.php

To initialise: $('#myMenu').menuResizer(function () { // This function will be called to find out how much // available horizontal space there is for the menu return $('body').width() - 5; // Some extra margin for good measure });

To trigger a resize operation: $('#myMenu').menuResizer('resize'); // Bind this to $(window).resize()

To restore the menu to a state like before it was initialized: $('#myMenu').menuResizer('destroy');

Source:
Parameters:
Name Type Description
$container Element
widthCalculator function
Returns:
Type:
void

mousedown(object)

Event handler for initiating a resize of the panel

Source:
Parameters:
Name Type Description
object

e Event data (contains a reference to resizeHandler)
Returns:

void

mousemove(object)

Event handler for updating the panel during a resize operation

Source:
Parameters:
Name Type Description
object

e Event data (contains a reference to resizeHandler)
Returns:

void

mouseup(object)

Event handler for terminating a resize of the panel

Source:
Parameters:
Name Type Description
object

e Event data (contains a reference to resizeHandler)
Returns:

void

restores the filter state on navigation reload

Source:
Returns:

void

updates the filter state in sessionStorage

Source:
Returns:

void

updates the tree state in sessionStorage

Source:
Returns:

void

nullify(theType, urlField, md5Field, multi_edit)

Modify form controls when the "NULL" checkbox is checked

Source:
Parameters:
Name Type Description
theType

string the MySQL field type
urlField

string the urlencoded field name - OBSOLETE
md5Field

string the md5 hashed field name
multi_edit

string the multi_edit row sequence number
Returns:

boolean always true

offerPrefsAutoimport()

Prepares message which informs that localStorage preferences are available and can be imported or deleted

Source:

onload()

Here we register a function that will remove the onsubmit event from all forms that will be handled by the generic page loader. We then save this event handler in the "jQuery data", so that we can fire it up later in AJAX.requestHandler().

See bug #3583316

Source:

onload2()

Popup behaviour

Source:

onloadCreateTable()

jQuery coding for 'Create Table'. Used on db_operations.php, db_structure.php and db_tracking.php (i.e., wherever PhpMyAdmin\Display\CreateTable is used)

Attach Ajax Event handlers for Create Table

Source:

onloadDbTracking()

Bind event handlers

Source:

onloadImport()

Binding event handlers on page load

Source:

onloadIndexes()

Ajax scripts for table index page

Actions ajaxified here:

  • Showing/hiding inputs depending on the index type chosen
  • create/edit/drop indexes
Source:

onloadPageSettings()

Binding event handler on page load.

Source:

onloadServerDatabases()

Binding event handlers on page load

Source:

onloadServerPlugins()

Binding event handlers on page load.

Source:

onloadServerPrivileges()

Binding event handlers on page load.

Source:

onloadServerStatusAdvisor()

Binding event handlers on page load

Source:

onloadServerStatusProcesses()

Binding event handlers on page load

Source:

onloadServerStatusVariables()

Binding event handlers on page load

Source:

onloadServerUserGroups()

Bind event handlers on page load.

Source:

onloadServerVariables()

Binding event handlers on page load.

Source:

onloadSqlEditor()

Attach CodeMirror2 editor to SQL edit area.

Source:

onloadSqlInlineEditor()

Jquery Coding for inline editing SQL_QUERY

Source:

onloadTblChange()

Ajax handlers for Change Table page

Actions Ajaxified here: Submit Data to be inserted into the table. Restart insertion with 'N' rows.

Source:

onloadTblFindReplace()

Bind events

Source:

onloadTblOperations()

jQuery coding for 'Table operations'. Used on tbl_operations.php Attach Ajax Event handlers for Table operations

Source:

onloadTblStructueDropdown()

Handler for "More" dropdown in structure table rows

Source:

onloadTblTracking()

Bind event handlers

Source:

PieChart(elementId)

Abstract pie chart

Source:
Parameters:
Name Type Description
elementId

id of the div element the chart is drawn in

PMA_addColumnToIndex(array, string, string, string)

Adds a column to an Index.

Source:
Parameters:
Name Type Description
array

source_array Array holding corresponding indexes
string

array_index Index of an INDEX in array
string

index_choice Choice of Index
string

col_index Index of column on form
Returns:

void

PMA_adjustTotals()

Adjust number of rows and total size in the summary when truncating, creating, dropping or inserting into a table

Source:

PMA_ajaxRemoveMessage(jQuery)

Removes the message shown for an Ajax operation when it's completed

Source:
Parameters:
Name Type Description
jQuery

object jQuery Element that holds the notification
Returns:

nothing

PMA_ajaxShowMessage(string, mixed, string)

Show a message on the top of the page for an Ajax request

Sample usage:

1) var $msg = PMA_ajaxShowMessage(); This will show a message that reads "Loading...". Such a message will not disappear automatically and cannot be dismissed by the user. To remove this message either the PMA_ajaxRemoveMessage($msg) function must be called or another message must be show with PMA_ajaxShowMessage() function.

2) var $msg = PMA_ajaxShowMessage(PMA_messages.strProcessingRequest); This is a special case. The behaviour is same as above, just with a different message

3) var $msg = PMA_ajaxShowMessage('The operation was successful'); This will show a message that will disappear automatically and it can also be dismissed by the user.

4) var $msg = PMA_ajaxShowMessage('Some error', false); This will show a message that will not disappear automatically, but it can be dismissed by the user after he has finished reading it.

Source:
Parameters:
Name Type Description
string

message string containing the message to be shown. optional, defaults to 'Loading...'
mixed

timeout number of milliseconds for the message to be visible optional, defaults to 5000. If set to 'false', the notification will never disappear
string

type string to dictate the type of message shown. optional, defaults to normal notification. If set to 'error', the notification will show message with red background. If set to 'success', the notification will show with a green background.
Returns:

jQuery object jQuery Element that holds the message div this object can be passed to PMA_ajaxRemoveMessage() to remove the notification

PMA_autosaveSQL(string)

Saves SQL query in local storage or cookie

Source:
Parameters:
Name Type Description
string

SQL query
Returns:

void

PMA_autosaveSQLSort(string)

Saves SQL query with sort in local storage or cookie

Source:
Parameters:
Name Type Description
string

SQL query
Returns:

void

PMA_changeClassForColumn()

Starting from some th, change the class of all td under it. If isAddClass is specified, it will be used to determine whether to add or remove the class.

Source:

PMA_checkIfDataTypeNumericOrDate(string)

Checks if given data-type is numeric or date.

Source:
Parameters:
Name Type Description
string

data_type Column data-type
Returns:

bool|string

PMA_checkReservedWordColumns(jQuery)

check for reserved keyword column name

Source:
Parameters:
Name Type Description
jQuery

Object $form Form
Returns:

true|false

PMA_disableNaviSettings()

Disable navigation panel settings

Source:
Returns:

void

PMA_doc_add()

Adds doc link to single highlighted SQL element

Source:

PMA_doc_builtin()

Generates doc links for builtins inside highlighted SQL

Source:

PMA_doc_keyword()

Generates doc links for keywords inside highlighted SQL

Source:

PMA_ensureNaviSettings()

Ensure that navigation panel settings is properly setup. If not, set it up

Source:
Returns:

void

PMA_fetchRealRowCount(object)

Gets the real row count for a table or DB.

Source:
Parameters:
Name Type Description
object

$target Target for appending the real count value.

PMA_getCellValue()

Return value of a cell in a table.

Source:

PMA_getCompositeIndexList(string, array)

Get choices list for a column to create a composite index with.

Source:
Parameters:
Name Type Description
string

index_choice Choice of index
array

source_array Array hodling columns for particular index
Returns:

jQuery Object

PMA_getImage(image, alternate, attributes) → {Object}

Returns an HTML IMG tag for a particular image from a theme, which may be an actual file or an icon from a sprite

Source:
Parameters:
Name Type Description
image string

The name of the file to get
alternate string

Used to set 'alt' and 'title' attributes of the image
attributes object

An associative array of other attributes
Returns:
Type:
Object

The requested image, this object has two methods: .toString() - Returns the IMG tag for the requested image .attr(name) - Returns a particular attribute of the IMG tag given it's name .attr(name, value) - Sets a particular attribute of the IMG tag to the given value

PMA_getIndexArray(index_choice)

Returns the array of indexes based on the index choice

Source:
Parameters:
Name Type Description
index_choice

index choice

PMA_getSQLEditor($textarea, options, resize, lintOptions)

Creates an SQL editor which supports auto completing etc.

Source:
Parameters:
Name Type Description
$textarea

jQuery object wrapping the textarea to be made the editor
options

optional options for CodeMirror
resize

optional resizing ('vertical', 'horizontal', 'both')
lintOptions

additional options for lint

PMA_handleSimulateQueryButton()

Handles 'Simulate query' button on SQL query box.

Source:
Returns:

void

PMA_hideShowConnection($engine_selector)

If the chosen storage engine is FEDERATED show connection field. Hide otherwise

Source:
Parameters:
Name Type Description
$engine_selector

storage engine selector

PMA_hideShowDefaultValue()

Hides/shows the default value input field, depending on the default type Ticks the NULL checkbox if NULL is chosen as default value.

Source:

PMA_hideShowExpression($virtuality)

Hides/shows the input field for column expression based on whether VIRTUAL/PERSISTENT is selected

Source:
Parameters:
Name Type Description
$virtuality

virtuality dropdown

PMA_highlightSQL()

Higlights SQL using CodeMirror.

Source:

PMA_indexTypeSelectionDialog(array, string, string)

Creates a advanced index type selection dialog.

Source:
Parameters:
Name Type Description
array

source_array Array holding a particular type of indexes
string

index_choice Choice of index
string

col_index Index of new column on form
Returns:

void

PMA_init_slider()

Initializes slider effect.

Source:

PMA_makegrid(t, enableResize, enableReorder, enableVisib, enableGridEdit)

Create advanced table (resize, reorder, and show/hide columns; and also grid editing). This function is designed mainly for table DOM generated from browsing a table in the database. For using this function in other table DOM, you may need to:

  • add "draggable" class in the table header , in order to make it resizable, sortable or hidable
  • have at least one non-"draggable" header in the table DOM for placing column visibility drop-down arrow
  • pass the value "false" for the parameter "enableGridEdit"
  • adjust other parameter value, to select which features that will be enabled
Source:
Parameters:
Name Type Default Description
t

the table DOM element
enableResize true

Optional, if false, column resizing feature will be disabled
enableReorder true

Optional, if false, column reordering feature will be disabled
enableVisib true

Optional, if false, show/hide column feature will be disabled
enableGridEdit true

Optional, if false, grid editing feature will be disabled

PMA_navigationTreePagination(object)

Handles any requests to change the page in a branch of a tree

This can be called from link click or select change event handlers

Source:
Parameters:
Name Type Description
object

$this A jQuery object that points to the element that initiated the action of changing the page
Returns:

void

PMA_prepareForAjaxRequest($form)

Add a hidden field to the form to indicate that this will be an Ajax request (only if this hidden field does not exist)

Source:
Parameters:
Name Type Description
$form

object the form

PMA_previewSQL(jQuery)

Requests SQL for previewing before executing.

Source:
Parameters:
Name Type Description
jQuery

Object $form Form containing query data
Returns:

void

PMA_reloadNavigation(function, Object)

Reloads the whole navigation tree while preserving its state

Source:
Parameters:
Name Type Description
function

the callback function
Object

stored navigation paths
Returns:

void

PMA_removeColumnFromIndex(string)

Removes a column from an Index.

Source:
Parameters:
Name Type Description
string

col_index Index of column in form
Returns:

void

PMA_set_status_label()

Changes status of slider

Source:

PMA_setIndexFormParameters(array, string)

Sets current index information into form parameters.

Source:
Parameters:
Name Type Description
array

source_array Array containing index columns
string

index_choice Choice of index
Returns:

void

PMA_showAddIndexDialog(array, string, array, string, object)

Shows 'Add Index' dialog.

Source:
Parameters:
Name Type Description
array

source_array Array holding particluar index
string

array_index Index of an INDEX in array
array

target_columns Columns for an INDEX
string

col_index Index of column on form
object

index Index detail object
Returns:

void

PMA_showFullName(object)

Show full name when cursor hover and name not shown completely

Source:
Parameters:
Name Type Description
object

$containerELem Container element
Returns:

void

PMA_showHints(object)

Function to display tooltips that were generated on the PHP side by PhpMyAdmin\Util::showHint()

Source:
Parameters:
Name Type Description
object

$div a div jquery object which specifies the domain for searching for tooltips. If we omit this parameter the function searches in the whole body

PMA_showNoticeForEnum()

Hides/shows the "Open in ENUM/SET editor" message, depending on the data type of the column currently selected

Source:

PMA_showThisQuery(string, string, string)

Saves SQL query in local storage or cookie

Source:
Parameters:
Name Type Description
string

database name
string

table name
string

SQL query
Returns:

void

PMA_sprintf(string)

Source:
Parameters:
Name Type Description
string

string message to display
Returns:

string A concated string of aguments passed

PMA_tooltip($elements, item, myContent, additionalOptions)

Create a jQuery UI tooltip

Source:
Parameters:
Name Type Description
$elements

jQuery object representing the elements
item

the item (see https://api.jqueryui.com/tooltip/#option-items)
myContent

content of the tooltip
additionalOptions

to override the default options

PMA_updateCode(jQuery, string, string)

Updates an element containing code.

Source:
Parameters:
Name Type Description
jQuery

Object $base base element which contains the raw and the highlighted code.
string

htmlValue code in HTML format, displayed if code cannot be highlighted
string

rawValue raw code, used as a parameter for highlighter
Returns:

bool whether content was updated or not

PMA_urldecode(string)

decode a string URL_encoded

Source:
Parameters:
Name Type Description
string

str
Returns:

string the URL-decoded string

PMA_urlencode(string)

endecode a string URL_decoded

Source:
Parameters:
Name Type Description
string

str
Returns:

string the URL-encoded string

PMA_verifyColumnsProperties()

Show notices for ENUM columns; add/hide the default value

Source:

printPage()

Print page

Source:

printPreview()

Produce print preview

Source:

reloadFieldForm()

Reload fields table

Source:

removeColumnFromMultiSort(object, object)

This function is for navigating to the generated URL

Source:
Parameters:
Name Type Description
object

target HTMLAnchor element
object

parent HTMLDom Object

removePrintAndBackButton()

Remove print and back buttons and revert to normal view

Source:

restoreField(field_id)

Restores field's default value

Source:
Parameters:
Name Type Description
field_id String

savePrefsToLocalStorage(form)

Saves user preferences to localStorage

Source:
Parameters:
Name Type Description
form Element

ScatterChart(elementId)

Abstract scatter chart

Source:
Parameters:
Name Type Description
elementId

id of the div element the chart is drawn in

scrollToView(object, boolean)

Auto-scrolls the newly chosen database

Source:
Parameters:
Name Type Description
object

$element The element to set to view
boolean

$forceToTop Whether to force scroll to top

setDropdownValues()

Sets dropdown options to values

Source:

setFieldValue(field, field_type, value)

Sets field value

value must be of type: o undefined (omitted) - restore default value (form default, not PMA default) o String - if field_type is 'text' o boolean - if field_type is 'checkbox' o Array of values - if field_type is 'select'

Source:
Parameters:
Name Type Description
field Element
field_type String

see #getFieldType
value String | Boolean

setQuery()

Sets current value for query box.

Source:

setRestoreDefaultBtn(field, display)

Enables or disables the "restore default value" button

Source:
Parameters:
Name Type Description
field Element
display boolean

setShowThisQuery()

Set query to codemirror if show this query is checked and query for the db and table pair exists

Source:

setTab(tab_id)

Sets active tab

Source:
Parameters:
Name Type Description
tab_id String

setText(string, string)

Used for set text in input

Source:
Parameters:
Name Type Description
string

text
string

target
Returns:

void

setWidth(int)

Adjusts the width of the navigation panel to the specified value

Source:
Parameters:
Name Type Description
int

pos Navigation width in pixels
Returns:

void

show_hide_clauses()

for tbl_relation.php

Source:

showHistory()

Used for show history messages

Source:
Returns:

void

showInstructions(bool)

Used to show the correct message depending on which key combination executes the query (Ctrl+Enter or Enter).

Source:
Parameters:
Name Type Description
bool

enterExecutes Only Enter has to be pressed to execute query.
Returns:

void

showNaviSettings() → {void}

Source:
Returns:
Type:
void

showPageSettings() → {void}

Source:
Returns:
Type:
void

(private) showSettings(selector) → {void}

Source:
Parameters:
Name Type Description
selector Element

jQuery element for which setting need to be show
Returns:
Type:
void

(private) suggestPassword(passwdForm) → {boolean}

Generate a new password and copy it to the password input areas

Source:
Parameters:
Name Type Description
passwdForm Object

the form that holds the password fields
Returns:
Type:
boolean

always true

teadownFunctions()

Unbind all event handlers before tearing down a page

Source:

teardown1()

Unbind all event handlers before tearing down a page

Source:

teardown1()

Unbind all event handlers before tearing down a page

Source:

teardown1()

Unbind all event handlers before tearing down a page

Source:

teardown1()

Unbind all event handlers before tearing down a page

Source:

teardownConfig()

Unbind all event handlers before tearing down a page

Source:

teardownCreateTable()

Unbind all event handlers before tearing down a page

Source:

teardownCtrlEnterFormSubmit()

Unbind all event handlers before tearing down a page

Source:

teardownDbCentralColumns()

AJAX scripts for db_central_columns.php

Actions ajaxified here: Inline Edit and save of a result row Delete a row Multiple edit and delete option

Source:

teardownDbOperations()

Unbind all event handlers before tearing down a page

Source:

teardownDbSearch()

Unbind all event handlers before tearing down a page

Source:

teardownDbStructure()

Unbind all event handlers before tearing down a page

Source:

teardownDbTracking()

Unbind all event handlers before tearing down the page

Source:

teardownExport()

Unbind all event handlers before tearing down a page

Source:

teardownImport()

Unbind all event handlers before tearing down a page

Source:

teardownIndexes()

Unbind all event handlers before tearing down a page

Source:

teardownPageSettings()

Unbind all event handlers before tearing down a page.

Source:

teardownServerDatabases()

Unbind all event handlers before tearing down a page

Source:

teardownServerPrivileges()

Unbind all event handlers before tearing down a page.

Source:

teardownServerStatusAdvisor()

Unbind all event handlers before tearing down a page

Source:

teardownServerStatusProcesses()

Unbind all event handlers before tearing down a page

Source:

teardownServerStatusQueries()

Unbind all event handlers before tearing down a page

Source:

teardownServerStatusVariables()

Unbind all event handlers before tearing down a page

Source:

teardownServerUserGroups()

Unbind all event handlers before tearing down a page

Source:

teardownServerVariables()

Unbind all event handlers before tearing down a page.

Source:

teardownSqlInlineEditor()

Unbind all event handlers before tearing down a page

Source:

teardownSqlQueryExecute()

Unbind all event handlers before tearing down a page

Source:

teardownTblChange()

Unbind all event handlers before tearing down a page

Source:

teardownTblFindReplace()

Unbind all event handlers before tearing down a page

Source:

teardownTblOperations()

Unbind all event handlers before tearing down a page

Source:

teardownTblRelation()

Unbind all event handlers before tearing down a page

Source:

teardownTblSelect()

Unbind all event handlers before tearing down a page

Source:

teardownTblStructure()

Unbind all event handlers before tearing down a page

Source:

teardownTblTracking()

Unbind all event handlers before tearing down the page

Source:

TimelineChart(elementId)

Abstract timeline chart

Source:
Parameters:
Name Type Description
elementId

id of the div element the chart is drawn in

toggleDatepickerIfInvalid()

Toggle the Datetimepicker UI if the date value entered by the user in the 'text box' is not going to be accepted by the Datetimepicker plugin (but is accepted by MySQL)

Source:

toggleQuickOrCustom()

Toggles display of options when quick and custom export are selected

Source:

toggleSaveToFile()

Toggles the disabling of the "save to file" options

Source:

toggleSqlIncludeComments()

For SQL plugin, toggles the disabling of the "display comments" options

Source:

toggleStructureDataOpts()

Toggles the hiding and showing of plugin structure-specific and data-specific options

Source:

traverseNavigationForPaths()

Traverse the navigation tree backwards to generate all the actual and virtual paths, as well as the positions in the pagination at various levels, if necessary.

Source:
Returns:

Object

treeResize()

Event handler for resizing the navigation tree height on window resize

Source:
Returns:

void

updatePrefsDate()

Updates preferences timestamp in Import form

Source:

updateQueryParameters()

Updates the input fields for the parameters based on the query

Source:

updateTemplate(id)

Updates an existing template with current options

Source:
Parameters:
Name Type Description
id

ID of the template to update

validate_field(field, isKeyUp, errors)

Validates form field and puts errors in 'errors' object

Source:
Parameters:
Name Type Description
field Element
isKeyUp boolean
errors Object

validate_field_and_fieldset(field, isKeyUp)

Validates form field and parent fieldset

Source:
Parameters:
Name Type Description
field Element
isKeyUp boolean

validate_fieldset(fieldset, isKeyUp, errors)

Validates fieldset and puts errors in 'errors' object

Source:
Parameters:
Name Type Description
fieldset Element
isKeyUp boolean
errors Object

(private) validateField(id, type, onKeyUp, params) → {void}

Registers validator for given field

Source:
Parameters:
Name Type Description
id String

field id
type String

validator (key in validators object)
onKeyUp boolean

whether fire on key up
params Array

validation function parameters
Returns:
Type:
void

Generated by JSDoc 3.5.5 on Sat Aug 11 2018 03:34:32 GMT+0530 (IST) using the Minami theme.