Procedural File: announcements.inc.php

void change_visibility( $tool, $id)

This functions swithes the visibility a course resource

using the visibility field in 'item_property' values: 0 = invisibility for

Parameters

	$tool
	$id

void construct_not_selected_select_form( [ $group_list = null], [ $user_list = null], $to_already_selected)

this function shows the form for sending a message to a specific group or user.

Parameters

	$group_list
	$user_list
	$to_already_selected

void construct_selected_select_form( [ $group_list = null], [ $user_list = null], $to_already_selected)

this function shows the form for sending a message to a specific group or user.

Parameters

	$group_list
	$user_list
	$to_already_selected

void display_announcement( $announcement_id, $announcement_id)

displays one specific announcement

Tags:

Parameters

$announcement_id,

$announcement_id

the id of the announcement you want to display

void edit_advalvas_item( $id, $emailTitle, $newContent, $to)

This function stores the announcement Item in the table announcement

and updates the item_property also

Parameters

	$id
	$emailTitle
	$newContent
	$to

void get_course_groups( )

this function gets all the groups of the course,

not including linked courses

void get_course_users( )

this function gets all the users of the course,

including users from linked courses

void load_edit_users( $tool, $id)

This tools loads all the users and all the groups who have received

a specific item (in this case an announcement item)

Parameters

	$tool
	$id

void send_announcement_email( $user_list, $course_code, $_course, $mail_title, $mail_content)

Sends an announcement by email to a list of users.

Emails are sent one by one to try to avoid antispam.

Parameters

	$user_list
	$course_code
	$_course
	$mail_title
	$mail_content

void sent_to( $tool, $id)

returns all the users and all the groups a specific announcement item

has been sent to

Parameters

	$tool
	$id

void sent_to_form( $sent_to_array)

constructs the form to display all the groups and users the message has been sent to

input: $sent_to_array is a 2 dimensional array containing the groups and the users the first level is a distinction between groups and users: $sent_to_array['groups'] * and $sent_to_array['users'] $sent_to_array['groups'] (resp. $sent_to_array['users']) is also an array containing all the id's of the groups (resp. users) who have received this message.

Tags:

Parameters

$sent_to_array

void separate_users_groups( $to)

This function separates the users from the groups

users have a value USER:XXX (with XXX the dokeos id groups have a value GROUP:YYY (with YYY the group id)

Parameters

$to

void show_to_form( $to_already_selected)

this function shows the form for sending a message to a specific group or user.

Parameters

$to_already_selected

void store_advalvas_item( $emailTitle, $newContent, $order, $to)

Parameters

	$emailTitle
	$newContent
	$order
	$to

void to_javascript( )

returns all the javascript that is required for easily

setting the target people/groups this goes into the $htmlHeadXtra[] array

void update_mail_sent( $insert_id)

Parameters

$insert_id

void user_group_filter_javascript( )

returns the javascript for setting a filter

this goes into the $htmlHeadXtra[] array