Documentation

Registration extends Template
in package

Registration warning class.

Table of Contents

$color  : mixed
$description  : string|null
$folder  : mixed
$link  : string|null
$priority  : int
$status  : int
Status 0 - warning occurred, 1 - no warning.
$statusValue  : int
Status value 0 - active, 2 - ignored.
$title  : string
$tpl  : bool
getColor()  : string
Returns the warning color.
getDescription()  : string|null
Returns the warning description.
getFolder()  : string
Returns the warning folder.
getLink()  : string|null
Returns the warning link.
getPriority()  : int
Returns the warning priority.
getStatus()  : int
Returns the warning status.
getStatusValue()  : int
Get status value.
getTitle()  : string
Returns the warning title.
getTpl()  : mixed
preProcess()  : bool
Whether a warning is active.
process()  : void
Checking if registration is correct and display modal with info if not.
setFolder()  : string
Updates the warning folder.
update()  : bool
Update ignoring status.

Properties

$description

protected string|null $description

Modal description

protected string|null $link

Link URL

$priority

protected int $priority = 8

Warning priority code

$status

Status 0 - warning occurred, 1 - no warning.

protected int $status = 0

$statusValue

Status value 0 - active, 2 - ignored.

protected int $statusValue = 0

$title

protected string $title = 'LBL_REGISTRATION'

Modal header title

Methods

getColor()

Returns the warning color.

public getColor() : string
Return values
string

getDescription()

Returns the warning description.

public getDescription() : string|null
Return values
string|null

getFolder()

Returns the warning folder.

public getFolder([mixed $toArray = true ]) : string
Parameters
$toArray : mixed = true
Return values
string

Returns the warning link.

public getLink() : string|null
Return values
string|null

getPriority()

Returns the warning priority.

public getPriority() : int
Return values
int

getStatus()

Returns the warning status.

public getStatus() : int
Return values
int

getStatusValue()

Get status value.

public getStatusValue() : int
Return values
int

getTitle()

Returns the warning title.

public getTitle() : string
Return values
string

getTpl()

public getTpl() : mixed
Return values
mixed

preProcess()

Whether a warning is active.

public preProcess() : bool
Return values
bool

process()

Checking if registration is correct and display modal with info if not.

public process() : void
Return values
void

setFolder()

Updates the warning folder.

public setFolder(mixed $folder) : string
Parameters
$folder : mixed
Return values
string

update()

Update ignoring status.

public update(int $params) : bool
Parameters
$params : int
Return values
bool

        

Search results