FacturaScripts

BaseWidget extends VisualItem

Description of BaseWidget

Table of Contents

$autocomplete bool
$fieldname string
$icon string
$onclick string
$options array
$readonly string
$required bool
$type string
$value mixed
$class string
$i18n Translator
$id Identifies the object with a defined name in the view string
$level Selected security level. int
$name Name defined in the view as key string
$token string
$uniqueId int
__construct() mixed
edit() string
getType() Get the widget type string
gridFormat() array
inputHidden() string
plainText() string
processFormData() mixed
setCustomValue() Set custom fixed value to widget mixed
showTableTotals() bool
tableCell() string
assets() Adds assets to the asset manager. mixed
inputHtml() string
inputHtmlExtraParams() string
loadOptions() mixed
onclickHtml() string
readonly() bool
setValue() mixed
show() string
tableCellClass() string
__construct() mixed
getLevel() int
getToken() string
setLevel() mixed
setToken() mixed
colorToClass() string
getColorFromOption() Calculate color from option configuration string
applyOperatorFromOption() bool
combineClasses() string
css() Returns equivalent css class to $class. To extend in plugins. string
getUniqueId() int

Properties

$id

Identifies the object with a defined name in the view

public string $id

$level

Selected security level.

private static int $level = ""

$name

Name defined in the view as key

public string $name

Methods

__construct()

public __construct( $data : array ) : mixed
Parameters
$data : array
Return values
mixed

edit()

public edit( $model : object [, $title : string = '' ] [, $description : string = '' ] [, $titleurl : string = '' ] ) : string
Parameters
$model : object
$title : string = ''
$description : string = ''
$titleurl : string = ''
Return values
string

getType()

Get the widget type

public getType( ) : string
Return values
string

gridFormat()

public gridFormat( ) : array
Return values
array

inputHidden()

public inputHidden( $model : object ) : string
Parameters
$model : object
Return values
string

plainText()

public plainText( $model : object ) : string
Parameters
$model : object
Return values
string

processFormData()

public processFormData( &$model : object , $request : Request ) : mixed
Parameters
$model : object
$request : Request
Return values
mixed

setCustomValue()

Set custom fixed value to widget

public setCustomValue( $value : mixed ) : mixed
Parameters
$value : mixed
Return values
mixed

showTableTotals()

public showTableTotals( ) : bool
Return values
bool

tableCell()

public tableCell( $model : object [, $display : string = 'left' ] ) : string
Parameters
$model : object
$display : string = 'left'
Return values
string

assets()

Adds assets to the asset manager.

protected assets( ) : mixed
Return values
mixed

inputHtml()

protected inputHtml( [ $type : string = 'text' ] [, $extraClass : string = '' ] ) : string
Parameters
$type : string = 'text'
$extraClass : string = ''
Return values
string

inputHtmlExtraParams()

protected inputHtmlExtraParams( ) : string
Return values
string

loadOptions()

protected loadOptions( $children : array ) : mixed
Parameters
$children : array
Return values
mixed

onclickHtml()

protected onclickHtml( $inside : string [, $titleurl : string = '' ] ) : string
Parameters
$inside : string
$titleurl : string = ''
Return values
string

readonly()

protected readonly( ) : bool
Return values
bool

setValue()

protected setValue( $model : object ) : mixed
Parameters
$model : object
Return values
mixed

show()

protected show( ) : string
Return values
string

tableCellClass()

protected tableCellClass( [ $initialClass : string = '' ] [, $alternativeClass : string = '' ] ) : string
Parameters
$initialClass : string = ''
$alternativeClass : string = ''
Return values
string

__construct()

public __construct( $data : array ) : mixed
Parameters
$data : array
Return values
mixed

getLevel()

public static getLevel( ) : int
Return values
int

getToken()

public static getToken( ) : string
Return values
string

setLevel()

public static setLevel( $new : int ) : mixed
Parameters
$new : int
Return values
mixed

setToken()

public static setToken( $token : string ) : mixed
Parameters
$token : string
Return values
mixed

colorToClass()

protected colorToClass( $color : string , $prefix : string ) : string
Parameters
$color : string
$prefix : string
Return values
string

getColorFromOption()

Calculate color from option configuration

public getColorFromOption( $option : string[] , $value : mixed , $prefix : string ) : string
Parameters
$option : string[]
$value : mixed
$prefix : string
Return values
string

applyOperatorFromOption()

protected applyOperatorFromOption( $option : string[] , $value : mixed ) : bool
Parameters
$option : string[]
$value : mixed
Return values
bool

combineClasses()

protected combineClasses( ...$classes : array ) : string
Parameters
$classes : array
Return values
string

css()

Returns equivalent css class to $class. To extend in plugins.

protected css( $class : string ) : string
Parameters
$class : string
Return values
string

getUniqueId()

protected getUniqueId( ) : int
Return values
int

Search results