include/DetailView/DetailView2.php

Show:

inherited

Classes
- \DetailView2

Table of Contents

\DetailView2
jump to top

Package: SugarCRM

DetailView - display single record New implementation

Parent(s): \EditView
Api

Properties


                 $fieldDefs= ''

inheritedInherited from: \EditView::$$fieldDefs

Details

Type: n/a
Inherited_from: \EditView::$$fieldDefs


                 $focus= ''

inheritedInherited from: \EditView::$$focus

Details

Type: n/a
Inherited_from: \EditView::$$focus


                 $footerTpl= ''

inheritedInherited from: \EditView::$$footerTpl

Details

Type: n/a
Inherited_from: \EditView::$$footerTpl


                 $formName= ''''

inheritedInherited from: \EditView::$$formName

Default value''Details

Type: n/a
Inherited_from: \EditView::$$formName


                 $formatFields= 'true'

inheritedInherited from: \EditView::$$formatFields

Default valuetrueDetails

Type: n/a
Inherited_from: \EditView::$$formatFields


                 $headerTpl= ''

inheritedInherited from: \EditView::$$headerTpl

Details

Type: n/a
Inherited_from: \EditView::$$headerTpl


                 $id= ''

inheritedInherited from: \EditView::$$id

Details

Type: n/a
Inherited_from: \EditView::$$id


                 $isDuplicate= ''

inheritedInherited from: \EditView::$$isDuplicate

Details

Type: n/a
Inherited_from: \EditView::$$isDuplicate


                 $metadataFile= ''

inheritedInherited from: \EditView::$$metadataFile

Details

Type: n/a
Inherited_from: \EditView::$$metadataFile


                 $module= ''

inheritedInherited from: \EditView::$$module

Details

Type: n/a
Inherited_from: \EditView::$$module


                 $moduleTitleKey= ''

inheritedInherited from: \EditView::$$moduleTitleKey

Details

Type: n/a
Inherited_from: \EditView::$$moduleTitleKey


                 $notes= ''

inheritedInherited from: \EditView::$$notes

Details

Type: n/a
Inherited_from: \EditView::$$notes


                 $offset= '0'

inheritedInherited from: \EditView::$$offset

Default value0Details

Type: n/a
Inherited_from: \EditView::$$offset


                 $populateBean= 'true'

inheritedInherited from: \EditView::$$populateBean

Default valuetrueDetails

Type: n/a
Inherited_from: \EditView::$$populateBean


                 $quickSearchCode= ''

inheritedInherited from: \EditView::$$quickSearchCode

Details

Type: n/a
Inherited_from: \EditView::$$quickSearchCode


                 $returnAction= ''

inheritedInherited from: \EditView::$$returnAction

Details

Type: n/a
Inherited_from: \EditView::$$returnAction


                 $returnId= ''

inheritedInherited from: \EditView::$$returnId

Details

Type: n/a
Inherited_from: \EditView::$$returnId


                 $returnModule= ''

inheritedInherited from: \EditView::$$returnModule

Details

Type: n/a
Inherited_from: \EditView::$$returnModule


                 $sectionPanels= ''

inheritedInherited from: \EditView::$$sectionPanels

Details

Type: n/a
Inherited_from: \EditView::$$sectionPanels


                 $showDetailData= 'true'

inheritedInherited from: \EditView::$$showDetailData

Default valuetrueDetails

Type: n/a
Inherited_from: \EditView::$$showDetailData


                 $showSectionPanelsTitles= 'true'

inheritedInherited from: \EditView::$$showSectionPanelsTitles

Default valuetrueDetails

Type: n/a
Inherited_from: \EditView::$$showSectionPanelsTitles


                 $showVCRControl= 'true'

inheritedInherited from: \EditView::$$showVCRControl

Default valuetrueDetails

Type: n/a
Inherited_from: \EditView::$$showVCRControl


                 $ss= ''

inheritedInherited from: \EditView::$$ss

Details

Type: n/a
Inherited_from: \EditView::$$ss


                 $th= ''

inheritedInherited from: \EditView::$$th

Details

Type: n/a
Inherited_from: \EditView::$$th


                 $tpl= ''

inheritedInherited from: \EditView::$$tpl

Details

Type: n/a
Inherited_from: \EditView::$$tpl


                 $view= ''DetailView''

Default value'DetailView'Details

Type: n/a


                 $viewObject= 'null'

inheritedInherited from: \EditView::$$viewObject

Default valuenullDetails

Type: n/a
Inherited_from: \EditView::$$viewObject

Methods

callFunction(
           $vardef
          )
        
        :
          void

inherited

Inherited from: \EditView::callFunction()

Parameters

Name	Type	Description
$vardef

createFocus(
          
          )
        
        :
          void

inherited

Inherited from: \EditView::createFocus()

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

inherited

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

Inherited from: \EditView::display()

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

enableFormatting(
          \$format $format
              =
              true
          )
        
        :
          void

inherited

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

Inherited from: \EditView::enableFormatting()

Parameters

Name	Type	Description
$format	\$format	boolean value to turn on/off field formatting

getPanelWithFillers(
          array $panel
          )
        
        :
          array

inherited

Adds fillers to each row if required

Inherited from: \EditView::getPanelWithFillers()

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

getTemplateHandler(
          
          )
        
        :
          \TemplateHandler

inherited

Get template handler object

Inherited from: \EditView::getTemplateHandler()

Returns

Type	Description
\TemplateHandler

getValueFromRequest(
          \request $request, \name $name
          )
        
        :
          String

inherited

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

Inherited from: \EditView::getValueFromRequest()

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

insertJavascript(
           $javascript
          )
        
        :
          void

inherited

Inherited from: \EditView::insertJavascript()

Parameters

Name	Type	Description
$javascript

populateBean(
          
          )
        
        :
          void

inherited

Inherited from: \EditView::populateBean()

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

inherited

Inherited from: \EditView::process()

Parameters

Name	Type	Description
$checkFormName
$formName

render(
          
          )
        
        :
          void

inherited

Inherited from: \EditView::render()

requiredFirst(
          
          )
        
        :
          void

inherited

Enter description here ...

Inherited from: \EditView::requiredFirst()

setup(
          \$module $module, \$focus $focus, \$id $metadataFile
              =
              null, \$metadataFile $tpl
              =
              'include/DetailView/DetailView.tpl'
          )
        
        :
          void

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

Parameters

Name	Type	Description
$module	\$module	String value of module this detail 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

showTitle(
           $showTitle
              =
              false
          )
        
        :
          void

inherited

Allow Subviews to overwrite this method to show custom titles.

Inherited from: \EditView::showTitle()

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

Parameters

Name	Type	Description
$showTitle

include/DetailView/DetailView2.php

\DetailView2jump to top

Properties

Methods

\DetailView2
jump to top