\SioSignOut

success()

success() : boolean

Wrapper to the $committed variable.

Used to identify whether or not the formlet has committed. Will be true only during a post, when the inputs are all valid, and the commit has occured.

Returns

setcommit()

setcommit(boolean  $state = true) 

Wrapper to the $committed variable.

Used to set the formlet as if it were committed. This is typically used via a func() operator overload.

Parameters

newId()

newId() : integer

Wrapper to the $newid variable.

Provides access to an auto_incremented primary key after a commit.

Returns

valid()

valid() : boolean

Wrapper to the $valid variable.

Indicates if the formlet was found to be valid. When validation is out of scope, a formlet is always valid.

Returns

getId()

getId() : integer

Wrapper to the $id variable.

Returns the registered id for this formlet. A formlet's id must be unique for the form within which it is placed.

Returns

delete()

delete() 

Simple delete function which may be over-ridden.

This is typically called via a func() 'delete' being implemented.

validate()

validate() : \optional

This is the validation code block of the formlet.

Except for formlets that require no validation, it will be over-ridden. This code block should set the boolean value $this->valid, to indicate validity of the formlet.

Returns

bool indicating whether or not the formlet is valid.

populate()

populate() 

This is the populate code block of the formlet.

Except for formlets that require no population, it will be over-ridden. This code block is responsible for populating the formlet view with data:

• after a successful commit
• during a get, where the form is an editing a record.

sig()

sig() 

inScope()

inScope() 

'inScope' used to test if a particular class of form is being posted.

isMe()

isMe() 

'isMe' used to test if a particular form instance is being posted.

seterr()

seterr(  $ident = NULL,   $value = NULL) 

'seterr'

Parameters

setfld()

setfld(  $name = NULL,   $gsql = NULL,   $csql = NULL) 

'setfld'

Parameters

setsub()

setsub(  $name = NULL,   $dshow = true) 

'setsub'

Parameters

vset()

vset(  $input = '_unused',   $kind = NULL,   $special = NULL) 

'vset'

Parameters

formlets()

formlets(  $fms = array(),   $valfn = NULL,   $show = true) 

'formlets' Processes multiple interdependent formlets, preventing invalidity from commits.

All formlets must be processed for a commit. Call reveal() for each fm after this. LIMITATIONS: currently this does not support subscribers (which should be orthogonal) or functions.

Parameters

setfrompost()

setfrompost() 

forminfo()

forminfo() 

form()

form(  $show = true) 

'form'

Parameters

reveal()

reveal() 

setfields()

setfields(  $inpost = false) 

'setfields'

Parameters

redirection()

redirection(  $redirect = NULL,   $insert_qs = NULL,   $newid) 

Parameters

valMacro()

valMacro(  $name = '',   $msg = "Invalid Macrotext") 

validation functions

Parameters

valEmail()

valEmail(  $name = '',   $msg = "This must be a valid email address") 

Parameters

valSignificant()

valSignificant(  $name = '',   $msg = "This must have a value") 

Parameters

valNumeric()

valNumeric(  $name = '',   $msg = " This must be a number.") 

Parameters

valInt()

valInt(  $name = '',   $msg = " This must be a whole number.") 

Parameters

valNotZero()

valNotZero(  $name = '',   $msg = " This must be filled correctly.") 

Parameters

valNoWhitespace()

valNoWhitespace(  $name = '',   $msg = " This must contain no whitespace.") 

Parameters

valString()

valString(  $name = '',   $msg = "This must be a string") 

Parameters

valUnique()

valUnique(  $name = '',   $msg = "This must be unique") 

Parameters

__construct()

__construct(  $key = NULL) 

'__construct'

Parameters

initialise()

initialise(  $use_un = true,   $custom_views = array()) 

Parameters

func()

func() 

'func' fn overloading of trait 'Form'.

iniForm()

iniForm(  $idp = '',   $vp = NULL,   $vprefix = true,   $pk = 'id',   $debug = false) 

'iniForm' To be used in __construct methods.

vprefix = prefix sig to data-tr in form views.

Parameters

pkeysql()

pkeysql() 

'pkeysql'

vsetopts()

vsetopts(  $input = '_unused',   $qvp = 'select 0 as prompt,0 as value',   $v = NULL) 

'vsetopts'

Parameters

subscriber()

subscriber(  $name = NULL,   $orig = NULL) 

'subscriber' This is called only during a post. so we need to find out the current state of the sql.

Parameters

commit()

commit() 

'commit' fn OVERLOADING trait 'Form'.

ident()

ident() 

setId()

setId(  $id) 

Parameters

setsubsvalue()

setsubsvalue()