modules/ModuleBuilder/views/view.relationship.php

Show: inherited
Table of Contents

\ViewRelationship

Package:

Base Sugar view

Parent(s)
\SugarView

Properties

Propertypublic  $action= ''''
inherited

The name of the current action.

Inherited from: \SugarView::$$action
Default value''Details
Type
n/a
Inherited_from
\SugarView::$$action  
Propertypublic  $bean= 'null'
inherited

Inherited from: \SugarView::$$bean
Default valuenullDetails
Type
n/a
Inherited_from
\SugarView::$$bean  
Propertypublic  $errors= 'array()'
inherited

Any errors that occured this can either be set by the view or the controller or the model

Inherited from: \SugarView::$$errors
Default valuearray()Details
Type
n/a
Inherited_from
\SugarView::$$errors  
Propertypublic  $fileResources= ''
inheritedInherited from: \SugarView::$$fileResources
Details
Type
n/a
Inherited_from
\SugarView::$$fileResources  
Propertypublic  $module= ''''
inherited

The name of the current module.

Inherited from: \SugarView::$$module
Default value''Details
Type
n/a
Inherited_from
\SugarView::$$module  
Propertypublic  $options= 'array('show_header' => true, 'show_title' => true, 'show_subpanels' => false, 'show_search' => true, 'show_footer' => true, 'show_javascript' => true, 'view_print' => false,)'
inherited

Options for what UI elements to hide/show/

Inherited from: \SugarView::$$options
Default valuearray('show_header' => true, 'show_title' => true, 'show_subpanels' => false, 'show_search' => true, 'show_footer' => true, 'show_javascript' => true, 'view_print' => false,)Details
Type
n/a
Inherited_from
\SugarView::$$options  
Propertypublic  $responseTime= ''
inheritedInherited from: \SugarView::$$responseTime
Details
Type
n/a
Inherited_from
\SugarView::$$responseTime  
Propertypublic  $ss= 'null'
inherited

Sugar_Smarty. This is useful if you have a view and a subview you can share the same smarty object.

Inherited from: \SugarView::$$ss
Default valuenullDetails
Type
n/a
Inherited_from
\SugarView::$$ss  
Propertypublic  $suppressDisplayErrors= 'false'
inherited

Set to true if you do not want to display errors from SugarView::displayErrors(); instead they will be returned

Inherited from: \SugarView::$$suppressDisplayErrors
Default valuefalseDetails
Type
n/a
Inherited_from
\SugarView::$$suppressDisplayErrors  
Propertypublic  $type= 'null'
inheritedInherited from: \SugarView::$$type
Default valuenullDetails
Type
n/a
Inherited_from
\SugarView::$$type  
Propertypublic  $view_object_map= 'array()'
inherited

This array is meant to hold an objects/data that we would like to pass between the controller and the view. The bean will automatically be set for us, but this is meant to hold anything else.

Inherited from: \SugarView::$$view_object_map
Default valuearray()Details
Type
n/a
Inherited_from
\SugarView::$$view_object_map  

Methods

methodpublicSugarView(  $bean = null,  $view_object_map = array() ) : void
inherited

Constructor which will peform the setup.

Inherited from: \SugarView::SugarView()
Parameters
Name Type Description
$bean
$view_object_map
methodprotected_buildModuleList( ) : void
inherited

Inherited from: \SugarView::_buildModuleList()
methodprivate_calculateFooterMetrics( ) : void
inherited

Inherited from: \SugarView::_calculateFooterMetrics()
methodprotected_checkModule( ) : void
inherited

Checks to see if the module name passed is valid; dies if it is not

Inherited from: \SugarView::_checkModule()
methodprotected_displayJavascript( ) : void
inherited

Called from process(). This method will display the correct javascript.

Inherited from: \SugarView::_displayJavascript()
methodprotected_displayLoginJS( ) : void
inherited

Inherited from: \SugarView::_displayLoginJS()
methodprotected_displaySubPanels( ) : void
inherited

Called from process(). This method will display subpanels.

Inherited from: \SugarView::_displaySubPanels()
methodprotected_getModLanguageJS( ) : void
inherited

Inherited from: \SugarView::_getModLanguageJS()
methodprotected_getModuleTab( ) : void
inherited

Returns the module name which should be highlighted in the module menu

Inherited from: \SugarView::_getModuleTab()
methodprotected_getModuleTitleListParam( bool $browserTitle = false ) : string
inherited

Returns the portion of the array that will represent the listview in the breadcrumb

Inherited from: \SugarView::_getModuleTitleListParam()
Parameters
Name Type Description
$browserTitle bool

true if the returned string is being used for the browser title, meaning there should be no HTML in the string

Returns
Type Description
string
methodprotected_getModuleTitleParams( bool $browserTitle = false ) : array

Returns an array composing of the breadcrumbs to use for the module title

Parameters
Name Type Description
$browserTitle bool

true if the returned string is being used for the browser title, meaning there should be no HTML in the string

Returns
Type Description
array
Details
See
\SugarView::_getModuleTitleParams()  
methodprotected_getOption( string $option, bool $default = false ) : bool
inherited

private method used in process() to determine the value of a passed in option

Inherited from: \SugarView::_getOption()
Parameters
Name Type Description
$option string

option - the option that we want to know the valye of

$default bool

default - what the default value should be if we do not find the option

Returns
Type Description
bool - the value of the option
methodprivate_getStatistics( ) : void
inherited

Inherited from: \SugarView::_getStatistics()
methodprotected_initSmarty( ) : void
inherited

Inherited from: \SugarView::_initSmarty()
methodprivate_track( ) : void
inherited

track Private function to track information about the view request

Inherited from: \SugarView::_track()
methodprotected_trackView( ) : void
inherited

trackView

Inherited from: \SugarView::_trackView()
methodpubliccheckPostMaxSizeError( ) : boolean
inherited

Determines whether the state of the post global array indicates there was an error uploading a file that exceeds the post_max_size setting. Such an error can be detected if: 1. The Server['REQUEST_METHOD'] will still point to POST 2. POST and FILES global arrays will be returned empty despite the request method This also results in a redirect to the home page (due to lack of module and action in POST)

Inherited from: \SugarView::checkPostMaxSizeError()
Returns
Type Description
boolean indicating true or false
methodpublicdisplay( ) : void

[OVERRIDE] - This method is meant to overidden in a subclass. This method will handle the actual display logic of the view.

methodpublicdisplayErrors( ) : void
inherited

This method will display the errors on the page.

Inherited from: \SugarView::displayErrors()
methodpublicdisplayFooter( ) : void
inherited

Called from process(). This method will display the footer on the page.

Inherited from: \SugarView::displayFooter()
methodpublicdisplayHeader(  $retModTabs = false ) : void
inherited

Displays the header on section of the page; basically everything before the content

Inherited from: \SugarView::displayHeader()
Parameters
Name Type Description
$retModTabs
methodprotectedfetchTemplate( \$file $file ) : \$content
inherited

fetchTemplate

Inherited from: \SugarView::fetchTemplate()

This function wraps the call to the fetch function of the Smarty variable for the view

Parameters
Name Type Description
$file \$file

String path of the file to fetch

Returns
Type Description
\$content String content from resulting Smarty fetch operation on template
methodpublicgetBreadCrumbSymbol( ) : string
inherited

Returns the correct breadcrumb symbol according to theme's directionality setting

Inherited from: \SugarView::getBreadCrumbSymbol()
Returns
Type Description
string
methodpublicgetBrowserTitle( ) : string
inherited

Returns the string which will be shown in the browser's title; defaults to using the same breadcrumb as in the module title

Inherited from: \SugarView::getBrowserTitle()
Returns
Type Description
string
methodprotectedgetCustomFilePathIfExists( \$file $file ) : \$file
inherited

getCustomFilePathIfExists

Inherited from: \SugarView::getCustomFilePathIfExists()

This function wraps a call to get_custom_file_if_exists from include/utils.php

Parameters
Name Type Description
$file \$file

String of filename to check

Returns
Type Description
\$file String of filename including custom directory if found
methodprotectedgetFavicon( ) : array
inherited

Retrieves favicon corresponding to currently requested module

Inherited from: \SugarView::getFavicon()
Returns
Type Description
array
methodprotectedgetHelpText( \$module $module ) : \$theTitle
inherited

getHelpText

Inherited from: \SugarView::getHelpText()

This is a protected function that returns the help text portion. It is called from getModuleTitle.

Parameters
Name Type Description
$module \$module

String the formatted module name

Returns
Type Description
\$theTitle String the HTML for the help text
methodpublicgetJavascriptValidation( ) : void
staticinherited

Get JS validation code for views

Inherited from: \SugarView::getJavascriptValidation()
methodpublicgetMenu( \$module $module = null ) : array
inherited

Loads the module shortcuts menu

Inherited from: \SugarView::getMenu()
Parameters
Name Type Description
$module \$module

string optional, can specify module to retrieve menu for if not the current one

Returns
Type Description
array module menu
methodpublicgetMetaDataFile( ) : string
inherited

Return the metadata file that will be used by this view.

Inherited from: \SugarView::getMetaDataFile()
Returns
Type Description
string File location of the metadata file.
methodpublicgetModuleMenuHTML( ) : void
inherited

Inherited from: \SugarView::getModuleMenuHTML()
methodpublicgetModuleTitle( bool $show_help = true ) : \HTML
inherited

Return the "breadcrumbs" to display at the top of the page

Inherited from: \SugarView::getModuleTitle()
Parameters
Name Type Description
$show_help bool

optional, true if we show the help links

Returns
Type Description
\HTML string containing breadcrumb title
methodprotectedgetModuleTitleIconPath(  $module ) : void
inherited

Inherited from: \SugarView::getModuleTitleIconPath()
Parameters
Name Type Description
$module
methodprotectedgetSugarConfigJS( ) : array
inherited

Fetch config values to be put into an array for JavaScript

Inherited from: \SugarView::getSugarConfigJS()
Returns
Type Description
array
methodpublicincludeClassicFile( string $file ) : void
inherited

If the view is classic then this method will include the file and setup any global variables.

Inherited from: \SugarView::includeClassicFile()
Parameters
Name Type Description
$file string
methodpublicinit(  $bean = null,  $view_object_map = array() ) : void
inherited

Inherited from: \SugarView::init()
Parameters
Name Type Description
$bean
$view_object_map
methodprotectedlogMemoryStatistics( \$newline $newline = '
' )
: \$message
inherited

logMemoryStatistics

Inherited from: \SugarView::logMemoryStatistics()

This function returns a string message containing the memory statistics as well as writes to the memory_usage.log file the memory statistics for the SugarView invocation.

Parameters
Name Type Description
$newline \$newline

String of newline character to use (defaults to )

Returns
Type Description
\$message String formatted message about memory statistics
methodpublicoverrideDefinitionFromPOST(  $definition ) : void

Parameters
Name Type Description
$definition
methodpublicpreDisplay( ) : void
inherited

[OVERRIDE] - This method is meant to overidden in a subclass. The purpose of this method is to allow a view to do some preprocessing before the display method is called. This becomes useful when you have a view defined at the application level and then within a module have a sub-view that extends from this application level view. The application level view can do the setup in preDisplay() that is common to itself and any subviews and then the subview can just override display(). If it so desires, can also override preDisplay().

Inherited from: \SugarView::preDisplay()
methodprotectedprepareConfigVarForJs( string $key, string $value ) : string
inherited

Utility method to convert sugar_config values into a JS acceptable format.

Inherited from: \SugarView::prepareConfigVarForJs()
Parameters
Name Type Description
$key string

Config Variable Name

$value string

Config Variable Value

Returns
Type Description
string
methodpublicprocess( ) : void
inherited

This method will be called from the controller and is not meant to be overridden.

Inherited from: \SugarView::process()
methodpublicrenderJavascript( ) : void
inherited

Inherited from: \SugarView::renderJavascript()
Documentation was generated by DocBlox 0.18.1.