Documentation

CFIVirtualElements
in package

Table of Contents

Properties

$field  : mixed
$core  : Core7
$index  : mixed

Methods

__construct()  : mixed
CFI constructor.
addType()  : CFIVirtualElements
Apply a type a virtual_elements
addTypeAvatar()  : CFIVirtualElements
Add a virtual_elements with type=image
addTypeCalculate()  : CFIVirtualElements
Add a virtual_elements with type=calculate
addTypeCheckbox()  : CFIVirtualElements
Add a virtual_elements with type=ico
addTypeDisplay()  : CFIVirtualElements
Add a virtual_elements with type=display It allow to Display the current CFO
addTypeDisplayCFO()  : CFIVirtualElements
Apply an update type to virtual_elements with CFO information.
addTypeIcon()  : CFIVirtualElements
Add a virtual_elements with type=ico
addTypeImage()  : CFIVirtualElements
Add a virtual_elements with type=image
addTypeOnClick()  : CFIVirtualElements
Add a virtual_elements with type=onClick
addTypeUpdateCFO()  : CFIVirtualElements
Apply an update type to virtual_elements with CFO information.
addTypeValue()  : CFIVirtualElements
Add a virtual_elements with type=value
button()  : CFIVirtualElements
The virtual element will be shown as a button
icon()  : CFIVirtualElements
add an attribute ico on the currect virtual_element
jsCondition()  : CFIVirtualElements
Javascript condition to be evaluated in frontend
onClick()  : CFIVirtualElements
add an attribute onClick on the currect virtual_element
title()  : $this
Apply a title to the field

Properties

$field

public mixed $field

$core

private Core7 $core

$index

private mixed $index = 0

Methods

__construct()

CFI constructor.

public __construct(Core7 &$core, array<string|int, mixed> &$field) : mixed
Parameters
$core : Core7
$field : array<string|int, mixed>

addType()

Apply a type a virtual_elements

public addType(string $type) : CFIVirtualElements
Parameters
$type : string

type of virtual_element. Allowed values: 'calculate',

Return values
CFIVirtualElements

addTypeCalculate()

Add a virtual_elements with type=calculate

public addTypeCalculate(string $field, string $type) : CFIVirtualElements
Parameters
$field : string

name of the field in the data

$type : string

type of calculation. Allowed values: 'count'

Return values
CFIVirtualElements

addTypeCheckbox()

Add a virtual_elements with type=ico

public addTypeCheckbox(string $title, string $value[, bool $checked = false ][, string $onClick = '' ]) : CFIVirtualElements
Parameters
$title : string
$value : string
$checked : bool = false
$onClick : string = ''
Return values
CFIVirtualElements

addTypeDisplay()

Add a virtual_elements with type=display It allow to Display the current CFO

public addTypeDisplay([string $idField = '' ][, string $fields = '' ]) : CFIVirtualElements
Parameters
$idField : string = ''

optinal field name to be used as Id of the entity. You can leave ot empty if it is ds:Object

$fields : string = ''

optional fields separated by ',' to be send to the CFO to only represent those fields to be displayed

Return values
CFIVirtualElements

addTypeDisplayCFO()

Apply an update type to virtual_elements with CFO information.

public addTypeDisplayCFO(string $cfo, mixed $id_value[, string $fields = '' ]) : CFIVirtualElements
Parameters
$cfo : string

The CFO information to be added.

$id_value : mixed

The ID value for the update operation.

$fields : string = ''

(Optional) Additional fields to be updated.

Return values
CFIVirtualElements

addTypeIcon()

Add a virtual_elements with type=ico

public addTypeIcon(string $icon) : CFIVirtualElements
Parameters
$icon : string

icon the be used (without fal fa- prefix))

Return values
CFIVirtualElements

addTypeOnClick()

Add a virtual_elements with type=onClick

public addTypeOnClick(string $onclick) : CFIVirtualElements
Parameters
$onclick : string

js value to be executed onClick

Return values
CFIVirtualElements

addTypeUpdateCFO()

Apply an update type to virtual_elements with CFO information.

public addTypeUpdateCFO(string $cfo, mixed $id_value[, string $fields = '' ]) : CFIVirtualElements
Parameters
$cfo : string

The CFO information to be added.

$id_value : mixed

The ID value for the update operation.

$fields : string = ''

(Optional) Additional fields to be updated.

Return values
CFIVirtualElements

addTypeValue()

Add a virtual_elements with type=value

public addTypeValue(string $value) : CFIVirtualElements
Parameters
$value : string

value to apply. The value admits {{variable}} substitute strings

Return values
CFIVirtualElements

button()

The virtual element will be shown as a button

public button([string $color = 'default' ][, string $icon = '' ]) : CFIVirtualElements
Parameters
$color : string = 'default'

optional color (default will be 'default') of the button: info, success, warning, default, primary, sencondary

$icon : string = ''

optional icon

Return values
CFIVirtualElements

icon()

add an attribute ico on the currect virtual_element

public icon(string $icon) : CFIVirtualElements
Parameters
$icon : string

to be shown (without fal fa- prefix))

Return values
CFIVirtualElements

jsCondition()

Javascript condition to be evaluated in frontend

public jsCondition(string $js_condition) : CFIVirtualElements
Parameters
$js_condition : string

js condition to be evaluated in the frontend

Return values
CFIVirtualElements

onClick()

add an attribute onClick on the currect virtual_element

public onClick(string $onclick) : CFIVirtualElements
Parameters
$onclick : string

js value to be executed onClick

Return values
CFIVirtualElements

title()

Apply a title to the field

public title(string $title) : $this
Parameters
$title : string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results