Gui Class Reference

Inheritance diagram for Gui:

Collaboration diagram for Gui:

List of all members.

Public Member Functions
	init ()
	render ()
	fillColors ($aStyles, $aColors)
	save ($blAjax=true)
	saveUserSettings ($sTheme, $aColors, $aStyles)
	loadUserSettings (&$sTheme, &$aColors, &$aStyles)
	previewCss ()
	previewGif ()
	gif ($sTpl=null, $aColors=null, $sFile=null, $sDir=null)
	getUserColors ()
	getUserStyles ()
	getThemes ()
	getColors ($sThemeId, $sKey= 'index', $sValue= 'color')
	getStyles ()
	getRes ($sRes)
	getResColors ($sRes, $sTpl)
	getImageColors ($sImageID, $aStyles)
	getStyleTree ()
	hex2rgb ($sHexColor)
Protected Member Functions
	_isDomLoaded ()
	_loadGuiFiles ()
Protected Attributes
	$_sSrcDir
	$_sGuiDir = "gui/"
	$_sBgDir = "bg/"
	$_sGuiXml = "gui.xml"
	$_sUserGui = "usergui.php"
	$_oGuiDom
	$_sThemeXml = "theme.xml"
	$_oThemesDom
	$_blLoaded = false
	$_sThisTemplate = 'gui.tpl'
	$_sThisErrorTemplate = 'gui_error.tpl'

---

Detailed Description

Look&Feel editor file

Definition at line 7 of file gui.php.

---

Member Function Documentation

Gui._isDomLoaded

(

)

[protected]

Returns dom objects load state

Returns:

bool

Definition at line 107 of file gui.php.

Gui._loadGuiFiles

(

)

[protected]

Loads gui and theme xml files DOM documents

protected

Returns:

array

Definition at line 424 of file gui.php.

Gui.fillColors	(	$	aStyles,
		$	aColors
	)

Fills array with color values according to the index

Parameters:

	array	$aStyles array to fill
	array	$aColors values to fill

Returns:

array

Definition at line 163 of file gui.php.

Gui.getColors	(	$	sThemeId,
		$	sKey = 'index',
		$	sValue = 'color'
	)

Returns default theme color palette

Parameters:

	string	$sThemeId Theme id
	string	$sKey index name
	string	$sValue value name

Returns:

array

Definition at line 470 of file gui.php.

Gui.getImageColors	(	$	sImageID,
		$	aStyles
	)

Returns gif image colors array taken from styles array

Parameters:

	string	$sImageID Image id
	array	$aStyles Styles array with collors

Returns:

array

Definition at line 547 of file gui.php.

Gui.getRes

(

$

sRes

)

Returns gui resource from dom object

Parameters:

string

$sRes Resource name

Returns:

DOMNodeList

Definition at line 510 of file gui.php.

Gui.getResColors	(	$	sRes,
		$	sTpl
	)

Returns gui resource template colors array

Parameters:

	string	$sRes Resource name
	string	$sTpl Template name

Returns:

array

Definition at line 526 of file gui.php.

Gui.getStyles

(

)

Returns default styles

Returns:

array

Definition at line 490 of file gui.php.

Gui.getStyleTree

(

)

Returns element styles tree nodes

Returns:

DOMNodeList

Definition at line 565 of file gui.php.

Gui.getThemes

(

)

Returns themes array

Returns:

array

Definition at line 450 of file gui.php.

Gui.getUserColors

(

)

Returns default and posted colors array

Returns:

array

Definition at line 384 of file gui.php.

Gui.getUserStyles

(

)

Returns default and posted styles array

Returns:

array

Definition at line 402 of file gui.php.

Gui.gif	(	$	sTpl = null,
		$	aColors = null,
		$	sFile = null,
		$	sDir = null
	)

Renders and outputs or saves gif image (saves if not null, otherwise outputs directly)

Parameters:

	string	$sTpl Theme id
	array	$aColors Colors array
	string	$sFile File name
	string	$sDir Directory name

Returns:

null

Definition at line 360 of file gui.php.

Gui.hex2rgb

(

$

sHexColor

)

Conversts hex color code to their RGB components. Supports short and long hex codes (eg $f90 and FF9900)

Parameters:

string

$sHexColor Hex color code

Returns:

array

Definition at line 581 of file gui.php.

Gui.init

(

)

Ininializes internal fields and loads dom objects

Returns:

null

Reimplemented from oxAdminView.

Definition at line 89 of file gui.php.

Gui.loadUserSettings	(	&$	sTheme,
		&$	aColors,
		&$	aStyles
	)

Loads user setting from php file

Parameters:

	string	&$sTheme Theme id
	string	&$aColors Color palette
	string	&$aStyles Element styles

Returns:

null

Definition at line 287 of file gui.php.

Gui.previewCss

(

)

Renders css preview with image preview link

Returns:

null

Definition at line 300 of file gui.php.

Gui.previewGif

(

)

Renders image preview

Returns:

null

Definition at line 339 of file gui.php.

Gui.render

(

)

Render template and loads all needed data

Returns:

string

Reimplemented from oxAdminView.

Definition at line 117 of file gui.php.

Gui.save

(

$

blAjax = true

)

Generates css and background image files

Parameters:

bool

$blAjax do not render page if called from ajax

Returns:

null

Definition at line 180 of file gui.php.

Gui.saveUserSettings	(	$	sTheme,
		$	aColors,
		$	aStyles
	)

Saves user setting to php file

Parameters:

	string	$sTheme Theme id
	string	$aColors Color palette
	string	$aStyles Element styles

Returns:

null

Definition at line 261 of file gui.php.

---

Member Data Documentation

Gui.$_blLoaded = false [protected]

Definition at line 70 of file gui.php.

Gui.$_oGuiDom [protected]

Definition at line 49 of file gui.php.

Gui.$_oThemesDom [protected]

Definition at line 63 of file gui.php.

Gui.$_sBgDir = "bg/" [protected]

Definition at line 28 of file gui.php.

Gui.$_sGuiDir = "gui/" [protected]

Definition at line 21 of file gui.php.

Gui.$_sGuiXml = "gui.xml" [protected]

Definition at line 35 of file gui.php.

Gui.$_sSrcDir [protected]

Definition at line 14 of file gui.php.

Gui.$_sThemeXml = "theme.xml" [protected]

Definition at line 56 of file gui.php.

Gui.$_sThisErrorTemplate = 'gui_error.tpl' [protected]

Definition at line 82 of file gui.php.

Gui.$_sThisTemplate = 'gui.tpl' [protected]

Reimplemented from oxAdminView.

Definition at line 76 of file gui.php.

Gui.$_sUserGui = "usergui.php" [protected]

Definition at line 42 of file gui.php.

---

The documentation for this class was generated from the following file:

• admin/gui.php