Website
\Components\Website\Designs \Components\Website\Pages \Components\Website\Pages\Forms \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\Locations
Commerce
\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\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\Assets\CSS \Framework\Assets\JavaScript \Framework\Caching\FileBased \Framework\Data\Util \Framework\Date \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
.
.
.
Description
Methods
get()
getAll()
getColumn()
getCount()
getLastSubmission()
getSubmissions()
save()
saveColumn()
search()
delete()
Fields

\Components\Website\Pages\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 ss:forms:form tag with recordsubmissions="true"

Class Methods

The following methods are available on this class:
array get($iFormId)
Gets a record from the database
Parameters
$iFormId
int
A record's form_id
Return
Form
array getAll($arrProperties)
Return a set of records from the database
Parameters
$arrProperties
array
Properties Array
Return
Array of Forms
mixed getColumn($iFormId, $strColumn)
Gets a single field from a record
Parameters
$iFormId
int
A record's form_id
$strColumn
string
Return
mixed
int getCount($arrFilter)
Returns the number of records in the database
Parameters
$arrFilter
array
Filter Array
Return
int
array getLastSubmission($iFormId)
Returns the last submission for a form for the current logged in user
Parameters
$iFormId
int
Return
array
array getSubmissions($iFormId, $arrProperties)
Returns the submissions for a given form id
Parameters
$iFormId
int
$arrProperties
array
Return
array
int save($arrEntity)
Saves a record into the database
Parameters
$arrEntity
array
Return
The record's form_id
void saveColumn($iFormId, $strColumn, $strValue)
Saves a specific column of a row into a database
Parameters
$iFormId
int
A record's form_id
$strColumn
string
$strValue
string
array search($strSearch, $arrProperties)
Performs a search
Parameters
$strSearch
string
Search query
$arrProperties
array
Properties Array
Return
Array of Forms that match the search query.
bool delete($iFormId, $bDeleteMedia)
Deletes a record from the database
Parameters
$iFormId
int
A record's form_id
$bDeleteMedia
bool
Return
Returns true if record existed and was deleted, otherwise false

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 (65535)
form_workflow
string (65535)
form_test_answers
string (65535)
form_field_overrides
string (65535)