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 moviemasher
 * 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 moviemasher 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.
 */


define('moviemasher_INCLUDE_TEST', 1);
//TABS
define('moviemasher_TAB1', 1);
    define('moviemasher_TABNAME_PAGEONE', 'firsttabname');
define('moviemasher_TAB2', 2);
    define('moviemasher_TABNAME_PAGETWO', 'secondtabname');
define('moviemasher_TAB3', 3);
   define('moviemasher_TABNAME_PAGETHREE', 'thirdtabname');

//PAGES
// pages of tab 1
// no pages foreseen for first tab

// pages of tab 2
define('moviemasher_TAB2_PAGE1', '1');
    define('moviemasher_TAB2_PAGE1NAME', 'tab2page1');
define('moviemasher_TAB2_PAGE2', '2');
    define('moviemasher_TAB2_PAGE2NAME', 'tab2page2');
define('moviemasher_TAB2_PAGE3', '3');
    define('moviemasher_TAB2_PAGE3NAME', 'tab2page3');
define('moviemasher_TAB2_PAGE4', '4');
    define('moviemasher_TAB2_PAGE4NAME', 'tab2page4');
define('moviemasher_TAB2_PAGE5', '5');
    define('moviemasher_TAB2_PAGE5NAME', 'tab2page5');

// pages of tab 3
define('moviemasher_TAB3_PAGE1', '1');
    define('moviemasher_TAB3_PAGE1NAME', 'tab3page1');
define('moviemasher_TAB3_PAGE2', '2');
    define('moviemasher_TAB3_PAGE2NAME', 'tab3page2');
require_once('locallib.php');

/**
 * 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 $moviemasher An object from the form in mod_form.php
 * @return int The id of the newly inserted moviemasher record
 */
function moviemasher_add_instance($moviemasher) {

    $moviemasher->timecreated = time();
    # You may have to add extra stuff in here #	
	$moviemasher->default_mash = "<mash id={ID}> </mash>";
   $aux =  insert_record('moviemasher', $moviemasher); 
   return $aux;
}


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

    $moviemasher->timemodified = time();
    $moviemasher->id = $moviemasher->instance;	
    # You may have to add extra stuff in here #
	global $db;
	$db->debug = true;
     return  update_record('moviemasher', $moviemasher);	
}


/**
 * 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 moviemasher_delete_instance($id) {

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

    $result = true;

    # Delete any dependent records here #

    if (! delete_records('moviemasher', 'id', $moviemasher->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 moviemasher_user_outline($course, $user, $mod, $moviemasher) {
    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 moviemasher_user_complete($course, $user, $mod, $moviemasher) {
    return true;
}


/**
 * Given a course and a time, this module should find recent activity
 * that has occurred in moviemasher 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 moviemasher_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 moviemasher_cron () {
    return true;
}


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


/**
 * This function returns if a scale is being used by one moviemasher
 * 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 $moviemasherid ID of an instance of this module
 * @return mixed
 * @todo Finish documenting this function
 */
function moviemasher_scale_used($moviemasherid, $scaleid) {
    $return = false;

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

    return $return;
}


/**
 * Checks if scale is being used by any instance of moviemasher.
 * 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 moviemasher
 */
function moviemasher_scale_used_anywhere($scaleid) {
    if ($scaleid and record_exists('moviemasher', '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 moviemasher_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 moviemasher_uninstall() {
    return true;
}


//////////////////////////////////////////////////////////////////////////////////////
/// Any other moviemasher functions go here.  Each of them must have a name that
/// starts with moviemasher_
/// 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.


?>