FormBuilderEntries class

Located in file /site/modules/FormBuilder/FormBuilderEntries.php

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the FormBuilderEntries class also inherits all the methods and properties of: Wire.

Show class?             Show args?        

Common

NameReturnSummary 
addEntryFlag(array $entry, $flag)
arrayAdd flag to entry (in memory only) and return entry 
database()
WireDatabasePDO@return WireDatabasePDO 
delete(int $id)
int boolDelete a form entry
deleteAll()
boolDelete all entries for this form
deleteOlderThan(int $age)
intDelete entries older than a given number of days
deleted(array $entryIDs)
(nothing)Hook called after one or more entries are deleted
exportCSV(FormBuilderForm $form, string $selectorString)
(nothing)Works like find() except that it exports a CSV file
find($selectorString)
arrayGet an array of form entries 
findIdsOlderThan(int $age)
arrayFind entries older than a given number of days 
get($key)
null array string intGet entry by ID or selector string 
getById(int $id)
bool arrayGet a form entry by ID 
getByName(string $name)
bool arrayGet a form entry by name 
getBySelector($selectorString)
null arrayGet a single form result array by selector string, or null if not found 
getFilesPath()
stringReturn the path that may be used by entries
getForm()
FormBuilderForm@return FormBuilderForm 
getFormID()
intGet the current form ID 
getFormIdFromEntryId(Wire $wire, int $entryID)
intGet a form ID from an entry ID 
getLastEntryDate()
stringGet date of last entry 
getLastTotal()
(nothing)Return the total known from the last find() query 
getTotal()
intReturn total number of entries 
hasFilesPath()
boolDoes a files path exist for form/entry? 
importCSV(string $filename)
arrayImport CSV file
isReservedProperty(string $property)
boolIs the given property name reserved for system use in entries? 
makeEntryStr()
stringMake an entry string (entryStr property) 
mySqlVersion()
string boolGet current MySQL version 
removeEntryFlag(array $entry, $flag)
arrayRemove flag to entry (in memory only) and return entry 
resend($id)
(nothing)Re-send (email) for the given entry ID
save(array $entry)
int boolSave the given entry
saveField(int $id, string $name, mixed $value)
boolUpdate a single form field value for an existing entry
validEntryName(string $name)
stringGiven an entry name, validate it, returning blank string if not valid or given entry name if valid 

Additional methods and properties

In addition to the methods and properties above, FormBuilderEntries also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.244

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani