Step
class Step
This class allows the storage and retrieval of the attributes of a simulation step.
Properties
private Simulator | $simulator | ||
private int | $id | ||
private string | $name | ||
private string | $label | ||
private string | $template | ||
private string | $output | ||
private string | $description | ||
private bool | $dynamic | ||
private array | $panels | ||
private array | $actions | ||
private Footnotes | $footnotes | ||
private bool | $displayable |
Methods
Constructor of class Step
Returns the Simulator object to which this step belongs
Returns the ID of this step
Sets the ID of this step
Returns the name of this step
Sets the name of this step
Returns the name of the twig template that is used to display the simulation form for this step
Sets the name of the twig template that is used to display the simulation form for this step
Returns the output of the result of the execution of the step
Sets the output of the result of the execution of the step
Returns the label of this step
Sets the label of this step
Returns the description of this step
Sets the description of this step
Returns the dynamic attribute of this Step object
Returns the dynamic attribute of this Step object
Determines whether this step is dynamic or not
Returns the list of panels of this step.
Sets the list of panels of this step.
Removes a Panel object from the list of panels of this step.
Retrieves an Panel object by its ID in the list of panels of this step
Returns the list of action buttons of this step.
Sets the list of action buttons of this step.
Removes an Action object from the list of action buttons of this step.
Retrieves an Action object by its name in the list of action buttons of this step
Returns the footnotes container of this step
Returns the displayable attribute of this Step object
Returns the displayable attribute of this Step object
Determines whether this step can be displayed or not
Details
at line 145
void
__construct(Simulator $simulator, int $id, string $name, string $label, string $template)
Constructor of class Step
at line 160
Simulator
getSimulator()
Returns the Simulator object to which this step belongs
at line 171
int
getId()
Returns the ID of this step
at line 183
void
setId(int $id)
Sets the ID of this step
at line 194
string
getName()
Returns the name of this step
at line 206
void
setName(string $name)
Sets the name of this step
at line 217
string
getTemplate()
Returns the name of the twig template that is used to display the simulation form for this step
at line 229
void
setTemplate(string $template)
Sets the name of the twig template that is used to display the simulation form for this step
at line 247
string
getOutput()
Returns the output of the result of the execution of the step
The possible values are:
- normal: the step is displayed normally.
- inlinePDF: G6K displays a PDF rendering of the generated page.
- downloadablePDF: G6K generates a PDF file of the rendering of the page to be downloaded.
- html: Not implemented
at line 266
void
setOutput(string $output)
Sets the output of the result of the execution of the step
The possible values are:
- normal: the step is displayed normally.
- inlinePDF: G6K displays a PDF rendering of the generated page.
- downloadablePDF: G6K generates a PDF file of the rendering of the page to be downloaded.
- html: Not implemented
at line 277
string
getLabel()
Returns the label of this step
at line 289
void
setLabel(string $label)
Sets the label of this step
at line 300
string
getDescription()
Returns the description of this step
at line 312
void
setDescription(string $description)
Sets the description of this step
at line 325
bool
isDynamic()
Returns the dynamic attribute of this Step object
if true, the simulation engine will use Javascript to give interactivity to the simulation for this step
at line 338
bool
getDynamic()
Returns the dynamic attribute of this Step object
if true, the simulation engine will use Javascript to give interactivity to the simulation for this step
at line 352
void
setDynamic(bool $dynamic)
Determines whether this step is dynamic or not
if true, the simulation engine will use Javascript to give interactivity to the simulation for this step
at line 363
array
getPanels()
Returns the list of panels of this step.
at line 375
void
setPanels(array $panels)
Sets the list of panels of this step.
at line 387
void
addPanel(Panel $panel)
Adds a Panel object to the list of panels of this step.
at line 399
void
removePanel(int $index)
Removes a Panel object from the list of panels of this step.
at line 411
Panel|null
getPanelById(int $id)
Retrieves an Panel object by its ID in the list of panels of this step
at line 427
array
getActions()
Returns the list of action buttons of this step.
at line 439
void
setActions(array $actions)
Sets the list of action buttons of this step.
at line 451
void
addAction(Action $action)
Adds an Action object to the list of action buttons of this step.
at line 463
void
removeAction(int $index)
Removes an Action object from the list of action buttons of this step.
at line 475
Action|null
getActionByName(string $name)
Retrieves an Action object by its name in the list of action buttons of this step
at line 491
Footnotes
getFootNotes()
Returns the footnotes container of this step
at line 503
void
setFootNotes(FootNotes $footnotes)
Sets the footnotes container of this step
at line 514
bool
isDisplayable()
Returns the displayable attribute of this Step object
at line 525
bool
getDisplayable()
Returns the displayable attribute of this Step object
at line 537
void
setDisplayable(bool $displayable)
Determines whether this step can be displayed or not