Development:Automatic Course Archival - Revision history

Mudrd8mz: Text replacement - "class="nicetable"" to "class="wikitable""

2021-07-14T13:24:38Z

Text replacement - "class="nicetable"" to "class="wikitable""

← Older revision		Revision as of 13:24, 14 July 2021
Line 9:		Line 9:
	To reduce confusion, some terms and definitions are presented below:		To reduce confusion, some terms and definitions are presented below:

	{\| class="~~nicetable~~"		{\| class="wikitable"
	!Term		!Term
	!Definition		!Definition

Luciandipeso: /* ArchiveCategory::set_defaults($categoryid, $options_array) */

2009-05-05T21:16:43Z

ArchiveCategory::set_defaults($categoryid, $options_array)

← Older revision		Revision as of 21:16, 5 May 2009
Line 169:		Line 169:
	Sets archive defaults for a particular category (all options are not required—if not present, site-wide defaults will be used). Returns true on success, false on failure. The $option_array should have the following format:		Sets archive defaults for a particular category (all options are not required—if not present, site-wide defaults will be used). Returns true on success, false on failure. The $option_array should have the following format:

	Array(~~<br />~~		<pre>Array(
	'archive_enabled'=>[true\|false] ~~<br />~~		'archive_enabled'=>[true\|false]
	'archive_date_point'=>'[epoch\|course_end\|...]', ~~<br />~~		'archive_date_point'=>'[epoch\|course_end\|...]',
	'archive_date'=>~~<i>~~int~~</i>~~, ~~<br />~~		'archive_date'=>[int],
	'delete_enabled'=>[true\|false] ~~<br />~~		'delete_enabled'=>[true\|false]
	'delete_date_type'=>'[epoch\|course_end\|...]', ~~<br />~~		'delete_date_type'=>'[epoch\|course_end\|...]',
	'delete_date'=>~~<i>~~int~~</i>~~, <br />		'delete_date'=>[int],
	)		)</pre>

	===ArchiveCategory::remove_defaults($categoryid)===		===ArchiveCategory::remove_defaults($categoryid)===

Luciandipeso: /* ArchiveCourse::set_archive_options($courseid, $options_array) */

2009-05-05T21:16:32Z

ArchiveCourse::set_archive_options($courseid, $options_array)

← Older revision		Revision as of 21:16, 5 May 2009
Line 153:		Line 153:
	'archive_enabled'=>[true\|false]		'archive_enabled'=>[true\|false]
	'archive_date_point'=>'[epoch\|course_end\|...]',		'archive_date_point'=>'[epoch\|course_end\|...]',
	'archive_date'=>int,		'archive_date'=>[int],
	'delete_enabled'=>[true\|false]		'delete_enabled'=>[true\|false]
	'delete_date_type'=>'[epoch\|course_end\|...]',		'delete_date_type'=>'[epoch\|course_end\|...]',
	'delete_date'=>int,		'delete_date'=>[int],
	)</pre>		)</pre>

Luciandipeso: /* ArchiveCourse::set_archive_options($courseid, $options_array) */

2009-05-05T21:16:06Z

ArchiveCourse::set_archive_options($courseid, $options_array)

← Older revision		Revision as of 21:16, 5 May 2009
Line 150:		Line 150:
	Sets archive options for a particular course (all options are not required—if not present, defaults will be used). Returns true on success, false on failure. The $option_array should have the following format:		Sets archive options for a particular course (all options are not required—if not present, defaults will be used). Returns true on success, false on failure. The $option_array should have the following format:

	<pre>Array(~~<br />~~		<pre>Array(
	'archive_enabled'=>[true\|false] ~~<br />~~		'archive_enabled'=>[true\|false]
	'archive_date_point'=>'[epoch\|course_end\|...]', ~~<br />~~		'archive_date_point'=>'[epoch\|course_end\|...]',
	'archive_date'=~~><i~~>int~~</i>~~, ~~<br />~~		'archive_date'=>int,
	'delete_enabled'=>[true\|false] ~~<br />~~		'delete_enabled'=>[true\|false]
	'delete_date_type'=>'[epoch\|course_end\|...]', ~~<br />~~		'delete_date_type'=>'[epoch\|course_end\|...]',
	'delete_date'=~~><i~~>int~~</i>~~, ~~<br />~~		'delete_date'=>int,
	)</pre>		)</pre>

Luciandipeso: /* ArchiveCourse::set_archive_options($courseid, $options_array) */

2009-05-05T21:15:32Z

ArchiveCourse::set_archive_options($courseid, $options_array)

← Older revision		Revision as of 21:15, 5 May 2009
Line 150:		Line 150:
	Sets archive options for a particular course (all options are not required—if not present, defaults will be used). Returns true on success, false on failure. The $option_array should have the following format:		Sets archive options for a particular course (all options are not required—if not present, defaults will be used). Returns true on success, false on failure. The $option_array should have the following format:

	<~~nowiki~~>Array(<br />		<pre>Array(<br />
	'archive_enabled'=>[true\|false] <br />		'archive_enabled'=>[true\|false] <br />
	'archive_date_point'=>'[epoch\|course_end\|...]', <br />		'archive_date_point'=>'[epoch\|course_end\|...]', <br />
Line 157:		Line 157:
	'delete_date_type'=>'[epoch\|course_end\|...]', <br />		'delete_date_type'=>'[epoch\|course_end\|...]', <br />
	'delete_date'=><i>int</i>, <br />		'delete_date'=><i>int</i>, <br />
	)</~~nowiki~~>		)</pre>

	===ArchiveCourse::unarchive_course($courseid)===		===ArchiveCourse::unarchive_course($courseid)===

Luciandipeso: /* ArchiveCourse::set_archive_options($courseid, $options_array) */

2009-05-05T21:15:02Z

ArchiveCourse::set_archive_options($courseid, $options_array)

← Older revision		Revision as of 21:15, 5 May 2009
Line 150:		Line 150:
	Sets archive options for a particular course (all options are not required—if not present, defaults will be used). Returns true on success, false on failure. The $option_array should have the following format:		Sets archive options for a particular course (all options are not required—if not present, defaults will be used). Returns true on success, false on failure. The $option_array should have the following format:

	Array(<br />		<nowiki>Array(<br />
	'archive_enabled'=>[true\|false] <br />		'archive_enabled'=>[true\|false] <br />
	'archive_date_point'=>'[epoch\|course_end\|...]', <br />		'archive_date_point'=>'[epoch\|course_end\|...]', <br />
Line 157:		Line 157:
	'delete_date_type'=>'[epoch\|course_end\|...]', <br />		'delete_date_type'=>'[epoch\|course_end\|...]', <br />
	'delete_date'=><i>int</i>, <br />		'delete_date'=><i>int</i>, <br />
	)		)</nowiki>


	===ArchiveCourse::unarchive_course($courseid)===		===ArchiveCourse::unarchive_course($courseid)===

Luciandipeso at 19:08, 5 May 2009

2009-05-05T19:08:47Z

← Older revision		Revision as of 19:08, 5 May 2009
Line 91:		Line 91:
	\|unique; The category		\|unique; The category
	\|-		\|-
	\|"~~enabled~~"		\|"archive_enabled"
	\|int(1)		\|int(1)
	\|<center>1</center>		\|<center>1</center>
	\|If automatic archiving~~/deleting~~ should be enabled by default for these courses.		\|If automatic archiving should be enabled by default for these courses.
	\|-		\|-
	\|"~~archive_date_type~~"		\|"archive_date_point"
	\|varchar(10)		\|varchar(10)
	\|<center>~~NULL~~</center>		\|<center>"epoch"</center>
	\|Can be '~~relative~~', '~~absolute~~', ~~or NULL; If NULL~~, courses should ~~not~~ be ~~automatically~~ archived ~~by default~~. If '~~relative~~', ~~the value stored in~~ archive_date ~~is the number of days~~ after the end of the course~~. If 'absolute', the value stored in archive_date is a Unix timestamp~~.		\|Can be 'epoch', 'course_end', and in the future, some other values. Stores the point from which archive_date should be compared. E.g., if 'epoch', courses should be archived <i>archive_date</i> seconds after the Unix epoch. If 'course_end', courses should be archived <i>archive_date</i> seconds after the end of the course.
	\|-		\|-
	\|"archive_date"		\|"archive_date"
	\|int(10)		\|int(10)
	\|<center>~~NULL~~</center>		\|<center>0</center>
	\|When courses should be archived ~~by default~~. ~~Can either be~~ expressed as ~~an absolute value (as a Unix timestamp), or a relative value (~~the number of ~~days~~ after ~~the end of the course)~~. ~~This~~ is set ~~in the archive_date_type column~~.		\|When courses should be archived. Is expressed as the number of seconds after archive_date_point. (If archive_date_point is set to 'epoch', this is effectively a Unix timestamp.)
	\|-		\|-
	\|"~~delete_date_type~~"		\|"delete_enabled"
			\|int(1)
			\|<center>1</center>
			\|If automatic deleting should be enabled by default for these courses.
			\|-
			\|"delete_date_point"
	\|varchar(10)		\|varchar(10)
	\|<center>~~NULL~~</center>		\|<center>"epoch"</center>
	\|Can be '~~relative~~', '~~absolute~~', ~~or NULL; If NULL~~, courses should ~~not~~ be ~~automatically~~ deleted ~~by default~~. If '~~relative~~', ~~the value stored in~~ delete_date ~~is the number of days~~ after the end of the course~~. If 'absolute', the value stored in delete_date is a Unix timestamp~~.		\|Can be 'epoch', 'course_end', and in the future, some other values. Stores the point from which delete_date should be compared. E.g., if 'epoch', courses should be deleted <i>delete_date</i> seconds after the Unix epoch. If 'course_end', courses should be deleted <i>delete_date</i> seconds after the end of the course.
	\|-		\|-
	\|"delete_date"		\|"delete_date"
	\|int(10)		\|int(10)
	\|<center>~~NULL~~</center>		\|<center>0</center>
	\|When courses should be deleted ~~by default~~. ~~Can either be~~ expressed as ~~an absolute value (as a Unix timestamp), or a relative value (~~the number of ~~days~~ after ~~the end of the course)~~. ~~This~~ is set ~~in the delete_date_type column~~.		\|When courses should be deleted. Is expressed as the number of seconds after delete_date_point. (If delete_date_point is set to 'epoch', this is effectively a Unix timestamp.)

	\|}		\|}

Luciandipeso at 19:05, 5 May 2009

2009-05-05T19:05:31Z

← Older revision		Revision as of 19:05, 5 May 2009
Line 146:		Line 146:

	Array(<br />		Array(<br />
	'~~archive_date_type~~'=>'[~~relative~~\|~~absolute~~]', <br />		'archive_enabled'=>[true\|false] <br />
	'archive_date'=>''int'', <br />		'archive_date_point'=>'[epoch\|course_end\|...]', <br />
	'~~delete_date_type~~'=>'[~~relative~~\|~~absolute~~]', <br />		'archive_date'=><i>int</i>, <br />
	'~~delete_date~~'=>'~~'int'~~', <br />		'delete_enabled'=>[true\|false] <br />
	'~~enabled~~'=>~~[true\|false]~~ <br />		'delete_date_type'=>'[epoch\|course_end\|...]', <br />
			'delete_date'=><i>int</i>, <br />
	)		)


	===ArchiveCourse::unarchive_course($courseid)===		===ArchiveCourse::unarchive_course($courseid)===
Line 164:		Line 166:

	Array(<br />		Array(<br />
	'~~archive_date_type~~'=>'[~~relative~~\|~~absolute~~]', <br />		'archive_enabled'=>[true\|false] <br />
			'archive_date_point'=>'[epoch\|course_end\|...]', <br />
	'archive_date'=><i>int</i>, <br />		'archive_date'=><i>int</i>, <br />
	'delete_date_type'=>'[~~relative~~\|~~absolute~~]', <br />		'delete_enabled'=>[true\|false] <br />
			'delete_date_type'=>'[epoch\|course_end\|...]', <br />
	'delete_date'=><i>int</i>, <br />		'delete_date'=><i>int</i>, <br />
	~~'enabled'=>[true\|false] <br />~~
	)		)

Luciandipeso at 19:03, 5 May 2009

2009-05-05T19:03:43Z

← Older revision		Revision as of 19:03, 5 May 2009
Line 39:		Line 39:
	\|unique; The course that should be archived or deleted.		\|unique; The course that should be archived or deleted.
	\|-		\|-
	\|"~~enabled~~"		\|"archive_enabled"
	\|tinyint(1)		\|tinyint(1)
	\|<center>1</center>		\|<center>1</center>
	\|If automatic archiving~~/deleting~~ should be enabled for this course.		\|If automatic archiving should be enabled for this course.
	\|-		\|-
	\|"~~archive_date_type~~"		\|"archive_date_point"
	\|varchar(10)		\|varchar(10)
	\|<center>~~NULL~~</center>		\|<center>"epoch"</center>
	\|Can be '~~relative~~', '~~absolute~~', ~~or NULL; If NULL~~, ~~this~~ course should ~~not~~ be ~~automatically~~ archived. If '~~relative~~', the ~~value stored in~~ archive_date ~~is the number of days~~ after the end of the course~~. If 'absolute', the value stored in archive_date is a Unix timestamp~~.		\|Can be 'epoch', 'course_end', and in the future, some other values. Stores the point from which archive_date should be compared. E.g., if 'epoch', the course should be archived <i>archive_date</i> seconds after the Unix epoch. If 'course_end', the course should be archived <i>archive_date</i> seconds after the end of the course.
	\|-		\|-
	\|"archive_date"		\|"archive_date"
	\|int(10)		\|int(10)
	\|<center>~~NULL~~</center>		\|<center>0</center>
	\|When the course should be archived. ~~Can either be~~ expressed as ~~an absolute value (as a Unix timestamp), or a relative value (~~the number of ~~days~~ after ~~the end of the course)~~. ~~This~~ is set ~~in the archive_date_type column~~.		\|When the course should be archived. Is expressed as the number of seconds after archive_date_point. (If archive_date_point is set to 'epoch', this is effectively a Unix timestamp.)
	\|-		\|-
	\|"~~delete_date_type~~"		\|"delete_enabled"
			\|tinyint(1)
			\|<center>1</center>
			\|If automatic deleting should be enabled for this course.
			\|-
			\|"delete_date_point"
	\|varchar(10)		\|varchar(10)
	\|<center>~~NULL~~</center>		\|<center>"epoch"</center>
	\|Can be '~~relative~~', '~~absolute~~', ~~or NULL; If NULL~~, ~~this~~ course should ~~not~~ be ~~automatically~~ deleted. If '~~relative~~', the ~~value stored in~~ delete_date ~~is the number of days~~ after the end of the course~~. If 'absolute', the value stored in delete_date is a Unix timestamp~~.		\|Can be 'epoch', 'course_end', and in the future, some other values. Stores the point from which delete_date should be compared. E.g., if 'epoch', the course should be deleted <i>delete_date</i> seconds after the Unix epoch. If 'course_end', the course should be deleted <i>delete_date</i> seconds after the end of the course.
	\|-		\|-
	\|"delete_date"		\|"delete_date"
	\|int(10)		\|int(10)
	\|<center>~~NULL~~</center>		\|<center>0</center>
	\|When the course should be deleted. ~~Can either be~~ expressed as ~~an absolute value (as a Unix timestamp), or a relative value (~~the number of ~~days~~ after ~~the end of the course)~~. ~~This~~ is set ~~in the delete_date_type column~~.		\|When the course should be deleted. Is expressed as the number of seconds after delete_date_point. (If delete_date_point is set to 'epoch', this is effectively a Unix timestamp.)

	\|}		\|}

Luciandipeso at 22:37, 30 April 2009

2009-04-30T22:37:38Z

← Older revision		Revision as of 22:37, 30 April 2009
Line 138:		Line 138:

	===ArchiveCourse::set_archive_options($courseid, $options_array)===		===ArchiveCourse::set_archive_options($courseid, $options_array)===
	Sets archive options for a particular course (all options are not required -- if not present, defaults will be used). Returns true on success, false on failure. The $option_array should have the following format:		Sets archive options for a particular course (all options are not required—if not present, defaults will be used). Returns true on success, false on failure. The $option_array should have the following format:

	Array(<br />		Array(<br />
Line 156:		Line 156:

	===ArchiveCategory::set_defaults($categoryid, $options_array)===		===ArchiveCategory::set_defaults($categoryid, $options_array)===
	Sets archive defaults for a particular category (all options are not required -- if not present, site-wide defaults will be used). Returns true on success, false on failure. The $option_array should have the following format:		Sets archive defaults for a particular category (all options are not required—if not present, site-wide defaults will be used). Returns true on success, false on failure. The $option_array should have the following format:

	Array(<br />		Array(<br />