Element index for package dokeos-library

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ l ] [ m ] [ n ] [ o ] [ p ] [ q ] [ r ] [ s ] [ t ] [ u ] [ v ] [ w ] [ x ] [ _ ]

_

$_concat: in file xmd.lib.php, variable xmddoc::$_concat
$_last: in file xmd.lib.php, variable xmddoc::$_last
$_nesting: in file xmd.lib.php, variable xmddoc::$_nesting
$_ns: in file xmd.lib.php, variable xmddoc::$_ns
$_nsp: in file xmd.lib.php, variable xmddoc::$_nsp
$_prev_param: in file xht.lib.php, variable xhtdoc::$_prev_param
$_strings: in file xmd.lib.php, variable xmddoc::$_strings
_cData: in file xmd.lib.php, method xmddoc::_cData()
_endElement: in file xmd.lib.php, method xmddoc::_endElement()
_lang: in file xht.lib.php, method xhtdoc::_lang()
_lookup: in file xmd.lib.php, method xmddoc::_lookup()
_nsPfx: in file xmd.lib.php, method xmddoc::_nsPfx()
_show_param: in file xht.lib.php, method xhtdoc::_show_param()
_sibnum: in file xmd.lib.php, method xmddoc::_sibnum()
_startElement: in file xmd.lib.php, method xmddoc::_startElement()
_startNs: in file xmd.lib.php, method xmddoc::_startNs()
_text_parse_glossary: in file text.lib.php, function _text_parse_glossary()
This function should not be accessed directly but should be accesse through the text_filter function
_text_parse_tex: in file text.lib.php, function _text_parse_tex()
Apply parsing to content to parse tex commandos that are seperated by [tex] [/tex] to make it readable for techexplorer plugin.
_text_parse_texexplorer: in file text.lib.php, function _text_parse_texexplorer()
Apply parsing to content to parse tex commandos that are seperated by [tex] [/tex] to make it readable for techexplorer plugin.
_text_parse_tool: in file text.lib.php, function _text_parse_tool()
this function makes a valid link to a different tool This function should not be accessed directly but should be accesse through the text_filter function
_uncache: in file xmd.lib.php, method xmddoc::_uncache()

top

a

$api_failureList: in file main_api.lib.php, variable api_failure::$api_failureList
$api_failureList: in file main_api.lib.php, global variable $api_failureList
Pile the last failure in the failure list
$atns: in file xmd.lib.php, variable xmddoc::$atns
$attributes: in file xmd.lib.php, variable xmddoc::$attributes
addBrowser: in file stats.lib.inc.php, function addBrowser()
this function will :
addCountry: in file stats.lib.inc.php, function addCountry()
this function will increment number of occurrence
addOs: in file stats.lib.inc.php, function addOs()
this function will :
addProvider: in file stats.lib.inc.php, function addProvider()
this function will :
addReferer: in file stats.lib.inc.php, function addReferer()
this function will :
add_all_documents_in_folder_to_database: in file fileUpload.lib.php, function add_all_documents_in_folder_to_database()
This recursive function can be used during the upgrade process form older versions of Dokeos It crawls the given directory, checks if the file is in the DB and adds it if it's not
add_announcement: in file system_announcements.lib.php, method SystemAnnouncementManager::add_announcement()
Adds an announcement to the database
add_document: in file fileUpload.lib.php, function add_document()
Adds a new document to the database
add_ext_on_mime: in file fileUpload.lib.php, function add_ext_on_mime()
Try to add an extension to files without extension Some applications on Macintosh computers don't add an extension to the files.
add_user: in file classmanager.lib.php, method ClassManager::add_user()
Add a user to a class. If the class is subscribed to a course, the new user will also be subscribed to that course.
add_user_to_course: in file course.lib.php, method CourseManager::add_user_to_course()
Subscribe a user $user_id to a course $course_code.
affected_rows: in file database.lib.php, method Database::affected_rows()
Returns the number of affected rows
ANONYMOUS: in file main_api.lib.php, constant ANONYMOUS
global status of a user: human ressource manager
api_add_access_url: in file main_api.lib.php, function api_add_access_url()
Adds an access URL into the database
api_add_setting: in file main_api.lib.php, function api_add_setting()
Sets a platform configuration setting to a given value
api_add_url_param: in file main_api.lib.php, function api_add_url_param()
api_block_anonymous_users: in file main_api.lib.php, function api_block_anonymous_users()
Function used to prevent anonymous users from accessing a script.
api_check_password: in file main_api.lib.php, function api_check_password()
Checks a password to see wether it is OK to use.
api_chmod_R: in file main_api.lib.php, function api_chmod_R()
api_clear_anonymous: in file main_api.lib.php, function api_clear_anonymous()
Clear the user ID from the session if it was the anonymous user. Generally used on out-of-tools pages to remove a user ID that could otherwise be used in the wrong context.
api_delete_category_settings: in file main_api.lib.php, function api_delete_category_settings()
Delete all the settings from one category
api_delete_setting: in file main_api.lib.php, function api_delete_setting()
Delete setting
api_display_array: in file main_api.lib.php, function api_display_array()
Displays the contents of an array in a messagebox.
api_display_debug_info: in file main_api.lib.php, function api_display_debug_info()
Displays debug info
api_display_language_form: in file main_api.lib.php, function api_display_language_form()
Displays a form (drop down menu) so the user can select his/her preferred language.
api_display_tool_title: in file main_api.lib.php, function api_display_tool_title()
Displays the title of a tool.
api_display_tool_view_option: in file main_api.lib.php, function api_display_tool_view_option()
Display options to switch between student view and course manager view
api_disp_html_area: in file main_api.lib.php, function api_disp_html_area()
Displays the FckEditor WYSIWYG editor for online editing of html
api_failure: in file main_api.lib.php, class api_failure
collects and manage failures occuring during script execution The main purpose is allowing to manage the display messages externaly from functions or objects. This strengthens encupsalation principle
api_generate_password: in file main_api.lib.php, function api_generate_password()
Returns a difficult to guess password.
api_get_access_urls: in file main_api.lib.php, function api_get_access_urls()
Get all available access urls in an array (as in the database)
api_get_anonymous_id: in file main_api.lib.php, function api_get_anonymous_id()
Gets an anonymous user ID
api_get_cidreq: in file main_api.lib.php, function api_get_cidreq()
Returns the cidreq parameter name + current course id
api_get_course_id: in file main_api.lib.php, function api_get_course_id()
Returns the current course id (integer)
api_get_course_info: in file main_api.lib.php, function api_get_course_info()
Returns the current course info array.
api_get_course_path: in file main_api.lib.php, function api_get_course_path()
Returns the current course directory
api_get_course_setting: in file main_api.lib.php, function api_get_course_setting()
Gets a course setting from the current course_setting table. Try always using integer values.
api_get_interface_language: in file main_api.lib.php, function api_get_interface_language()
Gets the current interface language
api_get_item_visibility: in file main_api.lib.php, function api_get_item_visibility()
Gets item visibility from the item_property table
api_get_languages: in file main_api.lib.php, function api_get_languages()
Return a list of all the languages that are made available by the admin.
api_get_language_isocode: in file main_api.lib.php, function api_get_language_isocode()
Get language isocode column from the language table, taking the current language as a query
api_get_last_failure: in file main_api.lib.php, function api_get_last_failure()
get the last failure stored in $api_failureList;
api_get_navigator: in file main_api.lib.php, function api_get_navigator()
api_get_path: in file main_api.lib.php, function api_get_path()
Returns a full path to a certain Dokeos area, which you specify through a parameter.
api_get_self: in file main_api.lib.php, function api_get_self()
Returns an escaped version of $_SERVER['PHP_SELF'] to avoid XSS injection
api_get_setting: in file main_api.lib.php, function api_get_setting()
Returns the value of a setting from the web-adjustable admin config settings.
api_get_settings: in file main_api.lib.php, function api_get_settings()
Gets all the current settings for a specific access url
api_get_settings_categories: in file main_api.lib.php, function api_get_settings_categories()
Gets the distinct settings categories
api_get_status_langvars: in file main_api.lib.php, function api_get_status_langvars()
get the status langvars list
api_get_themes: in file main_api.lib.php, function api_get_themes()
Returns a list of CSS themes currently available in the CSS folder
api_get_user_id: in file main_api.lib.php, function api_get_user_id()
This function returns the id of the user which is stored in the $_user array.
api_get_user_info: in file main_api.lib.php, function api_get_user_info()
find all the information about a user. If no paramater is passed you find all the information about the current user.
api_get_version: in file main_api.lib.php, function api_get_version()
Get Dokeos version from the configuration files
api_is_allowed: in file main_api.lib.php, function api_is_allowed()
this fun
api_is_allowed_to_create_course: in file main_api.lib.php, function api_is_allowed_to_create_course()
Check if current user is allowed to create courses
api_is_allowed_to_edit: in file main_api.lib.php, function api_is_allowed_to_edit()
Function that removes the need to directly use is_courseAdmin global in tool scripts. It returns true or false depending on the user's rights in this particular course.
api_is_anonymous: in file main_api.lib.php, function api_is_anonymous()
Tells whether this user is an anonymous user
api_is_coach: in file main_api.lib.php, function api_is_coach()
Check if the current user is a course or session coach
api_is_course_admin: in file main_api.lib.php, function api_is_course_admin()
Check if the current user is a course administrator
api_is_course_coach: in file main_api.lib.php, function api_is_course_coach()
Check if the current user is a course coach
api_is_course_tutor: in file main_api.lib.php, function api_is_course_tutor()
Check if the current user is a course tutor
api_is_platform_admin: in file main_api.lib.php, function api_is_platform_admin()
Check if current user is a platform administrator
api_is_plugin_installed: in file main_api.lib.php, function api_is_plugin_installed()
Checks to see wether a certain plugin is installed.
api_is_self_registration_allowed: in file main_api.lib.php, function api_is_self_registration_allowed()
api_item_property_update: in file main_api.lib.php, function api_item_property_update()
update the item_properties table (if entry not exists, insert) of the course
api_max_sort_value: in file main_api.lib.php, function api_max_sort_value()
Find the largest sort value in a given user_course_category
api_not_allowed: in file main_api.lib.php, function api_not_allowed()
Displays message "You are not allowed here..." and exits the entire script.
api_number_of_plugins: in file main_api.lib.php, function api_number_of_plugins()
Determines the number of plugins installed for a given location
api_parse_tex: in file main_api.lib.php, function api_parse_tex()
Apply parsing to content to parse tex commandos that are seperated by [tex] [/tex] to make it readable for techexplorer plugin.
api_plugin: in file main_api.lib.php, function api_plugin()
including the necessary plugins
api_protect_admin_script: in file main_api.lib.php, function api_protect_admin_script()
Function used to protect an admin script.
api_protect_course_script: in file main_api.lib.php, function api_protect_course_script()
Function used to protect a course script.
api_replace_links_in_html: in file fileUpload.lib.php, function api_replace_links_in_html()
api_replace_links_in_string: in file fileUpload.lib.php, function api_replace_links_in_string()
api_replace_parameter: in file fileUpload.lib.php, function api_replace_parameter()
OK find all tags in that string with the specified parameter (like href or src)
api_return_html_area: in file main_api.lib.php, function api_return_html_area()
api_send_mail: in file main_api.lib.php, function api_send_mail()
Send an email.
api_session_clear: in file main_api.lib.php, function api_session_clear()
Clear the session
api_session_destroy: in file main_api.lib.php, function api_session_destroy()
Destroy the session
api_session_register: in file main_api.lib.php, function api_session_register()
save a variable into the session
api_session_start: in file main_api.lib.php, function api_session_start()
Start the Dokeos session.
api_session_unregister: in file main_api.lib.php, function api_session_unregister()
Remove a variable from the session.
api_set_anonymous: in file main_api.lib.php, function api_set_anonymous()
Sets the current user as anonymous if it hasn't been identified yet. This
api_set_failure: in file main_api.lib.php, function api_set_failure()
Fills a global array called $api_failureList
api_set_setting: in file main_api.lib.php, function api_set_setting()
Sets a platform configuration setting to a given value
api_set_settings_category: in file main_api.lib.php, function api_set_settings_category()
Sets a whole category of settings to one specific value
api_sql_query: in file main_api.lib.php, function api_sql_query()
Executes an SQL query You have to use addslashes() on each value that you want to record into the database
api_status_exists: in file main_api.lib.php, function api_status_exists()
Check if status given in parameter exists in the platform
api_status_key: in file main_api.lib.php, function api_status_key()
Check if status given in parameter exists in the platform
api_store_result: in file main_api.lib.php, function api_store_result()
Store the result of a query into an array
api_time_to_hms: in file main_api.lib.php, function api_time_to_hms()
Transform a number of seconds in hh:mm:ss format
api_trunc_str: in file main_api.lib.php, function api_trunc_str()
truncates a string
array_search: in file fileDisplay.lib.php, function array_search()
Searches haystack for needle and returns the key if it is found in the array, FALSE otherwise.
attach_survey: in file surveymanager.lib.php, method SurveyManager::attach_survey()
attempt_create_virtual_course: in file course.lib.php, method CourseManager::attempt_create_virtual_course()
Checks all parameters needed to create a virtual course.
add_course.lib.inc.php: procedural page add_course.lib.inc.php
access_details.php: procedural page access_details.php

top

b

backupDatabase: in file export.lib.inc.php, function backupDatabase()
Backup a db to a file
browse_folders: in file add_course.lib.inc.php, function browse_folders()
buildTab2col: in file statsUtils.lib.inc.php, function buildTab2col()
display a 2 column tab from an array
buildTab2ColNoTitle: in file statsUtils.lib.inc.php, function buildTab2ColNoTitle()
display a 2 column tab from an array
buildTabDefcon: in file statsUtils.lib.inc.php, function buildTabDefcon()
this function is used to display
build_missing_files_form: in file fileUpload.lib.php, function build_missing_files_form()
This builds a form that asks for the missing images in a html file maybe we should do this another way?
build_production_list: in file usermanager.lib.php, method UserManager::build_production_list()
Returns an XHTML formatted list of productions for a user, or FALSE if he doesn't have any.

top

c

$children: in file xmd.lib.php, variable xmddoc::$children
$clean: in file security.lib.php, variable Security::$clean
$connexion: in file session_handler.class.php, variable session_handler::$connexion
calculHours: in file access_details.php, function calculHours()
Transforms seconds into a time format
can_delete_user: in file usermanager.lib.php, method UserManager::can_delete_user()
Can user be deleted? This functions checks if there's a course in which the given user is the only course administrator. If that is the case, the user can't be deleted because the course would remain without a course admin.
can_user_subscribe: in file groupmanager.lib.php, method GroupManager::can_user_subscribe()
Can a user subscribe to a specified group in a course
can_user_unsubscribe: in file groupmanager.lib.php, method GroupManager::can_user_unsubscribe()
Can a user unsubscribe to a specified group in a course
CHAT_CONNECTED_TABLE: in file database.lib.php, constant CHAT_CONNECTED_TABLE
checkArchive: in file add_course.lib.inc.php, function checkArchive()
WARNING: this function always returns true.
check_abs_path: in file security.lib.php, method Security::check_abs_path()
Checks if the absolute path given is really under the checker path
check_for_missing_files: in file fileUpload.lib.php, function check_for_missing_files()
Checks the extension of a file, if it's .htm or .html we use search_img_from_html to get all image paths in the file
check_name_exist: in file fileManage.lib.php, function check_name_exist()
Cheks a file or a directory actually exist at this location
check_parameter: in file course.lib.php, method CourseManager::check_parameter()
Checks wether a parameter exists.
check_parameter_or_fail: in file course.lib.php, method CourseManager::check_parameter_or_fail()
Lets the script die when a parameter check fails.
check_rel_path: in file security.lib.php, method Security::check_rel_path()
Checks if the relative path given is really under the checker path
check_token: in file security.lib.php, method Security::check_token()
This function checks that the token generated in get_token() has been kept (prevents
check_ua: in file security.lib.php, method Security::check_ua()
Checks the user agent of the client as recorder by get_ua() to prevent most session hijacking attacks.
choose_image: in file fileDisplay.lib.php, function choose_image()
Define the image to display for each file extension.
ClassManager: in file classmanager.lib.php, class ClassManager
This library contains some functions for class-management.
class_name_exists: in file classmanager.lib.php, method ClassManager::class_name_exists()
Check if a classname is allready in use
cleanProcessedRecords: in file stats.lib.inc.php, function cleanProcessedRecords()
this function will delete the remote_host, user_agent
clean_up_files_in_zip: in file fileUpload.lib.php, function clean_up_files_in_zip()
this function is a callback function that is used while extracting a zipfile http://www.phpconcept.net/pclzip/man/en/index.php?options-pclzip_cb_pre_extract
clean_up_path: in file fileUpload.lib.php, function clean_up_path()
this function cleans up a given path by eliminating dangerous file names and cleaning them
clear_token: in file security.lib.php, method Security::clear_token()
Clear the security token from the session
close: in file session_handler.class.php, method session_handler::close()
compat_load_file: in file fileManage.lib.php, method FileManager::compat_load_file()
CONFIGURATION_PATH: in file main_api.lib.php, constant CONFIGURATION_PATH
convert_mysql_date: in file main_api.lib.php, function convert_mysql_date()
convert sql date to unix timestamp
copydir: in file export.lib.inc.php, function copydir()
copyDirTo: in file fileManage.lib.php, function copyDirTo()
Move a directory and its content to an other area
copyr: in file main_api.lib.php, function copyr()
function adapted from a php.net comment
count_course_per_student: in file tracking.lib.php, method Tracking::count_course_per_student()
count_login_per_student: in file tracking.lib.php, method Tracking::count_login_per_student()
count_nb_announcement: in file system_announcements.lib.php, method SystemAnnouncementManager::count_nb_announcement()
count_rows: in file database.lib.php, method Database::count_rows()
Count the number of rows in a table
count_student_assignments: in file tracking.lib.php, method Tracking::count_student_assignments()
count_student_downloaded_documents: in file tracking.lib.php, method Tracking::count_student_downloaded_documents()
count_student_messages: in file tracking.lib.php, method Tracking::count_student_messages()
count_student_visited_links: in file tracking.lib.php, method Tracking::count_student_visited_links()
CourseManager: in file course.lib.php, class CourseManager
COURSEMANAGER: in file main_api.lib.php, constant COURSEMANAGER
global status of a user: course manager
course_exists: in file course.lib.php, method CourseManager::course_exists()
check if course exists
COURSE_VISIBILITY_CLOSED: in file main_api.lib.php, constant COURSE_VISIBILITY_CLOSED
only visible for course admin
COURSE_VISIBILITY_OPEN_PLATFORM: in file main_api.lib.php, constant COURSE_VISIBILITY_OPEN_PLATFORM
open for all registered users on the platform
COURSE_VISIBILITY_OPEN_WORLD: in file main_api.lib.php, constant COURSE_VISIBILITY_OPEN_WORLD
open for the whole world
COURSE_VISIBILITY_REGISTERED: in file main_api.lib.php, constant COURSE_VISIBILITY_REGISTERED
only visible for users registered in the course
create_category: in file groupmanager.lib.php, method GroupManager::create_category()
Create group category
create_class: in file classmanager.lib.php, method ClassManager::create_class()
Create a class
create_class_groups: in file groupmanager.lib.php, method GroupManager::create_class_groups()
Create a group for every class subscribed to the current course
create_combined_code: in file course.lib.php, method CourseManager::create_combined_code()
Create a course code based on all real and virtual courses the user is registered in.
create_combined_name: in file course.lib.php, method CourseManager::create_combined_name()
Create a course title based on all real and virtual courses the user is registered in.
create_course: in file add_course.lib.inc.php, function create_course()
Not tested yet.
create_course_survey_rel: in file surveymanager.lib.php, method SurveyManager::create_course_survey_rel()
create_database_dump: in file course.lib.php, method CourseManager::create_database_dump()
Creates a file called mysql_dump.sql in the course folder
create_extra_field: in file usermanager.lib.php, method UserManager::create_extra_field()
Creates a new extra field
create_group: in file groupmanager.lib.php, method GroupManager::create_group()
Create a group
create_group: in file surveymanager.lib.php, method SurveyManager::create_group()
create_groups_from_virtual_courses: in file groupmanager.lib.php, method GroupManager::create_groups_from_virtual_courses()
Create groups from all virtual courses in the given course.
create_link_file: in file fileUpload.lib.php, function create_link_file()
Creates a file containing an html redirection to a given url
create_question: in file surveymanager.lib.php, method SurveyManager::create_question()
create_subgroups: in file groupmanager.lib.php, method GroupManager::create_subgroups()
Create subgroups.
create_survey: in file surveymanager.lib.php, method SurveyManager::create_survey()
create_survey_attach: in file surveymanager.lib.php, method SurveyManager::create_survey_attach()
create_survey_in_another_language: in file surveymanager.lib.php, method SurveyManager::create_survey_in_another_language()
create_unexisting_directory: in file fileUpload.lib.php, function create_unexisting_directory()
creates a new directory trying to find a directory name that doesn't already exist (we could use unique_name() here...)
create_user: in file usermanager.lib.php, method UserManager::create_user()
The function tries to retrieve $_user['user_id'] from the global space. if it exists, $_user['user_id'] is the creator id If a problem arises, it stores the error message in global $api_failureList
create_virtual_course: in file course.lib.php, method CourseManager::create_virtual_course()
This function creates a virtual course.
csv_to_array: in file import.lib.php, method Import::csv_to_array()
Reads a CSV-file into an array. The first line of the CSV-file should contain the array-keys.
classmanager.lib.php: procedural page classmanager.lib.php
course.lib.php: procedural page course.lib.php

top

d

Database: in file database.lib.php, class Database
date_to_str_ago: in file text.lib.php, function date_to_str_ago()
This function returns the difference between the current date (date(now)) with the parameter $date in a string format like "2 days, 1 hour" Example: $date="2008-03-07 15:44:08"; date_to_str($date) it will return 3 days, 20 hours
daysTab: in file statsUtils.lib.inc.php, function daysTab()
Return an assoc array. Keys are the days, values are
debug: in file debug.lib.inc.php, function debug()
This function displays the contend of a variable, array or object in a nicely formatted way.
debug_course: in file debug.lib.inc.php, function debug_course()
This function displays all the information of the dokeos $_course array This array stores all the information of the current course if the user is in a course.
debug_paths: in file debug.lib.inc.php, function debug_paths()
This function displays an overview of the different path constants that can be used with the api_get_path function
debug_user: in file debug.lib.inc.php, function debug_user()
This function displays all the information of the dokeos $_user array This array stores all the information of the current user.
decodeOpenInfos: in file stats.lib.inc.php, function decodeOpenInfos()
uses `$TABLETRACK_OPEN` to split recorded
DEFAULT_DOCUMENT_QUOTA: in file document.lib.php, constant DEFAULT_DOCUMENT_QUOTA
default quota for the course documents folder
DEFAULT_GROUP_CATEGORY: in file groupmanager.lib.php, constant DEFAULT_GROUP_CATEGORY
define_course_keys: in file add_course.lib.inc.php, function define_course_keys()
Defines the four needed keys to create a course based on several parameters.
delete_announcement: in file system_announcements.lib.php, method SystemAnnouncementManager::delete_announcement()
Deletes an announcement
delete_category: in file groupmanager.lib.php, method GroupManager::delete_category()
Delete a group category
delete_class: in file classmanager.lib.php, method ClassManager::delete_class()
Delete a class
delete_course: in file course.lib.php, method CourseManager::delete_course()
Delete a course This function deletes a whole course-area from the platform. When the given course is a virtual course, the database and directory will not be deleted.
delete_document: in file document.lib.php, method DocumentManager::delete_document()
This deletes a document by changing visibility to 2, renaming it to filename_DELETED_#id Files/folders that are inside a deleted folder get visibility 2
delete_group: in file surveymanager.lib.php, method SurveyManager::delete_group()
This function deletes a
delete_groups: in file groupmanager.lib.php, method GroupManager::delete_groups()
deletes groups and their data.
delete_survey: in file surveymanager.lib.php, method SurveyManager::delete_survey()
This function deletes a survey and all the groups and question belonging to it.
delete_user: in file usermanager.lib.php, method UserManager::delete_user()
Delete a user from the platform
destroy: in file session_handler.class.php, method session_handler::destroy()
determine_course_title_from_course_info: in file course.lib.php, method CourseManager::determine_course_title_from_course_info()
Find out for which courses the user is registered and determine a visual course code and course title from that.
dirsize: in file fileManage.lib.php, function dirsize()
to compute the size of the directory
DIR_HOTPOTATOES: in file main_api.lib.php, constant DIR_HOTPOTATOES
dir_total_space: in file fileUpload.lib.php, function dir_total_space()
Compute the size already occupied by a directory and is subdirectories
disable_dangerous_file: in file fileUpload.lib.php, function disable_dangerous_file()
this function executes our safety precautions more functions can be added
DISK_QUOTA_FIELD: in file document.lib.php, constant DISK_QUOTA_FIELD
This is the document library for Dokeos.
Display: in file display.lib.php, class Display
display_all_announcements: in file system_announcements.lib.php, method SystemAnnouncementManager::display_all_announcements()
display_announcements: in file system_announcements.lib.php, method SystemAnnouncementManager::display_announcements()
Displays all announcements
display_complex_table_header: in file display.lib.php, method Display::display_complex_table_header()
Display html header of table with several options.
display_complex_table_row: in file display.lib.php, method Display::display_complex_table_row()
Displays a table row.
display_confirmation_message: in file display.lib.php, method Display::display_confirmation_message()
Displays an confirmation message. Use this if something has been done successfully
display_error_message: in file display.lib.php, method Display::display_error_message()
Displays an error message. It is recommended to use this function if an error occurs
display_fleche: in file system_announcements.lib.php, method SystemAnnouncementManager::display_fleche()
display_footer: in file display.lib.php, method Display::display_footer()
Display the page footer
display_header: in file display.lib.php, method Display::display_header()
Display the page header
display_icon: in file display.lib.php, method Display::display_icon()
This function displays an icon
display_imported_group: in file surveymanager.lib.php, method SurveyManager::display_imported_group()
display_introduction_section: in file display.lib.php, method Display::display_introduction_section()
Displays the tool introduction of a tool.
display_localised_html_file: in file display.lib.php, method Display::display_localised_html_file()
display_normal_message: in file display.lib.php, method Display::display_normal_message()
Displays a normal message. It is recommended to use this function to display any normal information messages.
display_sortable_config_table: in file display.lib.php, method Display::display_sortable_config_table()
Display a table with a special configuration
display_sortable_table: in file surveymanager.lib.php, method SurveyManager::display_sortable_table()
Displays a sortable table for the surveys
display_sortable_table: in file display.lib.php, method Display::display_sortable_table()
Display a table
display_table_footer: in file display.lib.php, method Display::display_table_footer()
display html footer of table
display_table_header: in file display.lib.php, method Display::display_table_header()
Display simple html header of table.
display_table_row: in file display.lib.php, method Display::display_table_row()
Displays a table row.
display_warning_message: in file display.lib.php, method Display::display_warning_message()
Displays an warning message. Use this if you want to draw attention to something This can also be used for instance with the hint in the exercises
DocumentManager: in file document.lib.php, class DocumentManager
documents_total_space: in file fileUpload.lib.php, function documents_total_space()
Calculate the total size of all documents in a course
domesticate: in file main_api.lib.php, function domesticate()
handling simple and double apostrofe in order that strings be stored properly in database
DRH: in file main_api.lib.php, constant DRH
global status of a user: human ressource manager
database.lib.php: procedural page database.lib.php
debug.lib.inc.php: procedural page debug.lib.inc.php
display.lib.php: procedural page display.lib.php
document.lib.php: procedural page document.lib.php

top

e

$error: in file xmd.lib.php, variable xmddoc::$error
encrypted_mailto_link: in file display.lib.php, method Display::encrypted_mailto_link()
Return an encrypted mailto hyperlink
enough_size: in file fileUpload.lib.php, function enough_size()
Check if there is enough place to add a file on a directory
enough_space: in file fileUpload.lib.php, function enough_space()
Check if there is enough place to add a file on a directory on the base of a maximum directory size allowed
error: in file database.lib.php, method Database::error()
escape_string: in file database.lib.php, method Database::escape_string()
Escapes a string to insert into the database as text
event_access_course: in file events.lib.inc.php, function event_access_course()
Record information for access event for courses
event_access_tool: in file events.lib.inc.php, function event_access_tool()
Record information for access event for tools$tool can take this values : Links, Calendar, Document, Announcements, Group, Video, Works, Users, Exercices, Course Desc ... Values can be added if new modules are created (15char max) I encourage to use $nameTool as $tool when calling this functionFunctionality for "what's new" notification is added by Toon Van Hoecke
event_download: in file events.lib.inc.php, function event_download()
Record information for download event (when an user click to d/l a document) it will be used in a redirection page bug fixed: Roan Embrechts Roan: The user id is put in single quotes, (why? perhaps to prevent sql insertion hacks?) and later again. Doing this twice causes an error, I remove one of them.
event_exercice: in file events.lib.inc.php, function event_exercice()
Record result of user when an exercice was done
event_link: in file events.lib.inc.php, function event_link()
Record information for link event (when an user click on an added link) it will be used in a redirection page
event_login: in file events.lib.inc.php, function event_login()
Record information for login event (when an user identifies himself with username & password)
event_open: in file events.lib.inc.php, function event_open()
Record information for open event (when homepage is opened)
event_system: in file events.lib.inc.php, function event_system()
Record information for common (or admin) events (in the track_e_default table)
event_upload: in file events.lib.inc.php, function event_upload()
Record information for upload event used in the works tool to record informations when an user upload 1 work
exercise_attempt: in file events.lib.inc.php, function exercise_attempt()
Record an event for this attempt at answering an exercise
Export: in file export.lib.inc.php, class Export
export_table_csv: in file export.lib.inc.php, method Export::export_table_csv()
Export tabular data to CSV-file
export_table_xls: in file export.lib.inc.php, method Export::export_table_xls()
Export tabular data to XLS-file
export_table_xml: in file export.lib.inc.php, method Export::export_table_xml()
Export tabular data to XML-file
extractAgent: in file stats.lib.inc.php, function extractAgent()
this function will extract browser and OS from
extractCountry: in file stats.lib.inc.php, function extractCountry()
this function will extract the country from a given remote
extractProvider: in file stats.lib.inc.php, function extractProvider()
this function will extract the provider name from a given
events.lib.inc.php: procedural page events.lib.inc.php
export.lib.inc.php: procedural page export.lib.inc.php

top

f

fetch_array: in file database.lib.php, method Database::fetch_array()
Gets the array from a SQL result (as returned by api_sql_query) - help achieving database independence
fetch_object: in file database.lib.php, method Database::fetch_object()
Gets the next row of the result of the SQL query (as returned by api_sql_query) in an object form
fetch_row: in file database.lib.php, method Database::fetch_row()
Gets the array from a SQL result (as returned by api_sql_query) - help achieving database independence
FileManager: in file fileManage.lib.php, class FileManager
file_get_mime_type: in file document.lib.php, method DocumentManager::file_get_mime_type()
Get the content type of a file by checking the extension We could use mime_content_type() with php-versions > 4.3, but this doesn't work as it should on Windows installations
file_send_for_download: in file document.lib.php, method DocumentManager::file_send_for_download()
This function streams a file to the client
file_visible_to_user: in file document.lib.php, method DocumentManager::file_visible_to_user()
fillBrowsersTable: in file stats.lib.inc.php, function fillBrowsersTable()
update the browsers'table with new values
fillCountriesTable: in file stats.lib.inc.php, function fillCountriesTable()
update the countries'table with new values
fillOsTable: in file stats.lib.inc.php, function fillOsTable()
update the os'table with new values
fillProvidersTable: in file stats.lib.inc.php, function fillProvidersTable()
update the providers'table with new values
fillReferersTable: in file stats.lib.inc.php, function fillReferersTable()
update the referers'table with new values
fill_course_repository: in file add_course.lib.inc.php, function fill_course_repository()
Fills the course repository with some example content.
fill_Db_course: in file add_course.lib.inc.php, function fill_Db_course()
Fills the course database with some required content and example content.
fill_groups: in file groupmanager.lib.php, method GroupManager::fill_groups()
Fill the groups with students.
filter: in file security.lib.php, method Security::filter()
This function filters a variable to the type given, with the options given
filter_duplicates: in file groupmanager.lib.php, method GroupManager::filter_duplicates()
Filter out duplicates in a multidimensional array by comparing field $compare_field.
filter_extension: in file fileUpload.lib.php, function filter_extension()
Check if the file is dangerous, based on extension and/or mimetype.
filter_only_students: in file groupmanager.lib.php, method GroupManager::filter_only_students()
Remove all users that are not students and all users who have tutor status from the list.
filter_users_already_in_group: in file groupmanager.lib.php, method GroupManager::filter_users_already_in_group()
Filters from the array $user_array_in the users already in the group $group_id.
fix_database_parameter: in file database.lib.php, method Database::fix_database_parameter()
folder_size: in file fileDisplay.lib.php, function folder_size()
Get the total size of a directory.
format_date: in file fileDisplay.lib.php, function format_date()
Transform a UNIX time stamp in human readable format date.
format_file_size: in file fileDisplay.lib.php, function format_file_size()
Transform the file size in a human readable format.
format_glued_course_table_name: in file database.lib.php, method Database::format_glued_course_table_name()
Structures a course database and table name to ready them
format_locale_date: in file text.lib.php, function format_locale_date()
formats the date according to the locale settings
format_table_name: in file database.lib.php, method Database::format_table_name()
Structures a database and table name to ready them
format_url: in file fileDisplay.lib.php, function format_url()
Transform the file path to a URL.
form_dir_list: in file fileManage.lib.php, function form_dir_list()
build an html form listing all directories of a given directory
fileDisplay.lib.php: procedural page fileDisplay.lib.php
fileManage.lib.php: procedural page fileManage.lib.php
fileUpload.lib.php: procedural page fileUpload.lib.php

top

g

garbage: in file session_handler.class.php, method session_handler::garbage()
GARBAGE_PATH: in file main_api.lib.php, constant GARBAGE_PATH
generate_abstract_course_field_names: in file database.lib.php, method Database::generate_abstract_course_field_names()
This creates an abstraction layer between database field names and field names expected in code.
generate_abstract_user_field_names: in file database.lib.php, method Database::generate_abstract_user_field_names()
This creates an abstraction layer between database field names and field names expected in code.
generate_course_code: in file add_course.lib.inc.php, function generate_course_code()
get: in file security.lib.php, method Security::get()
This function returns a variable from the clean array. If the variable doesn't exist,
getextension: in file fileManage.lib.php, function getextension()
to extract the extention of the filename
getManyResults1Col: in file statsUtils.lib.inc.php, function getManyResults1Col()
Return many results of a query in a 1 column tab
getManyResults2Col: in file statsUtils.lib.inc.php, function getManyResults2Col()
Return many results of a query
getManyResults3Col: in file statsUtils.lib.inc.php, function getManyResults3Col()
Return many results of a query in a 3 column tab
getManyResultsXCol: in file statsUtils.lib.inc.php, function getManyResultsXCol()
Return many results of a query in a X column tab
getOneResult: in file statsUtils.lib.inc.php, function getOneResult()
return one result from a sql query (1 single result)
getUserAnswersDetails: in file surveymanager.lib.php, method SurveyManager::getUserAnswersDetails()
get_access_settings: in file course.lib.php, method CourseManager::get_access_settings()
Returns the access settings of the course: which visibility; wether subscribing is allowed; wether unsubscribing is allowed.
get_all_announcements: in file system_announcements.lib.php, method SystemAnnouncementManager::get_all_announcements()
Get all announcements
get_all_datas: in file surveymanager.lib.php, method SurveyManager::get_all_datas()
get_all_document_data: in file document.lib.php, method DocumentManager::get_all_document_data()
Fetches all document data for the given user/group
get_all_document_folders: in file document.lib.php, method DocumentManager::get_all_document_folders()
Gets the paths of all folders in a course
get_all_tutors: in file groupmanager.lib.php, method GroupManager::get_all_tutors()
Get all tutors for the current course.
get_alphabet_options: in file display.lib.php, method Display::get_alphabet_options()
Print an <option>-list with all letters (A-Z).
get_announcement: in file system_announcements.lib.php, method SystemAnnouncementManager::get_announcement()
Gets an announcement
get_author: in file surveymanager.lib.php, method SurveyManager::get_author()
get_avg_student_progress: in file tracking.lib.php, method Tracking::get_avg_student_progress()
get_avg_student_score: in file tracking.lib.php, method Tracking::get_avg_student_score()
get_categories: in file groupmanager.lib.php, method GroupManager::get_categories()
Get all categories
get_category: in file groupmanager.lib.php, method GroupManager::get_category()
Get a group category
get_category_from_group: in file groupmanager.lib.php, method GroupManager::get_category_from_group()
Get the category of a given group
get_classes_in_course: in file classmanager.lib.php, method ClassManager::get_classes_in_course()
Get all classes subscribed in a course
get_class_id: in file classmanager.lib.php, method ClassManager::get_class_id()
Get the class-id
get_class_info: in file classmanager.lib.php, method ClassManager::get_class_info()
Get class information
get_coach_list_from_course_code: in file course.lib.php, method CourseManager::get_coach_list_from_course_code()
get_complete_list_of_users_that_can_be_added_to_group: in file groupmanager.lib.php, method GroupManager::get_complete_list_of_users_that_can_be_added_to_group()
Get a combined list of all users of the real course $course_code
get_connections_to_course: in file access_details.php, function get_connections_to_course()
Gets the connections to a course as an array of login and logout time
get_courses: in file classmanager.lib.php, method ClassManager::get_courses()
Get all courses in which a class is subscribed
get_courses_followed_by_coach: in file tracking.lib.php, method Tracking::get_courses_followed_by_coach()
get_courses_list: in file course.lib.php, method CourseManager::get_courses_list()
Returns a list of courses. Should work with quickform syntax
get_courses_list_from_session: in file tracking.lib.php, method Tracking::get_courses_list_from_session()
get_course_chat_connected_table: in file database.lib.php, method Database::get_course_chat_connected_table()
get_course_info: in file database.lib.php, method Database::get_course_info()
Returns an array with all database fields for the specified course.
get_course_information: in file course.lib.php, method CourseManager::get_course_information()
Returns all the information of a given coursecode
get_course_list: in file database.lib.php, method Database::get_course_list()
get_course_list_in_session_from_student: in file tracking.lib.php, method Tracking::get_course_list_in_session_from_student()
get_course_list_of_user_as_course_admin: in file course.lib.php, method CourseManager::get_course_list_of_user_as_course_admin()
get_course_quota: in file document.lib.php, method DocumentManager::get_course_quota()
get_course_table: in file database.lib.php, method Database::get_course_table()
A more generic function than the older get_course_xxx_table functions, this one can return the correct complete name of any course table of which you pass the short name as a parameter.
get_course_table_prefix: in file database.lib.php, method Database::get_course_table_prefix()
Returns the course table prefix for single database.
get_current_course_database: in file database.lib.php, method Database::get_current_course_database()
Returns the name of the main Dokeos database.
get_current_course_glued_database: in file database.lib.php, method Database::get_current_course_glued_database()
Returns the glued name of the current course database.
get_current_max_groups_per_user: in file groupmanager.lib.php, method GroupManager::get_current_max_groups_per_user()
Returns the number of groups of the user with the greatest number of
get_data: in file surveymanager.lib.php, method SurveyManager::get_data()
get_database_glue: in file database.lib.php, method Database::get_database_glue()
The glue is the string needed between database and table.
get_database_name_prefix: in file database.lib.php, method Database::get_database_name_prefix()
Returns the database prefix.
get_document_id: in file document.lib.php, method DocumentManager::get_document_id()
Gets the id of a document with a given path
get_document_title: in file fileUpload.lib.php, function get_document_title()
Returns the name without extension, used for the title
get_extra_fields: in file usermanager.lib.php, method UserManager::get_extra_fields()
Get an array of extra fieds with field details (type, default value and options)
get_extra_user_data: in file usermanager.lib.php, method UserManager::get_extra_user_data()
Gets user extra fields data
get_first_connection_date: in file tracking.lib.php, method Tracking::get_first_connection_date()
get_first_connection_date_on_the_course: in file tracking.lib.php, method Tracking::get_first_connection_date_on_the_course()
get_groupname: in file surveymanager.lib.php, method SurveyManager::get_groupname()
get_group_ids: in file groupmanager.lib.php, method GroupManager::get_group_ids()
Get all group's from a given course in which a given user is ubscribed
get_group_list: in file groupmanager.lib.php, method GroupManager::get_group_list()
Get list of groups for current course.
get_group_list_of_course: in file course.lib.php, method CourseManager::get_group_list_of_course()
get_group_properties: in file groupmanager.lib.php, method GroupManager::get_group_properties()
Get group properties
get_HTML_token: in file security.lib.php, method Security::get_HTML_token()
This function sets a random token to be included in a form as a hidden field
get_inactives_students_in_course: in file tracking.lib.php, method Tracking::get_inactives_students_in_course()
get_lang: in file main_api.lib.php, function get_lang()
Whenever the server type in the Dokeos Config settings is set to test/development server you will get an indication that a language variable is not translated and a link to a suggestions form of DLTT.
get_language_isocode: in file database.lib.php, method Database::get_language_isocode()
Returns the isocode corresponding to the language directory given.
get_last_connection_date: in file tracking.lib.php, method Tracking::get_last_connection_date()
get_last_connection_date_on_the_course: in file tracking.lib.php, method Tracking::get_last_connection_date_on_the_course()
get_last_failure: in file main_api.lib.php, method api_failure::get_last_failure()
get the last failure stored
get_last_insert_id: in file database.lib.php, method Database::get_last_insert_id()
Gets the ID of the last item inserted into the database
get_levels: in file fileUpload.lib.php, function get_levels()
Returns the directory depth of the file.
get_list_of_virtual_courses_for_specific_user_and_real_course: in file course.lib.php, method CourseManager::get_list_of_virtual_courses_for_specific_user_and_real_course()
Return an array of arrays, listing course info of all courses in the list linked to the real course $real_course_code, to which the user $user_id is subscribed.
get_main_database: in file database.lib.php, method Database::get_main_database()
Returns the name of the main Dokeos database.
get_main_table: in file database.lib.php, method Database::get_main_table()
A more generic function than the other get_main_xxx_table functions, this one can return the correct complete name of any table of the main database of which you pass the short name as a parameter.
get_number_of_extra_fields: in file usermanager.lib.php, method UserManager::get_number_of_extra_fields()
Get the number of extra fields currently recorded
get_number_of_groups: in file groupmanager.lib.php, method GroupManager::get_number_of_groups()
Get the total number of groups for the current course.
get_personal_session_course_list: in file usermanager.lib.php, method UserManager::get_personal_session_course_list()
Gives a list of [session_id-course_code] => [status] for the current user.
get_platform_home_link_html: in file display.lib.php, method Display::get_platform_home_link_html()
Create a hyperlink to the platform homepage.
get_questions_move: in file surveymanager.lib.php, method SurveyManager::get_questions_move()
get_question_data: in file surveymanager.lib.php, method SurveyManager::get_question_data()
get_question_type: in file surveymanager.lib.php, method SurveyManager::get_question_type()
get_real_and_linked_user_list: in file course.lib.php, method CourseManager::get_real_and_linked_user_list()
Return user info array of all users registered in the specified course this includes the users of the course itsel and the users of all linked courses.
get_real_course_code_select_html: in file course.lib.php, method CourseManager::get_real_course_code_select_html()
This code creates a select form element to let the user choose a real course to link to.
get_real_course_list: in file course.lib.php, method CourseManager::get_real_course_list()
get_real_course_list_of_user_as_course_admin: in file course.lib.php, method CourseManager::get_real_course_list_of_user_as_course_admin()
get_scorm_database: in file database.lib.php, method Database::get_scorm_database()
Returns the name of the Dokeos SCORM database.
get_scorm_table: in file database.lib.php, method Database::get_scorm_table()
This generic function returns the correct and complete name of any scorm table of which you pass the short name as a parameter. Please define table names as constants in this library and use them instead of directly using magic words in your tool code.
get_sessions_coached_by_user: in file tracking.lib.php, method Tracking::get_sessions_coached_by_user()
get_setting: in file main_api.lib.php, function get_setting()
DEPRECATED, use api_get_setting instead
get_statistic_database: in file database.lib.php, method Database::get_statistic_database()
Returns the name of the Dokeos statistics database.
get_statistic_table: in file database.lib.php, method Database::get_statistic_table()
This generic function returns the correct and complete name of any statistic table of which you pass the short name as a parameter.
get_status: in file surveymanager.lib.php, method SurveyManager::get_status()
Enter description here...
get_student_followed_by_coach: in file tracking.lib.php, method Tracking::get_student_followed_by_coach()
gets the list of students followed by coach
get_student_followed_by_coach_in_a_session: in file tracking.lib.php, method Tracking::get_student_followed_by_coach_in_a_session()
get_student_followed_by_drh: in file tracking.lib.php, method Tracking::get_student_followed_by_drh()
get_student_list_from_course_code: in file course.lib.php, method CourseManager::get_student_list_from_course_code()
Return user info array of all users registered in the specified real or virtual course This only returns the users that are registered in this actual course, not linked courses.
get_subscribed_tutors: in file groupmanager.lib.php, method GroupManager::get_subscribed_tutors()
get_subscribed_users: in file groupmanager.lib.php, method GroupManager::get_subscribed_users()
Get all subscribed users from a group
get_surveyid: in file surveymanager.lib.php, method SurveyManager::get_surveyid()
get_surveyname: in file surveymanager.lib.php, method SurveyManager::get_surveyname()
get_surveyname_display: in file surveymanager.lib.php, method SurveyManager::get_surveyname_display()
get_survey_author: in file surveymanager.lib.php, method SurveyManager::get_survey_author()
get_survey_code: in file surveymanager.lib.php, method SurveyManager::get_survey_code()
get_survey_list: in file surveymanager.lib.php, method SurveyManager::get_survey_list()
get_target_of_linked_course: in file course.lib.php, method CourseManager::get_target_of_linked_course()
This function returns the course code of the real course to which a virtual course is linked.
get_teacher_list: in file usermanager.lib.php, method UserManager::get_teacher_list()
get_teacher_list_from_course_code: in file course.lib.php, method CourseManager::get_teacher_list_from_course_code()
Return user info array of all teacher-users registered in the specified real or virtual course This only returns the users that are registered in this actual course, not linked courses.
get_time_spent_on_the_course: in file tracking.lib.php, method Tracking::get_time_spent_on_the_course()
Calculates the time spent on the course
get_time_spent_on_the_platform: in file tracking.lib.php, method Tracking::get_time_spent_on_the_platform()
Calculates the time spent on the platform by a user
get_token: in file security.lib.php, method Security::get_token()
This function sets a random token to be included in a form as a hidden field and saves it into the user's session.
get_total_folder_size: in file fileDisplay.lib.php, function get_total_folder_size()
Calculates the total size of a directory by adding the sizes (that are stored in the database) of all files & folders in this directory.
get_ua: in file security.lib.php, method Security::get_ua()
Gets the user agent in the session to later check it with check_ua() to prevent most cases of session hijacking.
get_users: in file groupmanager.lib.php, method GroupManager::get_users()
Get all users from a given group
get_users: in file classmanager.lib.php, method ClassManager::get_users()
Get all users from a class
get_user_group_name: in file groupmanager.lib.php, method GroupManager::get_user_group_name()
Get all groups where a specific user is subscribed
get_user_info: in file usermanager.lib.php, method UserManager::get_user_info()
Get user information
get_user_info_by_id: in file usermanager.lib.php, method UserManager::get_user_info_by_id()
Get user information
get_user_info_from_id: in file database.lib.php, method Database::get_user_info_from_id()
find all the information about a specified user. Without parameter this is the current user.
get_user_in_course_status: in file course.lib.php, method CourseManager::get_user_in_course_status()
Returns the status of a user in a course, which is COURSEMANAGER or STUDENT.
get_user_list: in file usermanager.lib.php, method UserManager::get_user_list()
get_user_list_from_course_code: in file course.lib.php, method CourseManager::get_user_list_from_course_code()
Return user info array of all users registered in the specified real or virtual course This only returns the users that are registered in this actual course, not linked courses.
get_user_personal_database: in file database.lib.php, method Database::get_user_personal_database()
Returns the name of the database where all the personal stuff of the user is stored
get_user_personal_table: in file database.lib.php, method Database::get_user_personal_table()
This generic function returns the correct and complete name of any scorm table of which you pass the short name as a parameter. Please define table names as constants in this library and use them instead of directly using magic words in your tool code.
get_user_picture_path_by_id: in file usermanager.lib.php, method UserManager::get_user_picture_path_by_id()
Get user picture URL or path from user ID (returns an array).
get_user_productions: in file usermanager.lib.php, method UserManager::get_user_productions()
Returns an array with the user's productions.
get_virtual_courses_linked_to_real_course: in file course.lib.php, method CourseManager::get_virtual_courses_linked_to_real_course()
Return an array of arrays, listing course info of all virtual course linked to the real course ID $real_course_code
get_virtual_course_info: in file course.lib.php, method CourseManager::get_virtual_course_info()
Return course info array of virtual course
get_virtual_course_list: in file course.lib.php, method CourseManager::get_virtual_course_list()
glue_course_database_name: in file database.lib.php, method Database::glue_course_database_name()
Glues a course database.
GroupManager: in file groupmanager.lib.php, class GroupManager
This library contains some functions for group-management.
GROUP_PER_MEMBER_NO_LIMIT: in file groupmanager.lib.php, constant GROUP_PER_MEMBER_NO_LIMIT
No limit on the number of groups per user
GROUP_TOOL_ANNOUNCEMENT: in file groupmanager.lib.php, constant GROUP_TOOL_ANNOUNCEMENT
GROUP_TOOL_CALENDAR: in file groupmanager.lib.php, constant GROUP_TOOL_CALENDAR
GROUP_TOOL_DOCUMENTS: in file groupmanager.lib.php, constant GROUP_TOOL_DOCUMENTS
Constants for the available group tools
GROUP_TOOL_WORK: in file groupmanager.lib.php, constant GROUP_TOOL_WORK
groupmanager.lib.php: procedural page groupmanager.lib.php

top

h

$htt_array: in file xht.lib.php, variable xhtdoc::$htt_array
$htt_error: in file xht.lib.php, variable xhtdoc::$htt_error
handle_uploaded_document: in file fileUpload.lib.php, function handle_uploaded_document()
this function does the save-work for the documents.
has_virtual_courses_from_code: in file course.lib.php, method CourseManager::has_virtual_courses_from_code()
hoursTab: in file statsUtils.lib.inc.php, function hoursTab()
Return an assoc array. Keys are the hours, values are
htaccess2txt: in file fileUpload.lib.php, function htaccess2txt()
Renames .htaccess & .HTACCESS tot htaccess.txt

top

i

$idConnexion: in file session_handler.class.php, variable session_handler::$idConnexion
Import: in file import.lib.php, class Import
This class provides some functions which can be used when importing data from
import_existing_question: in file surveymanager.lib.php, method SurveyManager::import_existing_question()
import_group: in file surveymanager.lib.php, method SurveyManager::import_group()
import_question: in file surveymanager.lib.php, method SurveyManager::import_question()
import_questions: in file surveymanager.lib.php, method SurveyManager::import_questions()
INCLUDE_PATH: in file main_api.lib.php, constant INCLUDE_PATH
index_and_sort_dir: in file fileManage.lib.php, function index_and_sort_dir()
Indexes all the directories and subdirectories contented in a given directory, and sort them alphabetically
index_dir: in file fileManage.lib.php, function index_dir()
Indexes all the directories and subdirectories contented in a given directory
INFINITE: in file groupmanager.lib.php, constant INFINITE
infinite
insert_existing_groups: in file surveymanager.lib.php, method SurveyManager::insert_existing_groups()
insert_groups: in file surveymanager.lib.php, method SurveyManager::insert_groups()
insert_id: in file database.lib.php, method Database::insert_id()
Recovers the last ID of any insert query executed over this SQL connection
insert_into_group: in file surveymanager.lib.php, method SurveyManager::insert_into_group()
insert_old_groups: in file surveymanager.lib.php, method SurveyManager::insert_old_groups()
insert_questions: in file surveymanager.lib.php, method SurveyManager::insert_questions()
is_allowed_to_coach_student: in file tracking.lib.php, method Tracking::is_allowed_to_coach_student()
is_allowed_to_edit: in file main_api.lib.php, function is_allowed_to_edit()
is_course_teacher: in file course.lib.php, method CourseManager::is_course_teacher()
Is the user a teacher in the given course?
is_date_column: in file tablesort.lib.php, method TableSort::is_date_column()
Checks if a column of a 2D-array contains only dates (GNU date syntax)
is_existing_course_code: in file course.lib.php, method CourseManager::is_existing_course_code()
is_extra_field_available: in file usermanager.lib.php, method UserManager::is_extra_field_available()
Check if a field is available
is_image_column: in file tablesort.lib.php, method TableSort::is_image_column()
Checks if a column of a 2D-array contains only images (<img src="
is_numeric_column: in file tablesort.lib.php, method TableSort::is_numeric_column()
Checks if a column of a 2D-array contains only numeric values
is_self_registration_allowed: in file groupmanager.lib.php, method GroupManager::is_self_registration_allowed()
Is sef-registration allowed?
is_self_unregistration_allowed: in file groupmanager.lib.php, method GroupManager::is_self_unregistration_allowed()
Is sef-unregistration allowed?
is_subscribed: in file groupmanager.lib.php, method GroupManager::is_subscribed()
Is user subscribed in group?
is_tutor: in file groupmanager.lib.php, method GroupManager::is_tutor()
Is user a tutor in current course
is_tutor_of_group: in file groupmanager.lib.php, method GroupManager::is_tutor_of_group()
Is the user a tutor of this group?
is_username_available: in file usermanager.lib.php, method UserManager::is_username_available()
Check if a username is available
is_user_in_group: in file groupmanager.lib.php, method GroupManager::is_user_in_group()
Is the user part of this group? This can be a tutor or a normal member
is_user_subscribed_in_course: in file course.lib.php, method CourseManager::is_user_subscribed_in_course()
Return course info array of virtual course
is_user_subscribed_in_real_or_linked_course: in file course.lib.php, method CourseManager::is_user_subscribed_in_real_or_linked_course()
Is the user subscribed in the real course or linked courses?
is_virtual_course_from_system_code: in file course.lib.php, method CourseManager::is_virtual_course_from_system_code()
is_virtual_course_from_visual_code: in file course.lib.php, method CourseManager::is_virtual_course_from_visual_code()
What's annoying is that you can't overload functions in PHP.
item_property_update_on_folder: in file fileUpload.lib.php, function item_property_update_on_folder()
this function updates the last_edit_date, last edit user id on all folders in a given path
import.lib.php: procedural page import.lib.php

top

l

$lifetime: in file session_handler.class.php, variable session_handler::$lifetime
lang2db: in file add_course.lib.inc.php, function lang2db()
Function to convert a string from the Dokeos language files to a string ready to insert into the database.
latex_gif_renderer: in file text.lib.php, function latex_gif_renderer()
render LaTeX code into a gif or retrieve a cached version of the gif
LIBRARY_PATH: in file main_api.lib.php, constant LIBRARY_PATH
listAnswers: in file surveymanager.lib.php, method SurveyManager::listAnswers()
listGroups: in file surveymanager.lib.php, method SurveyManager::listGroups()
listQuestions: in file surveymanager.lib.php, method SurveyManager::listQuestions()
listUsers: in file surveymanager.lib.php, method SurveyManager::listUsers()
list_all_directories: in file fileManage.lib.php, method FileManager::list_all_directories()
list_all_files: in file fileManage.lib.php, method FileManager::list_all_files()
loadBrowsers: in file stats.lib.inc.php, function loadBrowsers()
This function is used to build an array containing
loadCountries: in file stats.lib.inc.php, function loadCountries()
This function is used to build an array containing
loadOs: in file stats.lib.inc.php, function loadOs()
This function is used to build an array containing

top

m

main_api.lib.php: procedural page main_api.lib.php
makeHitsTable: in file statsUtils.lib.inc.php, function makeHitsTable()
Display a 4 column array
makeTheBackup: in file export.lib.inc.php, function makeTheBackup()
Export a course to a zip file
make_clickable: in file text.lib.php, function make_clickable()
completes url contained in the text with "<a href ...". However the function simply returns the submitted text without any transformation if it already contains some "<a href:" or "<img src=".
maximum_number_of_students: in file groupmanager.lib.php, method GroupManager::maximum_number_of_students()
Maximum number of students in a group
MEMBER_PER_GROUP_NO_LIMIT: in file groupmanager.lib.php, constant MEMBER_PER_GROUP_NO_LIMIT
No limit on the number of users in a group
mkdirs: in file fileManage.lib.php, method FileManager::mkdirs()
Like in Java, creates the directory named by this abstract pathname, including any necessary but nonexistent parent directories.
mkpath: in file fileManage.lib.php, function mkpath()
to create missing directory in a gived path
monthTab: in file statsUtils.lib.inc.php, function monthTab()
Return an assoc array. Keys are the days, values are
move: in file fileManage.lib.php, function move()
Move a file or a directory to an other area
move_question: in file surveymanager.lib.php, method SurveyManager::move_question()
move_uploaded_file_collection_into_directory: in file fileUpload.lib.php, function move_uploaded_file_collection_into_directory()
Handles uploaded missing images
my_delete: in file fileManage.lib.php, function my_delete()
Delete a file or a directory
my_rename: in file fileManage.lib.php, function my_rename()
Rename a file or a directory

top

n

$name: in file xmd.lib.php, variable xmddoc::$name
$names: in file xmd.lib.php, variable xmddoc::$names
$ns: in file xmd.lib.php, variable xmddoc::$ns
$numbers: in file xmd.lib.php, variable xmddoc::$numbers
NOT_VISIBLE_NO_SUBSCRIPTION_ALLOWED: in file course.lib.php, constant NOT_VISIBLE_NO_SUBSCRIPTION_ALLOWED
NOT_VISIBLE_SUBSCRIPTION_ALLOWED: in file course.lib.php, constant NOT_VISIBLE_SUBSCRIPTION_ALLOWED
no_of_question: in file surveymanager.lib.php, method SurveyManager::no_of_question()
number_of_students: in file groupmanager.lib.php, method GroupManager::number_of_students()
Get the number of students in a group.
num_rows: in file database.lib.php, method Database::num_rows()
Gets the number of rows from the last query result - help achieving database independence

top

o

open: in file session_handler.class.php, method session_handler::open()
orderingstring: in file tablesort.lib.php, method TableSort::orderingstring()
Create a string to use in sorting.

top

p

$parent: in file xmd.lib.php, variable xmddoc::$parent
php2phps: in file fileUpload.lib.php, function php2phps()
change the file name extension from .php to .phps Useful to secure a site !!
pick_author: in file surveymanager.lib.php, method SurveyManager::pick_author()
pick_surveyname: in file surveymanager.lib.php, method SurveyManager::pick_surveyname()
PLATFORM_AUTH_SOURCE: in file main_api.lib.php, constant PLATFORM_AUTH_SOURCE
PLUGIN_PATH: in file main_api.lib.php, constant PLUGIN_PATH
prepare_course_repository: in file add_course.lib.inc.php, function prepare_course_repository()
printVar: in file debug.lib.inc.php, function printVar()
process_uploaded_file: in file fileUpload.lib.php, function process_uploaded_file()
This checks if the upload succeeded

top

q

query: in file database.lib.php, method Database::query()
question_import: in file surveymanager.lib.php, method SurveyManager::question_import()
ques_id_group_name: in file surveymanager.lib.php, method SurveyManager::ques_id_group_name()

top

r

read: in file session_handler.class.php, method session_handler::read()
readPropertiesInArchive: in file add_course.lib.inc.php, function readPropertiesInArchive()
recent_modified_file_time: in file fileDisplay.lib.php, function recent_modified_file_time()
Get the most recent time the content of a folder was changed.
register_course: in file add_course.lib.inc.php, function register_course()
function register_course to create a record in the course table of the main database
REL_CODE_PATH: in file main_api.lib.php, constant REL_CODE_PATH
REL_COURSE_PATH: in file main_api.lib.php, constant REL_COURSE_PATH
REL_PATH: in file main_api.lib.php, constant REL_PATH
removeDir: in file fileManage.lib.php, function removeDir()
removes a directory recursively
remove_accents: in file fileUpload.lib.php, function remove_accents()
remove_user_production: in file usermanager.lib.php, method UserManager::remove_user_production()
Remove a user production.
remove_XSS: in file security.lib.php, method Security::remove_XSS()
This function tackles the XSS injections.
replace_accents: in file fileUpload.lib.php, function replace_accents()
Replaces all accentuated characters by non-accentuated characters for filenames, as well as special HTML characters by their HTML entity's first letter.
replace_dangerous_char: in file fileUpload.lib.php, function replace_dangerous_char()
replaces "forbidden" characters in a filename string
replace_img_path_in_html_file: in file fileUpload.lib.php, function replace_img_path_in_html_file()
result: in file database.lib.php, method Database::result()
Acts as the relative *_result() function of most DB drivers and fetches a
return_icon: in file display.lib.php, method Display::return_icon()
This function returns the htmlcode for an icon

top

s

$sessionName: in file session_handler.class.php, variable session_handler::$sessionName
security.lib.php: procedural page security.lib.php
session_handler.class.php: procedural page session_handler.class.php
stats.lib.inc.php: procedural page stats.lib.inc.php
statsUtils.lib.inc.php: procedural page statsUtils.lib.inc.php
surveymanager.lib.php: procedural page surveymanager.lib.php
system_announcements.lib.php: procedural page system_announcements.lib.php
search_img_from_html: in file fileUpload.lib.php, function search_img_from_html()
retrieve the image path list in a html file
SECTION_CAMPUS: in file main_api.lib.php, constant SECTION_CAMPUS
SECTION_COURSES: in file main_api.lib.php, constant SECTION_COURSES
SECTION_COURSE_ADMIN: in file main_api.lib.php, constant SECTION_COURSE_ADMIN
SECTION_MYAGENDA: in file main_api.lib.php, constant SECTION_MYAGENDA
SECTION_MYGRADEBOOK: in file main_api.lib.php, constant SECTION_MYGRADEBOOK
SECTION_MYPROFILE: in file main_api.lib.php, constant SECTION_MYPROFILE
SECTION_PLATFORM_ADMIN: in file main_api.lib.php, constant SECTION_PLATFORM_ADMIN
Security: in file security.lib.php, class Security
Security class
select_and_sort_categories: in file course.lib.php, method CourseManager::select_and_sort_categories()
create recursively all categories as option of the select passed in paramater.
select_group_list: in file surveymanager.lib.php, method SurveyManager::select_group_list()
select_survey_list: in file surveymanager.lib.php, method SurveyManager::select_survey_list()
Creates a new survey for the platform
send_system_announcement_by_email: in file system_announcements.lib.php, method SystemAnnouncementManager::send_system_announcement_by_email()
SESSIONADMIN: in file main_api.lib.php, constant SESSIONADMIN
global status of a user: session admin
session_handler: in file session_handler.class.php, class session_handler
This class allows to manage the session. Session is stored in the database
session_handler: in file session_handler.class.php, method session_handler::session_handler()
set_default_settings: in file fileUpload.lib.php, function set_default_settings()
Adds file to document table in database
set_default_settings: in file fileManage.lib.php, method FileManager::set_default_settings()
Adds file/folder to document table in database
set_document_as_template: in file document.lib.php, method DocumentManager::set_document_as_template()
Allow to set a specific document as a new template for FCKEditor for a particular user in a particular course
set_failure: in file main_api.lib.php, method api_failure::set_failure()
set_group_properties: in file groupmanager.lib.php, method GroupManager::set_group_properties()
Set group properties Changes the group's properties.
set_name: in file classmanager.lib.php, method ClassManager::set_name()
Change the name of a class
set_visibility: in file system_announcements.lib.php, method SystemAnnouncementManager::set_visibility()
Change the visibility of an announcement
shorten: in file main_api.lib.php, function shorten()
show_course_navigation_menu: in file display.lib.php, method Display::show_course_navigation_menu()
Show the so-called "left" menu for navigating
SORT_DATE: in file tablesort.lib.php, constant SORT_DATE
This is a library with some functions to sort tabular data
SORT_IMAGE: in file tablesort.lib.php, constant SORT_IMAGE
sort_pictures: in file add_course.lib.inc.php, function sort_pictures()
sort_table: in file tablesort.lib.php, method TableSort::sort_table()
Sort 2-dimensional table.
sort_table: in file surveymanager.lib.php, method SurveyManager::sort_table()
sort_table_config: in file tablesort.lib.php, method TableSort::sort_table_config()
Sort 2-dimensional table. It is possile of change the columns that will be show and the way that the columns are sorted.
sqlClose: in file session_handler.class.php, method session_handler::sqlClose()
sqlConnect: in file session_handler.class.php, method session_handler::sqlConnect()
sqlQuery: in file session_handler.class.php, method session_handler::sqlQuery()
string2binary: in file add_course.lib.inc.php, function string2binary()
function string2binary converts the string "true" or "false" to the boolean true false (0 or 1)
string_2_boolean: in file main_api.lib.php, function string_2_boolean()
This function converts the string "true" or "false" to a boolean true or false.
string_send_for_download: in file document.lib.php, method DocumentManager::string_send_for_download()
This function streams a string to the client for download.
strtolower_eorlatin: in file tablesort.lib.php, method TableSort::strtolower_eorlatin()
String to lowercase.
strtolower_keepaccents: in file tablesort.lib.php, method TableSort::strtolower_keepaccents()
String to lowercase (keep accents).
STUDENT: in file main_api.lib.php, constant STUDENT
global status of a user: student
SUBSCRIBE_ALLOWED: in file main_api.lib.php, constant SUBSCRIBE_ALLOWED
SUBSCRIBE_NOT_ALLOWED: in file main_api.lib.php, constant SUBSCRIBE_NOT_ALLOWED
subscribe_to_course: in file classmanager.lib.php, method ClassManager::subscribe_to_course()
Subscribe all members of a class to a course
subscribe_tutors: in file groupmanager.lib.php, method GroupManager::subscribe_tutors()
Subscribe tutor(s) to a specified group in current course
subscribe_user: in file course.lib.php, method CourseManager::subscribe_user()
Subscribe a user to a course. No checks are performed here to see if course subscription is allowed.
subscribe_users: in file groupmanager.lib.php, method GroupManager::subscribe_users()
Subscribe user(s) to a specified group in current course
SurveyManager: in file surveymanager.lib.php, class SurveyManager
This library provides functions for user management.
swap_category_order: in file groupmanager.lib.php, method GroupManager::swap_category_order()
Swaps the display-order of two categories
SystemAnnouncementManager: in file system_announcements.lib.php, class SystemAnnouncementManager
This is the system announcements library for Dokeos.
SYS_ARCHIVE_PATH: in file main_api.lib.php, constant SYS_ARCHIVE_PATH
SYS_CODE_PATH: in file main_api.lib.php, constant SYS_CODE_PATH
SYS_COURSE_PATH: in file main_api.lib.php, constant SYS_COURSE_PATH
SYS_LANG_PATH: in file main_api.lib.php, constant SYS_LANG_PATH
SYS_PATH: in file main_api.lib.php, constant SYS_PATH
SYS_PLUGIN_PATH: in file main_api.lib.php, constant SYS_PLUGIN_PATH

top

t

$textstring: in file xmd.lib.php, variable xmddoc::$textstring
tablesort.lib.php: procedural page tablesort.lib.php
text.lib.php: procedural page text.lib.php
tracking.lib.php: procedural page tracking.lib.php
TableSort: in file tablesort.lib.php, class TableSort
TABLE_AGENDA: in file database.lib.php, constant TABLE_AGENDA
TABLE_AGENDA_REPEAT: in file database.lib.php, constant TABLE_AGENDA_REPEAT
TABLE_AGENDA_REPEAT_NOT: in file database.lib.php, constant TABLE_AGENDA_REPEAT_NOT
TABLE_ANNOUNCEMENT: in file database.lib.php, constant TABLE_ANNOUNCEMENT
TABLE_BLOGS: in file database.lib.php, constant TABLE_BLOGS
TABLE_BLOGS_ATTACHMENT: in file database.lib.php, constant TABLE_BLOGS_ATTACHMENT
TABLE_BLOGS_COMMENTS: in file database.lib.php, constant TABLE_BLOGS_COMMENTS
TABLE_BLOGS_POSTS: in file database.lib.php, constant TABLE_BLOGS_POSTS
TABLE_BLOGS_RATING: in file database.lib.php, constant TABLE_BLOGS_RATING
TABLE_BLOGS_REL_USER: in file database.lib.php, constant TABLE_BLOGS_REL_USER
TABLE_BLOGS_TASKS: in file database.lib.php, constant TABLE_BLOGS_TASKS
TABLE_BLOGS_TASKS_PERMISSIONS: in file database.lib.php, constant TABLE_BLOGS_TASKS_PERMISSIONS
TABLE_BLOGS_TASKS_REL_USER: in file database.lib.php, constant TABLE_BLOGS_TASKS_REL_USER
TABLE_CHAT_CONNECTED: in file database.lib.php, constant TABLE_CHAT_CONNECTED
TABLE_COURSE_DESCRIPTION: in file database.lib.php, constant TABLE_COURSE_DESCRIPTION
TABLE_COURSE_SETTING: in file database.lib.php, constant TABLE_COURSE_SETTING
TABLE_DOCUMENT: in file database.lib.php, constant TABLE_DOCUMENT
TABLE_DROPBOX_CATEGORY: in file database.lib.php, constant TABLE_DROPBOX_CATEGORY
TABLE_DROPBOX_FEEDBACK: in file database.lib.php, constant TABLE_DROPBOX_FEEDBACK
TABLE_DROPBOX_FILE: in file database.lib.php, constant TABLE_DROPBOX_FILE
TABLE_DROPBOX_PERSON: in file database.lib.php, constant TABLE_DROPBOX_PERSON
TABLE_DROPBOX_POST: in file database.lib.php, constant TABLE_DROPBOX_POST
TABLE_FORUM: in file database.lib.php, constant TABLE_FORUM
TABLE_FORUM_ATTACHMENT: in file database.lib.php, constant TABLE_FORUM_ATTACHMENT
TABLE_FORUM_CATEGORY: in file database.lib.php, constant TABLE_FORUM_CATEGORY
TABLE_FORUM_POST: in file database.lib.php, constant TABLE_FORUM_POST
TABLE_FORUM_THREAD: in file database.lib.php, constant TABLE_FORUM_THREAD
TABLE_GROUP: in file database.lib.php, constant TABLE_GROUP
TABLE_GROUP_CATEGORY: in file database.lib.php, constant TABLE_GROUP_CATEGORY
TABLE_GROUP_TUTOR: in file database.lib.php, constant TABLE_GROUP_TUTOR
TABLE_GROUP_USER: in file database.lib.php, constant TABLE_GROUP_USER
TABLE_ITEM_PROPERTY: in file database.lib.php, constant TABLE_ITEM_PROPERTY
TABLE_LEARNPATH_CHAPTER: in file database.lib.php, constant TABLE_LEARNPATH_CHAPTER
TABLE_LEARNPATH_ITEM: in file database.lib.php, constant TABLE_LEARNPATH_ITEM
TABLE_LEARNPATH_MAIN: in file database.lib.php, constant TABLE_LEARNPATH_MAIN
TABLE_LEARNPATH_USER: in file database.lib.php, constant TABLE_LEARNPATH_USER
TABLE_LINK: in file database.lib.php, constant TABLE_LINK
TABLE_LINKED_RESOURCES: in file database.lib.php, constant TABLE_LINKED_RESOURCES
TABLE_LINK_CATEGORY: in file database.lib.php, constant TABLE_LINK_CATEGORY
TABLE_LP_ITEM: in file database.lib.php, constant TABLE_LP_ITEM
TABLE_LP_ITEM_VIEW: in file database.lib.php, constant TABLE_LP_ITEM_VIEW
TABLE_LP_IV_INTERACTION: in file database.lib.php, constant TABLE_LP_IV_INTERACTION
TABLE_LP_MAIN: in file database.lib.php, constant TABLE_LP_MAIN
TABLE_LP_VIEW: in file database.lib.php, constant TABLE_LP_VIEW
TABLE_MAIN_ACCESS_URL: in file database.lib.php, constant TABLE_MAIN_ACCESS_URL
TABLE_MAIN_ADMIN: in file database.lib.php, constant TABLE_MAIN_ADMIN
TABLE_MAIN_CATEGORY: in file database.lib.php, constant TABLE_MAIN_CATEGORY
TABLE_MAIN_CLASS: in file database.lib.php, constant TABLE_MAIN_CLASS
TABLE_MAIN_CLASS_USER: in file database.lib.php, constant TABLE_MAIN_CLASS_USER
TABLE_MAIN_COURSE: in file database.lib.php, constant TABLE_MAIN_COURSE
This is the main database library for Dokeos.
TABLE_MAIN_COURSE_CLASS: in file database.lib.php, constant TABLE_MAIN_COURSE_CLASS
TABLE_MAIN_COURSE_MODULE: in file database.lib.php, constant TABLE_MAIN_COURSE_MODULE
TABLE_MAIN_COURSE_USER: in file database.lib.php, constant TABLE_MAIN_COURSE_USER
TABLE_MAIN_GRADEBOOK_CATEGORY: in file database.lib.php, constant TABLE_MAIN_GRADEBOOK_CATEGORY
TABLE_MAIN_GRADEBOOK_EVALUATION: in file database.lib.php, constant TABLE_MAIN_GRADEBOOK_EVALUATION
TABLE_MAIN_GRADEBOOK_LINK: in file database.lib.php, constant TABLE_MAIN_GRADEBOOK_LINK
TABLE_MAIN_GRADEBOOK_RESULT: in file database.lib.php, constant TABLE_MAIN_GRADEBOOK_RESULT
TABLE_MAIN_GRADEBOOK_SCORE_DISPLAY: in file database.lib.php, constant TABLE_MAIN_GRADEBOOK_SCORE_DISPLAY
TABLE_MAIN_GROUP: in file database.lib.php, constant TABLE_MAIN_GROUP
TABLE_MAIN_LANGUAGE: in file database.lib.php, constant TABLE_MAIN_LANGUAGE
TABLE_MAIN_OPENID_ASSOCIATION: in file database.lib.php, constant TABLE_MAIN_OPENID_ASSOCIATION
TABLE_MAIN_SESSION: in file database.lib.php, constant TABLE_MAIN_SESSION
TABLE_MAIN_SESSION_CLASS: in file database.lib.php, constant TABLE_MAIN_SESSION_CLASS
TABLE_MAIN_SESSION_COURSE: in file database.lib.php, constant TABLE_MAIN_SESSION_COURSE
TABLE_MAIN_SESSION_COURSE_USER: in file database.lib.php, constant TABLE_MAIN_SESSION_COURSE_USER
TABLE_MAIN_SESSION_USER: in file database.lib.php, constant TABLE_MAIN_SESSION_USER
TABLE_MAIN_SETTINGS_CURRENT: in file database.lib.php, constant TABLE_MAIN_SETTINGS_CURRENT
TABLE_MAIN_SETTINGS_OPTIONS: in file database.lib.php, constant TABLE_MAIN_SETTINGS_OPTIONS
TABLE_MAIN_SHARED_SURVEY: in file database.lib.php, constant TABLE_MAIN_SHARED_SURVEY
TABLE_MAIN_SHARED_SURVEY_QUESTION: in file database.lib.php, constant TABLE_MAIN_SHARED_SURVEY_QUESTION
TABLE_MAIN_SHARED_SURVEY_QUESTION_OPTION: in file database.lib.php, constant TABLE_MAIN_SHARED_SURVEY_QUESTION_OPTION
TABLE_MAIN_SURVEY: in file database.lib.php, constant TABLE_MAIN_SURVEY
TABLE_MAIN_SURVEYQUESTION: in file database.lib.php, constant TABLE_MAIN_SURVEYQUESTION
TABLE_MAIN_SYSTEM_ANNOUNCEMENTS: in file database.lib.php, constant TABLE_MAIN_SYSTEM_ANNOUNCEMENTS
TABLE_MAIN_TEMPLATES: in file database.lib.php, constant TABLE_MAIN_TEMPLATES
TABLE_MAIN_USER: in file database.lib.php, constant TABLE_MAIN_USER
TABLE_MAIN_USER_FIELD: in file database.lib.php, constant TABLE_MAIN_USER_FIELD
TABLE_MAIN_USER_FIELD_OPTIONS: in file database.lib.php, constant TABLE_MAIN_USER_FIELD_OPTIONS
TABLE_MAIN_USER_FIELD_VALUES: in file database.lib.php, constant TABLE_MAIN_USER_FIELD_VALUES
TABLE_ONLINE_CONNECTED: in file database.lib.php, constant TABLE_ONLINE_CONNECTED
TABLE_ONLINE_LINK: in file database.lib.php, constant TABLE_ONLINE_LINK
TABLE_PERMISSION_GROUP: in file database.lib.php, constant TABLE_PERMISSION_GROUP
TABLE_PERMISSION_TASK: in file database.lib.php, constant TABLE_PERMISSION_TASK
TABLE_PERMISSION_USER: in file database.lib.php, constant TABLE_PERMISSION_USER
TABLE_PERSONAL_AGENDA: in file database.lib.php, constant TABLE_PERSONAL_AGENDA
TABLE_PERSONAL_AGENDA_REPEAT: in file database.lib.php, constant TABLE_PERSONAL_AGENDA_REPEAT
TABLE_PERSONAL_AGENDA_REPEAT_NOT: in file database.lib.php, constant TABLE_PERSONAL_AGENDA_REPEAT_NOT
TABLE_QUIZ_ANSWER: in file database.lib.php, constant TABLE_QUIZ_ANSWER
TABLE_QUIZ_QUESTION: in file database.lib.php, constant TABLE_QUIZ_QUESTION
TABLE_QUIZ_TEST: in file database.lib.php, constant TABLE_QUIZ_TEST
TABLE_QUIZ_TEST_QUESTION: in file database.lib.php, constant TABLE_QUIZ_TEST_QUESTION
TABLE_ROLE: in file database.lib.php, constant TABLE_ROLE
TABLE_ROLE_GROUP: in file database.lib.php, constant TABLE_ROLE_GROUP
TABLE_ROLE_PERMISSION: in file database.lib.php, constant TABLE_ROLE_PERMISSION
TABLE_ROLE_USER: in file database.lib.php, constant TABLE_ROLE_USER
TABLE_SCORMDOC: in file database.lib.php, constant TABLE_SCORMDOC
TABLE_SCORM_MAIN: in file database.lib.php, constant TABLE_SCORM_MAIN
TABLE_SCORM_SCO_DATA: in file database.lib.php, constant TABLE_SCORM_SCO_DATA
TABLE_STATISTIC_TRACK_E_ACCESS: in file database.lib.php, constant TABLE_STATISTIC_TRACK_E_ACCESS
TABLE_STATISTIC_TRACK_E_ATTEMPT: in file database.lib.php, constant TABLE_STATISTIC_TRACK_E_ATTEMPT
TABLE_STATISTIC_TRACK_E_COURSE_ACCESS: in file database.lib.php, constant TABLE_STATISTIC_TRACK_E_COURSE_ACCESS
TABLE_STATISTIC_TRACK_E_DEFAULT: in file database.lib.php, constant TABLE_STATISTIC_TRACK_E_DEFAULT
TABLE_STATISTIC_TRACK_E_DOWNLOADS: in file database.lib.php, constant TABLE_STATISTIC_TRACK_E_DOWNLOADS
TABLE_STATISTIC_TRACK_E_EXERCICES: in file database.lib.php, constant TABLE_STATISTIC_TRACK_E_EXERCICES
TABLE_STATISTIC_TRACK_E_HOTPOTATOES: in file database.lib.php, constant TABLE_STATISTIC_TRACK_E_HOTPOTATOES
TABLE_STATISTIC_TRACK_E_HOTSPOT: in file database.lib.php, constant TABLE_STATISTIC_TRACK_E_HOTSPOT
TABLE_STATISTIC_TRACK_E_LASTACCESS: in file database.lib.php, constant TABLE_STATISTIC_TRACK_E_LASTACCESS
TABLE_STATISTIC_TRACK_E_LINKS: in file database.lib.php, constant TABLE_STATISTIC_TRACK_E_LINKS
TABLE_STATISTIC_TRACK_E_LOGIN: in file database.lib.php, constant TABLE_STATISTIC_TRACK_E_LOGIN
TABLE_STATISTIC_TRACK_E_ONLINE: in file database.lib.php, constant TABLE_STATISTIC_TRACK_E_ONLINE
TABLE_STATISTIC_TRACK_E_UPLOADS: in file database.lib.php, constant TABLE_STATISTIC_TRACK_E_UPLOADS
TABLE_STUDENT_PUBLICATION: in file database.lib.php, constant TABLE_STUDENT_PUBLICATION
TABLE_SURVEY: in file database.lib.php, constant TABLE_SURVEY
TABLE_SURVEY_ANSWER: in file database.lib.php, constant TABLE_SURVEY_ANSWER
TABLE_SURVEY_INVITATION: in file database.lib.php, constant TABLE_SURVEY_INVITATION
TABLE_SURVEY_QUESTION: in file database.lib.php, constant TABLE_SURVEY_QUESTION
TABLE_SURVEY_QUESTION_OPTION: in file database.lib.php, constant TABLE_SURVEY_QUESTION_OPTION
TABLE_TOOL_INTRO: in file database.lib.php, constant TABLE_TOOL_INTRO
TABLE_TOOL_LIST: in file database.lib.php, constant TABLE_TOOL_LIST
TABLE_USER_COURSE_CATEGORY: in file database.lib.php, constant TABLE_USER_COURSE_CATEGORY
TABLE_USER_INFO: in file database.lib.php, constant TABLE_USER_INFO
TABLE_USER_INFO_CONTENT: in file database.lib.php, constant TABLE_USER_INFO_CONTENT
text_filter: in file text.lib.php, function text_filter()
this function does some parsing on the text that gets inputted. This parsing can be of any kind LaTeX notation, Word Censoring, Glossary Terminology (extension will available soon), Musical Notations, ... The inspiration for this filter function came from Moodle an phpBB who both use a similar approach
TOOL_ANNOUNCEMENT: in file main_api.lib.php, constant TOOL_ANNOUNCEMENT
TOOL_BACKUP: in file main_api.lib.php, constant TOOL_BACKUP
TOOL_BLOGS: in file main_api.lib.php, constant TOOL_BLOGS
TOOL_CALENDAR_EVENT: in file main_api.lib.php, constant TOOL_CALENDAR_EVENT
TOOL_CHAT: in file main_api.lib.php, constant TOOL_CHAT
TOOL_CONFERENCE: in file main_api.lib.php, constant TOOL_CONFERENCE
TOOL_COPY_COURSE_CONTENT: in file main_api.lib.php, constant TOOL_COPY_COURSE_CONTENT
TOOL_COURSE_DESCRIPTION: in file main_api.lib.php, constant TOOL_COURSE_DESCRIPTION
TOOL_COURSE_HOMEPAGE: in file main_api.lib.php, constant TOOL_COURSE_HOMEPAGE
TOOL_COURSE_MAINTENANCE: in file main_api.lib.php, constant TOOL_COURSE_MAINTENANCE
TOOL_COURSE_RIGHTS_OVERVIEW: in file main_api.lib.php, constant TOOL_COURSE_RIGHTS_OVERVIEW
TOOL_COURSE_SETTING: in file main_api.lib.php, constant TOOL_COURSE_SETTING
TOOL_DOCUMENT: in file main_api.lib.php, constant TOOL_DOCUMENT
TOOL_DROPBOX: in file main_api.lib.php, constant TOOL_DROPBOX
TOOL_FORUM: in file main_api.lib.php, constant TOOL_FORUM
TOOL_GROUP: in file main_api.lib.php, constant TOOL_GROUP
TOOL_HOMEPAGE_LINK: in file main_api.lib.php, constant TOOL_HOMEPAGE_LINK
TOOL_HOTPOTATOES: in file main_api.lib.php, constant TOOL_HOTPOTATOES
TOOL_LEARNPATH: in file main_api.lib.php, constant TOOL_LEARNPATH
TOOL_LINK: in file main_api.lib.php, constant TOOL_LINK
TOOL_NOT_AVAILABLE: in file groupmanager.lib.php, constant TOOL_NOT_AVAILABLE
The tools of a group can have 3 states
TOOL_POST: in file main_api.lib.php, constant TOOL_POST
TOOL_PRIVATE: in file groupmanager.lib.php, constant TOOL_PRIVATE
TOOL_PUBLIC: in file groupmanager.lib.php, constant TOOL_PUBLIC
TOOL_QUIZ: in file main_api.lib.php, constant TOOL_QUIZ
TOOL_RECYCLE_COURSE: in file main_api.lib.php, constant TOOL_RECYCLE_COURSE
TOOL_STUDENTPUBLICATION: in file main_api.lib.php, constant TOOL_STUDENTPUBLICATION
TOOL_SURVEY: in file main_api.lib.php, constant TOOL_SURVEY
TOOL_THREAD: in file main_api.lib.php, constant TOOL_THREAD
TOOL_TRACKING: in file main_api.lib.php, constant TOOL_TRACKING
TOOL_UPLOAD: in file main_api.lib.php, constant TOOL_UPLOAD
TOOL_USER: in file main_api.lib.php, constant TOOL_USER
TOOL_VISIO: in file main_api.lib.php, constant TOOL_VISIO
TOOL_VISIO_CLASSROOM: in file main_api.lib.php, constant TOOL_VISIO_CLASSROOM
TOOL_VISIO_CONFERENCE: in file main_api.lib.php, constant TOOL_VISIO_CONFERENCE
Tracking: in file tracking.lib.php, class Tracking
This is the tracking library for Dokeos.
treat_uploaded_file: in file fileUpload.lib.php, function treat_uploaded_file()

top

u

usermanager.lib.php: procedural page usermanager.lib.php
unique_name: in file fileUpload.lib.php, function unique_name()
this function generates a unique name for a file on a given location filenames are changed to name_#.ext
unset_document_as_template: in file document.lib.php, method DocumentManager::unset_document_as_template()
Unset a document as template
UNSUBSCRIBE_ALLOWED: in file main_api.lib.php, constant UNSUBSCRIBE_ALLOWED
unsubscribe_all_tutors: in file groupmanager.lib.php, method GroupManager::unsubscribe_all_tutors()
Unsubscribe all tutors from one or more groups
unsubscribe_all_users: in file groupmanager.lib.php, method GroupManager::unsubscribe_all_users()
Unsubscribe all users from one or more groups
unsubscribe_from_course: in file classmanager.lib.php, method ClassManager::unsubscribe_from_course()
Unsubscribe a class from a course.
UNSUBSCRIBE_NOT_ALLOWED: in file main_api.lib.php, constant UNSUBSCRIBE_NOT_ALLOWED
unsubscribe_user: in file course.lib.php, method CourseManager::unsubscribe_user()
Unsubscribe one or more users from a course
unsubscribe_user: in file classmanager.lib.php, method ClassManager::unsubscribe_user()
Unsubscribe a user from a class. If the class is also subscribed in a
unsubscribe_users: in file groupmanager.lib.php, method GroupManager::unsubscribe_users()
Unsubscribe user(s) from a specified group in current course
unzip_uploaded_document: in file fileUpload.lib.php, function unzip_uploaded_document()
Manages all the unzipping process of an uploaded document This uses the item_property table for properties of documents
unzip_uploaded_file: in file fileUpload.lib.php, function unzip_uploaded_file()
Manages all the unzipping process of an uploaded file
update_announcement: in file system_announcements.lib.php, method SystemAnnouncementManager::update_announcement()
Updates an announcement to the database
update_category: in file groupmanager.lib.php, method GroupManager::update_category()
Update group category
update_Db_course: in file add_course.lib.inc.php, function update_Db_course()
update_db_info: in file fileManage.lib.php, function update_db_info()
Update the file or directory path in the document db document table
update_existing_document: in file fileUpload.lib.php, function update_existing_document()
Update an existing document in the database as the file exists, we only need to change the size
update_extra_field: in file usermanager.lib.php, method UserManager::update_extra_field()
Update an extra field
update_extra_field_value: in file usermanager.lib.php, method UserManager::update_extra_field_value()
Update an extra field value for a given user
update_group: in file surveymanager.lib.php, method SurveyManager::update_group()
update_openid: in file usermanager.lib.php, method UserManager::update_openid()
Update user information with new openid
update_question: in file surveymanager.lib.php, method SurveyManager::update_question()
update_survey: in file surveymanager.lib.php, method SurveyManager::update_survey()
update_user: in file usermanager.lib.php, method UserManager::update_user()
Update user information
userCourseSort: in file course.lib.php, method CourseManager::userCourseSort()
UserManager: in file usermanager.lib.php, class UserManager
USER_FIELD_TYPE_DATE: in file usermanager.lib.php, constant USER_FIELD_TYPE_DATE
USER_FIELD_TYPE_DATETIME: in file usermanager.lib.php, constant USER_FIELD_TYPE_DATETIME
USER_FIELD_TYPE_RADIO: in file usermanager.lib.php, constant USER_FIELD_TYPE_RADIO
USER_FIELD_TYPE_SELECT: in file usermanager.lib.php, constant USER_FIELD_TYPE_SELECT
USER_FIELD_TYPE_SELECT_MULTIPLE: in file usermanager.lib.php, constant USER_FIELD_TYPE_SELECT_MULTIPLE
USER_FIELD_TYPE_TEXT: in file usermanager.lib.php, constant USER_FIELD_TYPE_TEXT
This library provides functions for user management.
USER_FIELD_TYPE_TEXTAREA: in file usermanager.lib.php, constant USER_FIELD_TYPE_TEXTAREA
user_has_access: in file groupmanager.lib.php, method GroupManager::user_has_access()
Check if a user has access to a certain group tool
user_in_number_of_groups: in file groupmanager.lib.php, method GroupManager::user_in_number_of_groups()
Number of groups of a user

top

v

VIRTUAL_COURSE_CATEGORY: in file groupmanager.lib.php, constant VIRTUAL_COURSE_CATEGORY
Fixed id's for group categories
VISIBLE_GUEST: in file system_announcements.lib.php, constant VISIBLE_GUEST
VISIBLE_NO_SUBSCRIPTION_ALLOWED: in file course.lib.php, constant VISIBLE_NO_SUBSCRIPTION_ALLOWED
VISIBLE_STUDENT: in file system_announcements.lib.php, constant VISIBLE_STUDENT
VISIBLE_SUBSCRIPTION_ALLOWED: in file course.lib.php, constant VISIBLE_SUBSCRIPTION_ALLOWED
VISIBLE_TEACHER: in file system_announcements.lib.php, constant VISIBLE_TEACHER

top

w

WEB_CODE_PATH: in file main_api.lib.php, constant WEB_CODE_PATH
WEB_COURSE_PATH: in file main_api.lib.php, constant WEB_COURSE_PATH
WEB_CSS_PATH: in file main_api.lib.php, constant WEB_CSS_PATH
WEB_IMG_PATH: in file main_api.lib.php, constant WEB_IMG_PATH
WEB_LIBRARY_PATH: in file main_api.lib.php, constant WEB_LIBRARY_PATH
WEB_PATH: in file main_api.lib.php, constant WEB_PATH
WEB_PLUGIN_PATH: in file main_api.lib.php, constant WEB_PLUGIN_PATH
write: in file session_handler.class.php, method session_handler::write()

top

x

$xht_dbgn: in file xht.lib.php, variable xhtdoc::$xht_dbgn
$xht_dbgo: in file xht.lib.php, variable xhtdoc::$xht_dbgo
$xht_get_lang: in file xht.lib.php, variable xhtdoc::$xht_get_lang
$xht_param: in file xht.lib.php, variable xhtdoc::$xht_param
$xht_resource: in file xht.lib.php, variable xhtdoc::$xht_resource
$xht_xmldoc: in file xht.lib.php, variable xhtdoc::$xht_xmldoc
xht.lib.php: procedural page xht.lib.php
xmd.lib.php: procedural page xmd.lib.php
xhtdoc: in file xht.lib.php, class xhtdoc
xhtdoc: in file xht.lib.php, method xhtdoc::xhtdoc()
xht_add_template: in file xht.lib.php, method xhtdoc::xht_add_template()
xht_explode_assoclist: in file xht.lib.php, function xht_explode_assoclist()
xht_fill_template: in file xht.lib.php, method xhtdoc::xht_fill_template()
xht_htmlwchars: in file xht.lib.php, function xht_htmlwchars()
This is an XML HTML template library.
xht_is_assoclist: in file xht.lib.php, function xht_is_assoclist()
xht_substitute: in file xht.lib.php, method xhtdoc::xht_substitute()
xmddoc: in file xmd.lib.php, method xmddoc::xmddoc()
xmddoc: in file xmd.lib.php, class xmddoc
This is the XML Dom library for Dokeos.
xmd_add_element: in file xmd.lib.php, method xmddoc::xmd_add_element()
xmd_add_text: in file xmd.lib.php, method xmddoc::xmd_add_text()
xmd_add_text_element: in file xmd.lib.php, method xmddoc::xmd_add_text_element()
xmd_cache: in file xmd.lib.php, method xmddoc::xmd_cache()
xmd_copy_foreign_child: in file xmd.lib.php, method xmddoc::xmd_copy_foreign_child()
xmd_get_element: in file xmd.lib.php, method xmddoc::xmd_get_element()
xmd_get_ns_uri: in file xmd.lib.php, method xmddoc::xmd_get_ns_uri()
xmd_html_value: in file xmd.lib.php, method xmddoc::xmd_html_value()
xmd_remove_element: in file xmd.lib.php, method xmddoc::xmd_remove_element()
xmd_remove_nodes: in file xmd.lib.php, method xmddoc::xmd_remove_nodes()
xmd_select_elements: in file xmd.lib.php, method xmddoc::xmd_select_elements()
xmd_select_elements_where: in file xmd.lib.php, method xmddoc::xmd_select_elements_where()
xmd_select_elements_where_notempty: in file xmd.lib.php, method xmddoc::xmd_select_elements_where_notempty()
xmd_select_single_element: in file xmd.lib.php, method xmddoc::xmd_select_single_element()
xmd_set_attribute: in file xmd.lib.php, method xmddoc::xmd_set_attribute()
xmd_text: in file xmd.lib.php, method xmddoc::xmd_text()
xmd_update: in file xmd.lib.php, method xmddoc::xmd_update()
xmd_update_many: in file xmd.lib.php, method xmddoc::xmd_update_many()
xmd_value: in file xmd.lib.php, method xmddoc::xmd_value()
xmd_xml: in file xmd.lib.php, method xmddoc::xmd_xml()

top

Documentation generated on Thu, 12 Jun 2008 12:53:00 -0500 by phpDocumentor 1.4.1