FormSession
in package
Table of Contents
Methods
- errorAdd() : void
- Adds/updates form session error.
- errorAddAll() : void
- Adds form session errors. This will clobber existing errors.
- errorGet() : array<string|int, mixed>
- Fetch form field error.
- errorGetAll() : array<string|int, mixed>
- Fetch all form session errors.
- errorRemove() : void
- Removes error from form session variables.
- errorRemoveAll() : void
- Clears form session errors.
- isSet() : bool
- Determine if given form session field or form session as a whole is set.
- removeAll() : void
- Clear form session values and errors.
- valueAdd() : void
- Adds/updates form session variable.
- valueAddAll() : void
- Adds form session variables. This will clobber existing values.
- valueAddDefault() : void
- Adds default form session variable, if not set.
- valueGet() : mixed
- Fetch form session field value.
- valueGetAll() : array<string|int, mixed>
- Fetch form session field values.
- valueRemove() : void
- Removes value from form session variables.
- valueRemoveAll() : void
- Clears form session values.
Methods
errorAdd()
Adds/updates form session error.
public
static errorAdd(string $session, string $field, mixed $msg) : void
Parameters
- $session : string
-
Session key
- $field : string
-
Field name
- $msg : mixed
-
Error message
errorAddAll()
Adds form session errors. This will clobber existing errors.
public
static errorAddAll(string $session, array<string|int, mixed> $fields) : void
Parameters
- $session : string
-
Session key
- $fields : array<string|int, mixed>
-
Key value pairs [field => msgs, ...]
errorGet()
Fetch form field error.
public
static errorGet(string $session, string $field) : array<string|int, mixed>
Parameters
- $session : string
- $field : string
Return values
array<string|int, mixed>errorGetAll()
Fetch all form session errors.
public
static errorGetAll(string $session) : array<string|int, mixed>
Parameters
- $session : string
Return values
array<string|int, mixed>errorRemove()
Removes error from form session variables.
public
static errorRemove(string $session, string $field) : void
Parameters
- $session : string
-
Session key
- $field : string
-
Field name
errorRemoveAll()
Clears form session errors.
public
static errorRemoveAll(string $session) : void
Parameters
- $session : string
-
Session key
isSet()
Determine if given form session field or form session as a whole is set.
public
static isSet(string $session[, string $field = '' ]) : bool
Parameters
- $session : string
-
Session key
- $field : string = ''
-
Optional field name. If blank determines if any field values are set
Return values
boolremoveAll()
Clear form session values and errors.
public
static removeAll(string $session) : void
Parameters
- $session : string
-
Session key
valueAdd()
Adds/updates form session variable.
public
static valueAdd(string $session, string $field, mixed $value) : void
Parameters
- $session : string
-
Session key
- $field : string
-
Field name
- $value : mixed
-
Field value
valueAddAll()
Adds form session variables. This will clobber existing values.
public
static valueAddAll(string $session, array<string|int, mixed> $fields) : void
Parameters
- $session : string
- $fields : array<string|int, mixed>
-
Key value pairs [field => value, ...]
valueAddDefault()
Adds default form session variable, if not set.
public
static valueAddDefault(string $session, string $field, mixed $value) : void
Parameters
- $session : string
-
Session key
- $field : string
-
Field name
- $value : mixed
-
Field value
valueGet()
Fetch form session field value.
public
static valueGet(string $session, string $field) : mixed
Parameters
- $session : string
- $field : string
-
Field name
valueGetAll()
Fetch form session field values.
public
static valueGetAll(string $session) : array<string|int, mixed>
Parameters
- $session : string
Return values
array<string|int, mixed>valueRemove()
Removes value from form session variables.
public
static valueRemove(string $session, string $field) : void
Parameters
- $session : string
-
Session key
- $field : string
-
Field name
valueRemoveAll()
Clears form session values.
public
static valueRemoveAll(string $session) : void
Parameters
- $session : string
-
Session key