SLOODLE_TYPE_PRESENTER )
// Null if there isn't one
var $module_filters = array();
// The group of objects to which this one should belong.
// Used in displaying objects in groups in the set.
var $group;
// Which collections of
// Was previously controlled by a variable called show
// ...and prior to that by a file called "noshow".
var $collections;
// An array of groupings containing an array of SloodleInputWidget objects
// One used for each configuration control.
// The keys of this array should correspond to a translation which appends 'fieldset:'
// eg. if you define a field_set called 'access', there should be a Sloodle translation key to display it called 'fieldset:access'.
var $field_sets = array();
// The value of the config as currently set.
// Needs to be filled from somewhere, eg. an object_config or layout_entry_config record
// For a newly created config, this will be null.
var $value = null;
// If you want a bunch of successive options to be shown together on the same row
// ...you can set the same row_code for each one.
// The default of '' will make the object get its own row.
var $row_code = '';
var $row_name= '';
// static function returning an object configuration for an object with the given name, or none if none is found
function ForObjectName($objname, $createDummy = true) {
$allconfigs = SloodleObjectConfig::AllAvailableAsArray();
if (isset($allconfigs[$objname])) {
return $allconfigs[$objname];
}
if (!$createDummy) {
return null;
}
// SLOODLE object, but we don't have a definition for it.
if (preg_match('/^SLOODLE/', $objname)) {
return null;
}
// Assume it's an object we don't know about, and provide a blank config allowing us to rez and derez.
return SloodleObjectConfig::ForNonSloodleObjectWithName($objname);
//return null;
}
// Return a SloodleObjectDefinition object for the given mod directory
// The optional objcode not used yet as of 2011-07-01
// In future it will allow the same linker to be shared by multiple objects
// ...but the objects will have to know how to report their own codes.
function ForObjectType($type) {
$modname = null;
$objcode = null;
// Sloodle 2 object types look like modname/objectcode
// eg quiz-1.0/default
if (preg_match('/^(.*?)\/(.*?)$/', $type, $matches) ) {
$modname = $matches[1];
$objcode = $matches[2];
// Legacy types are just the name of the module, so we'll use the default definition.
} else {
$modname = $type;
$objcode = 'default';
}
if ( !preg_match('/^[a-zA-Z0-9_-]+$/',$objcode) ) {
return false;
}
if ( !preg_match('/^[a-zA-Z0-9_-]+\d+\.\d+$/',$modname) ) {
return false;
}
$definition_file = SLOODLE_DIRROOT.'/mod/'.$modname.'/objects/'.$objcode.'/definition.php';
if (!file_exists($definition_file)) {
return null;
}
include($definition_file); // Will define a variable called $sloodleconfig
$sloodleconfig->object_code= $objcode;
$sloodleconfig->modname = $modname;
return $sloodleconfig;
}
function type() {
return $this->modname.'/'.$this->object_code;
}
// For anchors and things, we need a unique identifier to use internally, but with no slash in it.
function type_for_link() {
$t = preg_replace('/\//', '--', $this->type());
return preg_replace('/\./', '--', $t);
}
/*
Load an associative array of object definitions called object_configs, with the prim name as the key
...and a SloodleObjectConfig object as the value.
There should be a directory called object_definitions in each mod/ directory, containing .php files with the definitions..
Each definition will define an object called $sloodleconfig.
An object_definitions directory may contain multiple object definitions.
Previously, we dealt with multiple object definitions by creating a mod/ directory for each object.
Let's deprecate that approach and have each directory under mod/ represent a set of linker functionality.
As of 2011-06-26, the old folders are still there, eg. there is a mod/quiz-1.0 and a mod/quiz_pile_on-1.0.
This doesn't make much sense, as quiz_pile_on scripts end up calling linkers under quiz-1.0 anyhow.
But we'll leave them for backwards compatibility until we can kill of the old HTML configuration forms.
*/
function AllAvailableAsArray($key = 'primname') {
$currentdir = dirname(__FILE__);
$modtopdir = SLOODLE_DIRROOT.'/mod/';
$object_configs = array();
if (!is_dir($modtopdir)) {
return false;
}
if (!$dh = opendir($modtopdir)) {
return false;
}
while (($moddir = readdir($dh)) !== false) {
if ($moddir == '.') {
continue;
}
if ($moddir == '..') {
continue;
}
$object_dir = $modtopdir.'/'.$moddir.'/objects';
if ( !file_exists( $object_dir ) || !is_dir($object_dir) ) {
continue;
}
if (!$dh2 = opendir($object_dir)) {
continue;
}
while (($object_code = readdir($dh2)) !== false) {
if ($object_code == '.') {
continue;
}
if ($object_code == '..') {
continue;
}
$object_type = "$moddir/$object_code";
if ($sloodleconfig = SloodleObjectConfig::ForObjectType($object_type)) {
$object_configs[$sloodleconfig->$key] = $sloodleconfig;
}
}
closedir($dh2);
}
closedir($dh);
return $object_configs;
//usort( $object_configs, array('SloodleObjectConfig', 'object_config_cmp') );
}
function object_config_cmp($a, $b) {
return $a->primname > $b->primname;
}
/*
Static function returning a list of names of objects that want to be notified about something happening on the server.
You can say your object wants to be notified about something happening by putting the name of that something in the notify array in the object definition.
@param string $notification_action The thing you want to be notified about.
*/
function TypesOfObjectsRequiringNotification($notification_action) {
$defs = SloodleObjectConfig::AllAvailableAsArray();
$types = array();
foreach($defs as $def) {
if ( !isset($def->notify) || !is_array($def->notify) || count($def->notify) == 0 ) {
continue;
}
if ( !in_array( $notification_action, $def->notify) ) {
continue;
}
$types[] = $def->type();
}
return $types;
}
function AllAvailableAsArrayByGroup() {
$objectconfigsbygroup = array();
$allconfigs = SloodleObjectConfig::AllAvailableAsArray();
ksort($allconfigs);
foreach($allconfigs as $objname => $objconfig) {
$group = $objconfig->group;
if (!isset($objectconfigsbygroup[$group])) {
$objectconfigsbygroup[$group] = array();
}
$objectconfigsbygroup[$group][$objname] = $objconfig;
}
return $objectconfigsbygroup;
}
/**
* Extracts the object name and version number from an object identifier.
* @param string $objid An object identifier, such as "chat-1.0"
* @return array A numeric array of name then version number.
*/
function ParseModIdentifier($modname)
{
// Find the last dash character, and split the string around it.
$lastpos = strrpos($modname, '-');
// Check for common problems
if ($lastpos === false) return array($modname, ''); // No dash
if ($lastpos == 0) return array('', substr($modname, 1)); // Dash at start
if ($lastpos == (strlen($modname) - 1)) return array(substr($modname, 0, -1), ''); // Dash at end
// Split up the values
$name = substr($modname, 0, $lastpos);
$version = substr($modname, $lastpos + 1, strlen($modname) - $lastpos - 1);
return array($name, $version);
}
/*
Whether an object should be shown or not.
Controlled by whether it declares that it's a collection of objects that we support.
The collections we support are currently defined in the sloodle config
...although in future we'll probably improve on that to handle multiple different kinds of rezzer.
*/
function do_show() {
$supported_collections = unserialize(SLOODLE_SUPPORTED_OBJECT_COLLECTIONS);
// If you don't specify a collection, never show the object.
if ( !isset( $this->collections ) || !is_array( $this->collections ) ) {
return false;
}
return ( count( array_intersect( $supported_collections, $this->collections ) ) > 0 );;
}
function AllAvailableAsNameVersionHash() {
$objs = array();
$all_available = SloodleObjectConfig::AllAvailableAsArray();
foreach ($all_available as $obj_def) {
if (empty($obj_def)) continue;
$modname = $obj_def->modname;
// Parse the object identifier
list($name, $version) = SloodleObjectConfig::ParseModIdentifier($modname);
if (empty($name) || empty($version)) continue;
if (!isset($objs[$name])) {
$objs[$name] = array();
}
$objs[$name][$version] = $obj_def;
}
// Sort the array by name of the object
ksort($objs);
return $objs;
}
// This creates a config element for a non-sloodle object, allowing us to rez and derez it.
// It is still assumed that it will have a sloodle_rezzer object script in it.
function ForNonSloodleObjectWithName( $name ) {
// We need a url-safe version of the name
// J-query seems to choke on something, even if it's url-encoded.
$encoded_name = preg_replace("/[^a-zA-Z0-9]/", "", $name);
$encoded_name .= '_'.md5($name); // Append an md5sum of the original name to avoid collisions in case someone has "My Object" and "MyObject".
$sloodleconfig = new SloodleObjectConfig();
$sloodleconfig->name = $encoded_name;
$sloodleconfig->primname = $name;
$sloodleconfig->object_code= $encoded_name;
$sloodleconfig->modname = null;
$sloodleconfig->group = 'misc';
$sloodleconfig->collections= array('SLOODLE 2.0');
$sloodleconfig->aliases = array();
$sloodleconfig->field_sets = array();
return $sloodleconfig;
}
function possibleObjectNames() {
$names = array($this->primname);
if ( is_array($this->aliases) ) {
foreach($this->aliases as $al) {
array_push( $names, $al );
}
}
return $names;
}
// return an input widget for server access level
function access_level_server_option() {
$ctrl = new SloodleConfigurationOptionSelectOne();
$ctrl->fieldname = 'sloodleserveraccesslevel';
$ctrl->title = 'accesslevelserver';
$ctrl->description = '';
$ctrl->options = array(
SLOODLE_SERVER_ACCESS_LEVEL_PUBLIC => 'accesslevel:public',
SLOODLE_SERVER_ACCESS_LEVEL_COURSE => 'accesslevel:course',
SLOODLE_SERVER_ACCESS_LEVEL_SITE => 'accesslevel:site',
SLOODLE_SERVER_ACCESS_LEVEL_STAFF => 'accesslevel:staff'
);
$ctrl->default = SLOODLE_SERVER_ACCESS_LEVEL_PUBLIC;
$ctrl->type = 'radio'; // This is the recommended display type for the object.
return $ctrl;
}
// return an input widget for object use
function access_level_object_use_option() {
$ctrl = new SloodleConfigurationOptionSelectOne();
$ctrl->fieldname = 'sloodleobjectaccessleveluse';
$ctrl->title = 'accesslevelobject:use';
$ctrl->description = '';
$ctrl->options = array(
SLOODLE_OBJECT_ACCESS_LEVEL_PUBLIC => 'accesslevel:public',
SLOODLE_OBJECT_ACCESS_LEVEL_GROUP => 'accesslevel:group',
SLOODLE_OBJECT_ACCESS_LEVEL_OWNER => 'accesslevel:owner'
);
$ctrl->default = SLOODLE_OBJECT_ACCESS_LEVEL_PUBLIC;
$ctrl->type = 'radio'; // This is the recommended display type for the object.
return $ctrl;
}
// return an input widget for object control
function access_level_object_control_option() {
$ctrl = new SloodleConfigurationOptionSelectOne();
$ctrl->fieldname = 'sloodleobjectaccesslevelctrl';
$ctrl->title = 'accesslevelobject:control';
$ctrl->description = '';
$ctrl->options = array(
SLOODLE_OBJECT_ACCESS_LEVEL_PUBLIC => 'accesslevel:public',
SLOODLE_OBJECT_ACCESS_LEVEL_GROUP => 'accesslevel:group',
SLOODLE_OBJECT_ACCESS_LEVEL_OWNER => 'accesslevel:owner'
);
$ctrl->default = SLOODLE_OBJECT_ACCESS_LEVEL_OWNER;
$ctrl->type = 'radio'; // This is the recommended display type for the object.
return $ctrl;
}
function course_module_select( $courseid, $val = null ) {
if (!$options = $this->course_module_options( $courseid )) {
return false;
}
$str = '
';
/*
foreach($options as $n => $v) {
$selectedattr = ($val == $n) ? ' checked="checked"' : '';
$str .= ''.htmlentities( $v ).''." \n";
}
*/
return $str;
}
/*
function course_module_select( $courseid, $val = null ) {
if (!$options = $this->course_module_options( $courseid )) {
return false;
}
$str = '';
return $str;
}
*/
function course_module_options( $courseid ) {
$options = array();
$modtype = $this->module;
if (!$modtype) {
return false;
}
// Determine which course is being accessed
//$courseid = $auth_obj->course->get_course_id();
// We need to fetch a list of visible quizzes on the course
// Get the ID of the chat type
$rec = sloodle_get_record('modules', 'name', $modtype);
if (!$rec) {
return false;
}
$moduleid = $rec->id;
// Get all visible quizzes in the current course
$recs = sloodle_get_records_select_params('course_modules', "course = ? AND module = ? AND visible = 1", array(intval($courseid), intval($moduleid)));
if (!$recs) {
return false;
//error(get_string('noquizzes','sloodle'));
}
foreach ($recs as $cm) {
// Fetch the quiz instance
$inst = sloodle_get_record($modtype, 'id', $cm->instance);
if (!$inst) {
continue;
}
$skip = false;
if (is_array($this->module_filters)) {
foreach($this->module_filters as $n => $v) {
if ($inst->$n != $v) {
$skip = true;
break;
}
}
}
if ($skip) {
continue;
}
// Store the quiz details
$options[$cm->id] = $inst->name;
}
// Sort the list by name
natcasesort($options);
return $options;
}
/*
Return an array of configuration options related to giving someone points for interacting with the object.
By default, this produces a single configuration option for interacting with the object.
If your object specifies multiple kinds of interaction, you can pass them in as an array.
By default, this will replace the default interaction, so if you want that too, put it in your array.
The result will be something like (with the default interaction):
Using the object gives you [ ] of the currency [ ]
Using the object costs you [ ] of the currency [ ]
...or with customized interactions:
Getting an answer right gives you [ ] of the currency [ ]
Getting an answer right costs you [ ] of the currency [ ]
Getting an answer wrong gives you [ ] of the currency [ ]
Getting an answer wrong costs you [ ] of the currency [ ]
*/
function awards_deposit_options( $interactions_to_labels ) {
$configs = array();
foreach($interactions_to_labels as $interactionname => $interactionlabel) {
$deposit_points_fieldname = 'sloodleawardsdeposit_numpoints_'.$interactionname;
$deposit_currency_fieldname = 'sloodleawardsdeposit_currency_'.$interactionname;
$deposit_row_name = 'sloodleawardsdeposit_row_'.$interactionname;
$configs[ $deposit_points_fieldname ] = new SloodleConfigurationOptionText( $deposit_points_fieldname, $interactionlabel, 'emptystring', 0, 8);
$configs[ $deposit_points_fieldname ]->row_name = $deposit_row_name;
$configs[ $deposit_currency_fieldname ] = new SloodleConfigurationOptionCurrencyChoice( $deposit_currency_fieldname, 'emptystring', '', '', 8);
$configs[ $deposit_currency_fieldname]->row_name = $deposit_row_name;
$configs[ $deposit_currency_fieldname ]->is_value_translatable = false;
}
return $configs;
}
function awards_require_options( $interactions_to_labels = null ) {
if ($interactions_to_labels == null) {
//$interactions = array('default' => array('awards:interactwithobjectrequires', 'awards:interactwithobjectminus', 'awards:notenoughmessage') );
//$interactions_to_labels = array('default' => array('awards:interactwithobjectrequires') );
$interactions_to_labels = array('default' => 'awards:interactwithobjectrequires' );
}
$configs = array();
foreach($interactions_to_labels as $interactionname => $interactionlabel) {
$require_points_fieldname = 'sloodleawardsrequire_numpoints_'.$interactionname;
$require_currency_fieldname = 'sloodleawardsrequire_currency_'.$interactionname;
$not_enough_message_fieldname = 'sloodleawardsrequire_notenoughmessage_'.$interactionname;
$require_points_row_name = 'sloodleawardsrequire_row_'.$interactionname;
$configs[ $require_points_fieldname ] = new SloodleConfigurationOptionText( $require_points_fieldname, $interactionlabel, 'emptystring', 0, 8);
$configs[ $require_points_fieldname ]->row_name = $require_points_row_name;
$configs[ $require_currency_fieldname ] = new SloodleConfigurationOptionCurrencyChoice( $require_currency_fieldname, 'emptystring', '', '', 8);
$configs[ $require_currency_fieldname ]->row_name = $require_points_row_name;
$configs[ $require_currency_fieldname ]->is_value_translatable = false;
$configs[ $not_enough_message_fieldname] = new SloodleConfigurationOptionText( $not_enough_message_fieldname, 'awards:notenoughmessage', '', '', 120);
}
return $configs;
}
function awards_withdraw_options( $interactions_to_labels = null ) {
if ($interactions_to_labels == null) {
//$interactions = array('default' => array('awards:interactwithobjectwithdraws', 'awards:interactwithobjectminus', 'awards:notenoughmessage') );
$interactions_to_labels = array('default' => 'awards:interactwithobjectwithdraws' );
}
$configs = array();
foreach($interactions_to_labels as $interactionname => $interactionlabel) {
$withdraw_points_fieldname = 'sloodleawardswithdraw_numpoints_'.$interactionname;
$withdraw_currency_fieldname = 'sloodleawardswithdraw_currency_'.$interactionname;
$not_enough_message_fieldname = 'sloodleawardswithdraw_notenoughmessage_'.$interactionname;
$withdraw_points_row_name = 'sloodleawardswithdraw_row_'.$interactionname;
$configs[ $withdraw_points_fieldname ] = new SloodleConfigurationOptionText( $withdraw_points_fieldname, $interactionlabel, 'emptystring', 0, 8);
$configs[ $withdraw_points_fieldname ]->row_name = $withdraw_points_row_name;
$configs[ $withdraw_currency_fieldname ] = new SloodleConfigurationOptionCurrencyChoice( $withdraw_currency_fieldname, 'emptystring', '', '', 8);
$configs[ $withdraw_currency_fieldname ]->row_name = $withdraw_points_row_name;
$configs[ $withdraw_currency_fieldname ]->is_value_translatable = false;
$configs[ $not_enough_message_fieldname] = new SloodleConfigurationOptionText( $not_enough_message_fieldname, 'awards:notenoughmessage', '', '', 120);
}
return $configs;
}
function module_choice( $courseid ) {
if (!$this->module) {
return null;
}
$options = $this->course_module_options( $courseid );
$op = new SloodleConfigurationOptionSelectOne( 'sloodlemoduleid', $this->module_choice_message, $this->module_no_choices_message, null, $options );
$op->is_value_translatable = false;
return $op;
}
// Over-write in the default values of the fields
// ...with the ones specified in the $settings name=>value hash.
function populateDefaults( $settings ) {
foreach($this->field_sets as $n=>$fs) {
foreach($fs as $f) {
if ( isset($settings[ $f->field_name ] ) ) {
$this->field_sets[$n][$fs]->default = $settings[ $f->field_name ];
}
}
}
}
function field_set_row_groups() {
$fsgs = array();
foreach($this->field_sets as $n => $fs) {
$rowgroups = array();
$last_row_name = '';
foreach($fs as $fn => $ctrl) {
if ( !isset($ctrl->row_name) || ( $ctrl->row_name == '') || ($ctrl->row_name != $last_row_name) ) { // make a new row
$rowgroups[] = array($fn => $ctrl);
} else { // append this control to the last rowgroup
$lastrowgroup = array_pop($rowgroups);
$lastrowgroup[$fn] = $ctrl;
$rowgroups[] = $lastrowgroup;
}
$last_row_name = isset($ctrl->row_name) ? $ctrl->row_name : '';
}
$fsgs[$n] = $rowgroups;
}
/*
print "";
var_dump($this->field_sets);
print "";
var_dump($fsgs);
print "";
exit;
*/
return $fsgs;
}
/*
Return all object definitions that say they have the capability of the specified task.
Initially used for the distributor-2 vending machine
...to say that it is capable of giving someone an object.
This is done by defining a capabilities array, like:
$sloodleconfig->capabilities = array('distributor_send_object_http_in');
*/
function DefinitionsOfObjectsCapableOf($task) {
$definitions = SloodleObjectConfig::AllAvailableAsArray();
$capable_defs = array();
foreach($definitions as $name=>$def) {
if (!isset($def->capabilities)) {
continue;
}
if (!is_array($def->capabilities)) {
continue;
}
if (!in_array($task, $def->capabilities)) {
continue;
}
$capable_defs[$name] = $def;
}
return $capable_defs;
}
}
// Represents a single entry or potential entry in an object configuration.
// eg. sloodlemoduleid or sloodlerefreshtime
//
class SloodleConfigurationOption {
// the fieldname of the option
var $fieldname;
// the displayed title of the widget to be fed to get_string
var $title;
// the description of the widget
var $description;
// a set of name-value pairs of keys and their display values
var $options = array();
// whether the value (options or text) can be translated.
var $is_value_translatable = true;
// the size of the display element, if applicable
var $size = 255;
// the maximum number of characters allowed
var $max_length = 255;
// the default value. should be one of the keys listed in options.
var $default;
// the recommended display type for the object.
// currently support radio, select
var $ctrl;
// the type of the object, eg. yesno, select etc.
// TODO: It would be better if these objects could render their own html, then we wouldn't need to tell anyone the type
var $type;
// Return an array of translated options.
// Usually we'd keep our options untranslated, and translate them at the last minute.
// But sometimes, eg with things from the database, there are no translations.
function translatedOptions() {
if (!$this->is_value_translatable) {
return $this->options;
}
if ( (!is_array($this->options)) || ( count($this->options) == 0) ) {
return $this->options;
}
$to = array();
foreach($this->options as $n=>$v) {
if ($v == '') {
$v = 'emptystring';
}
$to[$n] = get_string($v, 'sloodle');
}
return $to;
}
function renderForMoodleForm() {
}
function renderForIUIForm() {
}
}
class SloodleConfigurationOptionYesNo extends SloodleConfigurationOption {
function SloodleConfigurationOptionYesNo( $fieldname, $title, $description = '', $default = 0 ) {
$this->fieldname = $fieldname;
$this->title = $title;
$this->description = $description;
$this->options = array(1 => 'Yes', 0 => 'No');
$this->default = $default;
$this->type = 'yesno';
}
}
class SloodleConfigurationOptionText extends SloodleConfigurationOption {
function SloodleConfigurationOptionText( $fieldname, $title, $description, $default = '', $length = 8 ) {
$this->fieldname = $fieldname;
$this->title = $title;
$this->description = $description;
$this->size = $length > 40 ? 40 : $length;
$this->max_length = $length;
$this->default= $default;
$this->type = 'input';
}
}
// NB This could be presented as a set of radio buttons rather than a select
class SloodleConfigurationOptionSelectOne extends SloodleConfigurationOption {
function SloodleConfigurationOptionSelectOne( $fieldname = null, $title = null, $no_option_text = null, $description = null, $options = array(), $default = null) {
$this->fieldname = $fieldname;
$this->title = $title;
$this->no_option_text = $no_option_text;
$this->description = $description;
$this->options = $options;
$this->default = $default;
$this->type = 'select_one';
}
function renderForMoodleForm($selectedoption) {
}
}
// A setting needing a choice of course modules
class SloodleConfigurationOptionCourseModuleChoice extends SloodleConfigurationOptionSelectOne {
// The message displayed if there are no module instances available
var $noneavailablemessage = '';
// An array of key-value pairs for filtering the instance modules
var $instancefilters = array();
function SloodleConfigurationOptionCourseModuleChoice( $fieldname, $title, $description, $noneavailablemessage, $instancefilters ) {
$this->fieldname = $fieldname;
$this->title = $title;
$this->is_value_translatable = false;
$this->description = $description;
$this->options = $this->course_module_options();
$this->instancefilters = $instancefilters;
}
}
class SloodleConfigurationOptionCurrencyChoice extends SloodleConfigurationOption {
function SloodleConfigurationOptionCurrencyChoice( $fieldname, $title, $description, $default = '', $length = 8 ) {
if ( !$currencies = SloodleCurrency::FetchAll() ) {
return false;
}
$options = array();
foreach($currencies as $c) {
$options[$c->id] = $c->name;
}
$first_currency = array_shift($currencies);
$this->fieldname = $fieldname;
$this->title = $title;
$this->description = $description;
$this->size = $length;
$this->options = $options;
$this->no_option_text = 'nocurrencies';
$this->max_length = $length;
$this->default = $first_currency->id;
$this->type = 'select';
$this->is_value_translatable = false;
}
}
?>