class Header (View source)

Class used to output the HTTP and HTML headers

Methods

__construct()

Creates a new class instance

array
getJsParams()

Returns, as an array, a list of parameters used on the client side

string
getJsParamsCode()

Returns, as a string, a list of parameters used on the client side

void
disable()

Disables the rendering of the header

void
setAjax(bool $isAjax)

Set the ajax flag to indicate whether we are servicing an ajax request

getScripts()

Returns the Scripts object

getMenu()

Returns the Menu object

void
setBodyId(string $id)

Setter for the ID attribute in the BODY tag

void
setTitle(string $title)

Setter for the title of the page

void
disableMenuAndConsole()

Disables the display of the top menu

void
disableWarnings()

Disables the display of the top menu

string
getDisplay()

Generates the header

string
getMessage()

Returns the message to be displayed at the top of the page, including the executed SQL query, if any.

void
sendHttpHeaders()

Sends out the HTTP headers

string
getPageTitle()

If the page is missing the title, this function will set it to something reasonable

static string
getVersionParameter()

Returns the phpMyAdmin version to be appended to the url to avoid caching between versions

void
setIsTransformationWrapper(bool $isTransformationWrapper)

No description

Details

__construct()

Creates a new class instance

array getJsParams()

Returns, as an array, a list of parameters used on the client side

Return Value

array

string getJsParamsCode()

Returns, as a string, a list of parameters used on the client side

Return Value

string

void disable()

Disables the rendering of the header

Return Value

void

void setAjax(bool $isAjax)

Set the ajax flag to indicate whether we are servicing an ajax request

Parameters

bool $isAjax

Whether we are servicing an ajax request

Return Value

void

Scripts getScripts()

Returns the Scripts object

Return Value

Scripts object

Menu getMenu()

Returns the Menu object

Return Value

Menu object

void setBodyId(string $id)

Setter for the ID attribute in the BODY tag

Parameters

string $id

Value for the ID attribute

Return Value

void

void setTitle(string $title)

Setter for the title of the page

Parameters

string $title

New title

Return Value

void

void disableMenuAndConsole()

Disables the display of the top menu

Return Value

void

void disableWarnings()

Disables the display of the top menu

Return Value

void

string getDisplay()

Generates the header

Return Value

string

The header

string getMessage()

Returns the message to be displayed at the top of the page, including the executed SQL query, if any.

Return Value

string

void sendHttpHeaders()

Sends out the HTTP headers

Return Value

void

string getPageTitle()

If the page is missing the title, this function will set it to something reasonable

Return Value

string

static string getVersionParameter()

Returns the phpMyAdmin version to be appended to the url to avoid caching between versions

Return Value

string

urlencoded pma version as a parameter

void setIsTransformationWrapper(bool $isTransformationWrapper)

No description

Parameters

bool $isTransformationWrapper

Return Value

void