include/EditView/EditView2.php

Show: inherited
Table of Contents

\EditView

Package: SugarCRM

New EditView

Children
\SearchForm
\DetailView2
\QuickCreate
Api
 

Properties

Propertypublic  $fieldDefs= ''
Details
Type
n/a
Propertypublic  $focus= ''
Details
Type
n/a
Propertypublic  $footerTpl= ''
Details
Type
n/a
Propertypublic  $formName= ''''
Default value''Details
Type
n/a
Propertypublic  $formatFields= 'true'
Default valuetrueDetails
Type
n/a
Propertypublic  $headerTpl= ''
Details
Type
n/a
Propertypublic  $id= ''
Details
Type
n/a
Propertypublic  $isDuplicate= ''
Details
Type
n/a
Propertypublic  $metadataFile= ''
Details
Type
n/a
Propertypublic  $module= ''
Details
Type
n/a
Propertypublic  $moduleTitleKey= ''
Details
Type
n/a
Propertypublic  $notes= ''
Details
Type
n/a
Propertypublic  $offset= '0'
Default value0Details
Type
n/a
Propertypublic  $populateBean= 'true'
Default valuetrueDetails
Type
n/a
Propertypublic  $quickSearchCode= ''
Details
Type
n/a
Propertypublic  $returnAction= ''
Details
Type
n/a
Propertypublic  $returnId= ''
Details
Type
n/a
Propertypublic  $returnModule= ''
Details
Type
n/a
Propertypublic  $sectionPanels= ''
Details
Type
n/a
Propertypublic  $showDetailData= 'true'
Default valuetrueDetails
Type
n/a
Propertypublic  $showSectionPanelsTitles= 'true'
Default valuetrueDetails
Type
n/a
Propertypublic  $showVCRControl= 'true'
Default valuetrueDetails
Type
n/a
Propertypublic  $ss= ''
Details
Type
n/a
Propertypublic  $th= ''
Details
Type
n/a
Propertypublic  $tpl= ''
Details
Type
n/a
Propertypublic  $view= ''EditView''
Default value'EditView'Details
Type
n/a
Propertypublic  $viewObject= 'null'
Default valuenullDetails
Type
n/a

Methods

methodpubliccallFunction(  $vardef ) : void

Parameters
Name Type Description
$vardef
methodpubliccreateFocus( ) : void

methodpublicdisplay( \$showTitle $showTitle = true, \$ajaxSave $ajaxSave = false ) : \HTML

display This method makes the Smarty variable assignments and then displays the generated view.

Parameters
Name Type Description
$showTitle \$showTitle

boolean value indicating whether or not to show a title on the resulting page

$ajaxSave \$ajaxSave

boolean value indicating whether or not the operation is an Ajax save request

Returns
Type Description
\HTML display for view as String
methodpublicenableFormatting( \$format $format = true ) : void

enableFormatting This method is used to manually turn on/off the field formatting

Parameters
Name Type Description
$format \$format

boolean value to turn on/off field formatting

methodprotectedgetPanelWithFillers( array $panel ) : array

Adds fillers to each row if required

Panel alignment will be off if the panel doesn't have a row with the max column It will not be aligned to the other panels so we fill out the columns in the last row

Parameters
Name Type Description
$panel array
Returns
Type Description
array
methodprotectedgetTemplateHandler( ) : \TemplateHandler

Get template handler object

Returns
Type Description
\TemplateHandler
methodpublicgetValueFromRequest( \request $request, \name $name ) : String

getValueFromRequest This is a helper method to extract a value from the request Array. We do some special processing for fields that start with 'date_' by checking to see if they also include time and meridiem values

Parameters
Name Type Description
$request \request

The request Array

$name \name

The field name to extract value for

Returns
Type Description
String value for given name
methodpublicinsertJavascript(  $javascript ) : void

Parameters
Name Type Description
$javascript
methodpublicpopulateBean( ) : void

methodpublicprocess(  $checkFormName = false,  $formName = '' ) : void

Parameters
Name Type Description
$checkFormName
$formName
methodpublicrender( ) : void

methodpublicrequiredFirst( ) : void

Enter description here ...

methodpublicsetup( \$module $module, \$focus $focus = null, \$id $metadataFile = null, \$metadataFile $tpl = 'include/EditView/EditView.tpl', \tpl $createFocus = true ) : void

EditView constructor This is the EditView constructor responsible for processing the new Meta-Data framework

Parameters
Name Type Description
$module \$module

String value of module this Edit view is for

$focus \$focus

An empty sugarbean object of module

$metadataFile \$id

The record id to retrieve and populate data for

$tpl \$metadataFile

String value of file location to use in overriding default metadata file

$createFocus \tpl

String value of file location to use in overriding default Smarty template

methodpublicshowTitle(  $showTitle = false ) : void

Allow Subviews to overwrite this method to show custom titles.

Examples: Projects & Project Templates. params: $showTitle: boolean for backwards compatibility.

Parameters
Name Type Description
$showTitle
Documentation was generated by DocBlox 0.18.1.