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

Latest news

  • ProcessWire Weekly #556
    In the 556th issue of ProcessWire Weekly we're going to share the latest core development news, highlight a new third party module, and more. Read on!
    Weekly.pw / 4 January 2025
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.