Documentation

CFI
in package

[$cfi = $this->core->loadClass('CFI');] Class CFI to handle CFO app for CloudFrameworkInterface https://www.notion.so/cloudframework/CFI-PHP-Class-c26b2a1dd2254ddd9e663f2f8febe038 last_update: 20221003

Table of Contents

Properties

$json_object  : mixed
$buttons  : mixed
$core  : mixed
$fields  : mixed
$version  : mixed

Methods

__construct()  : mixed
CFI constructor.
addTab()  : mixed
Change title of the App
button()  : CFIButton
Return a CFIButton $button
changeFieldsToDisabled()  : mixed
Change All the fields fields to readonly
changeFieldsToReadOnly()  : mixed
Change All the fields fields to readonly
closeButton()  : mixed
set the title for close button
delete()  : mixed
Delete a field
field()  : CFIField
Return a CFIField field
getApp()  : mixed
initApp()  : mixed
Init a CFI app
reloadCFO()  : mixed
Set if the CFO list view has to be reloaded
requireReloadOnReturn()  : mixed
Change title of the App
returnData()  : mixed
Return the App structure: $this->json_object
setTile()  : mixed
Change title of the App
getButton()  : CFIButton
Internal method to return a button
getField()  : CFIField

Properties

$json_object

public mixed $json_object = ['title' => 'Pending', 'allow_copy' => \false, 'allow_delete' => \false, 'allow_display' => \false, 'allow_update' => \false, 'tabs' => [], 'fields' => [], 'buttons' => [], 'close' => 'Cancel']

$buttons

private mixed $buttons = []

$core

private mixed $core

$fields

private mixed $fields = []

$version

private mixed $version = '20221003'

Methods

__construct()

CFI constructor.

public __construct(Core7 &$core[, string $bucket = '' ]) : mixed
Parameters
$core : Core7
$bucket : string = ''

addTab()

Change title of the App

public addTab( $title[, mixed $icon = 'home' ]) : mixed
Parameters
$title :
$icon : mixed = 'home'

button()

Return a CFIButton $button

public button([ $button_title = 'Button' ][, string $align = 'right' ]) : CFIButton
Parameters
$button_title : = 'Button'
$align : string = 'right'

where to show the button in the bottom: right or left

Return values
CFIButton

changeFieldsToDisabled()

Change All the fields fields to readonly

public changeFieldsToDisabled([array<string|int, mixed> $fields = [] ]) : mixed
Parameters
$fields : array<string|int, mixed> = []

array of fields to change. If empty it will change every field.

changeFieldsToReadOnly()

Change All the fields fields to readonly

public changeFieldsToReadOnly([array<string|int, mixed> $fields = [] ]) : mixed
Parameters
$fields : array<string|int, mixed> = []

array of fields to change. If empty it will change every field.

closeButton()

set the title for close button

public closeButton( $title) : mixed
Parameters
$title :

delete()

Delete a field

public delete( $field) : mixed
Parameters
$field :

field()

Return a CFIField field

public field( $field) : CFIField
Parameters
$field :
Return values
CFIField

getApp()

public getApp() : mixed

initApp()

Init a CFI app

public initApp( $title) : mixed
Parameters
$title :

reloadCFO()

Set if the CFO list view has to be reloaded

public reloadCFO([bool $reload = true ]) : mixed
Parameters
$reload : bool = true

default is true

requireReloadOnReturn()

Change title of the App

public requireReloadOnReturn([bool $required = true ]) : mixed
Parameters
$required : bool = true

returnData()

Return the App structure: $this->json_object

public returnData() : mixed

setTile()

Change title of the App

public setTile( $title) : mixed
Parameters
$title :

getButton()

Internal method to return a button

private getButton( $button) : CFIButton
Parameters
$button :
Return values
CFIButton 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results