include/MVC/SugarApplication.php

Show:

inherited

Classes
- \SugarApplication

Table of Contents

\SugarApplication
jump to top

Package: SugarCRM

SugarCRM application

Api

Properties


                 $controller= 'null'

Default valuenullDetails

Type: n/a


                 $default_action= ''index''

Default value'index'Details

Type: n/a


                 $default_module= ''Home''

Default value'Home'Details

Type: n/a

array
                 $globalModifyActions= 'array(
		'massupdate', 'configuredashlet', 'import', 'importvcardsave', 'inlinefieldsave',
	    'wlsave', 'quicksave'
	)'

Actions that always modify data and thus require referrers save* and delete* hardcoded as modified

Default value

array(
		'massupdate', 'configuredashlet', 'import', 'importvcardsave', 'inlinefieldsave',
	    'wlsave', 'quicksave'
	)

Details

Type: array


                 $headerDisplayed= 'false'

Default valuefalseDetails

Type: n/a

array
                 $modifyActions= 'array()'

Actions that modify data in this controller's instance and thus require referrers

Default valuearray()Details

Type: array


                 $modifyModules= 'array(
		'Administration' => true,
		'UpgradeWizard' => true,
		'Configurator' => true,
		'Studio' => true,
		'ModuleBuilder' => true,
		'Emails' => true,
	    'DCETemplates' => true,
		'DCEInstances' => true,
		'DCEActions' => true,
		'Trackers' => array('trackersettings'),
	    'SugarFavorites' => array('tag'),
	    'Import' => array('last', 'undo'),
	    'Users' => array('changepassword', "generatepassword"),
	)'

Modules that modify data and thus require referrers for all actions

Default value

array(
		'Administration' => true,
		'UpgradeWizard' => true,
		'Configurator' => true,
		'Studio' => true,
		'ModuleBuilder' => true,
		'Emails' => true,
	    'DCETemplates' => true,
		'DCEInstances' => true,
		'DCEActions' => true,
		'Trackers' => array('trackersettings'),
	    'SugarFavorites' => array('tag'),
	    'Import' => array('last', 'undo'),
	    'Users' => array('changepassword', "generatepassword"),
	)

Details

Type: n/a


                 $redirectVars= 'array('module', 'action', 'record', 'token', 'oauth_token', 'mobile')'

Default valuearray('module', 'action', 'record', 'token', 'oauth_token', 'mobile')Details

Type: n/a

array
                 $whiteListActions= 'array('index', 'ListView', 'DetailView', 'EditView', 'oauth', 'authorize', 'Authenticate', 'Login', 'SupportPortal')'

The list of the actions excepted from referer checks by default

Default valuearray('index', 'ListView', 'DetailView', 'EditView', 'oauth', 'authorize', 'Authenticate', 'Login', 'SupportPortal')Details

Type: array

Methods

ACLFilter(
          
          )
        
        :
          void

SugarApplication(
          
          )
        
        :
          void

appendErrorMessage(
           $error_message
          )
        
        :
          void

static

Redirect to another URL

Parameters

Name	Type	Description
$error_message

Details

Access: public

checkDatabaseVersion(
           $dieOnFailure
              =
              true
          )
        
        :
          void

checkDatabaseVersion Check the db version sugar_version.php and compare to what the version is stored in the config table.

Ensure that both are the same.

Parameters

Name	Type	Description
$dieOnFailure

checkHTTPReferer(
           $dieIfInvalid
              =
              true
          )
        
        :
          void

Checks a request to ensure the request is coming from a valid source or it is for one of the white listed actions

Parameters

Name	Type	Description
$dieIfInvalid

createLoginVars(
          
          )
        
        :
          string

Create string to attach to login URL with vars to preserve post-login

Returns

Type	Description
string	URL part with login vars

endSession(
          
          )
        
        :
          void

execute(
          
          )
        
        :
          void

Perform execution of the application. This method is called from index2.php

getErrorMessages(
          
          )
        
        :
          void

static

getLoginRedirect(
          
          )
        
        :
          string

Get URL to redirect after the login

Returns

Type	Description
string	the URL to redirect to

getLoginVars(
          bool $add_empty
              =
              true
          )
        
        :
          array

Get the list of vars passed with login form

Parameters

Name	Type	Description
$add_empty	bool	Add empty vars to the result?

Returns

Type	Description
array	List of vars passed with login

handleAccessControl(
          
          )
        
        :
          void

Handles everything related to authorization.

handleOfflineClient(
          
          )
        
        :
          void

isModifyAction(
          
          )
        
        :
          void

loadDisplaySettings(
          
          )
        
        :
          void

Load the themes/images.

loadGlobals(
          
          )
        
        :
          void

loadLanguages(
          
          )
        
        :
          void

Load application wide languages as well as module based languages so they are accessible from the module.

loadLicense(
          
          )
        
        :
          void

loadUser(
          
          )
        
        :
          void

Load the authenticated user. If there is not an authenticated user then redirect to login screen.

preLoadLanguages(
          
          )
        
        :
          void

static

Load only bare minimum of language that can be done before user init and MVC stuff

preProcess(
          
          )
        
        :
          void

redirect(
          string $url
          )
        
        :
          void

Redirect to another URL

Parameters

Name	Type	Description
$url	string	The URL to redirect to

Details

Access: public

setCookie(
           $name,  $value,  $expire
              =
              0,  $path
              =
              '/',  $domain
              =
              null,  $secure
              =
              false,  $httponly
              =
              false
          )
        
        :
          void

static

Wrapper for the PHP setcookie() function, to handle cases where headers have already been sent

Parameters

Name	Type	Description
$name
$value
$expire
$path
$domain
$secure
$httponly

setupPrint(
          
          )
        
        :
          void

setupResourceManagement(
           $module
          )
        
        :
          void

setupResourceManagement This function initialize the ResourceManager and calls the setup method on the ResourceManager instance.

Parameters

Name	Type	Description
$module

startSession(
          
          )
        
        :
          void

trackLogin(
          
          )
        
        :
          void

trackLogin

This is a protected function used to separate tracking the login information. This allows us to better cleanly separate a PRO feature as well as unit test this block. This function writes log entries to the tracker_sessions table to record a login session.

include/MVC/SugarApplication.php

\SugarApplicationjump to top

Properties

Methods

\SugarApplication
jump to top