Phpxforms documentation

InputSelectGroups extends Input
in package

Phpxform

Input Select with groups

Properties

$baseDir : string
$bindTypes : array<string, int>
$class : string
$empty : bool
$error : array<string|int, string>
$filter : string|bool
$id : string|int
$jsType : string|null
$mark : string
$method : int
$mode : string
$quotes : bool
$save : string|bool|null
$size : int
$sizeClass : string
$table : bool
$value : mixed|null
$valueInit : mixed|null
$dataBind : array<string|int, array<string|int, Input>|Input>
$disabled : array<string|int, bool>
$editModes : array<string, int>
$groups : array<string|int, string>
$name : array<string, string>
$names : array<string, int>
$options : array<string|int, array<string|int, mixed>>
$rules : array<string|int, Rule>
$saveModes : array<string|int, int>

Methods

__construct() : mixed: Basic input settings
__toString() : string
addBind() : self: Bind other inputs which interact with current one
delete() : string|bool: Action associated with deleting a master record
duplicate() : void: Duplicate content from another input via POST/GET
getAssetScripts() : array<string, mixed>|null: Get javascript files
getBind() : array<string|int, Input>|Input|null: Get specified input bind-type
getBinds() : array<string|int, array<string|int, Input>|Input>: Get bounded inputs
getClass() : string: Get input classes
getForm() : string: Get full form visualization
getHide() : string: Get input for type hidden
getInput() : string: Get <input /> html
getJMark() : string: Get javascript input var name
getLabel() : string: Get html for <label />
getName() : string: Get input name based on place
getOptions() : array<string|int, array<string|int, mixed>>
getOptList() : string
getRule() : Rule|null: Get selected input rule
getRules() : array<string|int, Rule>: Return input rules
getScript() : string|null: Javascript code for form visualization
getScriptTable() : string|null: Javascript code for table visualization
getSize() : string: Gets adequate css class for input size
getTable() : array{VALUE: string, CLASS?: string, REWRITE?: bool}: Get input's value for presentation in list/table
getText() : string: Get input's value for visualization
getValue() : string|float|int|null: Get input raw value
isEmpty() : bool: Is input empty
isQuotes() : bool: Are magic quotes active
isValid() : bool: Is input valid
load() : void: Load POST/GET value
resetBinds() : void: Remove bounded inputs
resetRules() : void: Remove input rules
set() : self: Set input value
setGroups() : self
setId() : self: Set form ID
setMode() : self: Set input work mode
setName() : self: Set input descriptions
setOptions() : self
setRequired() : self: Set required message
setRule() : self: Set input rule of selected type
setSave() : self: Set input save mode
setValue() : self: Set input value
translate() : void: Translate input and rules descriptions
update() : array<string, mixed>|string|null: Get data for storage update from form
updateTable() : array<string|int, string>|bool: Get sql request for action from table
getInpName() : string: Get input element name
getMethod() : array<string|int, string|mixed>
getPost() : mixed: Get POST/GET data and filter them
getPostData() : mixed|null: Get POST/GET raw data
getValueForm() : string: Get value for input
inputBasic() : string: Get general part of <input /> tag
isTransmitted() : bool: Is (must be) input included in POST/GET
jErrors() : string: Get error messages for javascript
modify() : mixed: Change value based on input class/type

$baseDir


    public
    static    string
    $baseDir
     = './'

Base directory for scripts

$bindTypes


    public
        array<string, int>
    $bindTypes
     = []

Inputs bound to current one

$class


    public
        string
    $class
     = 'form-control'

Default input CSS class

$empty


    public
        bool
    $empty
     = true

Can be empty, default true

$error


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

Error messages

$filter


    public
        string|bool
    $filter
     = 'option'

$id


    public
        string|int
    $id

ID of form where input is

$jsType


    public
    static    string|null
    $jsType
     = 'jInput'

Javascript constructor name

$mark


    public
        string
    $mark

Input element name and db column

$method


    public
    static    int
    $method
     = INPUT_POST

Input content method

$mode


    public
        string
    $mode
     = 'write'

Edit input type ( write / read / disable / hide / dummy - virtual input )

$quotes


    public
    static    bool
    $quotes
     = null

$save


    public
        string|bool|null
    $save
     = 'var'

Input storing value mode ( var / const - keep saved value / default - refreshing default value )

$size


    public
        int
    $size
     = 60

$sizeClass


    public
    static    string
    $sizeClass
     = 'col-md-'

CSS class prefix

$table


    public
        bool
    $table
     = true

Show in table, default true

$value


    public
        mixed|null
    $value
     = null

Input value

$valueInit


    public
        mixed|null
    $valueInit

Initial value (for save default)

$dataBind


    protected
        array<string|int, array<string|int, Input>|Input>
    $dataBind
     = []

Using another input as reference (type=>mark)

$disabled


    protected
        array<string|int, bool>
    $disabled
     = []

$editModes


    protected
    static    array<string, int>
    $editModes
     = ['write' => 1, 'read' => 1, 'disable' => 1, 'hide' => 1, 'dummy' => 1]

Show modes

$groups


    protected
        array<string|int, string>
    $groups
     = []

$name


    protected
        array<string, string>
    $name

LABEL name, TABLE name, SCRIPT name, TITLE input description text

$names


    protected
    static    array<string, int>
    $names
     = ['LABEL' => 1, 'TITLE' => 1, 'TABLE' => 1, 'PLACEHOLDER' => 1, 'SCRIPT' => 1]

$options


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

$rules


    protected
        array<string|int, Rule>
    $rules
     = []

Appended rules for input

$saveModes


    protected
    static    array<string|int, int>
    $saveModes
     = [
    'var' => 1,
    'const' => 1,
    'default' => 1,
    0 => 1,
    // FALSE
    '' => 1,
]

Value modes - allow FALSE and NULL

__construct()

Basic input settings


    public
                    __construct(string $mark, array<string, string>|string $name[, array{EMPTY?: bool, MODE?: string, SAVE?: string|bool|null, TABLE?: bool, FILTER?: mixed, ID?: string|int}|bool $sets = [] ][, mixed $value = [] ][, array<string|int, array<string|int, mixed>> $option = [] ][, array<string|int, string> $groups = [] ]) : mixed

Parameters

$mark : string: Input name
$name : array<string, string>|string: Label text
$sets : array{EMPTY?: bool, MODE?: string, SAVE?: string|bool|null, TABLE?: bool, FILTER?: mixed, ID?: string|int}|bool = []
$value : mixed = []
$option : array<string|int, array<string|int, mixed>> = []
$groups : array<string|int, string> = []

__toString()


    public
                    __toString() : string

Return values

string

addBind()

Bind other inputs which interact with current one


    public
                    addBind(Input $input[, string|null $type = null ]) : self

Parameters

$input : Input
$type : string|null = null

Return values

self

delete()

Action associated with deleting a master record


    public
                    delete() : string|bool

Return values

string|bool

duplicate()

Duplicate content from another input via POST/GET


    public
                    duplicate(int $fromId[, string|null $fromMark = null ]) : void

Parameters

$fromId : int
$fromMark : string|null = null

getAssetScripts()

Get javascript files


    public
                    getAssetScripts(bool $edit) : array<string, mixed>|null

Parameters

$edit : bool

Return values

array<string, mixed>|null

getBind()

Get specified input bind-type


    public
                    getBind(string $type) : array<string|int, Input>|Input|null

Parameters

$type : string

Return values

array<string|int, Input>|Input|null

getBinds()

Get bounded inputs


    public
                    getBinds() : array<string|int, array<string|int, Input>|Input>

Return values

array<string|int, array<string|int, Input>|Input>

getClass()

Get input classes


    public
                    getClass() : string

Return values

string

getForm()

Get full form visualization


    public
                    getForm([string|bool $label = true ][, array{0: string, 1?: string|null, 2?: bool}|null $elem = ['p'] ][, string $post = '' ]) : string

Parameters

$label : string|bool = true
$elem : array{0: string, 1?: string|null, 2?: bool}|null = ['p']
$post : string = ''

Return values

string

getHide()

Get input for type hidden


    public
                    getHide() : string

Return values

string

getInput()

Get <input /> html


    public
                    getInput() : string

Return values

string

getJMark()

Get javascript input var name


    public
                    getJMark() : string

Return values

string

getLabel()

Get html for <label />


    public
                    getLabel([string|null $class = null ]) : string

Parameters

$class : string|null = null

Return values

string

getName()

Get input name based on place


    public
                    getName([string $type = 'TABLE' ]) : string

Parameters

$type : string = 'TABLE'

Return values

string

getOptions()


    public
                    getOptions() : array<string|int, array<string|int, mixed>>

Return values

array<string|int, array<string|int, mixed>>

getOptList()


    public
                    getOptList(array<string|int, mixed> $list) : string

Parameters

$list : array<string|int, mixed>

Return values

string

getRule()

Get selected input rule


    public
                    getRule(string $type) : Rule|null

Parameters

$type : string

Return values

Rule|null

getRules()

Return input rules


    public
                    getRules() : array<string|int, Rule>

Return values

array<string|int, Rule>

getScript()

Javascript code for form visualization


    public
                    getScript(string $jForm[, array<string, mixed> $base = [] ][, array<string, mixed> $para = [] ]) : string|null

Parameters

$jForm : string
$base : array<string, mixed> = []
$para : array<string, mixed> = []

Return values

string|null

getScriptTable()

Javascript code for table visualization


    public
                    getScriptTable() : string|null

Return values

string|null

getSize()

Gets adequate css class for input size


    public
                    getSize([int $crop = 0 ]) : string

Parameters

$crop : int = 0

Return values

string

getTable()

Get input's value for presentation in list/table


    public
                    getTable() : array{VALUE: string, CLASS?: string, REWRITE?: bool}

Return values

array{VALUE: string, CLASS?: string, REWRITE?: bool}

getText()

Get input's value for visualization


    public
                    getText() : string

Return values

string

getValue()

Get input raw value


    public
                    getValue() : string|float|int|null

Return values

string|float|int|null

isEmpty()

Is input empty


    public
                    isEmpty() : bool

Return values

bool

isQuotes()

Are magic quotes active


    public
                    isQuotes() : bool

Return values

bool

isValid()

Is input valid


    public
                    isValid() : bool

Return values

bool

load()

Load POST/GET value


    public
                    load() : void

resetBinds()

Remove bounded inputs


    public
                    resetBinds() : void

resetRules()

Remove input rules


    public
                    resetRules() : void

set()

Set input value


    public
                    set(array<string, mixed> $array[, bool $force = false ]) : self

Parameters

$array : array<string, mixed>
$force : bool = false

Return values

self

setGroups()


    public
                    setGroups(array<string|int, string> $groups) : self

Parameters

$groups : array<string|int, string>

Return values

self

setId()

Set form ID


    public
                    setId(string|int $id) : self

Parameters

$id : string|int

Return values

self

setMode()

Set input work mode


    public
                    setMode(string $mode) : self

Parameters

$mode : string

Return values

self

setName()

Set input descriptions


    public
                    setName(array<string, string>|string $name[, string|null $type = null ]) : self

Parameters

$name : array<string, string>|string
$type : string|null = null

Return values

self

setOptions()


    public
                    setOptions(array<string|int, array<string|int, mixed>> $options) : self

Parameters

$options : array<string|int, array<string|int, mixed>>

Return values

self

setRequired()

Set required message


    public
                    setRequired([bool $require = true ][, string|null $msg = null ]) : self

Parameters

$require : bool = true
$msg : string|null = null

Return values

self

setRule()

Set input rule of selected type


    public
                    setRule(string $type, Rule $rule) : self

Parameters

$type : string
$rule : Rule

Return values

self

setSave()

Set input save mode


    public
                    setSave(string|bool|null $mode) : self

Parameters

$mode : string|bool|null

Return values

self

setValue()

Set input value


    public
                    setValue(mixed $val) : self

Parameters

$val : mixed

Return values

self

translate()

Translate input and rules descriptions


    public
                    translate(Translator $tr) : void

Parameters

$tr : Translator

update()

Get data for storage update from form


    public
                    update() : array<string, mixed>|string|null

Return values

array<string, mixed>|string|null

updateTable()

Get sql request for action from table


    public
                    updateTable(array<string, mixed>|string $action) : array<string|int, string>|bool

Parameters

$action : array<string, mixed>|string

Return values

array<string|int, string>|bool

getInpName()

Get input element name


    protected
                    getInpName() : string

Return values

string

getMethod()


    protected
        final    static    &    getMethod() : array<string|int, string|mixed>

Return values

array<string|int, string|mixed>

getPost()

Get POST/GET data and filter them


    protected
                    getPost() : mixed

getPostData()

Get POST/GET raw data


    protected
                    getPostData() : mixed|null

Return values

mixed|null

getValueForm()

Get value for input


    protected
                    getValueForm() : string

Return values

string

inputBasic()

Get general part of <input /> tag


    protected
                    inputBasic([string|null $append = null ]) : string

Parameters

$append : string|null = null

Return values

string

isTransmitted()

Is (must be) input included in POST/GET


    protected
                    isTransmitted() : bool

Return values

bool

jErrors()

Get error messages for javascript


    protected
        final            jErrors(string $jInput) : string

Parameters

$jInput : string

Return values

string

modify()

Change value based on input class/type


    protected
                    modify(mixed $val) : mixed

Parameters

$val : mixed

InputSelectGroups extends Input in package Phpxform

Table of Contents

Properties

Methods

Properties

$baseDir

$bindTypes

$class

$empty

$error

$filter

$id

$jsType

$mark

$method

$mode

$quotes

Tags

$save

$size

$sizeClass

$table

$value

$valueInit

$dataBind

$disabled

$editModes

$groups

$name

$names

$options

$rules

$saveModes

Methods

__construct()

Parameters

__toString()

Return values

addBind()

Parameters

Tags

Return values

delete()

Return values

duplicate()

Parameters

getAssetScripts()

Parameters

Return values

getBind()

Parameters

Return values

getBinds()

Return values

getClass()

Return values

getForm()

Parameters

Return values

getHide()

Return values

getInput()

Return values

getJMark()

Return values

getLabel()

Parameters

Return values

getName()

Parameters

Return values

getOptions()

Return values

getOptList()

Parameters

Return values

getRule()

Parameters

Return values

getRules()

InputSelectGroups extends Input
in package

Phpxform