install/install_utils.php

Show:

inherited

Table of Contents

Functions

addDefaultRoles(
           $defaultRoles
              =
              array()
          )
        
        :
          void

Parameters

Name	Type	Description
$defaultRoles

add_digits(
           $quantity,  $string,  $min
              =
              0,  $max
              =
              9
          )
        
        :
          void

Parameters

Name	Type	Description
$quantity
$string
$min
$max

commitLanguagePack(
          bool $uninstall
              =
              false
          )
        
        :
          array

copies the temporary unzip'd files to their final destination removes unzip'd files from system if $uninstall=true

Parameters

Name	Type	Description
$uninstall	bool	uninstall true if uninstalling a language pack

Returns

Type	Description
array	sugar_config

commitModules(
           $unlink
              =
              false,  $type
              =
              'module'
          )
        
        :
          void

Parameters

Name	Type	Description
$unlink
$type

commitPatch(
           $unlink
              =
              false,  $type
              =
              'patch'
          )
        
        :
          void

Parameters

Name	Type	Description
$unlink
$type

copyFromArray(
          \intput_array $input_array, \needles $needles, \output_array $output_array
          )
        
        :
          void

given an array it will check to determine if the key exists in the array, if so it will addd to the return array

Parameters

Name	Type	Description
$input_array	\intput_array	haystack to check
$needles	\needles	list of needles to search for
$output_array	\output_array	the array to add the keys to

createEmailAddress(
          
          )
        
        :
          string

creates a random email address

Returns

Type	Description
string

createWebAddress(
          
          )
        
        :
          void

creates a random, DNS-clean webaddress

create_current_date_time(
          
          )
        
        :
          void

create_date(
           $year
              =
              null,  $mnth
              =
              null,  $day
              =
              null
          )
        
        :
          void

Parameters

Name	Type	Description
$year
$mnth
$day

create_db_user_creds(
           $numChars
              =
              10
          )
        
        :
          void

Parameters

Name	Type	Description
$numChars

create_default_users(
          
          )
        
        :
          void

create_past_date(
          
          )
        
        :
          void

create_phone_number(
          
          )
        
        :
          void

create_table_if_not_exist(
           $focus
          )
        
        :
          void

Parameters

Name	Type	Description
$focus

create_time(
           $hr
              =
              null,  $min
              =
              null,  $sec
              =
              null
          )
        
        :
          void

Parameters

Name	Type	Description
$hr
$min
$sec

create_writable_dir(
           $dirname
          )
        
        :
          void

Parameters

Name	Type	Description
$dirname

drop_table_install(
           $focus
          )
        
        :
          void

Drop old tables if table exists and told to drop it

Parameters

Name	Type	Description
$focus

enableInsideViewConnector(
          
          )
        
        :
          void

Enable the InsideView connector for the four default modules.

enableSugarFeeds(
          
          )
        
        :
          void

Fully enable SugarFeeds, enabling the user feed and all available modules that have SugarFeed data.

extractFile(
           $zip_file,  $file_in_zip,  $base_tmp_upgrade_dir
          )
        
        :
          void

Parameters

Name	Type	Description
$zip_file
$file_in_zip
$base_tmp_upgrade_dir

extractManifest(
           $zip_file,  $base_tmp_upgrade_dir
          )
        
        :
          void

Parameters

Name	Type	Description
$zip_file
$base_tmp_upgrade_dir

getDbConnection(
          
          )
        
        :
          void

getHostPortFromString(
           $hostname
              =
              ''
          )
        
        :
          void

Parameters

Name	Type	Description
$hostname

getInstallDbInstance(
          
          )
        
        :
          void

getInstallType(
           $type_string
          )
        
        :
          void

Parameters

Name	Type	Description
$type_string

getInstalledLangPacks(
           $showButtons
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$showButtons

getInstalledLanguages(
          
          )
        
        :
          array

finds all installed languages and returns an array with the names

Returns

Type	Description
array	langs array of installed languages

getLangPacks(
           $display_commit
              =
              true,  $types
              =
              array('langpack'),  $notice_text
              =
              ''
          )
        
        :
          string

searches upgrade dir for lang pack files.

Parameters

Name	Type	Description
$display_commit
$types
$notice_text

Returns

Type	Description
string	HTML of available lang packs

getLanguagePackName(
           $the_file
          )
        
        :
          void

Parameters

Name	Type	Description
$the_file

getLicenseContents(
           $filename
          )
        
        :
          void

Parameters

Name	Type	Description
$filename

getLicenseDisplay(
           $type,  $manifest,  $zipFile,  $next_step,  $license_file,  $clean_file
          )
        
        :
          void

Parameters

Name	Type	Description
$type
$manifest
$zipFile
$next_step
$license_file
$clean_file

getPackButton(
          string $type, string $manifest, string $zipFile, int $next_step,  $uninstallable
              =
              'Yes',  $showButtons
              =
              true
          )
        
        :
          string

creates the remove/delete form for langpack page

Parameters

Name	Type	Description
$type	string	type commit/remove
$manifest	string	manifest path to manifest file
$zipFile	string	zipFile path to uploaded zip file
$next_step	int	nextstep current step
$uninstallable
$showButtons

Returns

Type	Description
string	ret <form> for this package

getSugarConfigLanguageArray(
           $langZip
          )
        
        :
          void

Parameters

Name	Type	Description
$langZip

get_boolean_from_request(
           $field
          )
        
        :
          void

Parameters

Name	Type	Description
$field

get_help_button_url(
          
          )
        
        :
          void

handleDbCharsetCollation(
          
          )
        
        :
          void

ensures that the charset and collation for a given database is set MYSQL ONLY

handleDbCreateDatabase(
          
          )
        
        :
          void

creates the new database

handleDbCreateSugarUser(
          
          )
        
        :
          void

creates the Sugar DB user (if not admin)

handleHtaccess(
          
          )
        
        :
          void

(re)write the .htaccess file to prevent browser access to the log file

handleLog4Php(
          
          )
        
        :
          void

handles creation of Log4PHP properties file This function has been deprecated. Use SugarLogger.

handleSugarConfig(
          
          )
        
        :
          array

takes session vars and creates config.php

Returns

Type	Description
array	bottle collection of error messages

handleWebConfig(
          
          )
        
        :
          void

(re)write the web.config file to prevent browser access to the log file

insert_default_settings(
          
          )
        
        :
          void

installLog(
           $entry
          )
        
        :
          void

Parameters

Name	Type	Description
$entry

installerHook(
          string $function_name,  $options
              =
              array()
          )
        
        :
          mixed

Calls a custom function (if it exists) based on the first parameter, and returns result of function call, or 'undefined' if the function doesn't exist

Parameters

Name	Type	Description
$function_name	string	function name to call in custom install hooks
$options

Returns

Type	Description
mixed	function call result, or 'undefined'

langPackFinalMove(
          object $file
          )
        
        :
          bool

handles language pack uploads - code based off of upload_file->final_move() puts it into the cache/upload dir to be handed off to langPackUnpack();

Parameters

Name	Type	Description
$file	object	file UploadFile object

Returns

Type	Description
bool	true if successful

langPackUnpack(
           $unpack_type,  $full_file
          )
        
        :
          void

Parameters

Name	Type	Description
$unpack_type
$full_file

make_writable(
           $file
          )
        
        :
          void

Parameters

Name	Type	Description
$file

parseAcceptLanguage(
          
          )
        
        :
          string

returns lowercase lang encoding

Returns

Type	Description
string	encoding or blank on false

post_install_modules(
          
          )
        
        :
          void

This method will look for a file modules_post_install.php in the root directory and based on the contents of this file, it will silently install any modules as specified in this array.

print_debug_array(
           $name,  $debug_array
          )
        
        :
          void

Parameters

Name	Type	Description
$name
$debug_array

print_debug_comment(
          
          )
        
        :
          void

pullSilentInstallVarsIntoSession(
          
          )
        
        :
          void

recursive_is_writable(
           $start_file
          )
        
        :
          void

Parameters

Name	Type	Description
$start_file

recursive_make_writable(
           $start_file
          )
        
        :
          void

Parameters

Name	Type	Description
$start_file

removeLanguagePack(
          
          )
        
        :
          void

removes the installed language pack, but the zip is still in the cache dir

set_admin_password(
           $password
          )
        
        :
          void

Parameters

Name	Type	Description
$password

stripslashes_checkstrings(
           $value
          )
        
        :
          void

Parameters

Name	Type	Description
$value

uninstallLangPack(
          
          )
        
        :
          void

uninstalls the Language pack

uninstallLanguagePack(
          
          )
        
        :
          void

unlinkTempFiles(
           $manifest
              =
              '',  $zipFile
              =
              ''
          )
        
        :
          void

Parameters

Name	Type	Description
$manifest
$zipFile

updateUpgradeHistory(
          
          )
        
        :
          void

creates UpgradeHistory entries

validate_dbConfig(
          
          )
        
        :
          void

validate_manifest(
           $manifest
          )
        
        :
          void

Parameters

Name	Type	Description
$manifest

validate_siteConfig(
           $type
          )
        
        :
          void

Parameters

Name	Type	Description
$type

validate_systemOptions(
          
          )
        
        :
          void

writeSugarConfig(
          array $sugar_config
          )
        
        :
          void

takes the current value of $sugar_config and writes it out to config.php (sorta the same as the final step)

Parameters

Name	Type	Description
$sugar_config	array	sugar_config