modules/Administration/updater_utils.php

Show:

inherited

Table of Contents

Functions

authenticateDownloadKey(
          
          )
        
        :
          void

checkDownloadKey(
           $data
          )
        
        :
          void

Parameters

Name	Type	Description
$data

checkSystemLicenseStatus(
          
          )
        
        :
          void

checkSystemState(
          
          )
        
        :
          void

check_now(
           $send_usage_info
              =
              true,  $get_request_data
              =
              false,  $response_data
              =
              false,  $from_install
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$send_usage_info
$get_request_data
$response_data
$from_install

compareVersions(
           $ver1,  $ver2
          )
        
        :
          void

Parameters

Name	Type	Description
$ver1
$ver2

getBaseSystemInfo(
           $send_usage_info
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$send_usage_info

getModuleWhiteListForLicenseCheck(
          \User $user
          )
        
        :
          array

Whitelist of modules and actions that don't need redirect

Use following standard for whitelist: array( 'module_name_1' => array('action_name_1', 'action_name_2', ...), // Allow only "action_name_1" and "action_name_2" for "module_name_1" 'module_name_2' => 'all', | // Allow ALL actions in module "module_name_2" ... )

Parameters

Name	Type	Description
$user	\User

Returns

Type	Description
array

getSystemInfo(
           $send_usage_info
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$send_usage_info

get_CheckUpdates_config_setting(
          
          )
        
        :
          void

get_last_check_date_config_setting(
          
          )
        
        :
          void

get_last_check_version_config_setting(
          
          )
        
        :
          void

get_sugarbeat(
          
          )
        
        :
          void

hasExceededOfflineClientLicenses(
           $num_oc_lic
          )
        
        :
          void

Parameters

Name	Type	Description
$num_oc_lic

isAboutToExpire(
           $expire_date,  $days_before_warning
              =
              7
          )
        
        :
          void

Parameters

Name	Type	Description
$expire_date
$days_before_warning

isNeedRedirectDependingOnUserAndSystemState(
          string $state, string $module
              =
              null, string $action
              =
              null,  $whiteList
              =
              array()
          )
        
        :
          boolean

Check if $module and $action don't get into whitelist and do we need redirect

Parameters

Name	Type	Description
$state	string	Now works only for 'LICENSE_KEY' state (TODO: do we need any other state?)
$module	string	Module to check
$action	string	(optional) Action to check. Can be omitted because some modules include all actions
$whiteList

Returns

Type	Description
boolean

loadLicense(
           $firstLogin
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$firstLogin

loginLicense(
          
          )
        
        :
          void

ocLicense(
          
          )
        
        :
          void

setSystemState(
          string $state
          )
        
        :
          void

Redirect current user if current module and action isn't in whitelist

Parameters

Name	Type	Description
$state	string	Now works only for 'LICENSE_KEY' state (TODO: do we need any other state?)

Details

Global: User $current_user User object that stores current application user

set_CheckUpdates_config_setting(
           $value
          )
        
        :
          void

Parameters

Name	Type	Description
$value

set_last_check_date_config_setting(
           $value
          )
        
        :
          void

Parameters

Name	Type	Description
$value

set_last_check_version_config_setting(
           $value
          )
        
        :
          void

Parameters

Name	Type	Description
$value

set_sugarbeat(
           $value
          )
        
        :
          void

Parameters

Name	Type	Description
$value

shouldCheckSugar(
          
          )
        
        :
          void