ModuleInstall/ModuleInstaller.php

Show:

inherited

Constants
- DISABLED_PATH
Functions
- UpdateSystemTabs
Classes
- \ModuleInstaller

Table of Contents

Constants

 
                DISABLED_PATH
                = 'Disabled'

Functions

UpdateSystemTabs(
           $action,  $installed_modules
          )
        
        :
          void

Parameters

Name	Type	Description
$action
$installed_modules

\ModuleInstaller
jump to top

Package:

Properties


                 $base_dir= ''''

Default value''Details

Type: n/a


                 $disabled_path= 'DISABLED_PATH'

Default valueDISABLED_PATHDetails

Type: n/a


                 $modules= 'array()'

Default valuearray()Details

Type: n/a


                 $modulesInPackage= 'array()'

Default valuearray()Details

Type: n/a


                 $silent= 'false'

Default valuefalseDetails

Type: n/a

Methods

ModuleInstaller(
          
          )
        
        :
          void

__call(
           $name,  $args
          )
        
        :
          void

BC implementation to provide specific calls to extensions

Parameters

Name	Type	Description
$name
$args

abort(
          \errors $errors
              =
              array()
          )
        
        :
          void

Static function which allows a module developer to abort their progress, pass in an array of errors and redirect back to the main module loader page

Parameters

Name	Type	Description
$errors	\errors	an array of error messages which will be displayed on the main module loader page once it is loaded.

addFieldsToLayout(
           $layoutAdditions
          )
        
        :
          void

Parameters

Name	Type	Description
$layoutAdditions

copy_path(
           $from,  $to,  $backup_path
              =
              '',  $uninstall
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$from
$to
$backup_path
$uninstall

copy_recursive_with_backup(
           $source,  $dest,  $backup_path,  $uninstall
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$source
$dest
$backup_path
$uninstall

dir_file_count(
           $path
          )
        
        :
          void

Parameters

Name	Type	Description
$path

dir_get_files(
           $path,  $base_path
          )
        
        :
          void

Parameters

Name	Type	Description
$path
$base_path

disable(
           $base_dir
          )
        
        :
          void

Parameters

Name	Type	Description
$base_dir

disableExt(
          string $section, string $extname, string $module
              =
              ''
          )
        
        :
          void

Disable generic extension

Parameters

Name	Type	Description
$section	string	Install file section name
$extname	string	Extension directory
$module	string	This extension belongs to a specific module

disable_copy(
          
          )
        
        :
          void

disable_dashlets(
          
          )
        
        :
          void

disable_extensions(
          
          )
        
        :
          void

disable_global_search(
          
          )
        
        :
          void

Method disables module in global search configurations by disabled_module_visible key

return bool

disable_languages(
          
          )
        
        :
          void

disable_manifest_logichooks(
          
          )
        
        :
          void

disable_relationships(
           $action
              =
              'disable'
          )
        
        :
          void

Parameters

Name	Type	Description
$action

enable(
           $base_dir,  $is_upgrade
              =
              false,  $previous_version
              =
              ''
          )
        
        :
          void

Parameters

Name	Type	Description
$base_dir
$is_upgrade
$previous_version

enableExt(
          string $section, string $extname, string $module
              =
              ''
          )
        
        :
          void

Enable generic extension

Parameters

Name	Type	Description
$section	string	Install file section name
$extname	string	Extension directory
$module	string	This extension belongs to a specific module

enable_copy(
          
          )
        
        :
          void

enable_dashlets(
          
          )
        
        :
          void

enable_extensions(
          
          )
        
        :
          void

enable_global_search(
          
          )
        
        :
          void

Method enables module in global search configurations by disabled_module_visible key

return bool

enable_languages(
          
          )
        
        :
          void

enable_layoutdef(
           $to_module
          )
        
        :
          void

Parameters

Name	Type	Description
$to_module

enable_manifest_logichooks(
          
          )
        
        :
          void

enable_relationships(
          
          )
        
        :
          void

enable_vardef(
           $to_module
          )
        
        :
          void

Parameters

Name	Type	Description
$to_module

getErrors(
          
          )
        
        :
          \an

Return the set of errors stored in the SESSION

Returns

Type	Description
\an	array of errors

getExtDir(
          string $module
          )
        
        :
          void

Get directory where module's extensions go

Parameters

Name	Type	Description
$module	string	Module name

install(
           $base_dir,  $is_upgrade
              =
              false,  $previous_version
              =
              ''
          )
        
        :
          void

Parameters

Name	Type	Description
$base_dir
$is_upgrade
$previous_version

installExt(
          string $section, string $extname, string $module
              =
              ''
          )
        
        :
          void

Install file(s) into Ext/ part

Parameters

Name	Type	Description
$section	string	Name of the install file section
$extname	string	Name in Ext directory
$module	string	This extension belongs to a specific module

install_beans(
           $beans
          )
        
        :
          void

Parameters

Name	Type	Description
$beans

install_connectors(
          
          )
        
        :
          void

install_copy(
          
          )
        
        :
          void

install_custom_fields(
           $fields
          )
        
        :
          void

Parameters

Name	Type	Description
$fields

install_dashlets(
          
          )
        
        :
          void

install_dcactions(
          
          )
        
        :
          void

install_extensions(
          
          )
        
        :
          void

install_images(
          
          )
        
        :
          void

install_languages(
          
          )
        
        :
          void

install_layoutdef(
           $from,  $to_module
          )
        
        :
          void

Parameters

Name	Type	Description
$from
$to_module

install_layoutfields(
          
          )
        
        :
          void

install_modules(
          
          )
        
        :
          void

install_relationship(
           $file
          )
        
        :
          void

Parameters

Name	Type	Description
$file

install_relationships(
          
          )
        
        :
          void

install_user_prefs(
           $module,  $hide_from_user
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$module
$hide_from_user

install_vardef(
           $from,  $to_module
          )
        
        :
          void

Parameters

Name	Type	Description
$from
$to_module

log(
           $str
          )
        
        :
          void

Parameters

Name	Type	Description
$str

merge_files(
           $path,  $name,  $filter
              =
              '',  $application
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$path
$name
$filter
$application

post_execute(
          
          )
        
        :
          void

post_uninstall(
          
          )
        
        :
          void

pre_execute(
          
          )
        
        :
          void

pre_uninstall(
          
          )
        
        :
          void

rebuildExt(
          string $ext, string $filename
          )
        
        :
          void

Rebuild generic extension

Parameters

Name	Type	Description
$ext	string	Extension directory
$filename	string	Target filename

rebuild_all(
          boolean $silent
              =
              false
          )
        
        :
          void

Rebuilds the extension files found in custom/Extension

Parameters

Name	Type	Description
$silent	boolean

rebuild_dashletcontainers(
          
          )
        
        :
          void

rebuild_extensions(
          
          )
        
        :
          void

rebuild_languages(
           $languages
              =
              array(),  $modules
              =
              ""
          )
        
        :
          void

Parameters

Name	Type	Description
$languages
$modules

rebuild_relationships(
          
          )
        
        :
          void

rebuild_tabledictionary(
          
          )
        
        :
          void

rebuild_vardefs(
          
          )
        
        :
          void

removeFieldsFromLayout(
           $layoutAdditions
          )
        
        :
          void

Parameters

Name	Type	Description
$layoutAdditions

remove_acl_actions(
          
          )
        
        :
          void

repair_indices(
          
          )
        
        :
          void

Wrapper call to modules/Administration/RepairIndex.php

reset_opcodes(
          
          )
        
        :
          void

uninstall(
           $base_dir
          )
        
        :
          void

Parameters

Name	Type	Description
$base_dir

uninstallExt(
          string $section, string $extname, string $module
              =
              ''
          )
        
        :
          void

Uninstall file(s) into Ext/ part

Parameters

Name	Type	Description
$section	string	Name of the install file section
$extname	string	Name in Ext directory
$module	string	This extension belongs to a specific module

uninstall_beans(
           $beans
          )
        
        :
          void

Parameters

Name	Type	Description
$beans

uninstall_connectors(
          
          )
        
        :
          void

uninstall_copy(
          
          )
        
        :
          void

uninstall_custom_fields(
           $fields
          )
        
        :
          void

Parameters

Name	Type	Description
$fields

uninstall_customizations(
           $beans
          )
        
        :
          void

Remove any customizations made within Studio while the module was installed.

Parameters

Name	Type	Description
$beans

uninstall_dashlets(
          
          )
        
        :
          void

uninstall_dcactions(
          
          )
        
        :
          void

uninstall_extensions(
          
          )
        
        :
          void

uninstall_global_search(
          
          )
        
        :
          void

Method removes module from global search configurations

return bool

uninstall_languages(
          
          )
        
        :
          void

uninstall_layoutfields(
          
          )
        
        :
          void

uninstall_new_files(
           $cp,  $backup_path
          )
        
        :
          void

Removes any files that were added by the loaded module. If the files already existed prior to install it will be handled by copy_path with the uninstall parameter.

Parameters

Name	Type	Description
$cp
$backup_path

uninstall_relationship(
           $file,  $rel_dictionary
              =
              null
          )
        
        :
          void

Parameters

Name	Type	Description
$file
$rel_dictionary

uninstall_relationships(
           $include_studio_relationships
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$include_studio_relationships

uninstall_user_prefs(
           $module
          )
        
        :
          void

Parameters

Name	Type	Description
$module

ModuleInstall/ModuleInstaller.php

Constants

Functions

\ModuleInstallerjump to top

Properties

Methods

\ModuleInstaller
jump to top