Class DefaultModuleSetup

Summary

File
Package hierarchy PHPBoost\Module
Class hierarchy \DefaultModuleSetup
Implements \ModuleSetup

package
PHPBoost
subpackage
Module
copyright
© 2005-2020 PHPBoost
license
https://www.gnu.org/licenses/gpl-3.0.html GNU/GPL-3.0
author
Loic ROUCHON horn@phpboost.com
version
PHPBoost 6.0 - last update: 2020 02 28
since
PHPBoost 2.0 - 2009 01 16
contributor
Julien BRISWALTER j1.seth@phpboost.com

Methods

__static()

__static()

static

Inherited from \DefaultModuleSetup

Tags

None found

__construct()

__construct( $module_id = '')

Parameters

$module_id

Inherited from \DefaultModuleSetup

Tags

None found

check_environment()

check_environment() : \ValidationResult

Returns a validation result containing environment errors

Returns

\ValidationResult —

a validation result containing environment errors

Inherited from \DefaultModuleSetup

Tags

None found

install()

install()

Install the module

Inherited from \DefaultModuleSetup

Tags

None found

uninstall()

uninstall() : string

Uninstall the module

Returns

string —

error if module uninstall failled

Inherited from \DefaultModuleSetup

Tags

None found

upgrade()

upgrade( $installed_version) : \version

Upgrade the module

Parameters

$installed_version

Returns

\version —

upgrading

Inherited from \DefaultModuleSetup

Tags

None found

get_sql_tables_list()

get_sql_tables_list()

Inherited from \DefaultModuleSetup

Tags

None found

insert_default_data()

insert_default_data()

Inherited from \DefaultModuleSetup

Tags

None found

insert_default_categories()

insert_default_categories( $lang)

Parameters

$lang

Inherited from \DefaultModuleSetup

Tags

None found

insert_default_items()

insert_default_items( $lang)

Parameters

$lang

Inherited from \DefaultModuleSetup

Tags

None found

add_category()

add_category( $name,  $description = '',  $thumbnail = \FormFieldThumbnail::DEFAULT_VALUE,  $id_parent,  $auth = '',  $additional_fields = array())

Parameters

	$name
	$description
	$thumbnail
	$id_parent
	$auth
	$additional_fields

Inherited from \DefaultModuleSetup

Tags

None found

add_item()

add_item( $title,  $content,  $summary = '',  $thumbnail = \FormFieldThumbnail::DEFAULT_VALUE,  $id_category = \Category::ROOT_CATEGORY,  $additional_fields = array())

Parameters

	$title
	$content
	$summary
	$thumbnail
	$id_category
	$additional_fields

Inherited from \DefaultModuleSetup

Tags

None found

drop_tables()

drop_tables()

Inherited from \DefaultModuleSetup

Tags

None found

create_tables()

create_tables()

Inherited from \DefaultModuleSetup

Tags

None found

Properties

$db_querier

$db_querier :

Tags

None found

$dbms_utils

$dbms_utils :

Tags

None found

$module_configuration

$module_configuration :

Tags

None found

$module_id

$module_id :

Tags

None found

$id_category

$id_category :

Tags

None found

$id_item

$id_item :

Tags

None found