Docs For Class atkDialog

mixed	$m_action
mixed	$m_height
mixed	$m_modifierObject
mixed	$m_nodeType
mixed	$m_params
mixed	$m_partial
mixed	$m_serializeForm
mixed	$m_sessionStatus
mixed	$m_themeLoad
mixed	$m_themeName
mixed	$m_title
mixed	$m_width

[ Top ]

Method Summary

static string	getAjaxUpdateCall()	Returns JavaScript code to update the contents of the current modal dialog using an Ajax request to the given URL.
static string	getCloseCall()	Returns JavaScript code to close the current ATK dialog.
static string	getReloadCall()	Returns JavaScript code to reload the contents of the current modal dialog.
static string	getSaveAndCloseCall()	Returns JavaScript code to save the contents of the current active ATK dialog and close it immediately.
static string	getSaveCall()	Returns JavaScript code to save the contents of the current active ATK dialog.
static string	getUpdateCall()	Returns JavaScript code to update the contents of the current modal dialog.
static void	loadScriptsAndStyles()	Load JavaScript and stylesheets.
atkDialog	__construct()	Constructor.
string	getAction()	Returns the dialog action.
string	getCall()	Returns the JavaScript call to open the dialog.
mixed	getModifierObject()	Returns the modifier object.
string	getNodeType()	Returns the dialog node type.
array	getOptions()	Returns the dialog options.
string	getPartial()	Returns the dialog partial.
int	getSessionStatus()	Returns the dialog sessionStatus.
string	getUrl()	Returns the dialog URL.
unknown	getWindowOptions()	Window options like the show effect etc. These options can be controlled by setting the special theme attribute 'dialog_window_options'. This attribute should contain a JavaScript object with the window options.
void	load()	Load JavaScript and stylesheets.
void	setAutoSize()	Reset to auto-size.
void	setHeight()	Set height.
void	setModifierObject()	Sets an object which modifyObject method will be called (if exists) just before showing the dialog. This method is allowed to alter the dialog.
void	setSerializeForm()	Serialize the form with the given name.
void	setSessionStatus()	Sets the dialog sessionStatus.
void	setSize()	Set dialog dimensions.
void	setTheme()	Sets the theme to use.
void	setTitle()	Sets the dialog title.
void	setWidth()	Set width.

[ Top ]

Properties

mixed $m_action [line 29]

API Tags:

Access:

protected

[ Top ]

mixed $m_height = null [line 40]

API Tags:

Access:

protected

[ Top ]

mixed $m_modifierObject = null [line 44]

API Tags:

Access:

protected

[ Top ]

mixed $m_nodeType [line 27]

API Tags:

Access:

protected

[ Top ]

mixed $m_params [line 31]

API Tags:

Access:

protected

[ Top ]

mixed $m_partial [line 30]

API Tags:

Access:

protected

[ Top ]

mixed $m_serializeForm = null [line 42]

API Tags:

Access:

protected

[ Top ]

mixed $m_sessionStatus = SESSION_NEW [line 32]

API Tags:

Access:

protected

[ Top ]

mixed $m_themeLoad [line 37]

API Tags:

Access:

protected

[ Top ]

mixed $m_themeName [line 36]

API Tags:

Access:

protected

[ Top ]

mixed $m_title [line 34]

API Tags:

Access:

protected

[ Top ]

mixed $m_width = null [line 39]

API Tags:

Access:

protected

[ Top ]

Methods

static method getAjaxUpdateCall [line 439]

static string getAjaxUpdateCall(
string
$url 
)

Returns JavaScript code to update the contents of the current modal dialog using an Ajax request to the given URL.

Parameters:

string

$url:

url for the Ajax request

API Tags:

Return:	JavaScript call for updating the dialog contents
Access:	public

[ Top ]

static method getCloseCall [line 380]

static string getCloseCall(
)

Returns JavaScript code to close the current ATK dialog.

API Tags:

Return:	JavaScript call for closing the current dialog
Access:	public

[ Top ]

static method getReloadCall [line 451]

static string getReloadCall(
)

Returns JavaScript code to reload the contents of the current modal dialog.

API Tags:

Return:	JavaScript call for reloading the dialog contents
Access:	public

[ Top ]

static method getSaveAndCloseCall [line 397]

static string getSaveAndCloseCall(
string
$url, [string
$formName = 'dialogform'], [array
$extraParams = array()], [boolean
$encode = true] 
)

Returns JavaScript code to save the contents of the current active ATK dialog and close it immediately.

Parameters:

string	$url:	save URL
string	$formName:	form name (will be serialized)
array	$extraParams:	key/value array with URL parameters that need to be send the parameters will override form element with the same name!
boolean	$encode:	encode using htmlentities (needed to use in links etc.)

API Tags:

Return:	JavaScript call for saving the current dialog and closing it immediately
Access:	public

[ Top ]

static method getSaveCall [line 360]

static string getSaveCall(
string
$url, [string
$formName = 'dialogform'], [array
$extraParams = array()], [boolean
$encode = true] 
)

Returns JavaScript code to save the contents of the current active ATK dialog.

Parameters:

string	$url:	save URL
string	$formName:	form name (will be serialized)
array	$extraParams:	key/value array with URL parameters that need to be send the parameters will override form element with the same name!
boolean	$encode:	encode using htmlentities (needed to use in links etc.)

API Tags:

Return:	JavaScript call for saving the current dialog
Access:	public

[ Top ]

static method getUpdateCall [line 420]

static string getUpdateCall(
string
$content, [boolean
$encode = true] 
)

Returns JavaScript code to update the contents of the current modal dialog.

Parameters:

string	$content:	new dialog contents
boolean	$encode:	encode using htmlentities (needed to use in links etc.)

API Tags:

Return:	JavaScript call for updating the dialog contents
Access:	public

[ Top ]

static method loadScriptsAndStyles [line 236]

static void loadScriptsAndStyles(
[string|boolean
$theme = null] 
)

Load JavaScript and stylesheets.

Parameters:

string|boolean

$theme:

uses the given window theme, by default checks the current ATK theme which window theme should be used, if set explicitly to false no theme will be loaded

API Tags:

Access:

public

[ Top ]

Constructor __construct [line 56]

atkDialog __construct(
string
$nodeType, string
$action, [string
$partial = 'dialog'], [array
$params = array()] 
)

Constructor.

Parameters:

string	$nodeType:	node type
string	$action:	node action
string	$partial:	partial name
array	$params:	url parameters

[ Top ]

getAction [line 89]

string getAction(
)

Returns the dialog action.

API Tags:

Return:	action
Access:	public

[ Top ]

getCall [line 313]

string getCall(
[boolean
$load = true], [boolean
$encode = true], [boolean
$callModifier = true], [boolean
$lateParamBinding = false] 
)

Returns the JavaScript call to open the dialog.

Parameters:

boolean	$load:	load JavaScript and stylesheets needed to show this dialog?
boolean	$encode:	encode using htmlentities (needed to use in links etc.)
boolean	$callModifier:	call node's dialog modifier (modifyDialog method)?
boolean	$lateParamBinding:

API Tags:

Return:

JavaScript call for opening the dialog

[ Top ]

getModifierObject [line 203]

mixed getModifierObject(
)

Returns the modifier object.

API Tags:

Return:	modifier object
Access:	public

[ Top ]

getNodeType [line 79]

string getNodeType(
)

Returns the dialog node type.

API Tags:

Return:	node type
Access:	public

[ Top ]

getOptions [line 275]

array getOptions(
)

Returns the dialog options.

API Tags:

Return:	dialog options
Access:	private

[ Top ]

getPartial [line 99]

string getPartial(
)

Returns the dialog partial.

API Tags:

Return:	partial
Access:	public

[ Top ]

getSessionStatus [line 109]

int getSessionStatus(
)

Returns the dialog sessionStatus.

API Tags:

Return:	sessionStatus (SESSION_BACK=3, SESSION_DEFAULT=0, SESSION_NESTED=2, SESSION_NEW=1, SESSION_PARTIAL=5, SESSION_REPLACE=4)
Access:	public

[ Top ]

getUrl [line 264]

string getUrl(
)

Returns the dialog URL.

API Tags:

Return:	dialog URL
Access:	private

[ Top ]

getWindowOptions [line 296]

unknown getWindowOptions(
)

Window options like the show effect etc. These options can be controlled by setting the special theme attribute 'dialog_window_options'. This attribute should contain a JavaScript object with the window options.

API Tags:

Access:

protected

[ Top ]

load [line 224]

void load(
)

Load JavaScript and stylesheets.

[ Top ]

setAutoSize [line 149]

void setAutoSize(
)

Reset to auto-size.

[ Top ]

setHeight [line 182]

void setHeight(
int
$height 
)

Set height.

Parameters:

int

$height:

API Tags:

Access:

public

[ Top ]

setModifierObject [line 216]

void setModifierObject(
mixed
$object 
)

Sets an object which modifyObject method will be called (if exists) just before showing the dialog. This method is allowed to alter the dialog.

Parameters:

mixed

$object:

modifier object

API Tags:

See:	atkDialog::getCall
Access:	public

[ Top ]

setSerializeForm [line 193]

void setSerializeForm(
[string
$form = 'entryform'] 
)

Serialize the form with the given name.

Defaults to the entryform.

Parameters:

string

$form:

form name

[ Top ]

setSessionStatus [line 119]

void setSessionStatus(
int
$sessionStatus 
)

Sets the dialog sessionStatus.

Parameters:

int

$sessionStatus:

(SESSION_BACK=3, SESSION_DEFAULT=0, SESSION_NESTED=2, SESSION_NEW=1, SESSION_PARTIAL=5, SESSION_REPLACE=4)

API Tags:

Access:

public

[ Top ]

setSize [line 161]

void setSize(
int
$width, int
$height 
)

Set dialog dimensions.

Parameters:

int	$width:	width
int	$height:	height

[ Top ]

setTheme [line 140]

void setTheme(
string
$name, [boolean
$load = true] 
)

Sets the theme to use.

Parameters:

string	$name:	theme name
boolean	$load:	load theme?

[ Top ]

setTitle [line 129]

void setTitle(
string
$title 
)

Sets the dialog title.

Parameters:

string

$title:

[ Top ]

setWidth [line 172]

void setWidth(
int
$width 
)

Set width.

Parameters:

int

$width:

API Tags:

Access:

public

[ Top ]