SproutCMS

class JsonForm

Processes forms using configuration stored in a JSON file which specifies database columns, their HTML input fields,
and validation rules.
A generic implementation which should work for most cases is found in ManagedAdminController::_getEditForm
(generates the form) and Controller::saveJsonData (saves the POST submission)

• File: /sprout/Helpers/JsonForm.php
• Namespace: Sprout\Helpers
• Extends: Form

Variables

Functions

public __callStatic (from Form)

Auto-wrapper around Fb methods

Will wrap the Fb method with the same name as the called method, e.g. Form::datepicker wraps Fb::datepicker
Wrapping is done using Form::fieldAuto

private argReplace

Replace magic strings in "args" arrays with various metadata values

Replacements:
    %%       The current record id

public autofillList (from Form)

Returns HTML for an auto-complete list of records

The form data for this field should be an array of arrays with at least the following keys:
[
    'id' => record ID,
    'value' => title text visible in the list item,
    'orderkey' => ordinal value for record ordering
]

public autofillOptionDefaults

Determine the auto-generated default values for an autofill-list

Defaults:
    joiner_local_col        Singular of local table name + '_id'
    joiner_foreign_col      Singular of the foreign_table option + '_id'
    foreign_label_col       'name'
    reorder                 false

protected changeFieldRequired

Modify a JSON form config to change the 'required' status of a particular field
This implements JsonForm::makeOptional and JsonForm::makeRequired

public checkboxList (from Form)

Returns HTML for a list of checkboxes, applying name conversions along the way

Uses Fb::checkboxBoolList to generate the underlying checkbox list

public collateData

Collates POST data using specified config options

protected collateFieldData

Collates a single field's $_POST data for INSERT/UPDATE queries, and performs validation

protected convertFieldName (from Form)

Format a field name as per the specification defined by Form::setFieldNameFormat

public expandItemDefns

Expands item definitions for a field pulled from JSON

public fieldAuto (from Form)

Return HTML for a field, with the wrapping HTML detected automatically.

To enable fieldset wrapping, add the docblock tag @wrap-in-fieldset to the field generation method

public fieldFieldset (from Form)

Return HTML for a field wrapped in a FIELDSET

The main wrapping DIV will contain additional classes if the field is required, disabled or has an error.
A class is also output for hte field method name (if the name contains "Sprout\Helpers\Fb::" this is removed)
If the field has an explicit ID set, that will be added as a class on the wrapper too.

The special attribute "-wrapper-class" can be used to add classes to the wrapper DIV.
Multiple classes can be specified, space separated.
These classes will be prefixed with "field-element--"

protected fieldMethodClass (from Form)

Convert a full method name (e.g. Sprout\Helpers\Fb::text) into a friendly class name

The classes Fb and Form aren't emitted, but all other class names are

public fieldPlain (from Form)

Return HTML for a 'plain' field, i.e. one which doesn't require a FIELDSET wrapped around it.

The main wrapping DIV will contain additional classes if the field is required, disabled or has an error.
A class is also output for the field method name (if the name contains "Sprout\Helpers\Fb::" this is removed)
If the field has an explicit ID set, that will be added as a class on the wrapper too.

The special attribute "-wrapper-class" can be used to add classes to the wrapper DIV.
Multiple classes can be specified, space separated.
These classes will be prefixed with "field-element--"

public flattenGroups

Extract field defns from a list (which may include groups)

protected genId (from Form)

Generate a unique id which should be stable across calls to this URL
as long as the number and order of fields on the page remains the same

public getData (from Form)

Gets the form per-field value for a single field

As form field datas are stored using the Fb class, this method just gets the data from there

public getFieldErrors (from Form)

Return the errors for a given field

Supports nested error arrays; If $field_name is something like member[5][test] then the error
will be read from self::$errors['member']['5']['test']

public html (from Form)

Return HTML which has been wrapped in the form field DIVs

public loadAutofillListData

Loads autofill_list data for use on a view

public loadFromSession (from Form)

Load data and errors from the session, with optional record id validation

Expected session keys:
    record_id       Checked against $verify_record_id, session data is thrown away in case of mismatch
    field_values    Field data, loaded using Form::setData
    field_errors    Field errors, loaded using Form::setErrors

public loadMultiEditData

Loads multiedit data for use on a view

public makeOptional

Modify a JSON form config to make a particular field optional

public makeRequired

Modify a JSON form config to make a particular field required

public money (from Form)

Returns HTML for a money field, using Fb::money to generate the field itself

public multiradio (from Form)

Returns HTML for a bunch of radiobuttons, using Fb::multiradio to generate the fields

public nextFieldDetails (from Form)

Set the details for the next field which will be outputted.

After returning a field, these values will be cleared from the state machine

Both the label and helptext support a subset of HTML, Text::limitedSubsetHtml for more details

public number (from Form)

Returns HTML for a number field, using Fb::number to generate the field itself

public out (from Form)

Return content which has been HTML-encoded and wrapped in the form field DIVs

protected passString (from Form)

Returns the first argument

This hacky little method works around the fact that fieldPlain only accepts a method name

public password (from Form)

Returns HTML for a password field, using Fb::password to generate the field itself

public renderField

Renders the input for a field definition pulled from a JSON file

public renderTabItem

Render a tab item, which may be a field, heading, html block, etc

public resetField (from Form)

Reset the state machine for field values

public setData (from Form)

Set form per-field values for the fields

As form fields are rendered using the Fb class, this method just sets the data there

public setErrors (from Form)

Set per-field error messages to display

A given field can have either a single error message or an array of errors
The output from the Validator::getFieldErrors method can be used directly as input to this method

public setFieldIdPrefix (from Form)

Sets the prefix for generated IDs

public setFieldNameFormat (from Form)

Set a format string which will alter the field name prior to being passed to the underlying render method

Formatting is done using sprintf
A single parameter is provided to the sprintf() call, the field name
The default format does no transformation, i.e. the string '%s'
This parameter persists across multiple form fields

public setFieldValue (from Form)

Sets the value for a single field

As form fields are rendered using the Fb class, this method just sets the data there

public setParameterForColumns

Set a parameter for fields to be a specific value, for one or more columns

public text (from Form)

Returns HTML for a text field, using Fb::text to generate the field itself