lib.php

<?php  // $Id: lib.php,v 1.7.2.5 2009/04/22 21:30:57 skodak Exp $

/**
 * Library of functions and constants for module teambuilder
 * This file should have two well differenced parts:
 *   - All the core Moodle functions, neeeded to allow
 *     the module to work integrated in Moodle.
 *   - All the teambuilder specific functions, needed
 *     to implement all the module logic. Please, note
 *     that, if the module become complex and this lib
 *     grows a lot, it's HIGHLY recommended to move all
 *     these module specific functions to a new php file,
 *     called "locallib.php" (see forum, quiz...). This will
 *     help to save some memory when Moodle is performing
 *     actions across all modules.
 */

/// (replace teambuilder with the name of your module and delete this line)

$teambuilder_EXAMPLE_CONSTANT = 42;     /// for example


/**
 * Given an object containing all the necessary data,
 * (defined by the form in mod_form.php) this function
 * will create a new instance and return the id number
 * of the new instance.
 *
 * @param object $teambuilder An object from the form in mod_form.php
 * @return int The id of the newly inserted teambuilder record
 */
function teambuilder_add_instance($teambuilder) {

    # You may have to add extra stuff in here #
    return insert_record('teambuilder', $teambuilder);
}


/**
 * 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.
 *
 * @param object $teambuilder An object from the form in mod_form.php
 * @return boolean Success/Fail
 */
function teambuilder_update_instance($teambuilder) {

    $teambuilder->timemodified = time();
    $teambuilder->id = $teambuilder->instance;
    # You may have to add extra stuff in here #
	
	if($teambuilder->opendt)
		$teambuilder->open = $teambuilder->opendt;
	
    return update_record('teambuilder', $teambuilder);
}


/**
 * Given an ID of an instance of this module,
 * this function will permanently delete the instance
 * and any data that depends on it.
 *
 * @param int $id Id of the module instance
 * @return boolean Success/Failure
 */
function teambuilder_delete_instance($id) {

    if (! $teambuilder = get_record('teambuilder', 'id', $id)) {
        return false;
    }

    $result = true;

    # Delete any dependent records here #

    if (! delete_records('teambuilder', 'id', $teambuilder->id)) {
        $result = false;
    }

    return $result;
}


/**
 * 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.
 * $return->time = the time they did it
 * $return->info = a short text description
 *
 * @return null
 * @todo Finish documenting this function
 */
function teambuilder_user_outline($course, $user, $mod, $teambuilder) {
    return $return;
}


/**
 * Print a detailed representation of what a user has done with
 * a given particular instance of this module, for user activity reports.
 *
 * @return boolean
 * @todo Finish documenting this function
 */
function teambuilder_user_complete($course, $user, $mod, $teambuilder) {
    return true;
}


/**
 * Given a course and a time, this module should find recent activity
 * that has occurred in teambuilder activities and print it out.
 * Return true if there was output, or false is there was none.
 *
 * @return boolean
 * @todo Finish documenting this function
 */
function teambuilder_print_recent_activity($course, $isteacher, $timestart) {
    return false;  //  True if anything was printed, otherwise false
}


/**
 * 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 ...
 *
 * @return boolean
 * @todo Finish documenting this function
 **/
function teambuilder_cron () {
    return true;
}


/**
 * Must return an array of user records (all data) who are participants
 * for a given instance of teambuilder. Must include every user involved
 * in the instance, independient of his role (student, teacher, admin...)
 * See other modules as example.
 *
 * @param int $teambuilderid ID of an instance of this module
 * @return mixed boolean/array of students
 */
function teambuilder_get_participants($teambuilderid) {
    return false;
}


/**
 * This function returns if a scale is being used by one teambuilder
 * if it has support for grading and scales. Commented code should be
 * modified if necessary. See forum, glossary or journal modules
 * as reference.
 *
 * @param int $teambuilderid ID of an instance of this module
 * @return mixed
 * @todo Finish documenting this function
 */
function teambuilder_scale_used($teambuilderid, $scaleid) {
    $return = false;

    //$rec = get_record("teambuilder","id","$teambuilderid","scale","-$scaleid");
    //
    //if (!empty($rec) && !empty($scaleid)) {
    //    $return = true;
    //}

    return $return;
}


/**
 * Checks if scale is being used by any instance of teambuilder.
 * This function was added in 1.9
 *
 * This is used to find out if scale used anywhere
 * @param $scaleid int
 * @return boolean True if the scale is used by any teambuilder
 */
function teambuilder_scale_used_anywhere($scaleid) {
    if ($scaleid and record_exists('teambuilder', 'grade', -$scaleid)) {
        return true;
    } else {
        return false;
    }
}


/**
 * Execute post-install custom actions for the module
 * This function was added in 1.9
 *
 * @return boolean true if success, false on error
 */
function teambuilder_install() {
    return true;
}


/**
 * Execute post-uninstall custom actions for the module
 * This function was added in 1.9
 *
 * @return boolean true if success, false on error
 */
function teambuilder_uninstall() {
    return true;
}


//////////////////////////////////////////////////////////////////////////////////////
/// Any other teambuilder functions go here.  Each of them must have a name that
/// starts with teambuilder_
/// Remember (see note in first lines) that, if this section grows, it's HIGHLY
/// recommended to move all funcions below to a new "localib.php" file.


function teambuilder_get_questions($id,$userid = null) {
	$questions = get_records("teambuilder_question","builder",$id,"ordinal ASC");
	
	foreach($questions as &$q)
	{
		$q->answers = get_records("teambuilder_answer","question",$q->id,"ordinal ASC");
		if($userid)
		{
			foreach($q->answers as &$a)
			{
				if(get_record("teambuilder_response","userid",$userid,"answerid",$a->id))
					$a->selected = true;
				else
					$a->selected = false;
			}
		}
	}
	
	return $questions;
}

/**
 * Get responses for a particular team builder questionnaire.
 *
 * @param int $id Team Builder id
 * @return An array of student ids => array of answers they selected
 * @author Morgan Harris
 */
function teambuilder_get_responses($id, $student = null) {

	global $CFG;
	$teambuilder = get_record("teambuilder","id",$id);
	if($student == null)
	{
		if($teambuilder->group)
		{
			$students = groups_get_members($teambuilder->group,"u.id");
		}
		else
		{
			$ctxt = get_context_instance(CONTEXT_COURSE,$teambuilder->course);
			$students = get_users_by_capability($ctxt, 'mod/teambuilder:respond');
		}
		$responses = array();
		foreach($students as $s)
		{
			$responses[$s->id] = teambuilder_get_responses($id,$s->id);
		}
		return $responses;
	}
	$rslt = get_records_sql("select answerid from {$CFG->prefix}teambuilder_response where userid = $student and answerid in (select id from {$CFG->prefix}teambuilder_answer where question in (select id from {$CFG->prefix}teambuilder_question where builder = $id))");
	$ret = false;
	if($rslt!==false)
		$ret = array_keys($rslt);
	return $ret;
}

?>