claroline/claroline/admin/upgrade/upgrade.lib.php File Reference

Go to the source code of this file.

Data Structures
class	UpgradeTrackingOffset
Namespaces
namespace	UPGRADE
Functions
	upgrade_disp_header ()
	upgrade_disp_footer ()
	save_current_version_file ($clarolineVersion, $databaseVersion)
	get_current_version ()
	get_new_version ()
	upgrade_apply_sql ($array_query)
	upgrade_sql_query ($sql, $verbose=null)
	count_course_upgraded ($version)
	register_tool_in_main_database ($claro_label, $script_url, $icon, $default_access= 'ALL', $add_in_course= 'AUTOMATIC', $access_manager= 'COURSE_ADMIN')
	add_tool_in_course_tool_list ($claro_label, $access=null, $courseDbNameGlu=null)
	save_course_current_version ($course_code, $fileVersion)
	sql_repair_main_database ()
	sql_repair_course_database ($courseDbNameGlu)
	get_upgrade_status ($claro_label, $course_code=null)
	set_upgrade_status ($claro_label, $status, $course_code=null)
	clean_upgrade_status ($course_code=null)
	log_message ($message)
	open_upgrade_log ()
	upgrade_disp_auth_form ()
	fill_table_config_with_md5 ()

---

Function Documentation

add_tool_in_course_tool_list	(	$	claro_label,
		$	access = null,
		$	courseDbNameGlu = null
	)

Add a new tool in tool_list table of a course

Parameters:

	string	claro_label
	string	access level to tools if null get the default value from main table
	string	course db name glued

Returns:

boolean

Definition at line 372 of file upgrade.lib.php.

clean_upgrade_status

(

$

course_code = null

)

Clean status of a tool

Parameters:

string

course_code

Returns:

integer status value

Since:

1.7

Definition at line 567 of file upgrade.lib.php.

count_course_upgraded

(

$

version

)

Count courses, courses upgraded and upgrade failed

Parameters:

	string	new database version
	string	new file version

Returns:

array

In cours table, versionClaro contain :

• 'error' if upgrade already tried but failed
• version of last upgrade succeed (so previous or current)

Definition at line 263 of file upgrade.lib.php.

fill_table_config_with_md5

(

)

Definition at line 690 of file upgrade.lib.php.

get_current_version

(

)

Get current version of claroline and database

Returns:

array with current version of claroline and database

Since:

1.7

Definition at line 137 of file upgrade.lib.php.

get_new_version

(

)

Get new version of claroline and database

Returns:

array with new version of claroline and database

Since:

1.7

Definition at line 167 of file upgrade.lib.php.

get_upgrade_status	(	$	claro_label,
		$	course_code = null
	)

Get upgrade status of a tool

Parameters:

	string	claro_label
	string	course_code optionnal

Returns:

integer status value

Since:

1.7

Definition at line 486 of file upgrade.lib.php.

log_message

(

$

message

)

Write in log file

Parameters:

	string	claroline version
	string	database version

Since:

1.7

Definition at line 592 of file upgrade.lib.php.

open_upgrade_log

(

)

Open log file

Parameters:

	string	claroline version
	string	database version

Since:

1.7

Definition at line 624 of file upgrade.lib.php.

register_tool_in_main_database	(	$	claro_label,
		$	script_url,
		$	icon,
		$	default_access = 'ALL',
		$	add_in_course = 'AUTOMATIC',
		$	access_manager = 'COURSE_ADMIN'
	)

Add a new tool in course_tool table

Parameters:

	string	claro_label
	string	script_url
	string	icon
	string	default_access
	string	add_in_course
	string	access_manager

Returns:

boolean

Definition at line 319 of file upgrade.lib.php.

save_course_current_version	(	$	course_code,
		$	fileVersion
	)

Save the file currentVersion.inc.php

Parameters:

	string	course code
	string	claroline version
	string	database version

Since:

1.7

Definition at line 427 of file upgrade.lib.php.

save_current_version_file	(	$	clarolineVersion,
		$	databaseVersion
	)

Save the file currentVersion.inc.php

Parameters:

	string	claroline version
	string	database version

Since:

1.7

Definition at line 112 of file upgrade.lib.php.

set_upgrade_status	(	$	claro_label,
		$	status,
		$	course_code = null
	)

Set status of a tool

Parameters:

	string	claro_label
	int	status value
	string	course_code optionnal

Returns:

integer status value

Since:

1.7

Definition at line 536 of file upgrade.lib.php.

sql_repair_course_database

(

$

courseDbNameGlu

)

Execute repair query on course table

Since:

1.7

Definition at line 464 of file upgrade.lib.php.

sql_repair_main_database

(

)

Execute repair query on main table

Since:

1.7

Definition at line 447 of file upgrade.lib.php.

upgrade_apply_sql

(

$

array_query

)

Apply sql queries to upgrade

Parameters:

	array	sql queries
	boolean	verbose mode

Returns:

integer number of errors

Since:

1.7

Definition at line 192 of file upgrade.lib.php.

upgrade_disp_auth_form

(

)

Definition at line 656 of file upgrade.lib.php.

upgrade_disp_footer

(

)

Display footer of the upgrade tool

Parameters:

	string	claroline version
	string	database version

Since:

1.7

Definition at line 87 of file upgrade.lib.php.

upgrade_disp_header

(

)

Display header of the upgrade tool

Parameters:

	string	claroline version
	string	database version

Since:

1.7

Definition at line 29 of file upgrade.lib.php.

upgrade_sql_query	(	$	sql,
		$	verbose = null
	)

Definition at line 208 of file upgrade.lib.php.