1. class
  2. App
  3. \
  4. G6K
  5. \
  6. Model
  7. \
  8. Action

Action

class Action

This class allows the stockage and the retrieval of the attributes of an action button for a step

Properties

private Step $step
private string $name
private string $label
private string $clazz
private string $what
private string $for
private string $uri
private string $location
private string $shape
private bool $displayable

Methods

void
__construct(Step $step, string $name, string $label)

Constructor of class Action

Step
getStep()

Returns the step that defines this action button

string
getName()

Returns the name of this action button

void
setName(string $name)

Sets the name of this action button

string
getLabel()

Returns the label of this action button

void
setLabel(string $label)

Sets the label of this action button

string
getClass()

Returns the class style of this action button

void
setClass(string $clazz)

Sets the class style of this action button

string
getWhat()

Returns the "what to do" of this action button

void
setWhat(string $what)

Sets the "what to do" of this action button

string
getFor()

Returns the "for what" of this action button

void
setFor(string $for)

Sets the "for what" of this action button

string
getUri()

Returns the uri attribute of this action button

string
getUriDecoded()

Returns the decoded uri attribute of this action button

void
setUri(string $uri)

Sets the uri attribute of this action button

string
getLocation()

Returns the "location" of this action button

void
setLocation(string $location)

Sets the "location" of this action button

string
getShape()

Returns the "shape" of this action button

void
setShape(string $shape)

Sets the "shape" of this action button

bool
isDisplayable()

Returns the displayable attribute of this action button

bool
getDisplayable()

Returns the displayable attribute of this action button

void
setDisplayable(bool $displayable)

Determines whether this action button can be displayed or not

Details

at line 128
void __construct(Step $step, string $name, string $label)

Constructor of class Action

Parameters

Step $step Step that defines this action button
string $name Button name without spaces or special or accented characters
string $label Button label

Return Value

void

at line 141
Step getStep()

Returns the step that defines this action button

Return Value

Step step

at line 152
string getName()

Returns the name of this action button

Return Value

string the action name

at line 164
void setName(string $name)

Sets the name of this action button

Parameters

string $name Button name without spaces or special or accented characters

Return Value

void

at line 175
string getLabel()

Returns the label of this action button

Return Value

string the value of label

at line 187
void setLabel(string $label)

Sets the label of this action button

Parameters

string $label Button label

Return Value

void

at line 198
string getClass()

Returns the class style of this action button

Return Value

string the value of class

at line 210
void setClass(string $clazz)

Sets the class style of this action button

Parameters

string $clazz Button class style eg "Primary" or "Default"

Return Value

void

at line 221
string getWhat()

Returns the "what to do" of this action button

Return Value

string the value of what

at line 233
void setWhat(string $what)

Sets the "what to do" of this action button

Parameters

string $what Button action eg "submit", "reset", "execute"

Return Value

void

at line 244
string getFor()

Returns the "for what" of this action button

Return Value

string the value of for

at line 256
void setFor(string $for)

Sets the "for what" of this action button

Parameters

string $for Button action triggered for : currentStep (only for what=reset) priorStep, nextStep, pdfOutput, htmlOutput, externalPage

Return Value

void

at line 269
string getUri()

Returns the uri attribute of this action button

The uri attribute is a step number or the URL of a page.

Return Value

string the value of uri

at line 282
string getUriDecoded()

Returns the decoded uri attribute of this action button

The uri attribute is a step number or the URL of a page or a JSON string.

Return Value

string the value of decoded uri

at line 296
void setUri(string $uri)

Sets the uri attribute of this action button

The uri attribute is a step number or the URL of a page.

Parameters

string $uri url for externalPage

Return Value

void

at line 307
string getLocation()

Returns the "location" of this action button

Return Value

string the value of location

at line 319
void setLocation(string $location)

Sets the "location" of this action button

Parameters

string $location location of the container of this action button

Return Value

void

at line 330
string getShape()

Returns the "shape" of this action button

Return Value

string the value of shape

at line 342
void setShape(string $shape)

Sets the "shape" of this action button

Parameters

string $shape shape of this action button

Return Value

void

at line 353
bool isDisplayable()

Returns the displayable attribute of this action button

Return Value

bool the value of displayable

at line 364
bool getDisplayable()

Returns the displayable attribute of this action button

Return Value

bool the value of displayable

at line 376
void setDisplayable(bool $displayable)

Determines whether this action button can be displayed or not

Parameters

bool $displayable Button displayable or not

Return Value

void