\FML\Script\FeaturesClock

Script Feature showing the current time on a Label

Summary

Methods
Properties
Constants
collect()
prepare()
__construct()
getLabel()
setLabel()
getShowSeconds()
setShowSeconds()
getShowFullDate()
setShowFullDate()
No public properties found
No constants found
getScriptText()
$label
$showSeconds
$showFullDate
N/A
No private methods found
No private properties found
N/A

Properties

$showSeconds

$showSeconds : boolean

Type

boolean — Show the seconds

$showFullDate

$showFullDate : boolean

Type

boolean — Show the date

Methods

collect()

collect() : array<mixed,\FML\Script\Features\ScriptFeature>

Collect the Script Features of the given objects

Returns

array<mixed,\FML\Script\Features\ScriptFeature>

prepare()

prepare(\FML\Script\Script  $script) : static

Prepare the given Script for rendering by adding the needed Labels, etc.

Parameters

\FML\Script\Script $script

Script to prepare

Returns

static

__construct()

__construct(\FML\Controls\Label  $label = null, boolean  $showSeconds = true, boolean  $showFullDate = false) 

Construct a new Clock

Parameters

\FML\Controls\Label $label

(optional) Clock Label

boolean $showSeconds

(optional) Show the seconds

boolean $showFullDate

(optional) Show the date

setLabel()

setLabel(\FML\Controls\Label  $label) : static

Set the Label

Parameters

\FML\Controls\Label $label

Clock Label

Returns

static

getShowSeconds()

getShowSeconds() : boolean

Get if seconds should be shown

Returns

boolean

setShowSeconds()

setShowSeconds(boolean  $showSeconds) : static

Set if seconds should be shown

Parameters

boolean $showSeconds

If seconds should be shown

Returns

static

getShowFullDate()

getShowFullDate() : boolean

Get if the full date should be shown

Returns

boolean

setShowFullDate()

setShowFullDate(boolean  $showFullDate) : static

Set if the full date should be shown

Parameters

boolean $showFullDate

If the full date should be shown

Returns

static

getScriptText()

getScriptText() : string

Get the script text

Returns

string