PMA PHP Documentation

UI
in package

Wrapper around PMA.UI JavaScript framework

Table of Contents

$_pma_start_ui_javascript_path  : mixed
$_pma_ui_javascript_path  : mixed
$_pma_ui_framework_embedded  : mixed
$_pma_ui_galleries  : mixed
$_pma_ui_gallery_count  : mixed
$_pma_ui_loader_count  : mixed
$_pma_ui_loaders  : mixed
$_pma_ui_viewport_count  : mixed
$_pma_ui_viewports  : mixed
embedGalleryBySessionID()  : mixed
output HTML code to display a gallery that shows all thumbnails that exist in a specific folder hosted by the specified PMA.core instance authentication against PMA.core happens through a pre-established SessionID
embedGalleryByUsername()  : mixed
output HTML code to display a gallery that shows all thumbnails that exist in a specific folder hosted by the specified PMA.core instance authentication against PMA.core happens in real-time through the provided $username and $password credentials Note that the username and password and NOT rendered in the HTML output (authentication happens in PHP on the server-side).
embedSlideBySessionID()  : mixed
output HTML code to display a single slide through a PMA.UI viewport control authentication against PMA.core happens through a pre-established SessionID
embedSlideByUsername()  : mixed
output HTML code to display a single slide through a PMA.UI viewport control authentication against PMA.core happens in real-time through the provided $username and $password credentials Note that the username and password and NOT rendered in the HTML output (authentication happens in PHP on the server-side).
linkGalleryToViewport()  : mixed
output HTML code to couple an earlier instantiated PMA.UI gallery to a PMA.UI viewport. The PMA.UI viewport can be instantiated earlier, or not at all
_pma_embed_pma_ui_framework()  : mixed
internal helper function to prevent PMA.UI framework from being loaded more than once

Properties

$_pma_start_ui_javascript_path

public static mixed $_pma_start_ui_javascript_path = "http://localhost:54001/js/pmaui/"

$_pma_ui_javascript_path

public static mixed $_pma_ui_javascript_path = "pmaui/"

$_pma_ui_framework_embedded

private static mixed $_pma_ui_framework_embedded = false

$_pma_ui_galleries

private static mixed $_pma_ui_galleries = []

$_pma_ui_gallery_count

private static mixed $_pma_ui_gallery_count = 0

$_pma_ui_loader_count

private static mixed $_pma_ui_loader_count = 0

$_pma_ui_loaders

private static mixed $_pma_ui_loaders = []

$_pma_ui_viewport_count

private static mixed $_pma_ui_viewport_count = 0

$_pma_ui_viewports

private static mixed $_pma_ui_viewports = []

Methods

embedGalleryBySessionID()

output HTML code to display a gallery that shows all thumbnails that exist in a specific folder hosted by the specified PMA.core instance authentication against PMA.core happens through a pre-established SessionID

public static embedGalleryBySessionID(mixed $server, mixed $path, mixed $sessionID[, mixed $options = null ]) : mixed
Parameters
$server : mixed
$path : mixed
$sessionID : mixed
$options : mixed = null
Return values
mixed —

embedGalleryByUsername()

output HTML code to display a gallery that shows all thumbnails that exist in a specific folder hosted by the specified PMA.core instance authentication against PMA.core happens in real-time through the provided $username and $password credentials Note that the username and password and NOT rendered in the HTML output (authentication happens in PHP on the server-side).

public static embedGalleryByUsername(mixed $server, mixed $path, mixed $username[, mixed $password = "" ][, mixed $options = null ]) : mixed
Parameters
$server : mixed
$path : mixed
$username : mixed
$password : mixed = ""
$options : mixed = null
Return values
mixed —

embedSlideBySessionID()

output HTML code to display a single slide through a PMA.UI viewport control authentication against PMA.core happens through a pre-established SessionID

public static embedSlideBySessionID(mixed $server, mixed $slideRef, mixed $sessionID[, mixed $options = null ]) : mixed
Parameters
$server : mixed
$slideRef : mixed
$sessionID : mixed
$options : mixed = null
Return values
mixed —

embedSlideByUsername()

output HTML code to display a single slide through a PMA.UI viewport control authentication against PMA.core happens in real-time through the provided $username and $password credentials Note that the username and password and NOT rendered in the HTML output (authentication happens in PHP on the server-side).

public static embedSlideByUsername(mixed $server, mixed $slideRef, mixed $username[, mixed $password = "" ][, mixed $options = null ]) : mixed
Parameters
$server : mixed
$slideRef : mixed
$username : mixed
$password : mixed = ""
$options : mixed = null
Return values
mixed —

linkGalleryToViewport()

output HTML code to couple an earlier instantiated PMA.UI gallery to a PMA.UI viewport. The PMA.UI viewport can be instantiated earlier, or not at all

public static linkGalleryToViewport(mixed $galleryDiv, mixed $viewportDiv) : mixed
Parameters
$galleryDiv : mixed
$viewportDiv : mixed
Return values
mixed —

_pma_embed_pma_ui_framework()

internal helper function to prevent PMA.UI framework from being loaded more than once

private static _pma_embed_pma_ui_framework(mixed $sessionID) : mixed
Parameters
$sessionID : mixed
Return values
mixed —

Search results