include/MVC/View/views/view.fts.php

Show: inherited
Table of Contents

\ViewFts

Package:

Base Sugar view

Parent(s)
\SugarView

Properties

Propertypublic  $action= ''''
inherited

The name of the current action.

Inherited from: \SugarView::$$action
Propertypublic  $bean= 'null'
inherited

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
Propertypublic  $fileResources= ''
inheritedInherited from: \SugarView::$$fileResources
Propertypublic  $module= ''''
inherited

The name of the current module.

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
Propertypublic  $responseTime= ''
inheritedInherited 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
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
Propertypublic  $type= 'null'
inheritedInherited 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

Methods

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

Constructor which will peform the setup.

Inherited from: \SugarView::SugarView()
methodpublic__construct( ) : void

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()
methodpublicdisplay(  $return = false,  $encode = false ) : 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()
methodpublicgetBreadCrumbSymbol( ) : string
inherited

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

Inherited from: \SugarView::getBreadCrumbSymbol()
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()
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()
methodpublicgetMetaDataFile( ) : string
inherited

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

Inherited from: \SugarView::getMetaDataFile()
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()
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()
methodpublicinit(  $bean = null,  $view_object_map = array() ) : void
inherited

Inherited from: \SugarView::init()
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()
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.