\apex\core\formnotification

Summary

Methods
Properties
Constants
get_fields()
get_record()
validate()
$allow_post_values
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$allow_post_values

$allow_post_values :

Type

Methods

get_fields()

get_fields(array  $data = array()): array

Defines the form fields included within the HTML form.

@param array $data An array of all attributes specified within the e:function tag that called the form.

Parameters

array $data

Any attributes passed in the tag.

Returns

array —

Keys of the array are the names of the form fields. Values of the array are arrays that specify the attributes of the form field. Refer to documentation for details.

get_record()

get_record(string  $record_id): array

Method is called if a 'record_id' attribute exists within the e:function tag that calls the form. Will retrieve the values from the database to populate the form fields with.

Parameters

string $record_id

The value of the 'record_id' attribute from the e:function tag.

Returns

array —

An array of key-value pairs containg the values of the form fields.

validate()

validate(array  $data = array())

Allows for additional validation of the submitted form.

The standard server-side validation checks are carried out, automatically as designated in the $form_fields defined for this form. However, this allows additional validation if warranted.

Parameters

array $data

Any array of data passed to the registry::validate_form() method. Used to validate based on existing records / rows (eg. duplocate username check, but don't include the current user).