FacturaScripts

WidgetLibrary extends BaseWidget
in package

Description of BaseWidget

Table of Contents

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

Properties

$id

Identifies the object with a defined name in the view

public string $id

$name

Name defined in the view as key

public string $name

$options

public array<string|int, mixed> $options = []

$level

Selected security level.

private static int $level = 0

Methods

__construct()

public __construct(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>
Return values
mixed —

edit()

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

files()

public files([string $query = '' ][, string $sort = 'date-desc' ]) : array<string|int, AttachedFile>
Parameters
$query : string = ''
$sort : string = 'date-desc'
Return values
array<string|int, AttachedFile> —

getColorFromOption()

Calculate color from option configuration

public getColorFromOption(array<string|int, string> $option, mixed $value, string $prefix) : string
Parameters
$option : array<string|int, string>
$value : mixed
$prefix : string
Return values
string —

getLevel()

public static getLevel() : int
Return values
int —

getToken()

public static getToken() : string
Return values
string —

getType()

Get the widget type

public getType() : string
Return values
string —

gridFormat()

public gridFormat() : array<string|int, mixed>
Return values
array<string|int, mixed> —

inputHidden()

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

plainText()

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

processFormData()

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

renderFileList()

public renderFileList([array<string|int, mixed> $files = [] ][, int|null $selected_value = null ][, string|null $id = null ]) : string
Parameters
$files : array<string|int, mixed> = []
$selected_value : int|null = null
$id : string|null = null
Return values
string —

setCustomValue()

Set custom fixed value to widget

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

setLevel()

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

setToken()

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

showTableTotals()

public showTableTotals() : bool
Return values
bool —

tableCell()

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

applyOperatorFromOption()

protected applyOperatorFromOption(array<string|int, string> $option, mixed $value) : bool
Parameters
$option : array<string|int, string>
$value : mixed
Return values
bool —

assets()

Adds assets to the asset manager.

protected assets() : mixed
Return values
mixed —

colorToClass()

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

combineClasses()

protected combineClasses(array<string|int, mixed> ...$classes) : string
Parameters
$classes : array<string|int, mixed>
Return values
string —

css()

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

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

getUniqueId()

protected getUniqueId() : int
Return values
int —

inputHtml()

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

inputHtmlExtraParams()

protected inputHtmlExtraParams() : string
Return values
string —

loadOptions()

protected loadOptions(array<string|int, mixed> $children) : mixed
Parameters
$children : array<string|int, mixed>
Return values
mixed —

onclickHtml()

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

readonly()

protected readonly() : bool
Return values
bool —

renderModal()

protected renderModal(string $icon, string $label) : string
Parameters
$icon : string
$label : string
Return values
string —

renderQueryFilter()

protected renderQueryFilter() : string
Return values
string —

renderSelectNoneBtn()

protected renderSelectNoneBtn() : string
Return values
string —

renderSortFilter()

protected renderSortFilter() : string
Return values
string —

setValue()

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

show()

protected show() : string
Return values
string —

tableCellClass()

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

Search results