Docs For Class PMA

Description

handles theme

todo: add the possibility to make a theme depends on another theme and by default on orignal
todo: add an optional global css file - which will be used for both frames
todo: make all components optional - taking missing compnents from 'parent' theme
todo: make css optionaly replacing 'parent' css or extending it (by appending at the end)
usedby: PMA_Theme::load()

Located in /trunk/libraries/Theme.class.php (line 18)

Variable Summary

string $id

string $img_path

integer $mtime_info

string $name

string $path

array $types

string $version

Method Summary

static object PMA_Theme load (string $folder)

void checkImgPath ()

boolean checkVersion (string $version)

string getId ()

string getImgPath ()

string getLayoutFile ()

string getName ()

string getPath ()

string getVersion ()

void loadCss ( &$type, string $type)

boolean loadInfo ()

void printPreview ()

void setId (string $id)

void setImgPath (string $path)

void setName (string $name)

void setPath (string $path)

void setVersion (string $version)

Variables

string $id = '' (line 35)

var: theme id
access: protected
usedby: PMA_Theme::getId() - as return value
usedby: PMA_Theme::setId() - to set it

string $img_path = '' (line 47)

var: image path
access: protected
usedby: PMA_Theme::getImgPath() - as retunr value
usedby: PMA_Theme::setImgPath() - to set it

integer $mtime_info = 0 (line 59)

var: last modification time for info file
access: protected
usedby: PMA_Theme::loadInfo()

string $name = '' (line 29)

var: theme name
access: protected
usedby: PMA_Theme::getName() - as return value
usedby: PMA_Theme::setName() - to set it

string $path = '' (line 41)

var: theme path
access: protected
usedby: PMA_Theme::setPath() - to set it
usedby: PMA_Theme::getPath() - as return value

array $types = array('left', 'right', 'print') (line 53)

var: valid css types
access: protected
usedby: PMA_Theme::loadCss()

string $version = '0.0.0.0' (line 23)

var: theme version
access: protected
usedby: PMA_Theme::getVersion()
usedby: PMA_Theme::setVersion()

Methods

static load (line 113)

returns theme object loaded from given folder or false if theme is invalid

static object PMA_Theme load (string $folder)

string $folder: path to theme

checkImgPath (line 140)

checks image path for existance - if not found use img from original theme

access: public
uses: PMA_Theme::setImgPath()
uses: sprintf()
usedby: PMA_Theme::load()
uses: PMA_Theme::getPath()
uses: PMA_Theme::getName()
uses: $GLOBALS['cfg']['ThemePath']
uses: $GLOBALS['strThemeNoValidImgPath']
uses: is_dir()

void checkImgPath ()

checkVersion (line 226)

checks theme version agaisnt $version returns true if theme version is equal or higher to $version

access: public
uses: version_compare()
uses: PMA_Theme::getVersion()

boolean checkVersion (string $version)

string $version: version to compare to

getId (line 275)

returns id

return: id
access: public
usedby: PMA_Theme_Manager::setThemeCookie()
uses: PMA_Theme::$id - as return value
usedby: PMA_Theme::printPreview()

string getId ()

getImgPath (line 295)

return: image path for this theme
access: public
uses: PMA_Theme::$img_path - as retunr value

string getImgPath ()

getLayoutFile (line 175)

returns layout file

return: layout file
access: public
uses: PMA_Theme::getPath()

string getLayoutFile ()

getName (line 251)

returns name

return: name
access: public
usedby: PMA_Theme::printPreview()
uses: PMA_Theme::$name - as return value
usedby: PMA_Theme::checkImgPath()

string getName ()

getPath (line 163)

returns path to theme

return: path to theme
access: public
usedby: PMA_Theme::loadCss()
usedby: PMA_Theme::printPreview()
usedby: PMA_Theme::getLayoutFile()
usedby: PMA_Theme::checkImgPath()
uses: PMA_Theme::$path - as return value
usedby: PMA_Theme::loadInfo()

string getPath ()

getVersion (line 211)

returns version

return: version
access: public
usedby: PMA_Theme::printPreview()
uses: PMA_Theme::$version
usedby: PMA_Theme::checkVersion()

string getVersion ()

loadCss (line 311)

load css (send to stdout, normaly the browser)

void loadCss ( &$type, string $type)

string $type: left, right or print
&$type

loadInfo (line 71)

return: whether loading them info was successful or not
access: public
uses: PMA_Theme::setVersion()
usedby: PMA_Theme::load()
uses: PMA_Theme::setName()
uses: PMA_Theme::$mtime_info
uses: filemtime()
uses: file_exists()
uses: PMA_Theme::getPath()

boolean loadInfo ()

printPreview (line 355)

prints out the preview for this theme

access: public
uses: PMA_Theme::getName()
uses: PMA_Theme::getPath()
uses: PMA_Theme::getVersion()
usedby: PMA_Theme_Manager::printPreviews()
uses: PMA_Theme::getId()
uses: htmlspecialchars()
uses: $GLOBALS['strTakeIt']
uses: $GLOBALS['strThemeNoPreviewAvailable']
uses: addslashes()
uses: file_exists()
uses: PMA_generate_common_url()

void printPreview ()

setId (line 263)

sets id

access: public
uses: PMA_Theme::$id - to set it

void setId (string $id)

string $id: new id

setImgPath (line 285)

access: public
usedby: PMA_Theme::checkImgPath()
uses: PMA_Theme::$img_path - to set it

void setImgPath (string $path)

string $path: path to images for this theme

setName (line 239)

sets name

access: public
usedby: PMA_Theme::loadInfo()
uses: PMA_Theme::$name - to set it
uses: trim()

void setName (string $name)

string $name: new name

setPath (line 187)

set path to theme

access: public
usedby: PMA_Theme::load()
uses: PMA_Theme::$path - to set it

void setPath (string $path)

string $path: path to theme

setVersion (line 199)

sets version

access: public
usedby: PMA_Theme::loadInfo()
uses: PMA_Theme::$version

void setVersion (string $version)

string $version: new version

Class PMA_Theme