\Website\Pages\Forms
Templating
Global Functions
Website
\Components\Website\Designs \Components\Website\Media \Components\Website\Pages \Components\Website\Pages\Forms
DESCRIPTION
METHODS
delete()
get()
getAll()
getColumn()
getCount()
getLastSubmission()
getSubmissions()
save()
saveColumn()
search()
\Components\Website\Posts \Components\Website\Posts\Categories
Customers
\Components\Customers\Contacts \Components\Customers\Contacts\Relationships \Components\Customers\Contacts\Relationships\Types \Components\Customers\Groups
Marketing
\Components\Marketing\EmailMarketing \Components\Marketing\Events \Components\Marketing\Events\Attendees \Components\Marketing\Events\Categories \Components\Marketing\Events\Locations
Commerce
\Components\Commerce\Carts \Components\Commerce\Carts\Current \Components\Commerce\Configuration\PaymentMethods \Components\Commerce\Configuration\ShippingMethods \Components\Commerce\Discounts \Components\Commerce\Products \Components\Commerce\Products\Brands \Components\Commerce\Products\Categories \Components\Commerce\Products\Inventory \Components\Commerce\Sales \Components\Commerce\Sales\Items \Components\Commerce\Sales\Receipts \Components\Commerce\Sales\Receipts\Allocations
Settings
\Components\Settings\Administrators \Components\Settings\CustomFields \Components\Settings\Domains
Other Apps
\Components\Website\Comments \Components\Commerce\Affiliates \Components\Commerce\Affiliates\Administrators \Components\Commerce\Affiliates\Commissions \Components\Commerce\Affiliates\Payments \Components\Commerce\RecurringSales \Components\Commerce\RecurringSales\StoredCards
Framework
\Framework\Caching \Framework\Data\Util \Framework\DOM\CurrentContext \Framework\HTML\Converters \Framework\HTTP\Cookies \Framework\HTTP\Redirection \Framework\HTTP\Request \Framework\HTTP\Session \Framework\HTTP\UserAgent \Framework\I18N\CompanyTypes \Framework\I18N\Countries \Framework\I18N\Languages \Framework\Network\GeoIP

Forms

Use this API to create, update and delete website forms and their submissions.

If you are looking to develop your own form, please use the forms:form tag with recordsubmissions="true"

Methods

Invoke via \Components\Website\Pages\Forms::method()
Click a method name to copy it.
- ` bool delete($iFormId, $bDeleteMedia) `
Deletes a record from the database
Parameters:
- $iFormId
int
A record's form_id
- $bDeleteMedia
mixed
Return
Returns true if record existed and was deleted, otherwise false
- ` array get($iFormId) `
Gets a record from the database
Parameters:
- $iFormId
int
A record's form_id
Return
Forms
- ` array getAll($arrQuery) `
Return a set of records from the database
Parameters:
- $arrQuery
mixed
Return
Array of Forms
- ` mixed getColumn($iFormId, $strColumn) `
Gets a single field from a record
Parameters:
- $iFormId
int
A record's form_id
- $strColumn
mixed
Return
mixed
- ` int getCount($arrFilter) `
Returns the number of records in the database (matching the filter if specified)
Parameters:
- $arrFilter
mixed
Return
int
- ` array getLastSubmission($iFormId) `
Returns the last submission for a form for the current logged in user
Parameters:
- $iFormId
mixed
Return
array
- ` array getSubmissions($iFormId, $arrQuery) `
Returns the submissions for a given form id
Parameters:
- $iFormId
mixed
- $arrQuery
mixed
Return
array
- ` string|int save($arrEntity) `
Saves a record into the database
Parameters:
- $arrEntity
mixed
Return
string|int
- ` void saveColumn($iFormId, $strColumn, $strValue) `
Saves a specific column of a row into a database
Parameters:
- $iFormId
int
A record's form_id
- $strColumn
mixed
- $strValue
mixed
- ` array search($strSearch, $arrQuery) `
Performs a search
Parameters:
- $strSearch
mixed
- $arrQuery
mixed
Return
Array of Forms that match the search query.

Database Fields

The following fields are used when retrieving and saving entities:
- `form_id`
int (11)
- `component_id`
string (255)
- `component_entity_id`
string (255)
- `form_id_attribute`
string (255)
- `form_tablename`
string (16777215)
- `form_workflow`
string (16777215)
- `form_test_answers`
string (16777215)
- `form_field_overrides`
string (16777215)