mod/label/lib.php

   1 <?php  // $Id$
   2
   3 /// Library of functions and constants for module label
   4
   5
   6 define("LABEL_MAX_NAME_LENGTH", 50);
   7
   8 function get_label_name($label) {
   9     $textlib = textlib_get_instance();
  10
  11     $name = addslashes(strip_tags(format_string(stripslashes($label->content),true)));
  12     if ($textlib->strlen($name) > LABEL_MAX_NAME_LENGTH) {
  13         $name = $textlib->substr($name, 0, LABEL_MAX_NAME_LENGTH)."...";
  14     }
  15
  16     if (empty($name)) {
  17         // arbitrary name
  18         $name = get_string('modulename','label');
  19     }
  20
  21     return $name;
  22 }
  23
  24 function label_add_instance($label) {
  25 /// Given an object containing all the necessary data,
  26 /// (defined by the form in mod.html) this function
  27 /// will create a new instance and return the id number
  28 /// of the new instance.
  29
  30     $label->name = get_label_name($label);
  31     $label->timemodified = time();
  32
  33     return insert_record("label", $label);
  34 }
  35
  36
  37 function label_update_instance($label) {
  38 /// Given an object containing all the necessary data,
  39 /// (defined by the form in mod.html) this function
  40 /// will update an existing instance with new data.
  41
  42     $label->name = get_label_name($label);
  43     $label->timemodified = time();
  44     $label->id = $label->instance;
  45
  46     return update_record("label", $label);
  47 }
  48
  49
  50 function label_delete_instance($id) {
  51 /// Given an ID of an instance of this module,
  52 /// this function will permanently delete the instance
  53 /// and any data that depends on it.
  54
  55     if (! $label = get_record("label", "id", "$id")) {
  56         return false;
  57     }
  58
  59     $result = true;
  60
  61     if (! delete_records("label", "id", "$label->id")) {
  62         $result = false;
  63     }
  64
  65     return $result;
  66 }
  67
  68 function label_get_participants($labelid) {
  69 //Returns the users with data in one resource
  70 //(NONE, but must exist on EVERY mod !!)
  71
  72     return false;
  73 }
  74
  75 /**
  76  * Given a course_module object, this function returns any
  77  * "extra" information that may be needed when printing
  78  * this activity in a course listing.
  79  * See get_array_of_activities() in course/lib.php
  80  */
  81 function label_get_coursemodule_info($coursemodule) {
  82     if ($label = get_record('label', 'id', $coursemodule->instance, '', '', '', '', 'id, content, name')) {
  83         if (empty($label->name)) {
  84             // label name missing, fix it
  85             $label->name = "label{$label->id}";
  86             set_field('label', 'name', $label->name, 'id', $label->id);
  87         }
  88         $info = new object();
  89         $info->extra = urlencode($label->content);
  90         $info->name = urlencode($label->name);
  91         return $info;
  92     } else {
  93         return null;
  94     }
  95 }
  96
  97 function label_get_view_actions() {
  98     return array();
  99 }
 100
 101 function label_get_post_actions() {
 102     return array();
 103 }
 104
 105 function label_get_types() {
 106     $types = array();
 107
 108     $type = new object();
 109     $type->modclass = MOD_CLASS_RESOURCE;
 110     $type->type = "label";
 111     $type->typestr = get_string('resourcetypelabel', 'resource');
 112     $types[] = $type;
 113
 114     return $types;
 115 }
 116
 117 /**
 118  * This function is used by the reset_course_userdata function in moodlelib.
 119  * @param $data the data submitted from the reset course.
 120  * @return array status array
 121  */
 122 function label_reset_userdata($data) {
 123     return array();
 124 }
 125
 126 /**
 127  * Returns all other caps used in module
 128  */
 129 function label_get_extra_capabilities() {
 130     return array('moodle/site:accessallgroups');
 131 }
 132
 133 ?>