Phpxforms documentation

InputFile extends InputText
in package

Phpxform

implements MultipleInput, InFileApi

For InputFile - bound inputs_ PATH, EXT, SIZE must be after FILE - inserting data into inputs -> it would not be reflected when writing to database File extension is always converted to lower case

Interfaces

MultipleInput: Interface for multiform input support
InFileApi: Inject FileApi into the input

Properties

$addon : array<int, string>|null
$allowHtml : bool
$autoComplete : string|null
$baseDir : string
$bindTypes : array<string, int>
$class : string
$copy : bool
$empty : bool
$error : array<string|int, string>
$filter : array<string, string>|string|bool
$id : string|int
$jsType : string|null
$mark : string
$maxSize : int
$method : int
$mode : string
$oldValue : string
$quotes : bool
$rewrite : bool
$sanitize : string
$save : string|bool|null
$showForm : bool
$showTable : bool
$size : int
$sizeClass : string
$table : bool
$tabSize : int
$value : mixed|null
$valueInit : mixed|null
$dataBind : array<string|int, array<string|int, Input>|Input>
$editable : bool
$editModes : array<string, int>
$file : string
$fileApi : FileApi
$fileName : string
$name : array<string, string>
$names : array<string, int>
$path : array<string, Input|string>
$pathStatic : string
$rules : array<string|int, Rule>
$saveModes : array<string|int, int>
$switch : bool
$type : string
$upload : bool

Methods

__construct() : mixed: Basic input settings
__toString() : string
addBind() : self: Bind other inputs which interact with current one
delete() : bool: Delete file
duplicate() : void
fileExist() : bool
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
getExt() : string
getFile() : string|null
getFileSize() : int|null
getForm() : string: Get full form visualization
getGlobalInput() : string: Get input for multi-upload inside form
getGlobalScript() : string: Get javascript for multi-upload
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
getRule() : Rule|null: Get selected input rule
getRules() : array<string|int, Rule>: Return input rules
getScript() : string|null
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
getValue() : string|float|int|null: Get input raw value
globalDuplicate() : void: Split selected values from multi-upload (without javascript)
injectFileApi() : void
isDeletable() : bool
isEmpty() : bool: Is input empty
isQuotes() : bool: Are magic quotes active
isUploaded() : bool
isValid() : bool
load() : void: Insert FILE values to bound POST inputs
move() : void
resetBinds() : void: Remove bounded inputs
resetRules() : void: Remove input rules
sanitize() : string: By default, fix possible problems with Windows (file duplicates, spec. chars in names)
set() : self
setAddon() : self
setFileSize() : self
setFilter() : self
setId() : self: Set form ID
setMaxLength() : self
setMime() : self
setMinLength() : self
setMode() : self: Input file can not be READONLY
setName() : self: Set input descriptions
setPattern() : self
setRequired() : self: Set required message
setRule() : self: Set input rule of selected type
setSave() : self: Set input save mode
setShow() : self
setValue() : self: Set input value
translate() : void: Translate input and rules descriptions
update() : array<string, string|null>|null: Upload file on server
updateTable() : array<string|int, string>|bool: Get sql request for action from table
appendAddon() : string: Add addons to input
check() : bool: Check length settings
getFileName() : string: Create new file name
getInpName() : string: Get input element name
getInputEmpty() : string
getInputFull() : string
getInputPreview() : string
getMaxLength() : int|null
getMethod() : array<string|int, string|mixed>
getPath() : string
getPost() : mixed: Get POST/GET data and filter them
getPostData() : mixed|null: Get POST/GET raw data
getType() : string
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
modValue() : string|null
noDbFile() : void
setBindData() : void: Inserts new data to connected inputs
setBindDataValue() : void
upload() : array<string, string>|null
wrapInputButton() : string

$addon


    public
        array<int, string>|null
    $addon
     = null

Input prefix or suffix

$allowHtml


    public
    static    bool
    $allowHtml
     = false

$autoComplete


    public
        string|null
    $autoComplete
     = null

Autocomplete attribute

$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

$copy


    public
        bool
    $copy
     = false

Copy or move uploaded file (used for record duplication)

$empty


    public
        bool
    $empty
     = true

Can be empty, default true

$error


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

Error messages

$filter


    public
        array<string, string>|string|bool
    $filter
     = false

Filter type and allow in table settings (false / true / text / number / check / option - need getOption() )

$id


    public
        string|int
    $id

ID of form where input is

$jsType


    public
    static    string|null
    $jsType
     = 'jInputFile'

$mark


    public
        string
    $mark

Input element name and db column

$maxSize


    public
    static    int
    $maxSize
     = 70

$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 )

$oldValue


    public
        string
    $oldValue

Old file from database

$quotes


    public
    static    bool
    $quotes
     = null

$rewrite


    public
        bool
    $rewrite
     = false

File being uploaded can replace an existing file

$sanitize


    public
    static    string
    $sanitize
     = 'FULL'

$save


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

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

$showForm


    public
        bool
    $showForm
     = true

Show preview in form

$showTable


    public
        bool
    $showTable
     = true

Show preview in table

$size


    public
        int
    $size

Size of input

$sizeClass


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

CSS class prefix

$table


    public
        bool
    $table
     = true

Show in table, default true

$tabSize


    public
    static    int
    $tabSize
     = 250

$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)

$editable


    protected
        bool
    $editable
     = true

Can be edited/replaced after save

$editModes


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

Show modes

$file


    protected
        string
    $file
     = ''

File rename

$fileApi


    protected
        FileApi
    $fileApi

$fileName


    protected
        string
    $fileName

Original file name

$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]

$path


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

Dynamic part of upload path

$pathStatic


    protected
        string
    $pathStatic
     = ''

Static part of upload path

$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

$switch


    protected
        bool
    $switch
     = false

Switch order of static and dynamic part in upload path

$type


    protected
    static    string
    $type
     = 'text'

$upload


    protected
        bool
    $upload
     = false

Uploaded file is ok

__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 = [] ][, array{NAME?: string, PATH?: string, MIME?: string, MAXSIZE?: int, SWITCH?: bool, EDITABLE?: bool, REWRITE?: bool, SHOW?: bool}|string $value = [] ][, array<string, int>|int $lengths = [] ][, array<string|int, string> $filter = [] ]) : 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 : array{NAME?: string, PATH?: string, MIME?: string, MAXSIZE?: int, SWITCH?: bool, EDITABLE?: bool, REWRITE?: bool, SHOW?: bool}|string = []
$lengths : array<string, int>|int = []
$filter : array<string|int, string> = []: Allowed extensions

__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()

Delete file


    public
                    delete([bool $new = true ]) : bool

Parameters

$new : bool = true: True if file does not exist or was successfully deleted

Return values

bool

duplicate()


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

Parameters

$fromId : int
$fromMark : string = null

fileExist()


    public
                    fileExist([bool $saved = true ]) : bool

Parameters

$saved : bool = true

Return values

bool

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

getExt()


    public
                    getExt(string $name) : string

Parameters

$name : string

Return values

string

getFile()


    public
                    getFile([bool $saved = true ]) : string|null

Parameters

$saved : bool = true

Return values

string|null

getFileSize()


    public
                    getFileSize() : int|null

Return values

int|null

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

getGlobalInput()

Get input for multi-upload inside form


    public
                    getGlobalInput(mixed $parentId, int $type) : string

Parameters

$parentId : mixed
$type : int

Return values

string

getGlobalScript()

Get javascript for multi-upload


    public
                    getGlobalScript(string $jMark) : string

Parameters

$jMark : 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

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()


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

Parameters

$jForm : string
$base : array<string|int, mixed> = []
$para : array<string|int, 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()


    public
                    getText() : string

Return values

string

getValue()

Get input raw value


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

Return values

string|float|int|null

globalDuplicate()

Split selected values from multi-upload (without javascript)


    public
                    globalDuplicate(int $parentId, int $type, int $ident) : void

Parameters

$parentId : int
$type : int
$ident : int

injectFileApi()


    public
                    injectFileApi(FileApi $api) : void

Parameters

$api : FileApi

isDeletable()


    public
                    isDeletable() : bool

Return values

bool

isEmpty()

Is input empty


    public
                    isEmpty() : bool

Return values

bool

isQuotes()

Are magic quotes active


    public
                    isQuotes() : bool

Return values

bool

isUploaded()


    public
                    isUploaded() : bool

Return values

bool

isValid()


    public
                    isValid() : bool

Return values

bool

load()

Insert FILE values to bound POST inputs


    public
                    load() : void

move()


    public
                    move([string $from = '' ][, string $to = '' ]) : void

Parameters

$from : string = ''
$to : string = ''

resetBinds()

Remove bounded inputs


    public
                    resetBinds() : void

resetRules()

Remove input rules


    public
                    resetRules() : void

sanitize()

By default, fix possible problems with Windows (file duplicates, spec. chars in names)


    public
            static        sanitize(string $value) : string

Parameters

$value : string

Return values

string

set()


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

Parameters

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

Return values

self

setAddon()


    public
                    setAddon(array<int, string>|string $addon) : self

Parameters

$addon : array<int, string>|string

Return values

self

setFileSize()


    public
                    setFileSize(float $size[, string|null $msg = null ]) : self

Parameters

$size : float: Size in megabytes
$msg : string|null = null

Return values

self

setFilter()


    public
                    setFilter(array<string|int, string> $types[, string|null $msg = null ]) : self

Parameters

$types : array<string|int, string>
$msg : string|null = null

Return values

self

setId()

Set form ID


    public
                    setId(string|int $id) : self

Parameters

$id : string|int

Return values

self

setMaxLength()


    public
                    setMaxLength(int $val[, string|null $msg = null ]) : self

Parameters

$val : int
$msg : string|null = null

Return values

self

setMime()


    public
                    setMime(string $mime[, string $msg = null ]) : self

Parameters

$mime : string
$msg : string = null

Return values

self

setMinLength()


    public
                    setMinLength(int $val[, string|null $msg = null ]) : self

Parameters

$val : int
$msg : string|null = null

Return values

self

setMode()

Input file can not be READONLY


    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

setPattern()


    public
                    setPattern(string $pattern[, string|null $msg = null ]) : self

Parameters

$pattern : string
$msg : string|null = null

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

setShow()


    public
                    setShow(array<string, bool>|bool $show) : self

Parameters

$show : array<string, bool>|bool

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()

Upload file on server


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

Return values

array<string, string|null>|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

appendAddon()

Add addons to input


    protected
                    appendAddon(string $inp) : string

Parameters

$inp : string

Return values

string

check()

Check length settings


    protected
                    check(array<string, int> $array) : bool

Parameters

$array : array<string, int>

Return values

bool

getFileName()

Create new file name


    protected
                    getFileName(string|null $value[, string|null $file = null ][, bool $cut = true ]) : string

Parameters

$value : string|null
$file : string|null = null
$cut : bool = true

Return values

string

getInpName()

Get input element name


    protected
                    getInpName() : string

Return values

string

getInputEmpty()


    protected
                    getInputEmpty() : string

Return values

string

getInputFull()


    protected
                    getInputFull(string $path, string $file) : string

Parameters

$path : string
$file : string

Return values

string

getInputPreview()


    protected
                    getInputPreview(string $path, string $file) : string

Parameters

$path : string
$file : string

Return values

string

getMaxLength()


    protected
                    getMaxLength() : int|null

Return values

int|null

getMethod()


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

Return values

array<string|int, string|mixed>

getPath()


    protected
                    getPath(string $type[, string $path = '' ]) : string

Parameters

$type : string
$path : string = ''

Return values

string

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

getType()


    protected
                    getType() : string

Return values

string

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

modValue()


    protected
                    modValue(string|null $value) : string|null

Parameters

$value : string|null

Return values

string|null

noDbFile()


    protected
                    noDbFile() : void

setBindData()

Inserts new data to connected inputs


    protected
                    setBindData([array<string, mixed> $dataList = [] ][, bool $forced = false ]) : void

Parameters

$dataList : array<string, mixed> = []
$forced : bool = false

setBindDataValue()


    protected
                    setBindDataValue(Input $inp, mixed $val[, bool $forced = false ]) : void

Parameters

$inp : Input
$val : mixed
$forced : bool = false

upload()


    protected
                    upload(string $value) : array<string, string>|null

Parameters

$value : string

Return values

array<string, string>|null

wrapInputButton()


    protected
                    wrapInputButton(string $input) : string

Parameters

$input : string

Return values

string

InputFile extends InputText in package Phpxform implements MultipleInput, InFileApi

Table of Contents

Interfaces

Properties

Methods

Properties

$addon

$allowHtml

$autoComplete

$baseDir

$bindTypes

$class

$copy

$empty

$error

$filter

$id

$jsType

$mark

$maxSize

$method

$mode

$oldValue

$quotes

Tags

$rewrite

$sanitize

$save

$showForm

$showTable

$size

$sizeClass

$table

$tabSize

$value

$valueInit

$dataBind

$editable

$editModes

$file

$fileApi

$fileName

$name

$names

$path

$pathStatic

$rules

$saveModes

$switch

$type

$upload

Methods

__construct()

Parameters

Tags

__toString()

Return values

addBind()

Parameters

Tags

Return values

delete()

Parameters

Return values

duplicate()

Parameters

fileExist()

Parameters

Return values

getAssetScripts()

Parameters

Return values

getBind()

Parameters

Return values

getBinds()

Return values

getClass()

Return values

getExt()

InputFile extends InputText
in package

Phpxform

implements MultipleInput, InFileApi