mixed	$action
mixed	$actionDisabledParams
mixed	$actionParams
mixed	$caption
mixed	$captionParams
mixed	$currentUser
mixed	$enabled
mixed	$image
mixed	$imageAboveText
mixed	$imageAfterText
mixed	$imageBeforeText
mixed	$imageDisabled
mixed	$imageParams
mixed	$imageText
mixed	$imageTextRelation
mixed	$imageUnderText
mixed	$linkedTo
mixed	$requiredCredentials

[ Top ]

Method Summary

w3sButton	__construct()	Constructor.
void	buttonSkeleton()	Returns the button skeleton, according to the imageTextRelation param.
void	checkImage()	Checks that the file name passed as reference is a valid string and a valid filename.
void	fromArray()	Sets the button's attributes from an array. No attributes are required.
void	fromYml()	Sets the button's attributes from a yml file.
void	getAction()
void	getActionDisabledParams()
void	getActionParams()
void	getCaption()
void	getCaptionParams()
void	getCurrentUser()
void	getEnabled()
void	getImage()
void	getImageAboveText()
void	getImageAfterText()
void	getImageBeforeText()
void	getImageDisabled()
void	getImageParams()
void	getImageText()
void	getImageTextRelation()
void	getImageUnderText()
void	getLinkedTo()
void	getRequiredCredentials()
string	render()	Renders the button
void	setAction()	Sets / Gets the value of the action property.
void	setActionDisabledParams()	Sets / Gets the value of the actionParams property.
void	setActionParams()	Sets / Gets the value of the actionParams property.
void	setCaption()	Sets / Gets the value of the caption property.
void	setCaptionParams()	Sets / Gets the value of the captionParams property.
void	setCurrentUser()	Sets / Gets the value of the currentUser property.
void	setEnabled()	Sets / Gets the value of the enabled property.
void	setImage()	Sets / Gets the value of the image property.
void	setImageAboveText()	Sets / Gets the value of the imageAboveText property.
void	setImageAfterText()	Sets / Gets the value of the imageAfterText property.
void	setImageBeforeText()	Sets / Gets the value of the imageBeforeText property.
void	setImageDisabled()	Sets / Gets the value of the imageDisabled property.
void	setImageParams()	Sets / Gets the value of the imageParams property.
void	setImageText()	Sets / Gets the value of the imageText property.
void	setImageTextRelation()	Sets / Gets the value of the imageTextRelation property.
void	setImageUnderText()	Sets / Gets the value of the imageUnderText property.
void	setLinkedTo()	Sets / Gets the value of the linkedTo property.
void	setRequiredCredentials()	Sets / Gets the value of the requiredCredentials property.

[ Top ]

Properties

mixed $action = '' [line 32]

API Tags:

Access:

protected

[ Top ]

mixed $actionDisabledParams = array() [line 36]

API Tags:

Access:

protected

[ Top ]

mixed $actionParams = array() [line 35]

API Tags:

Access:

protected

[ Top ]

mixed $caption = '' [line 31]

API Tags:

Access:

protected

[ Top ]

mixed $captionParams = array() [line 34]

API Tags:

Access:

protected

[ Top ]

mixed $currentUser [line 40]

API Tags:

Access:

protected

[ Top ]

mixed $enabled = true [line 30]

API Tags:

Access:

protected

[ Top ]

mixed $image = '' [line 28]

API Tags:

Access:

protected

[ Top ]

mixed $imageAboveText [line 44]

API Tags:

Access:

protected

[ Top ]

mixed $imageAfterText [line 43]

API Tags:

Access:

protected

[ Top ]

mixed $imageBeforeText [line 42]

API Tags:

Access:

protected

[ Top ]

mixed $imageDisabled = '' [line 29]

API Tags:

Access:

protected

[ Top ]

mixed $imageParams = array() [line 33]

API Tags:

Access:

protected

[ Top ]

mixed $imageText [line 41]

API Tags:

Access:

protected

[ Top ]

mixed $imageTextRelation [line 37]

API Tags:

Access:

protected

[ Top ]

mixed $imageUnderText [line 45]

API Tags:

Access:

protected

[ Top ]

mixed $linkedTo [line 39]

API Tags:

Access:

protected

[ Top ]

mixed $requiredCredentials [line 38]

API Tags:

Access:

protected

[ Top ]

Methods

Constructor __construct [line 53]

w3sButton __construct(
[object A
$user = null] 
)

Constructor.

Parameters:

object A

$user:

reference to current user

API Tags:

Access:

public

[ Top ]

buttonSkeleton [line 536]

void buttonSkeleton(
string
0 
)

Returns the button skeleton, according to the imageTextRelation param.

Parameters:

string

API Tags:

Access:

protected

[ Top ]

checkImage [line 517]

void checkImage(
string
$image 
)

Checks that the file name passed as reference is a valid string and a valid filename.

Parameters:

string

$image:

API Tags:

Access:

protected

[ Top ]

fromArray [line 429]

void fromArray(
array
$array 
)

Sets the button's attributes from an array. No attributes are required.

Example $button = array("image" => [value], "caption" => [value], ...)

Parameters:

array

$array:

API Tags:

Access:

public

[ Top ]

fromYml [line 457]

void fromYml(
array
$fileName 
)

Sets the button's attributes from a yml file.

See the editorButtonClose.yml for a full example

Parameters:

array

$fileName:

API Tags:

Access:

public

[ Top ]

getAction [line 143]

void getAction(
)

API Tags:

Access:

public

[ Top ]

getActionDisabledParams [line 223]

void getActionDisabledParams(
)

API Tags:

Access:

public

[ Top ]

getActionParams [line 203]

void getActionParams(
)

API Tags:

Access:

public

[ Top ]

getCaption [line 123]

void getCaption(
)

API Tags:

Access:

public

[ Top ]

getCaptionParams [line 183]

void getCaptionParams(
)

API Tags:

Access:

public

[ Top ]

getCurrentUser [line 311]

void getCurrentUser(
)

API Tags:

Access:

public

[ Top ]

getEnabled [line 106]

void getEnabled(
)

API Tags:

Access:

public

[ Top ]

getImage [line 69]

void getImage(
)

API Tags:

Access:

public

[ Top ]

getImageAboveText [line 395]

void getImageAboveText(
)

API Tags:

Access:

public

[ Top ]

getImageAfterText [line 374]

void getImageAfterText(
)

API Tags:

Access:

public

[ Top ]

getImageBeforeText [line 353]

void getImageBeforeText(
)

API Tags:

Access:

public

[ Top ]

getImageDisabled [line 86]

void getImageDisabled(
)

API Tags:

Access:

public

[ Top ]

getImageParams [line 163]

void getImageParams(
)

API Tags:

Access:

public

[ Top ]

getImageText [line 332]

void getImageText(
)

API Tags:

Access:

public

[ Top ]

getImageTextRelation [line 248]

void getImageTextRelation(
)

API Tags:

Access:

public

[ Top ]

getImageUnderText [line 416]

void getImageUnderText(
)

API Tags:

Access:

public

[ Top ]

getLinkedTo [line 290]

void getLinkedTo(
)

API Tags:

Access:

public

[ Top ]

getRequiredCredentials [line 269]

void getRequiredCredentials(
)

API Tags:

Access:

public

[ Top ]

render [line 468]

string render(
)

Renders the button

API Tags:

Access:

public

[ Top ]

setAction [line 134]

void setAction(
string
$value 
)

Sets / Gets the value of the action property.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setActionDisabledParams [line 214]

void setActionDisabledParams(
array
$value 
)

Sets / Gets the value of the actionParams property.

Parameters:

array

$value:

API Tags:

Access:

public

[ Top ]

setActionParams [line 194]

void setActionParams(
array
$value 
)

Sets / Gets the value of the actionParams property.

Parameters:

array

$value:

API Tags:

Access:

public

[ Top ]

setCaption [line 117]

void setCaption(
string
$value 
)

Sets / Gets the value of the caption property.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setCaptionParams [line 174]

void setCaptionParams(
array
$value 
)

Sets / Gets the value of the captionParams property.

Parameters:

array

$value:

API Tags:

Access:

public

[ Top ]

setCurrentUser [line 301]

void setCurrentUser(
object
$value 
)

Sets / Gets the value of the currentUser property.

Parameters:

object

$value:

API Tags:

Access:

public

[ Top ]

setEnabled [line 96]

void setEnabled(
boolean
$value 
)

Sets / Gets the value of the enabled property.

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setImage [line 63]

void setImage(
string
$value 
)

Sets / Gets the value of the image property.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setImageAboveText [line 385]

void setImageAboveText(
string
$value 
)

Sets / Gets the value of the imageAboveText property.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setImageAfterText [line 364]

void setImageAfterText(
string
$value 
)

Sets / Gets the value of the imageAfterText property.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setImageBeforeText [line 343]

void setImageBeforeText(
string
$value 
)

Sets / Gets the value of the imageBeforeText property.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setImageDisabled [line 80]

void setImageDisabled(
string
$value 
)

Sets / Gets the value of the imageDisabled property.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setImageParams [line 154]

void setImageParams(
array
$value 
)

Sets / Gets the value of the imageParams property.

Parameters:

array

$value:

API Tags:

Access:

public

[ Top ]

setImageText [line 322]

void setImageText(
string
$value 
)

Sets / Gets the value of the imageText property.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setImageTextRelation [line 234]

void setImageTextRelation(
int
$value 
)

Sets / Gets the value of the imageTextRelation property.

Parameters:

int

$value:

API Tags:

Access:

public

[ Top ]

setImageUnderText [line 406]

void setImageUnderText(
string
$value 
)

Sets / Gets the value of the imageUnderText property.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setLinkedTo [line 280]

void setLinkedTo(
string
$value 
)

Sets / Gets the value of the linkedTo property.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setRequiredCredentials [line 259]

void setRequiredCredentials(
array
$value 
)

Sets / Gets the value of the requiredCredentials property.

Parameters:

array

$value:

API Tags:

Access:

public

[ Top ]

Documentation generated on Tue, 11 Aug 2009 14:53:42 +0200 by phpDocumentor 1.4.0

	sfW3studioCMSPlugin w3sButton

[ class tree: sfW3studioCMSPlugin ] [ index: sfW3studioCMSPlugin ] [ all elements ]