Documentation

syscheckOption
in package

System config Objekt

Tags
author

Stefan Seehafer sea75300@yahoo.de

copyright

(c) 2011-2020, Stefan Seehafer

license

http://www.gnu.org/licenses/gpl.txt GPLv3

Table of Contents

$actionButton  : linkButton
Option is checked folder
$current  : string
Current value
$helplink  : string
Help link
$isFolder  : bool
Option is checked folder
$notice  : string
Add Notice
$optional  : bool
Option is not required
$result  : bool
Check result
__construct()  : mixed
Konstruktor
asString()  : string
Returns check string for cli
getActionButton()  : string
Return button code
getCurrent()  : string
Returns current value
getHelplink()  : string
Returns info/help link
getNotice()  : string
Returns notice
getOptional()  : bool
Returns optional flasg
getResult()  : string
Returns check value
isFolder()  : string
Returns if folder was checked
setActionButton()  : mixed
Set Action Button
setNotice()  : mixed
Set notice

Properties

$isFolder

Option is checked folder

protected bool $isFolder = false

$optional

Option is not required

protected bool $optional = false

Methods

__construct()

Konstruktor

public __construct(string $current, string $helplink, bool $result[, bool $optional = false ][, bool $isFolder = false ]) : mixed
Parameters
$current : string
$helplink : string
$result : bool
$optional : bool = false
$isFolder : bool = false
Return values
mixed

asString()

Returns check string for cli

public asString(string $descr) : string
Parameters
$descr : string
Return values
string

getActionButton()

Return button code

public getActionButton() : string
Return values
string

getCurrent()

Returns current value

public getCurrent() : string
Return values
string

Returns info/help link

public getHelplink() : string
Return values
string

getNotice()

Returns notice

public getNotice() : string
Return values
string

getOptional()

Returns optional flasg

public getOptional() : bool
Return values
bool

getResult()

Returns check value

public getResult() : string
Return values
string

isFolder()

Returns if folder was checked

public isFolder() : string
Return values
string

setNotice()

Set notice

public setNotice(string $notice) : mixed
Parameters
$notice : string
Return values
mixed

Search results