SproutCMS

class Fb

Quick and easy form builder

• File: /sprout/Helpers/Fb.php
• Namespace: Sprout\Helpers

Variables

ID for use on the field label and input/select/etc. element

Extra class(es) for use on div.field-wrapper, div.label, and div.field to support additional styling.
N.B. If this is set, all inputs will be wrapper in a div.field

Functions

protected addAttr

Adds an HTML attribute to the list of attributes.
If the attribute has already been set, it will be left alone.
N.B. the 'class' attribute is always appended

public autoCompleteAddress

Renders google autocomplete address fields

public autocomplete

Returns HTML for an autocomplete selection menu.
Expects to be provided AJAX data in a format defined by jQuery UI (see 'url' option below).
By default, this expects to stores an ID value for a foreign key. If this isn't the desired
behaviour, a plain text value can be stored by setting the 'save_id' option to false.

The URL which handles the lookups needs to use the 'term' GET param to find matching values.
If 'save_id' is true, then it also needs to accept the 'id' GET param to fetch the label for the relevant id.
A call to the URL should return JSON which contains an array of hashes, each with the following keys:
- 'value': data for the text input.
- 'label': data for display in the drop-down list (if different from value).
           This is used as the value if 'value' isn't specified.
- 'id': id value to save. This should only be specified if 'save_id' is true; see below.

public autocompleteList

Render autocomplete multi-list

protected checkbox

Returns the HTML for a single checkbox

public checkboxBoolList

Returns HTML containing multiple boolean checkboxes

public checkboxSet

Returns HTML containing multiple checkboxes, with values to store in a SET column or similar

public chunkedUpload

Generates a file upload field with a progress bar

To easily save the uploaded files in the form action function, see File::replaceSet

public colorpicker

Renders a colour picker

Uses the HTML5 'color' input type, and loads a JS fallback (spectrum)
http://bgrins.github.io/spectrum/
Note that spectrum requires jQuery 1.6 or later

public conditionsList

A conditions list, which is an interface for building rules for
use in dynamic IF-statement style systems.

Output POST data will be a JSON string of the condition rules,
as an array of objects with the keys 'field', 'op', 'val' for
each condition.

There are two parameters:
   fields   array    Available field types, name => label
   url      string   AJAX lookup method which returns the
                     operator and value lists

The lookup url is provided GET params 'field', 'op', 'val' and
should output JSON with two keys, 'op' and 'val', which are both
strings containing HTML for the fields; the op field should be
a SELECT and the val field should be an INPUT or a SELECT.

public datepicker

Renders HTML containing a date selection UI. Output field value is in YYYY-MM-DD

public daterangepicker

Renders a date range picker. Output is in the form of two fields (given in name as a comma separated list) e.g.
name => date_start, date_end will result in two fields: date_start => YYYY-MM-DD, date_end => YYYY-MM-DD

public datetimepicker

Renders HTML containing a date-time selection UI. Output field value is in YYYY-MM-DD HH:MM:SS

public datetimerangepicker

Renders a datetime range picker

Output is in the form of two fields (given in name as a comma separated list) e.g.
$name = 'date_start,date_end' will result in two fields:
date_start => YYYY-MM-DD HH:MM:SS, date_end => YYYY-MM-DD HH:MM:SS

public dropdown

Generates a dropdown selection menu

public dropdownItems

Returns HTML for a list of OPTIONs, and depending on the input array, OPTGROUP tags.

public dropdownTree

Generates a dropdown selection menu from a Treenode and its children

private dropdownTreeItem

Used internally for recursive dropdown generation.

public email

Renders a HTML5 email field

public fileSelector

A file selection field, for use in the admin only.

private genId

Generate a unique id

public geocodeAddress

Renders place name geocoding fields

public getData

Gets the data for a single field from the data array

Properly handles PHP sub-arrays (e.g. 'options[food]'), doesn't handle
anon arrays though (e.g. 'options[]').

public googleMap

Render map location selector
Zoom field is optional

public heading

Generates a heading using a H3 tag

public hiddenFields

Renders a set of hidden fields

protected injectId

Injects the current auto-generated id into an array of attributes.
Only applies if an auto-generated id exists and an id isn't already set in the attributes.
The auto-generated id is then cleared.

public input

Generates an HTML INPUT tag using Fb::tag, with auto-determined value

public lnk

Render the UI for our multi-type link fields

public money

Shows a HTML5 number field, formatted for dollar prices

public multiline

Generates a multiline text field

public multipleFileSelect

UI for selecting or drag-and-drop uploading one or more files.

The field (refrenced by $name) is an array. If it's passed a a string, it will be comma-separated into an array.
As JsonForm will auto-convert arrays into comma-separated strings, this field can easily be used with a MySQL
field of type TEXT.

You cannot have more than one of these on the page at a time

This field WILL NOT operate in a non-admin environment

public multiradio

Returns HTML for a bunch of radiobuttons

public number

Shows a HTML5 number field

public output

Outputs the value of the field directly, in a span

public pageDropdown

Generates a page dropdown selection menu

Just a wrapper for Fb::dropdownTree

public password

Generates a password field

public phone

Renders a HTML5 phone number field (type=tel)

public randomCode

Render a 'generate code' button + text field

public range

Generates a HTML5 range field

public richtext

Generates a richtext field - i.e. TinyMCE

public setData

Sets the data that is used for form-building
This is typically from a database row or saved session data
To set a single field, instead use Fb::setFieldValue

public setDropdownTop

Sets the text for the top item of dropdown lists.
Set to an empty string to not show the top item.
This will be reset to the default value after every call to Fb::dropdown

public setFieldValue

Sets the value for a single field
This is the non-array version of Fb::setData

public simpledaterangepicker

Renders simplified date range picker,
Output is in the form of two fields (given in name as a comma separated list) e.g.
name => date_start, date_end will result in two fields: date_start => YYYY-MM-DD, date_end => YYYY-MM-DD

public tag

Generates an HTML opening tag, and possibly its closing tag, depending on the params specified

You can specify either HTML or plain-text content, but not both

public text

Generates a text field

public timepicker

Renders a timepicker field inside a SPAN, which displays a dropdown date selection box when clicked

public title

Generates the title for a field, possibly enclosing it in a label, possibly with a generated ID

public totalselector

Renders HTML containing a total selector UI. Output field value for the total is in
a hidden field. The specific counts for each are also available

public upload

Generates a file upload field