lib.php File Reference

Functions
object	glossary_add_instance ($glossary)
	STANDARD FUNCTIONS ///////////////////////////////////////////////////////////.
	glossary_can_view_entry ($entry, $cminfo)
	Checks if the current user can see the glossary entry.
	glossary_check_updates_since (cm_info $cm, $from, $filter=array())
	Check if the module has any update that affects the current user since a given time.
	glossary_comment_permissions ($comment_param)
	Running addtional permission check on plugin, for example, plugins may have switch to turn on/off comments option, this callback will affect UI display, not like pluginname_comment_validate only throw exceptions.
	glossary_comment_validate ($comment_param)
	Validate comment parameter before perform other comments actions.
	glossary_concept_exists ($glossary, $concept)
	Check if a concept exists in a glossary.
moodle_database	glossary_count_unrated_entries ($glossaryid, $userid)
	How many unrated entries are in the given glossary for a given user?
	glossary_cron ()
	Function to be run periodically according to the moodle cron This function searches for things that need to be done, such as sending out mail, toggling flags etc ...
	glossary_debug ($debug, $text, $br=1)
object	glossary_delete_instance ($id)
	Given an ID of an instance of this module, this function will permanently delete the instance and any data that depends on it.
	glossary_edit_entry ($entry, $course, $cm, $glossary, $context)
	Creates or updates a glossary entry.
	glossary_end_tag ($tag, $level=0, $endline=true)
	Return the xml end tag.
	glossary_entry_view ($entry, $context)
	Notify that a glossary entry was viewed.
	glossary_extend_navigation ($navigation, $course, $module, $cm)
	glossary_extend_settings_navigation (settings_navigation $settings, navigation_node $glossarynode)
	Adds module specific settings to the settings block.
object	glossary_full_tag ($tag, $level, $endline, $content)
	Return the start tag, the contents and the end tag.
object	glossary_generate_export_csv ($entries, $aliases, $categories)
	glossary_generate_export_file ($glossary, $ignored="", $hook=0)
	glossary_get_all_tabs ()
	Return list of all glossary tabs.
	glossary_get_authors ($glossary, $context, $limit, $from, $options=array())
	Returns the authors in a glossary.
object	glossary_get_available_formats ()
	Any other glossary functions go here.
	glossary_get_categories ($glossary, $from, $limit)
	Returns the categories of a glossary.
	glossary_get_coursemodule_info ($coursemodule)
	Add a get_coursemodule_info function in case any glossary type wants to add 'extra' information for the course (see resource).
	glossary_get_editor_and_attachment_options ($course, $context, $entry)
	Return the editor and attachment options when editing a glossary entry.
object	glossary_get_entries ($glossaryid, $entrylist, $pivot="")
	glossary_get_entries_by_author ($glossary, $context, $letter, $field, $sort, $from, $limit, $options=array())
	Returns the entries of a glossary by author.
	glossary_get_entries_by_author_id ($glossary, $context, $authorid, $order, $sort, $from, $limit, $options=array())
	Returns the entries of a glossary by category.
	glossary_get_entries_by_category ($glossary, $context, $categoryid, $from, $limit, $options=array())
	Returns the entries of a glossary by category.
	glossary_get_entries_by_date ($glossary, $context, $order, $sort, $from, $limit, $options=array())
	Returns the entries of a glossary by date.
	glossary_get_entries_by_letter ($glossary, $context, $letter, $from, $limit, $options=array())
	Returns the entries of a glossary by letter.
	glossary_get_entries_by_search ($glossary, $context, $query, $fullsearch, $order, $sort, $from, $limit, $options=array())
	Returns the entries of a glossary by search.
	glossary_get_entries_by_term ($glossary, $context, $term, $from, $limit, $options=array())
	Returns the entries of a glossary by term.
object	glossary_get_entries_search ($concept, $courseid)
	@global object
	glossary_get_entries_to_approve ($glossary, $context, $letter, $order, $sort, $from, $limit)
	Returns the entries to be approved.
	glossary_get_entry_by_id ($id)
	Fetch an entry.
	glossary_get_extra_capabilities ()
	Returns all other caps used in module.
	glossary_get_file_areas ($course, $cm, $context)
	Lists all browsable file areas.
	glossary_get_file_info ($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename)
	File browsing support for glossary module.
	glossary_get_paging_bar ($totalcount, $page, $perpage, $baseurl, $maxpageallowed=99999, $maxdisplay=20, $separator=" ", $specialtext="", $specialvalue=-1, $previousandnext=true)
	Returns the html code to represent any pagging bar.
	glossary_get_post_actions ()
	List the actions that correspond to a post of this module.
	glossary_get_recent_mod_activity (&$activities, &$index, $timestart, $courseid, $cmid, $userid=0, $groupid=0)
	Returns all glossary entries since a given time for specified glossary.
	glossary_get_search_terms_sql (array $terms, $fullsearch=true, $glossaryid=null)
	Get the SQL where clause for searching terms.
object	glossary_get_user_entries ($glossaryid, $userid)
	glossary_get_user_grades ($glossary, $userid=0)
	Return grade for given user or all users.
	glossary_get_view_actions ()
	List the actions that correspond to a view of this module.
	glossary_get_visible_tabs ($displayformat)
	Convert 'showtabs' string to array.
	glossary_grade_item_delete ($glossary)
	Delete grade item for given glossary.
	glossary_grade_item_update ($glossary, $grades=NULL)
	Create/update grade item for given glossary.
object	glossary_log_info ($log)
	glossary_page_type_list ($pagetype, $parentcontext, $currentcontext)
	Return a list of page types.
	glossary_pluginfile ($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array())
	Serves the glossary attachments.
object	glossary_print_all_links ($cm, $glossary, $mode, $hook)
object	glossary_print_alphabet_links ($cm, $glossary, $mode, $hook, $sortkey, $sortorder)
	glossary_print_alphabet_menu ($cm, $glossary, $mode, $hook, $sortkey='', $sortorder='')
	glossary_print_approval_menu ($cm, $glossary, $mode, $hook, $sortkey='', $sortorder='')
object	glossary_print_attachments ($entry, $cm, $type=NULL, $unused=null)
	if return=html, then return a html string.
	glossary_print_author_menu ($cm, $glossary, $mode, $hook, $sortkey='', $sortorder='')
object	glossary_print_categories_menu ($cm, $glossary, $hook, $category)
	@global object
object	glossary_print_dynaentry ($courseid, $entries, $displayformat=-1)
	@global object @global object
object	glossary_print_entry ($course, $cm, $glossary, $entry, $mode='', $hook='', $printicons=1, $displayformat=-1, $printview=false)
	@global object
object	glossary_print_entry_aliases ($course, $cm, $glossary, $entry, $mode='', $hook='', $type='print')
object	glossary_print_entry_approval ($cm, $entry, $mode, $align="right", $insidetable=true)
	glossary_print_entry_attachment ($entry, $cm, $format=null, $unused1=null, $unused2=null)
	Print the list of attachments for this glossary entry.
	glossary_print_entry_concept ($entry, $return=false)
	Print glossary concept/term as a heading <h4>
	glossary_print_entry_default ($entry, $glossary, $cm)
	Default (old) print format used if custom function doesn't exist in format.
moodle_database	glossary_print_entry_definition ($entry, $glossary, $cm)
	DB.
object	glossary_print_entry_icons ($course, $cm, $glossary, $entry, $mode='', $hook='', $type='print')
	@global object @global object
	glossary_print_entry_lower_section ($course, $cm, $glossary, $entry, $mode, $hook, $printicons, $aliases=true, $printseparator=true)
object	glossary_print_entry_ratings ($course, $entry)
	@global object @global object
	glossary_print_export_menu ($cm, $glossary, $mode, $hook, $sortkey='', $sortorder='')
	glossary_print_import_menu ($cm, $glossary, $mode, $hook, $sortkey='', $sortorder='')
object	glossary_print_recent_activity ($course, $viewfullnames, $timestart)
	Given a course and a time, this module should find recent activity that has occurred in glossary activities and print it out.
	glossary_print_recent_mod_activity ($activity, $courseid, $detail, $modnames, $viewfullnames)
	Outputs the glossary entry indicated by $activity.
object	glossary_print_sorting_links ($cm, $mode, $sortkey='', $sortorder='')
object	glossary_print_special_links ($cm, $glossary, $mode, $hook)
	glossary_print_tabbed_table_end ()
	glossary_rating_permissions ($contextid, $component, $ratingarea)
	Return rating related permissions.
	glossary_rating_validate ($params)
	Validates a submitted rating.
object	glossary_read_imported_file ($file_content)
	Functions designed by Eloy Lafuente Functions to create, open and write header of the xml file.
	glossary_reset_course_form_defaults ($course)
	Course reset form defaults.
	glossary_reset_course_form_definition (&$mform)
	Implementation of the function for printing the form elements that control whether the course reset functionality affects the glossary.
	glossary_reset_gradebook ($courseid, $type='')
	Removes all grades from gradebook.
object	glossary_reset_userdata ($data)
	Actual implementation of the reset course functionality, delete all the glossary responses for course $data->courseid.
	glossary_scale_used ()
object	glossary_scale_used_anywhere ($scaleid)
	Checks if scale is being used by any instance of glossary.
object	glossary_search ($course, $searchterms, $extended=0, $glossary=NULL)
	It returns all entries from all glossaries that matches the specified criteria within a given $course.
object	glossary_search_entries ($searchterms, $glossary, $extended)
	glossary_set_default_visible_tabs ($glossaryformat)
	Set 'showtabs' value for glossary formats.
	glossary_sort_entries ( $entry0, $entry1)
	glossary_start_tag ($tag, $level=0, $endline=false)
	Return the xml start tag.
	glossary_supports ($feature)
	glossary_update_grades ($glossary=null, $userid=0, $nullifnone=true)
	Update activity grades.
object	glossary_update_instance ($glossary)
	Given an object containing all the necessary data, (defined by the form in mod_form.php) this function will update an existing instance with new data.
object	glossary_user_complete ($course, $user, $mod, $glossary)
	Print a detailed representation of what a user has done with a given particular instance of this module, for user activity reports.
	glossary_user_outline ($course, $user, $mod, $glossary)
	Return a small object with summary information about what a user has done with a given particular instance of this module Used for user activity reports.
	glossary_view ($glossary, $course, $cm, $context, $mode)
	Notify that the glossary was viewed.
	glossary_xml_export_files ($tag, $taglevel, $contextid, $filearea, $itemid)
	Prepares file area to export as part of XML export.
	glossary_xml_import_files ($xmlparent, $tag, $contextid, $filearea, $itemid)
	Parses files from XML import and inserts them into file system.
	mod_glossary_can_delete_entry ($entry, $glossary, $context, $return=true)
	Checks if the current user can delete the given glossary entry.
	mod_glossary_can_update_entry (stdClass $entry, stdClass $glossary, stdClass $context, object $cm, bool $return=true)
	Checks if the current user can update the given glossary entry.
	mod_glossary_core_calendar_provide_event_action (calendar_event $event, core_calendar\action_factory $factory, int $userid=0)
	This function receives a calendar event and returns the action associated with it, or null if there is none.
	mod_glossary_delete_entry ($entry, $glossary, $cm, $context, $course, $hook='', $prevmode='')
	Deletes the given entry, this function does not perform capabilities/permission checks.
	mod_glossary_get_completion_active_rule_descriptions ($cm)
	Callback which returns human-readable strings describing the active completion custom rules for the module instance.
	mod_glossary_get_fontawesome_icon_map ()
	Get icon mapping for font-awesome.
	mod_glossary_prepare_entry_for_edition (stdClass $entry)
	Prepares an entry for editing, adding aliases and category information.

Variables
const	GLOSSARY_ADDENTRY_VIEW 4
const	GLOSSARY_APPROVAL_VIEW 7
const	GLOSSARY_AUTHOR 'author'
const	GLOSSARY_AUTHOR_VIEW 3
const	GLOSSARY_CATEGORY 'category'
const	GLOSSARY_CATEGORY_VIEW 1
const	GLOSSARY_CONTINUOUS 'continuous'
const	GLOSSARY_DATE 'date'
const	GLOSSARY_DATE_VIEW 2
const	GLOSSARY_DICTIONARY 'dictionary'
const	GLOSSARY_EXPORT_VIEW 6
const	GLOSSARY_FULLWITHOUTAUTHOR 'fullwithoutauthor'
const	GLOSSARY_IMPORT_VIEW 5
const	GLOSSARY_NO_VIEW -1
const	GLOSSARY_SHOW_ALL_CATEGORIES 0
	Library of functions and constants for module glossary (replace glossary with the name of your module and delete this line)
const	GLOSSARY_SHOW_NOT_CATEGORISED -1
const	GLOSSARY_STANDARD 'standard'
const	GLOSSARY_STANDARD_VIEW 0