Docs For Class atkActionBoxBuilder

atkPageBuilder	$m_pageBuilder	Page builder.
array	$m_params	Action box parameters.
int	$m_sessionStatus	Session status.
string	$m_template	Box template.
string	$m_title	Box title.

[ Top ]

Method Summary

atkActionBoxBuilder	__construct()	Constructor.
atkActionBoxBuilder	buttons()	Set form buttons.
atkActionBoxBuilder	content()	Set content.
atkPageBuilder	endActionBox()	Stops building the action box and returns the page builder.
atkActionBoxBuilder	formEnd()	Set form end.
atkActionBoxBuilder	formStart()	Set form start.
atkActionBoxBuilder	locked()	Locked?
atkActionBoxBuilder	sessionStatus()	Sets the session status.
atkActionBoxBuilder	template()	Template.
atkActionBoxBuilder	title()	Sets the box title

[ Top ]

Properties

atkPageBuilder $m_pageBuilder [line 37]

Page builder.

API Tags:

Access:

protected

[ Top ]

array $m_params = array() [line 58]

Action box parameters.

API Tags:

Access:

protected

[ Top ]

int $m_sessionStatus = SESSION_DEFAULT [line 65]

Session status.

API Tags:

Access:

protected

[ Top ]

string $m_template = null [line 51]

Box template.

API Tags:

Access:

protected

[ Top ]

string $m_title = null [line 44]

Box title.

API Tags:

Access:

protected

[ Top ]

Methods

Constructor __construct [line 72]

atkActionBoxBuilder __construct(
atkPageBuilder
$pageBuilder 
)

Constructor.

Parameters:

atkPageBuilder

$pageBuilder:

page builder

API Tags:

Access:

public

[ Top ]

buttons [line 194]

atkActionBoxBuilder buttons(
string
$buttons 
)

Set form buttons.

Parameters:

string

$buttons:

form buttons

API Tags:

Access:

public

[ Top ]

content [line 181]

atkActionBoxBuilder content(
string
$content 
)

Set content.

Parameters:

string

$content:

content

API Tags:

Access:

public

[ Top ]

endActionBox [line 205]

atkPageBuilder endActionBox(
)

Stops building the action box and returns the page builder.

API Tags:

Access:

public

[ Top ]

formEnd [line 155]

atkActionBoxBuilder formEnd(
string
$formEnd 
)

Set form end.

Parameters:

string

$formEnd:

form end

API Tags:

Access:

public

[ Top ]

formStart [line 125]

atkActionBoxBuilder formStart(
string
$formStart 
)

Set form start.

Parameters:

string

$formStart:

form start

API Tags:

Access:

public

[ Top ]

locked [line 112]

atkActionBoxBuilder locked(
boolean
$locked 
)

Locked?

Parameters:

boolean

$locked:

locked

API Tags:

Access:

public

[ Top ]

sessionStatus [line 142]

atkActionBoxBuilder sessionStatus(
int
$status 
)

Sets the session status.

The default session status is SESSION_DEFAULT. If you don't want an automatically appended session form set the session status explicitly to null!

Parameters:

int

$status:

session status

API Tags:

Access:

public

[ Top ]

template [line 168]

atkActionBoxBuilder template(
string
$template 
)

Template.

Parameters:

string

$template:

template name

API Tags:

Access:

public

[ Top ]

title [line 99]

atkActionBoxBuilder title(
string
$title 
)

Sets the box title

Parameters:

string

$title:

title

API Tags:

Access:

public

[ Top ]