Modsetup
class Modsetup
Module Setup Class Helper for module installation
Traits
Properties
$module | |||
$sql_fieldtypes | |||
$sql_default_params | |||
$sql_smartfields | |||
$sql_fieldrename | |||
$shellplugin_types | |||
$silent | |||
$messages | |||
$errors | |||
$execute_sql | |||
$sql_queue | |||
$new_pages | |||
$user_group_to_id | |||
$dont_touch | |||
$policy_levels | |||
$testrun |
Methods
No description
No description
No description
No description
No description
Check and Install Daemons
No description
Checks all registered integrations for their availability and updates the integration database
No description
No description
No description
No description
No description
No description
No description
No description
No description
closes given transaction and returns
No description
No description
No description
Get config.yml values for a module
Get config.yml values for a module
No description
No description
No description
Returns an array with information about each shellplugin's usage by the installed modules
If system is in maintenance mode, the maintenance message is returned. Otherwise false
No description
No description
No description
No description
No description
No description
No description
No description
Tries to install the passed shellplugin; Must be run from command line
No description
Return true if system is in maintenance mode
Starts the seeding of the passed instance with the passed seed (if existing)
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
Callback to remove language markers from passed text (e.g. +++....+++)
No description
Return XELOS version for the supplied build number in PHP style notation e.g. 7.1.5 for use with version_compare()
Runs a Seed Script YML which contains a seeding plan The scripts must be available in the system's setup/seeds/ folder
No description
No description
Set currently active module
Set path rights in XELOS
Set the system to maintenance mode -> Maintenance Page is being shown, Daemons stopping automaticaly and Crons are no longer executed
check if there is still a transaction open - if so return false if no transaction is open, open one and return true
No description
No description
Return to normal execution. Pages are deleiverd normaly, Crons are executed, Daemons have to be started manually or by cron!
Run Composer Shell Command to update dependencies
No description
Update module
Updates the ShellPlugin registry with the information provided by the module and adds missing integration data
Updates all tokens of the specified module in the database
Details
at line 172
__construct()
No description
at line 4652
bool
add_module_to_registry(string $module_name, int|false $version, bool|string $package_name = false, bool|string $package_version = false, string $vendor = 'auto')
No description
at line 1016
check_config_page($module, $instance = false, $execute_sql = false)
No description
at line 835
check_config_variables($module, $instance = false, $execute_sql = false)
No description
at line 2162
check_cron($module, $instance = false)
No description
at line 2288
check_daemon(mixed $module, mixed $instance = false)
Check and Install Daemons
at line 2411
check_policies($module, $instance, $instance_details = false)
No description
at line 3514
check_shellplugin_availability($type = false, $name = false)
Checks all registered integrations for their availability and updates the integration database
at line 1332
check_systemconfig_variables($module)
No description
at line 4371
bool
compare_pages_and_instance_registry()
No description
at line 2736
create_datasources($instance_name, $module_name)
No description
at line 3030
bool
create_dependencies($instance_id, $module, $dependencies_settings = false)
No description
at line 330
array
create_structure_array(array $structure, $table_name)
No description
at line 631
create_table_by_structure($name, $structure, $instance_id = false)
No description
at line 261
create_tables($instance_id, $module, string $table_prefix = "xm_test_", bool $i18n_check = true)
internal | param string $ instance name |
internal | param string $ module name |
internal | param string $ table prefix |
No description
at line 237
drop_all_tables($really)
No description
at line 217
drop_tables($module, $table_prefix, $truncate = false)
No description
at line 4544
end_install_transaction($transaction)
closes given transaction and returns
at line 782
execute_sql_queue()
No description
at line 2141
array
get_config_group_details(string $instance_id, bool|string $module_name = false)
No description
at line 1920
get_config_values($instance_id, $module_id = false)
No description
at line 3586
array
get_config_yml(mixed $module, $vendor = false, $keep_language_markers = false)
Get config.yml values for a module
at line 3597
array
get_database_yml(mixed $module, $i18n = 'auto')
Get config.yml values for a module
at line 3167
array
get_dependencies_check_array($module, $details = true)
No description
at line 2029
get_dependency_values($instance_id, $module_name = false)
No description
at line 3672
array|bool
get_schema($module, $config_file, bool $vendor = false, bool $keep_language_markers = false)
No description
at line 3393
get_shellplugin_usage_list()
Returns an array with information about each shellplugin's usage by the installed modules
at line 5646
static
get_system_maintenance_message()
If system is in maintenance mode, the maintenance message is returned. Otherwise false
at line 2708
get_table_prefix($instance_id)
No description
at line 2885
bool
insert_default_config($instance_id, $module)
No description
at line 5103
bool
insert_document_registry($instance_id, $module)
No description
at line 1483
array
insert_initial_values($module, $instance = false, $execute = false, $sources = array('sql', 'yml'))
No description
at line 5426
bool
insert_notification_registry(string $instance_id, string $module, bool $overwrite = true)
No description
at line 1623
bool
insert_pages_to_navigation($instance_name, $module_name, $normal_node = false, $admin_node = false, $instance_title = false, $insert_only_missing = false)
No description
at line 2938
bool
insert_provided_hooks($instance_id, $module)
No description
at line 3735
int
install_new_instance($module, $instance_id, $instance_title = false, $instance_details = array(), $root_nodes = array(), $custom_values = array(), $add_navigation = true)
No description
at line 3421
install_shellplugin(string $type, string $name)
Tries to install the passed shellplugin; Must be run from command line
at line 5719
bool
isRequiredDependency(string $module)
No description
at line 5633
static
is_system_maintenance()
Return true if system is in maintenance mode
in
Seeding at line 251
loadSeed($instance_id, string[] $seeds = array("base"), int $group_id = 0, string|null $templateModule = null)
Starts the seeding of the passed instance with the passed seed (if existing)
at line 5023
log($message)
No description
in
Seeding at line 21
prepareInstallation()
No description
at line 2542
bool
register_all_pages($instance_name, $module_name, $instance_details = false)
No description
at line 2650
int
register_instance(string $instance_name, string $module, array $instance_details = array())
No description
at line 4119
bool
remove_document_registration($instance_id)
No description
at line 4292
bool
remove_instance_cron($instance_id, $module = false)
No description
at line 4261
bool
remove_instance_daemon($instance_id, $module = false)
No description
at line 4158
bool
remove_instance_datasource($instance_id)
No description
at line 4215
bool
remove_instance_filesource($instance_id)
No description
at line 4081
bool
remove_instance_from_config($instance_id)
No description
at line 3993
bool
remove_instance_from_navigation($instance_id)
No description
at line 4062
bool
remove_instance_from_pages($instance_id)
No description
at line 4324
bool
remove_instance_from_policy($instance_id, $module = false)
No description
at line 3974
bool
remove_instance_from_registry($instance_id)
No description
at line 4100
bool
remove_instance_hook($instance_id)
No description
at line 3719
remove_language_marker(mixed $item, mixed $key)
Callback to remove language markers from passed text (e.g. +++....+++)
at line 4138
bool
remove_notification_registration($instance_id)
No description
in
Seeding at line 9
resetInstallation($delete_xelos_installation = false)
No description
at line 5659
string
revisionToVersion(int $revision)
Return XELOS version for the supplied build number in PHP style notation e.g. 7.1.5 for use with version_compare()
in
Seeding at line 39
bool|void
runSeedScript(string $seed_script, bool $additional_default_seeds = false, bool $ignoreCache = false, string|null $templateModule = null)
Runs a Seed Script YML which contains a seeding plan The scripts must be available in the system's setup/seeds/ folder
at line 1893
bool
save_configuration($instance, $module, $values)
No description
at line 5554
set_initial_version_check($framework = true)
No description
at line 187
set_module(mixed $module, mixed $vendor = false)
Set currently active module
at line 5031
set_path_rights(bool $include_files = false)
Set path rights in XELOS
at line 5599
static
set_system_maintenance(string $message = false)
Set the system to maintenance mode -> Maintenance Page is being shown, Daemons stopping automaticaly and Crons are no longer executed
at line 4480
bool
start_install_transaction($transaction)
check if there is still a transaction open - if so return false if no transaction is open, open one and return true
at line 4398
trigger_event(string $event, bool|string $module = false, bool $instance_id = false, bool $install_event_revision = false)
No description
at line 3878
bool
uninstall_instance($instance_id)
No description
at line 5615
static
unset_system_maintenance()
Return to normal execution. Pages are deleiverd normaly, Crons are executed, Daemons have to be started manually or by cron!
at line 4964
bool|null
update_composer_dependencies()
Run Composer Shell Command to update dependencies
at line 2859
update_datasource($module, $table_prefix, $db_schema)
No description
at line 4798
bool
update_module(mixed $module_name, mixed $silent = true, mixed $instance_id = false, bool $update_dependencies = true)
Update module
at line 3321
update_shellplugin_dependencies(string $module, bool|string $instance = false)
Updates the ShellPlugin registry with the information provided by the module and adds missing integration data
at line 3379
bool
update_tokens(string $module_name)
Updates all tokens of the specified module in the database