Documentation

Settings extends Base
in package

Table of Contents

Properties

$fd  : mixed

Methods

__construct()  : mixed
dropdown()  : mixed
Renders settings for dropdown used at the back-end
getTemplate()  : mixed
Central method to generate a new theme object so that we can centralize and inject variables into the library
multilist()  : mixed
Renders settings for multiple select list used at the back-end
password()  : mixed
Renders a password for extension settings
select2()  : mixed
Renders settings for dropdown used at the back-end
text()  : mixed
Renders a textbox for extension settings
textarea()  : mixed
Renders a settings with textarea
toggle()  : mixed
Renders a toggle input
user()  : mixed
Renders the user browser
userGroupsTree()  : mixed
Renders the user groups tree checkbox

Properties

$fd

protected mixed $fd = null

Methods

__construct()

public __construct(mixed $fd) : mixed
Parameters
$fd : mixed

dropdown()

Renders settings for dropdown used at the back-end

public dropdown(mixed $name, mixed $title[, mixed $options = [] ][, mixed $desc = '' ][, mixed $attributes = '' ][, mixed $note = '' ][, mixed $formOptions = [] ]) : mixed
Parameters
$name : mixed
$title : mixed
$options : mixed = []
$desc : mixed = ''
$attributes : mixed = ''
$note : mixed = ''
$formOptions : mixed = []
Tags
since
1.0.0
access

public

getTemplate()

Central method to generate a new theme object so that we can centralize and inject variables into the library

public getTemplate() : mixed
Tags
since
1.0.0
access

public

multilist()

Renders settings for multiple select list used at the back-end

public multilist(mixed $name, mixed $title[, mixed $options = [] ][, mixed $desc = '' ][, mixed $attributes = '' ][, mixed $note = '' ][, mixed $formOptions = [] ]) : mixed
Parameters
$name : mixed
$title : mixed
$options : mixed = []
$desc : mixed = ''
$attributes : mixed = ''
$note : mixed = ''
$formOptions : mixed = []
Tags
since
1.1.2
access

public

password()

Renders a password for extension settings

public password(mixed $name, mixed $title[, mixed $desc = '' ][, mixed $options = [] ][, mixed $instructions = '' ][, mixed $class = '' ]) : mixed
Parameters
$name : mixed
$title : mixed
$desc : mixed = ''
$options : mixed = []
$instructions : mixed = ''
$class : mixed = ''
Tags
since
1.0.0
access

public

select2()

Renders settings for dropdown used at the back-end

public select2(mixed $name, mixed $title[, mixed $options = [] ][, mixed $desc = '' ][, mixed $attributes = '' ][, mixed $note = '' ][, mixed $formOptions = [] ]) : mixed
Parameters
$name : mixed
$title : mixed
$options : mixed = []
$desc : mixed = ''
$attributes : mixed = ''
$note : mixed = ''
$formOptions : mixed = []
Tags
since
1.1.4
access

public

text()

Renders a textbox for extension settings

public text(mixed $name, mixed $title[, mixed $desc = '' ][, mixed $options = [] ][, mixed $instructions = '' ][, mixed $class = '' ]) : mixed
Parameters
$name : mixed
$title : mixed
$desc : mixed = ''
$options : mixed = []
$instructions : mixed = ''
$class : mixed = ''
Tags
since
1.0.0
access

public

textarea()

Renders a settings with textarea

public textarea(mixed $name, mixed $title[, mixed $desc = '' ][, mixed $instructions = '' ][, mixed $options = [] ]) : mixed
Parameters
$name : mixed
$title : mixed
$desc : mixed = ''
$instructions : mixed = ''
$options : mixed = []
Tags
since
1.0.0
access

public

toggle()

Renders a toggle input

public toggle(mixed $name, mixed $title[, mixed $desc = '' ][, mixed $attributes = '' ][, mixed $note = '' ][, mixed $wrapperAttributes = '' ][, mixed $options = [] ]) : mixed
Parameters
$name : mixed
$title : mixed
$desc : mixed = ''
$attributes : mixed = ''
$note : mixed = ''
$wrapperAttributes : mixed = ''
$options : mixed = []
Tags
since
1.0.0
access

public

user()

Renders the user browser

public user(mixed $name, mixed $title[, mixed $desc = '' ][, mixed $options = [] ][, mixed $instructions = '' ][, mixed $class = '' ]) : mixed
Parameters
$name : mixed
$title : mixed
$desc : mixed = ''
$options : mixed = []
$instructions : mixed = ''
$class : mixed = ''
Tags
since
1.1.2
access

public

userGroupsTree()

Renders the user groups tree checkbox

public userGroupsTree(mixed $name, mixed $title[, mixed $desc = '' ][, mixed $checkSuperAdmin = false ][, mixed $options = [] ]) : mixed
Parameters
$name : mixed
$title : mixed
$desc : mixed = ''
$checkSuperAdmin : mixed = false
$options : mixed = []
Tags
since
1.1.2
access

public


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results