modules/Leads/LeadFormBase.php

Show: inherited
Table of Contents

\LeadFormBase

Package:

FormBase.php

Parent(s)
\PersonFormBase < \FormBase
Author
Collin Lee This is an abstract class to provide common functionality across the form base code used in the application.  

Properties

Propertypublic  $moduleName= ''Leads''
Default value'Leads'Details
Type
n/a
Propertypublic  $objectName= ''Lead''
Default value'Lead'Details
Type
n/a

Methods

methodpublicbuildTableForm( \$rows $rows ) : \$form
inherited

buildTableForm

Inherited from: \PersonFormBase::buildTableForm()

This function creates a table with form data. It is used by the form base code when checking for duplicates

Parameters
Name Type Description
$rows \$rows

Array of duplicate row data

Returns
Type Description
\$form The HTML form data
methodpubliccheckForDuplicates( \$prefix $prefix = '' ) : \$rows
inherited

checkForDuplicates

Inherited from: \PersonFormBase::checkForDuplicates()

This function is used to locate any duplicate Leads that may be created when a new Lead is saved. It is called from the handleSave method of this class.

Parameters
Name Type Description
$prefix \$prefix

String value of any prefix to the form input names

Returns
Type Description
\$rows Array of matching Leads entries found; null if none found
methodpublicgetDuplicateQuery( \$focus $focus, \$prefix $prefix = '' ) : \SQL

getDuplicateQuery

This function returns the SQL String used for initial duplicate Leads check

Parameters
Name Type Description
$focus \$focus

sugarbean

$prefix \$prefix

String value of prefix that may be present in $_POST variables

Returns
Type Description
\SQL String of the query that should be used for the initial duplicate lookup check
Details
See
\checkForDuplicates  
methodpublicgetForm(  $prefix,  $mod = 'Leads' ) : void

Parameters
Name Type Description
$prefix
$mod
methodpublicgetFormBody(  $prefix,  $mod = '',  $formname = '' ) : void

Parameters
Name Type Description
$prefix
$mod
$formname
methodpublicgetWideFormBody(  $prefix,  $mod = '',  $formname = '' ) : void

Parameters
Name Type Description
$prefix
$mod
$formname
methodpublichandleSave(  $prefix,  $redirect = true,  $useRequired = false,  $do_save = true,  $exist_lead = null ) : void

Parameters
Name Type Description
$prefix
$redirect
$useRequired
$do_save
$exist_lead
methodprotectedisEmptyReturnModuleAndAction( ) : bool

This is a function to help assist in determining if a save operation has been performed without a return module and action specified. This will likely be the case where we use AJAX to change the state of a record, but wish to keep the user remaining on the same view. For example, this is true when closing Calls and Meetings from dashlets or from from subpanels.

Returns
Type Description
bool Boolean value indicating whether or not a return module and return action are specified in request
methodprotectedisSaveFromDCMenu( ) : bool
inherited

isSaveFromDCMenu

Inherited from: \FormBase::isSaveFromDCMenu()\PersonFormBase::isSaveFromDCMenu()

This is a function to help assist in determining if a save operation has been performed from the DCMenu (the shortcut bar up top available for most themes).

Returns
Type Description
bool Boolean value indicating whether or not the save operation was triggered from DCMenu
Documentation was generated by DocBlox 0.18.1.