include/SugarWireless/SugarWirelessView.php

Show:

inherited

Classes
- \SugarWirelessView

Table of Contents

\SugarWirelessView
jump to top

Package: SugarCRM

SugarWirelessView extends SugarView and is the base class for wireless views.

The generic and reusable features of wireless views are contained in the base class. This includes the module select list, the saved search options and form, the search form, the subpanel data, the header, and the footer of the wireless views.

Parent(s): \SugarView
Children: \ViewWirelesslogin; \SugarWirelessListView; \ViewWirelessdetail; \ViewWirelessmodule; \ViewWirelessedit; \ViewWirelesssave; \ViewGS

Properties


                 $action= ''''

inherited

The name of the current action.

Inherited from: \SugarView::$$action

Default value''Details

Type: n/a
Inherited_from: \SugarView::$$action


                 $bean= 'null'

inherited

Inherited from: \SugarView::$$bean

Default valuenullDetails

Type: n/a
Inherited_from: \SugarView::$$bean


                 $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


                 $fileResources= ''

inheritedInherited from: \SugarView::$$fileResources

Details

Type: n/a
Inherited_from: \SugarView::$$fileResources


                 $module= ''''

inherited

The name of the current module.

Inherited from: \SugarView::$$module

Default value''Details

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


                 $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 value

array('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


                 $responseTime= ''

inheritedInherited from: \SugarView::$$responseTime

Details

Type: n/a
Inherited_from: \SugarView::$$responseTime


                 $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


                 $subpanel_layout_defs= 'array()'

Default valuearray()Details

Type: n/a


                 $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


                 $type= 'null'

inheritedInherited from: \SugarView::$$type

Default valuenullDetails

Type: n/a
Inherited_from: \SugarView::$$type


                 $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

Array
                 $wl_mod_create_list= ''

wl_mod_create_list includes the list of modules that we can add new unrelated records to

of module strings

Details

Type: Array

Array
                 $wl_mod_select_list= ''

wl_mod_select_list includes the list of modules to be added as options to the navigation select list

of module strings

Details

Type: Array

Methods

SugarView(
           $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

__construct(
          
          )
        
        :
          \none

Constructor for the view, it performs the following tasks:

sets the view options
achieves the global module select list
calls the SugarView constructor
sets a smarty variable with the global action

Returns

Type	Description
\none

_buildModuleList(
          
          )
        
        :
          void

inherited

Inherited from: \SugarView::_buildModuleList()

_calculateFooterMetrics(
          
          )
        
        :
          void

inherited

Inherited from: \SugarView::_calculateFooterMetrics()

_checkModule(
          
          )
        
        :
          void

inherited

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

Inherited from: \SugarView::_checkModule()

_displayJavascript(
          
          )
        
        :
          void

inherited

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

Inherited from: \SugarView::_displayJavascript()

_displayLoginJS(
          
          )
        
        :
          void

inherited

Inherited from: \SugarView::_displayLoginJS()

_displaySubPanels(
          
          )
        
        :
          void

inherited

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

Inherited from: \SugarView::_displaySubPanels()

_getModLanguageJS(
          
          )
        
        :
          void

inherited

Inherited from: \SugarView::_getModLanguageJS()

_getModuleTab(
          
          )
        
        :
          void

inherited

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

Inherited from: \SugarView::_getModuleTab()

_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

_getModuleTitleParams(
          bool $browserTitle
              =
              false
          )
        
        :
          array

inherited

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

Inherited from: \SugarView::_getModuleTitleParams()

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

_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

_getStatistics(
          
          )
        
        :
          void

inherited

Inherited from: \SugarView::_getStatistics()

_initSmarty(
          
          )
        
        :
          void

inherited

Inherited from: \SugarView::_initSmarty()

_track(
          
          )
        
        :
          void

inherited

track Private function to track information about the view request

Inherited from: \SugarView::_track()

_trackView(
          
          )
        
        :
          void

inherited

trackView

Inherited from: \SugarView::_trackView()

bean_details(
           $view
          )
        
        :
          void

Public function that attains the bean detail and sets up an array for Smarty consumption.

Parameters

Name	Type	Description
$view

checkEditPermissions(
          
          )
        
        :
          void

checkPostMaxSizeError(
          
          )
        
        :
          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

display(
          
          )
        
        :
          void

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

displayErrors(
          
          )
        
        :
          void

inherited

This method will display the errors on the page.

Inherited from: \SugarView::displayErrors()

displayFooter(
          
          )
        
        :
          void

inherited

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

Inherited from: \SugarView::displayFooter()

displayHeader(
           $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

fetchTemplate(
          \$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

getBreadCrumbSymbol(
          
          )
        
        :
          string

inherited

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

Inherited from: \SugarView::getBreadCrumbSymbol()

Returns

Type	Description
string

getBrowserTitle(
          
          )
        
        :
          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

getCustomFilePathIfExists(
          \$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

getDataForSubpanel(
           $parent,  $subpanel,  $subpaneldefs
          )
        
        :
          void

Parameters

Name	Type	Description
$parent
$subpanel
$subpaneldefs

getFavicon(
          
          )
        
        :
          array

inherited

Retrieves favicon corresponding to currently requested module

Inherited from: \SugarView::getFavicon()

Returns

Type	Description
array

getHelpText(
          \$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

getJavascriptValidation(
          
          )
        
        :
          void

staticinherited

Get JS validation code for views

Inherited from: \SugarView::getJavascriptValidation()

getMenu(
          \$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

getMetaDataFile(
          string $view
          )
        
        :
          array

Retrieve the meta data file and module name for a particular view

Parameters

Name	Type	Description
$view	string

Returns

Type	Description
array	filename and module name information

getModuleMenuHTML(
          
          )
        
        :
          void

inherited

Inherited from: \SugarView::getModuleMenuHTML()

getModuleTitle(
          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

getModuleTitleIconPath(
           $module
          )
        
        :
          void

inherited

Inherited from: \SugarView::getModuleTitleIconPath()

Parameters

Name	Type	Description
$module

getSubpanelDefs(
           $layout_def_key
              =
              "",  $original_only
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def_key
$original_only

getSugarConfigJS(
          
          )
        
        :
          array

inherited

Fetch config values to be put into an array for JavaScript

Inherited from: \SugarView::getSugarConfigJS()

Returns

Type	Description
array

get_field_defs(
          
          )
        
        :
          void

includeClassicFile(
          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

init(
           $bean
              =
              null,  $view_object_map
              =
              array()
          )
        
        :
          void

Override the default init() method; build the module select list after calling it

Parameters

Name	Type	Description
$bean
$view_object_map

logMemoryStatistics(
          \$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

preDisplay(
          
          )
        
        :
          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()

prepareConfigVarForJs(
          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

process(
          
          )
        
        :
          void

inherited

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

Inherited from: \SugarView::process()

renderJavascript(
          
          )
        
        :
          void

inherited

Inherited from: \SugarView::renderJavascript()

set_wl_module_select_list(
          
          )
        
        :
          \none

Private function that determines the module list

This function reads the static metadata file that contains the list of included modules for SugarWireless. It will form a select list that gets consumed by the views. Also, it will do a check to make sure the user has access to the module.

Returns

Type	Description
\none

setup_detail_field(
           $field
          )
        
        :
          void

Parameters

Name	Type	Description
$field

setup_edit_field(
           $field
          )
        
        :
          void

Parameters

Name	Type	Description
$field

wl_footer(
           $footerTpl
              =
              'include/SugarWireless/tpls/wirelessfooter.tpl'
          )
        
        :
          void

Public function that displays the wireless view footer

Parameters

Name	Type	Description
$footerTpl

wl_get_metadata_location(
           $view
          )
        
        :
          void

Parameters

Name	Type	Description
$view

wl_get_subpanel_data(
          \SugarBean $child_seed, String $related_field, \aSubPanel $subpanel
              =
              null
          )
        
        :

Protected function that retrieves subpanel data for a given bean

This function will return an array with the subpanel data for a bean. The function needs to attain the relationship and modify the query. It will inject team security code into the query if that is needed, and construct a final query. Finally, it will call the list_query function to attain the subpanel data list.

Parameters

Name	Type	Description
$child_seed	\SugarBean	$child_seed the subpanel module bean
$related_field	String	$related_field the link field to use
$subpanel	\aSubPanel	$subpanel_def defninition of this subpanel

wl_header(
           $welcome
              =
              false,  $headerTpl
              =
              'include/SugarWireless/tpls/wirelessheader.tpl'
          )
        
        :
          void

Public function that displays the wireless view header.

Parameters

Name	Type	Description
$welcome
$headerTpl

wl_required_edit_fields(
          
          )
        
        :
          void

wl_saved_search_form(
          
          )
        
        :
          void

Public function that consumes the saved search options private function and returns the saved search form.

wl_saved_search_options(
          
          )
        
        :
          \html

Private function to determine the saved searches for particular modules

This function will take the current user id and the current module, and determine if there are any saved searches available. If yes, then the function will return a select list with the saved searches.

Returns

Type	Description
\html	for select list of saved searches

wl_search_form(
           $searchdefs
              =
              array()
          )
        
        :
          void

Public function that reads search metadata and creates an appropriate search form based on the metadata.

Parameters

Name	Type	Description
$searchdefs

wl_select_list(
           $selectListTpl
              =
              'include/SugarWireless/tpls/wirelessselectlist.tpl'
          )
        
        :
          void

Public function to display the select list

Parameters

Name	Type	Description
$selectListTpl

include/SugarWireless/SugarWirelessView.php

\SugarWirelessViewjump to top

Properties

Methods

\SugarWirelessView
jump to top