include/MVC/View/views/view.wirelesssave.php
inherited
Classes
\ViewWirelesssave
ViewWirelesslist extends SugarWirelessView and is the view for wireless list 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)
- \SugarWirelessView < \SugarView
- Children
- \CallsViewWirelesssave
- \MeetingsViewWirelesssave
Properties
$action= ''index''
The name of the current action.
'index'Details- Type
- n/a
$bean= 'null'
nullDetails- Type
- n/a
- Inherited_from
- \SugarView::$$bean
- Inherited_from
- \SugarWirelessView::$$bean
$errors= 'array()'
Any errors that occured this can either be set by the view or the controller or the model
Inherited from: \SugarView::$$errors\SugarWirelessView::$$errorsarray()Details- Type
- n/a
- Inherited_from
- \SugarView::$$errors
- Inherited_from
- \SugarWirelessView::$$errors
$fileResources= ''
- Type
- n/a
- Inherited_from
- \SugarView::$$fileResources
- Inherited_from
- \SugarWirelessView::$$fileResources
$module= ''Home''
The name of the current module.
'Home'Details- Type
- n/a
$options= 'array('show_header' => true, 'show_title' => true, 'show_subpanels' => false, 'show_search' => true, 'show_footer' => true, 'show_javascript' => true, 'view_print' => false,)'
Options for what UI elements to hide/show/
Inherited from: \SugarView::$$options\SugarWirelessView::$$optionsarray('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
- Inherited_from
- \SugarWirelessView::$$options
$record= ''''
The id of the current record.
''Details- Type
- n/a
$responseTime= ''
- Type
- n/a
- Inherited_from
- \SugarView::$$responseTime
- Inherited_from
- \SugarWirelessView::$$responseTime
$return_action= 'null'
The name of the return action.
nullDetails- Type
- n/a
$return_id= 'null'
The id of the return record.
nullDetails- Type
- n/a
$return_module= 'null'
The name of the return module.
nullDetails- Type
- n/a
$ss= 'null'
Sugar_Smarty. This is useful if you have a view and a subview you can share the same smarty object.
Inherited from: \SugarView::$$ss\SugarWirelessView::$$ssnullDetails- Type
- n/a
- Inherited_from
- \SugarView::$$ss
- Inherited_from
- \SugarWirelessView::$$ss
$subpanel_layout_defs= 'array()'
array()Details- Type
- n/a
- Inherited_from
- \SugarWirelessView::$$subpanel_layout_defs
$suppressDisplayErrors= 'false'
Set to true if you do not want to display errors from SugarView::displayErrors(); instead they will be returned
Inherited from: \SugarView::$$suppressDisplayErrors\SugarWirelessView::$$suppressDisplayErrorsfalseDetails- Type
- n/a
- Inherited_from
- \SugarView::$$suppressDisplayErrors
- Inherited_from
- \SugarWirelessView::$$suppressDisplayErrors
$type= 'null'
nullDetails- Type
- n/a
- Inherited_from
- \SugarView::$$type
- Inherited_from
- \SugarWirelessView::$$type
$view_object_map= 'array()'
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\SugarWirelessView::$$view_object_maparray()Details- Type
- n/a
- Inherited_from
- \SugarView::$$view_object_map
- Inherited_from
- \SugarWirelessView::$$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 stringsInherited from: \SugarWirelessView::$$wl_mod_create_list- Type
- Array
- Inherited_from
- \SugarWirelessView::$$wl_mod_create_list
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 stringsInherited from: \SugarWirelessView::$$wl_mod_select_list- Type
- Array
- Inherited_from
- \SugarWirelessView::$$wl_mod_select_list
Methods
SugarView(
$bean
=
null, $view_object_map
=
array()
)
:
voidConstructor which will peform the setup.
Inherited from: \SugarView::SugarView()\SugarWirelessView::SugarView()| Name | Type | Description |
|---|---|---|
| $bean | ||
| $view_object_map |
__construct(
)
:
\noneConstructor for the view, it runs the constructor of SugarWirelessView
- sets the view options
- achieves the global module select list
- calls the SugarView constructor
- sets a smarty variable with the global action
| Type | Description |
|---|---|
| \none |
_buildModuleList(
)
:
void
_calculateFooterMetrics(
)
:
void_checkModule(
)
:
voidChecks to see if the module name passed is valid; dies if it is not
Inherited from: \SugarView::_checkModule()\SugarWirelessView::_checkModule()_displayJavascript(
)
:
voidCalled from process(). This method will display the correct javascript.
Inherited from: \SugarView::_displayJavascript()\SugarWirelessView::_displayJavascript()_displayLoginJS(
)
:
void
_displaySubPanels(
)
:
voidCalled from process(). This method will display subpanels.
Inherited from: \SugarView::_displaySubPanels()\SugarWirelessView::_displaySubPanels()_getModLanguageJS(
)
:
void
_getModuleTab(
)
:
voidReturns the module name which should be highlighted in the module menu
Inherited from: \SugarView::_getModuleTab()\SugarWirelessView::_getModuleTab()_getModuleTitleListParam(
bool $browserTitle
=
false
)
:
stringReturns the portion of the array that will represent the listview in the breadcrumb
Inherited from: \SugarView::_getModuleTitleListParam()\SugarWirelessView::_getModuleTitleListParam()| 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 |
| Type | Description |
|---|---|
| string |
_getModuleTitleParams(
bool $browserTitle
=
false
)
:
arrayReturns an array composing of the breadcrumbs to use for the module title
Inherited from: \SugarView::_getModuleTitleParams()\SugarWirelessView::_getModuleTitleParams()| 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 |
| Type | Description |
|---|---|
| array |
_getOption(
string $option, bool $default
=
false
)
:
boolprivate method used in process() to determine the value of a passed in option
Inherited from: \SugarView::_getOption()\SugarWirelessView::_getOption()| 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 |
| Type | Description |
|---|---|
| bool | - the value of the option |
_getStatistics(
)
:
void
_initSmarty(
)
:
void
_track(
)
:
voidtrack Private function to track information about the view request
Inherited from: \SugarView::_track()\SugarWirelessView::_track()_trackView(
)
:
void
action_save(
)
:
voidPerform the actual save
bean_details(
$view
)
:
voidPublic function that attains the bean detail and sets up an array for Smarty consumption.
Inherited from: \SugarWirelessView::bean_details()| Name | Type | Description |
|---|---|---|
| $view |
checkPostMaxSizeError(
)
:
booleanDetermines 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()\SugarWirelessView::checkPostMaxSizeError()| Type | Description |
|---|---|
| boolean | indicating true or false |
display(
)
:
voidPublic function that handles the display of the wireless list view.
displayErrors(
)
:
voidThis method will display the errors on the page.
Inherited from: \SugarView::displayErrors()\SugarWirelessView::displayErrors()displayFooter(
)
:
voidCalled from process(). This method will display the footer on the page.
Inherited from: \SugarView::displayFooter()\SugarWirelessView::displayFooter()displayHeader(
$retModTabs
=
false
)
:
voidDisplays the header on section of the page; basically everything before the content
Inherited from: \SugarView::displayHeader()\SugarWirelessView::displayHeader()| Name | Type | Description |
|---|---|---|
| $retModTabs |
fetchTemplate(
\$file $file
)
:
\$contentfetchTemplate
Inherited from: \SugarView::fetchTemplate()\SugarWirelessView::fetchTemplate()This function wraps the call to the fetch function of the Smarty variable for the view
| Name | Type | Description |
|---|---|---|
| $file | \$file | String path of the file to fetch |
| Type | Description |
|---|---|
| \$content | String content from resulting Smarty fetch operation on template |
getBreadCrumbSymbol(
)
:
stringReturns the correct breadcrumb symbol according to theme's directionality setting
Inherited from: \SugarView::getBreadCrumbSymbol()\SugarWirelessView::getBreadCrumbSymbol()| Type | Description |
|---|---|
| string |
getBrowserTitle(
)
:
stringReturns 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()\SugarWirelessView::getBrowserTitle()| Type | Description |
|---|---|
| string |
getCustomFilePathIfExists(
\$file $file
)
:
\$filegetCustomFilePathIfExists
Inherited from: \SugarView::getCustomFilePathIfExists()\SugarWirelessView::getCustomFilePathIfExists()This function wraps a call to get_custom_file_if_exists from include/utils.php
| Name | Type | Description |
|---|---|---|
| $file | \$file | String of filename to check |
| Type | Description |
|---|---|
| \$file | String of filename including custom directory if found |
getDataForSubpanel(
$parent, $subpanel, $subpaneldefs
)
:
void| Name | Type | Description |
|---|---|---|
| $parent | ||
| $subpanel | ||
| $subpaneldefs |
getFavicon(
)
:
arrayRetrieves favicon corresponding to currently requested module
Inherited from: \SugarView::getFavicon()\SugarWirelessView::getFavicon()| Type | Description |
|---|---|
| array |
getHelpText(
\$module $module
)
:
\$theTitle
This is a protected function that returns the help text portion. It is called from getModuleTitle.
| Name | Type | Description |
|---|---|---|
| $module | \$module | String the formatted module name |
| Type | Description |
|---|---|
| \$theTitle | String the HTML for the help text |
getJavascriptValidation(
)
:
voidGet JS validation code for views
Inherited from: \SugarView::getJavascriptValidation()\SugarWirelessView::getJavascriptValidation()getMenu(
\$module $module
=
null
)
:
arrayLoads the module shortcuts menu
Inherited from: \SugarView::getMenu()\SugarWirelessView::getMenu()| Name | Type | Description |
|---|---|---|
| $module | \$module | string optional, can specify module to retrieve menu for if not the current one |
| Type | Description |
|---|---|
| array | module menu |
getMetaDataFile(
string $view
)
:
arrayRetrieve the meta data file and module name for a particular view
Inherited from: \SugarWirelessView::getMetaDataFile()| Name | Type | Description |
|---|---|---|
| $view | string |
| Type | Description |
|---|---|
| array | filename and module name information |
getModuleMenuHTML(
)
:
void
getModuleTitle(
bool $show_help
=
true
)
:
\HTMLReturn the "breadcrumbs" to display at the top of the page
Inherited from: \SugarView::getModuleTitle()\SugarWirelessView::getModuleTitle()| Name | Type | Description |
|---|---|---|
| $show_help | bool | optional, true if we show the help links |
| Type | Description |
|---|---|
| \HTML | string containing breadcrumb title |
getModuleTitleIconPath(
$module
)
:
void| Name | Type | Description |
|---|---|---|
| $module |
getSubpanelDefs(
$layout_def_key
=
"", $original_only
=
false
)
:
void| Name | Type | Description |
|---|---|---|
| $layout_def_key | ||
| $original_only |
getSugarConfigJS(
)
:
arrayFetch config values to be put into an array for JavaScript
Inherited from: \SugarView::getSugarConfigJS()\SugarWirelessView::getSugarConfigJS()| Type | Description |
|---|---|
| array |
includeClassicFile(
string $file
)
:
voidIf the view is classic then this method will include the file and setup any global variables.
Inherited from: \SugarView::includeClassicFile()\SugarWirelessView::includeClassicFile()| Name | Type | Description |
|---|---|---|
| $file | string |
init(
$bean
=
null, $view_object_map
=
array()
)
:
voidOverride the default init() method; build the module select list after calling it
Inherited from: \SugarWirelessView::init()| Name | Type | Description |
|---|---|---|
| $bean | ||
| $view_object_map |
loadPropertiesFromRequest(
)
:
voidSet properties on the Controller from the $_REQUEST
logMemoryStatistics(
\$newline $newline
=
'
'
)
:
\$messagelogMemoryStatistics
Inherited from: \SugarView::logMemoryStatistics()\SugarWirelessView::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.
| Name | Type | Description |
|---|---|---|
| $newline | \$newline | String of newline character to use (defaults to ) |
| Type | Description |
|---|---|
| \$message | String formatted message about memory statistics |
post_save(
)
:
voidSpecify what happens after the save has occurred.
preDisplay(
)
:
void[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()\SugarWirelessView::preDisplay()pre_save(
)
:
voidDo some processing before saving the bean to the database.
prepareConfigVarForJs(
string $key, string $value
)
:
stringUtility method to convert sugar_config values into a JS acceptable format.
Inherited from: \SugarView::prepareConfigVarForJs()\SugarWirelessView::prepareConfigVarForJs()| Name | Type | Description |
|---|---|---|
| $key | string | Config Variable Name |
| $value | string | Config Variable Value |
| Type | Description |
|---|---|
| string |
process(
)
:
voidThis method will be called from the controller and is not meant to be overridden.
Inherited from: \SugarView::process()\SugarWirelessView::process()redirect(
$url
)
:
void| Name | Type | Description |
|---|---|---|
| $url |
renderJavascript(
)
:
void
set_wl_module_select_list(
)
:
\nonePrivate function that determines the module list
Inherited from: \SugarWirelessView::set_wl_module_select_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.
| Type | Description |
|---|---|
| \none |
setup(
$module
=
''
)
:
void| Name | Type | Description |
|---|---|---|
| $module |
setup_detail_field(
$field
)
:
void| Name | Type | Description |
|---|---|---|
| $field |
setup_edit_field(
$field
)
:
void| Name | Type | Description |
|---|---|---|
| $field |
wl_footer(
$footerTpl
=
'include/SugarWireless/tpls/wirelessfooter.tpl'
)
:
voidPublic function that displays the wireless view footer
Inherited from: \SugarWirelessView::wl_footer()| Name | Type | Description |
|---|---|---|
| $footerTpl |
wl_get_metadata_location(
$view
)
:
void| 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
Inherited from: \SugarWirelessView::wl_get_subpanel_data()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.
| Name | Type | Description |
|---|---|---|
| $child_seed | \SugarBean |
|
| $related_field | String |
|
| $subpanel | \aSubPanel |
|
wl_header(
$welcome
=
false, $headerTpl
=
'include/SugarWireless/tpls/wirelessheader.tpl'
)
:
voidPublic function that displays the wireless view header.
Inherited from: \SugarWirelessView::wl_header()| Name | Type | Description |
|---|---|---|
| $welcome | ||
| $headerTpl |
wl_required_edit_fields(
)
:
voidwl_saved_search_form(
)
:
voidPublic function that consumes the saved search options private function and returns the saved search form.
Inherited from: \SugarWirelessView::wl_saved_search_form()wl_saved_search_options(
)
:
\htmlPrivate function to determine the saved searches for particular modules
Inherited from: \SugarWirelessView::wl_saved_search_options()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.
| Type | Description |
|---|---|
| \html | for select list of saved searches |
wl_search_form(
$searchdefs
=
array()
)
:
voidPublic function that reads search metadata and creates an appropriate search form based on the metadata.
Inherited from: \SugarWirelessView::wl_search_form()| Name | Type | Description |
|---|---|---|
| $searchdefs |
wl_select_list(
$selectListTpl
=
'include/SugarWireless/tpls/wirelessselectlist.tpl'
)
:
voidPublic function to display the select list
Inherited from: \SugarWirelessView::wl_select_list()| Name | Type | Description |
|---|---|---|
| $selectListTpl |