https://docs.moodle.org/2x/ca/api.php?action=feedcontributions&feedformat=atom&user=BrunoMoodleDocs - Contribucions de l'usuari [ca]2026-08-01T07:09:52ZContribucions de l'usuariMediaWiki 1.43.5https://docs.moodle.org/2x/ca/index.php?title=error/moodle/csvloaderror&diff=96690error/moodle/csvloaderror2012-03-27T21:01:07Z<p>Bruno: </p>
<hr />
<div>Unfortunately the module which loads the csv data doesn't explain what is wrong.<br />
<br />
#Check<br />
## First line must contain column headings SPELLED correctly<br />
## There should not be quotes (i.e. ")<br />
## There should not be a trailing comma (i.e. ,)<br />
## When uploading custom profile field names, make sure that the short name is in lowercase<br />
<br />
While you're here, contrary to popular belief, usernames must be in lowercase in the file to be uploaded.<br />
<br />
for more, see https://docs.moodle.org/24/en/admin/tool/uploaduser/index</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Administration_via_command_line&diff=82685Administration via command line2011-04-10T05:17:58Z<p>Bruno: /* Upgrading via command line */</p>
<hr />
<div>{{Moodle 2.0}}<br />
<br />
If you have shell access to your web server, you may find various CLI (command line interface) scripts useful during Moodle administration. All command line tools are located in <code>admin/cli/*</code> directory. To avoid problems with access control, you should run them as the owner of the web server process. It is especially important for CLI installation and upgrade as they create new files in moodledata directory and the web server has to have write access to them. In Linux distributions, the user that runs the web server is usually apache or wwrun or httpd or something similar. As a root, you will probably want to execute Moodle CLI scripts like this:<br />
<br />
$ cd /path/to/your/moodle/dir<br />
$ sudo -u apache /usr/bin/php admin/cli/somescript.php --params<br />
<br />
Most of the scripts accept common --help (or -h) parameter to display the full usage information, for example:<br />
<br />
$ sudo -u apache /usr/bin/php admin/cli/install.php --help<br />
<br />
<br />
== Installation via command line ==<br />
<br />
Since version 2.0, Moodle can be installed from the command line. There are two modes of installation. In interactive mode, the install script asks you for all data needed to properly set up new Moodle site. In non-interactive mode, you must provide all required data as the script parameters and then the new site is installed silently. The parameters can be passed in the interactive mode, too. The provided values are then used as the default values during the interactive session.<br />
<br />
$ sudo -u apache /usr/bin/php admin/cli/install.php --lang=cs<br />
<br />
== Maintenance mode ==<br />
<br />
To switch your site into the maintenance mode via CLI, you can use<br />
<br />
$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --enable<br />
<br />
To turn the maintenance mode off, just execute the same script with --disable parameter.<br />
<br />
== Offline mode ==<br />
<br />
In some situations, you may want to switch your Moodle site into offline mode so that it is not accessible via the web but you can not stop the web server completely (typically because there are other web pages and applications running there). If a file called <code>climaintenance.html</code> exists in the root folder of moodledata directory, Moodle will automatically display the contents of that file instead of any other page.<br />
<br />
$ cd /var/www/sites/moodle/moodledata/<br />
$ echo '&lt;h1&gt;Sorry, maintenance in progress&lt;/h1&gt;' &gt; climaintenance.html<br />
<br />
You can prepare a nice formatted HTML page to inform your users about the server being down and keep in the moodledata directory under a name like <code>climaintenance.off</code> and rename it to the <code>climaintenance.html</code> if needed.<br />
<br />
== Upgrading via command line ==<br />
<br />
Moodle can be upgraded from the command line. As with the installation script, there is either interactive or non-interactive mode of the upgrade. The script itself does not put the site into the maintenance mode, you have to do it on your own. Also, the script does not backup any data (if you read this page, you probably have some own scripts to backup your moodledata and the database, right?)<br />
<br />
$ sudo -u aphe cli script for upgrading to moodle 2.0 normally outputs those same messages too.ache /usr/bin/php admin/cli/upgrade.php --non-interactive<br />
<br />
Upgrading via command line is a very comfortable way of Moodle upgrade if you use [[CVS]] or [[Git|git]] checkout of the Moodle source code. See the following procedure how to upgrade your site within several seconds to the most recent version while preserving your eventual local customizations tracked in git repository:<br />
<br />
$ cd /var/www/sites/moodle/htdocs/<br />
$ git fetch<br />
$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --enable<br />
$ git merge origin/cvshead<br />
$ sudo -u apache /usr/bin/php admin/cli/upgrade.php<br />
$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --disable<br />
<br />
===Issues with Upgrading via Command Line===<br />
<br />
if your config.php contains information about several moodle instances (distinct moodle websites and databases sharing the same codebase), then this script will silently fail<br />
<br />
The solution is to temporarily eliminate from config.php all but the one instance you want to upgrade <br />
<br />
If this is a problem for the other instances (production sites), then modify the cli script to point to a copy of config.php (which will be the one edited to contain only one moodle instance at a time)<br />
<br />
== Custom site defaults ==<br />
<br />
During the install and upgrade via CLI, Moodle sets the administration variables to the default values. You can use different defaults. See MDL-17850 for details. Shortly, all you need to do is to add a file <code>local/defaults.php</code> into your Moodle installation. The format of the file is like<br />
<br />
<code php><br />
<?php<br />
$defaults['pluginname']['settingname'] = 'settingvalue'; // for plugins<br />
$defaults['moodle']['settingname'] = 'settingvalue'; // for core settings<br />
</code><br />
<br />
These defaults are used during install, upgrade and are also displayed as defaults at the Site administration pages.<br />
<br />
== Reset user password ==<br />
<br />
If you happen to forget your admin password (or you want to set a password for any other user of your Moodle system), you can use reset_password.php script. The script sets the correctly salted password for the given user.<br />
<br />
$ sudo -u apache /usr/bin/php admin/cli/reset_password.php<br />
<br />
== MySQL storage engine conversion ==<br />
<br />
If you run your Moodle site with MySQL database backend and use the default MyISAM as the storage engine for your tables, you may want to convert them to use some more reliable engine like InnoDB (actually, you should want to switch to PostgreSQL ;-) anyway).<br />
<br />
$ sudo -u apache /usr/bin/php admin/cli/mysql_engine.php --engine=InnoDB<br />
<br />
<br />
== Running cron via command line ==<br />
<br />
In versions 1.x, you could execute admin/cron.php either from command line or via the web. Since Moodle 2.0, only admin/cli/cron.php script can be run via command line.<br />
<br />
[[Category:Administrator]]<br />
<br />
[[fr:Administration en ligne de commande]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=DML_drivers&diff=78614DML drivers2010-12-03T06:41:02Z<p>Bruno: /* Query logging */</p>
<hr />
<div>{{Moodle_2.0}}Previous versions were using adodb abstraction partially encapsulated by old DML api. The database drivers are now fully separated from the rest of code and it is even possible to create new native drivers that do not rely on adodb abstraction anymore.<br />
<br />
At present there are three native drivers - mysqli, pgsql and unfinished Oracle driver. The benefits are:<br />
* more optimised and probably faster<br />
* consume less memory<br />
* better possibility to improve logging, debugging, profiling, etc.<br />
* less code, easier to fix and maintain<br />
* and more<br />
<br />
Please note old adodb based drivers will be removed before the branching of 2.0.<br />
<br />
==Query logging==<br />
New native DML drivers support logging of database queries to database table. Logging can be enabled in config.php<br />
<br />
$CFG->dboptions = array (<br />
'dbpersist' => 0,<br />
//'logall' => true,<br />
'logslow' => 5,<br />
'logerrors' => true,<br />
);<br />
<br />
* '''logall''' - log all queries - suitable only for developers, causes high server loads<br />
* '''logslow''' - log queries that take longer than specified number of seconds (float values are accepted)<br />
* '''logerrors''' - log all error queries<br />
<br />
==TODO==<br />
* add more info here<br />
* add separate docs pages for each driver - describe all options there<br />
<br />
==See also==<br />
* [[Development:DML functions|DML functions]]: Where all the functions used to handle DB data ([[wikipedia:Data_Manipulation_Language|DML]]) are defined.<br />
* [[Development:DML exceptions|DML exceptions]]: New DML code is throwing exceptions instead of returning false if anything goes wrong</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=DML_drivers&diff=78613DML drivers2010-12-03T06:40:25Z<p>Bruno: /* Query logging */ spelling correction</p>
<hr />
<div>{{Moodle_2.0}}Previous versions were using adodb abstraction partially encapsulated by old DML api. The database drivers are now fully separated from the rest of code and it is even possible to create new native drivers that do not rely on adodb abstraction anymore.<br />
<br />
At present there are three native drivers - mysqli, pgsql and unfinished Oracle driver. The benefits are:<br />
* more optimised and probably faster<br />
* consume less memory<br />
* better possibility to improve logging, debugging, profiling, etc.<br />
* less code, easier to fix and maintain<br />
* and more<br />
<br />
Please note old adodb based drivers will be removed before the branching of 2.0.<br />
<br />
==Query logging==<br />
New native DML drivers support logging of database queries to database table. Logging can be enabled in config.php<br />
<br />
$CFG->dboptions = array (<br />
'dbpersit' => 0,<br />
//'logall' => true,<br />
'logslow' => 5,<br />
'logerrors' => true,<br />
);<br />
<br />
* '''logall''' - log all queries - suitable only for developers, causes high server loads<br />
* '''logslow''' - log queries that take longer than specified number of seconds (float values are accepted)<br />
* '''logerrors''' - log all error queries<br />
<br />
==TODO==<br />
* add more info here<br />
* add separate docs pages for each driver - describe all options there<br />
<br />
==See also==<br />
* [[Development:DML functions|DML functions]]: Where all the functions used to handle DB data ([[wikipedia:Data_Manipulation_Language|DML]]) are defined.<br />
* [[Development:DML exceptions|DML exceptions]]: New DML code is throwing exceptions instead of returning false if anything goes wrong</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Broken/DML_functions&diff=78612Broken/DML functions2010-12-03T06:29:56Z<p>Bruno: /* Using Recordsets */</p>
<hr />
<div>{{Moodle_2.0}}This page describes the functions available to access data in the Moodle database. You should '''exclusively''' use these functions in order to retrieve or modify database content because these functions provide a high level of abstraction and guarantee that your database manipulation will work against different RDBMSes.<br />
<br />
Where possible, tricks and examples will be documented here in order to make developers' lives a bit easier. Of course, feel free to clarify, complete and add more information to this documentation. It will be welcome, absolutely!<br />
<br />
== Main info ==<br />
<br />
'''Important note:''' All the functions shown on this page are for use in '''Moodle 2.0 upwards''', where we changed the [[Development:DB layer 2.0|DB layer]] to support some new features. If you need information for previous Moodle version, take a look to the [[Development:DML functions - pre 2.0|DML functions - pre 2.0]] page. For a detailed reference of changes, see the [[Development:DB layer 2.0 migration docs|migration docs]].<br />
<br />
* All the function calls on this page are public methods of the $DB global object, so you'll need to "import" it within your functions (not needed in global scripts) with one simple:<br />
<code php>global $DB;</code><br />
* All the $table parameters in the functions are meant to be the table name ''without'' prefixes.<br />
<code php>$user = $DB->get_record('user', array('id'=>'1');</code><br />
* When using the xxx_sql() functions, table names must be enclosed between curly braces.<br />
<code php>$user = $DB->get_record_sql('SELECT * FROM {user} WHERE id = ?', array(1));</code><br />
* All the $conditions parameters in the functions are arrays of fieldname=>fieldvalue elements.<br />
<code php>$user = $DB->get_record('user', array('firstname'=>'Martin', 'lastname'=>'Dougiamas'));</code><br />
* All the $params parameters in the functions are arrays of values used to fill placeholders in SQL statements. Both the question mark and named placeholders can be used. Note that named params '''must be unique''' even if the value passed is the same.<br />
<code php><br />
/// Question mark placeholders:<br />
$DB->get_record_sql('SELECT * FROM {user} WHERE firstname = ? AND lastname = ?', <br />
array('Martin', 'Dougiamas'));<br />
<br />
/// Named placeholders:<br />
$DB->get_record_sql('SELECT * FROM {user} WHERE firstname = :firstname AND lastname = :lastname',<br />
array('firstname'=>'Martin', 'lastname'=>'Dougiamas'));<br />
</code><br />
<br />
== The functions ==<br />
<br />
===Seeing how many records match a given criteria===<br />
<code php><br />
o $DB->count_records($table, array $conditions=null) <br />
/// Count the records in a table where all the given conditions met.<br />
o $DB->count_records_select($table, $select, array $params=null, $countitem="COUNT('x')") <br />
/// Count the records in a table which match a particular WHERE clause.<br />
o $DB->count_records_sql($sql, array $params=null) <br />
/// Get the result of a SQL SELECT COUNT(...) query.<br />
</code><br />
<br />
===Seeing if one record exists===<br />
<code php><br />
o $DB->record_exists($table, array $conditions=null) <br />
/// Test whether a record exists in a table where all the given conditions met.<br />
o $DB->record_exists_select($table, $select, array $params=null) <br />
/// Test whether any records exists in a table which match a particular WHERE clause.<br />
o $DB->record_exists_sql($sql, array $params=null) <br />
/// Test whether a SQL SELECT statement returns any records.<br />
</code><br />
<br />
===Getting a single record===<br />
<code php><br />
o $DB->get_record($table, array $conditions, $fields='*', $ignoremultiple=false) <br />
/// Get a single database record as an object where all the given conditions met.<br />
o $DB->get_record_select($table, $select, array $params=null, $fields='*', $ignoremultiple=false)<br />
/// Get a single database record as an object which match a particular WHERE clause.<br />
o $DB->get_record_sql($sql, array $params=null)<br />
/// Get a single database record as an object using a SQL statement.<br />
</code><br />
<br />
===Getting an array of records===<br />
<code php><br />
o $DB->get_records($table, array $conditions=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) <br />
/// Get a number of records as an array of objects where all the given conditions met.<br />
o $DB->get_records_select($table, $select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) <br />
/// Get a number of records as an array of objects which match a particular WHERE clause.<br />
o $DB->get_records_sql($sql, array $params=null, $limitfrom=0, $limitnum=0)<br />
/// Get a number of records as an array of objects using a SQL statement.<br />
<br />
o $DB->get_records_menu($table, array $conditions=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) <br />
/// Get the first two columns from a number of records as an associative array where all the given conditions met.<br />
o $DB->get_records_select_menu($table, $select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0)<br />
/// Get the first two columns from a number of records as an associative array which match a particular WHERE clause.<br />
o $DB->get_records_sql_menu($sql, array $params=null, $limitfrom=0, $limitnum=0)<br />
/// Get the first two columns from a number of records as an associative array using a SQL statement.<br />
<br />
o $DB->get_records_list($table, $field='', $values='', $sort='', $fields='*', $limitfrom='', $limitnum='') <br />
/// Get a number of records as an array of objects where one field match one list of values.<br />
</code><br />
<br />
===Getting a particular field value from one record===<br />
<code php><br />
o $DB->get_field($table, $return, array $conditions)<br />
/// Get a single field value from a table record where all the given conditions met.<br />
o $DB->get_field_select($table, $return, $select, array $params=null)<br />
/// Get a single field value from a table record which match a particular WHERE clause.<br />
o $DB->get_field_sql($sql, array $params=null)<br />
/// Get a single field value (first field) using a SQL statement.<br />
</code><br />
<br />
===Getting a particular field value from various records===<br />
<br />
<code php><br />
o $DB->get_fieldset_select($table, $return, $select, array $params=null)<br />
/// Selects records and return values of chosen field as an array which match a particular WHERE clause.<br />
o $DB->get_fieldset_sql($sql, array $params=null)<br />
/// Selects records and return values (first field) as an array using a SQL statement.<br />
</code><br />
<br />
===Setting a particular field in the database===<br />
<code php><br />
o $DB->set_field($table, $newfield, $newvalue, array $conditions=null)<br />
/// Set a single field in every table record where all the given conditions met.<br />
o $DB->set_field_select($table, $newfield, $newvalue, $select, array $params=null)<br />
/// Set a single field in every table record which match a particular WHERE clause.<br />
</code><br />
<br />
===Deleting Records===<br />
<code php><br />
o $DB->delete_records($table, array $conditions=null) <br />
/// Delete the records from a table where all the given conditions met.<br />
o $DB->delete_records_select($table, $select, array $params=null)<br />
/// Delete one or more records from a table which match a particular WHERE clause.<br />
</code><br />
<br />
===Inserting Records===<br />
<code php><br />
o $DB->insert_record($table, $dataobject, $returnid=true, $bulk=false) <br />
/// Insert a record into a table and return the "id" field if required.<br />
</code><br />
<br />
===Updating Records===<br />
<code php><br />
o $DB->update_record($table, $dataobject, $bulk=false)<br />
/// Update a record in a table.<br />
</code><br />
<br />
===Using Recordsets===<br />
<br />
Where the number of records to be retrieved from DB is high, the '''get_records_xxx()''' functions above are far from optimal, because they load all the records in memory at the same time. Under those circumstances, it is highly recommended to use these '''get_recordset_xxx()''' functions instead, which use one nice mechanism to iterate over all the target records and save a lot of memory.<br />
<br />
Only one thing is '''absolutely important''': Don't forget to close the recordsets after using them! (This will free up a lot of resources in the RDBMS).<br />
<br />
Here is the general way to iterate over records using the '''get_recordset_xxx()''' functions:<br />
<br />
<code php><br />
if ($rs = $DB->get_recordset(....) {<br />
foreach ($rs as $record) {<br />
/// Do whatever you want with this record<br />
}<br />
$rs->close(); /// Don't forget to close the recordset!<br />
}<br />
</code><br />
<br />
And this is the list of available functions (100% paired with the get_records_xxx() above):<br />
<code php><br />
o $DB->get_recordset($table, array $conditions=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) <br />
/// Get a number of records as a moodle_recordset where all the given conditions met.<br />
o $DB->get_recordset_select($table, $select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) <br />
/// Get a number of records as a moodle_recordset which match a particular WHERE clause.<br />
o $DB->get_recordset_sql($sql, array $params=null, $limitfrom=0, $limitnum=0);<br />
/// Get a number of records as a moodle_recordset using a SQL statement.<br />
<br />
o $DB->get_recordset_list($table, $field='', $values='', $sort='', $fields='*', $limitfrom='', $limitnum='') <br />
/// Get a number of records as a moodle_recordset where one field matches one list of values.<br />
</code><br />
<br />
===Delegated transactions===<br />
<br />
* Please note some databases do not support transactions (such as the MyISAM MySQL database engine), however all server administrators are strongly encouraged to migrate to databases that support transactions (such as the InnoDB MySQL database engine).<br />
* Previous versions supported only one level of transaction. Since Moodle 2.0, the DML layer emulates delegated transactions that allow nesting of transactions.<br />
* Transactions should not be used much in Moodle core; they are intended for various plugins such as web services, enrol and auth plugins.<br />
* Some subsystems (such as messaging) do not support transactions because is it is not possible to rollback in external systems.<br />
<br />
A transaction is started by:<br />
<code php><br />
$transaction = $DB->start_delegated_transaction();<br />
</code><br />
<br />
and finished by:<br />
<code php><br />
$transaction->allow_commit();<br />
</code><br />
<br />
Usually a transaction is rolled back when an exception is thrown. <code>$transaction->rollback($ex);</code> must be used very carefully because it might break compatibility with databases that do not support transactions. Transactions cannot be used as part of expected code flow; they can be used only as an emergency protection of data consistency.<br />
<br />
See more details in [[Development:DB layer 2.0 delegated transactions]] or MDL-20625.<br />
<br />
===Helper Functions===<br />
<br />
In order have real cross-db compatibility, there are some helper functions used to build SQL fragments based on the DB Moodle is running. Using them we'll avoid conditional queries here and there and have those "incompatibilities" fixed once and for ever.<br />
<code php><br />
o $DB->sql_bitand($int1, $int2) <br />
/// Returns the SQL text to be used in order to perform one bitwise AND <br />
/// operation between 2 integers.<br />
o $DB->sql_bitnot($int1) <br />
/// Returns the SQL text to be used in order to perform one bitwise NOT <br />
/// operation with 1 integer.<br />
o $DB->sql_bitor($int1, $int2)<br />
/// Returns the SQL text to be used in order to perform one bitwise OR <br />
/// operation between 2 integers.<br />
o $DB->sql_bitxor($int1, $int2) <br />
/// Returns the SQL text to be used in order to perform one bitwise XOR <br />
/// operation between 2 integers.<br />
<br />
o $DB->sql_null_from_clause()<br />
/// Returns the FROM clause required by some DBs in all SELECT statements.<br />
<br />
o $DB->sql_ceil($fieldname)<br />
/// Returns the correct CEIL expression applied to fieldname.<br />
o $DB->sql_ilike()<br />
/// Returns the proper SQL to do LIKE in a case-insensitive way.<br />
o $DB->sql_length($fieldname)<br />
/// Returns the SQL text to be used to calculate the length in characters of one expression.<br />
o $DB->sql_modulo($int1, $int2)<br />
/// Returns the SQL text to be used in order to calculate module - remainder after division<br />
o $DB->sql_position($needle, $haystack)<br />
/// Returns the SQL for returning searching one string for the location of another.<br />
/// Note: If using placeholders BOTH in $needle and $haystack, they MUST be named placeholders.<br />
o $DB->sql_substr($expr, $start, $length=false)<br />
/// Returns the proper substr() SQL text used to extract substrings from DB.<br />
/// Note: This fuction has changed in Moodle 2.0 and now at least 2 params are mandatory.<br />
/// Note: Now it returns the whole SQL text to be used instead of only the function name.<br />
<br />
o $DB->sql_cast_char2int($fieldname, $text=false)<br />
/// Returns the SQL to be used in order to CAST one CHAR column to INTEGER.<br />
o $DB->sql_cast_char2real($fieldname, $text=false)<br />
/// Returns the SQL to be used in order to CAST one CHAR column to REAL number.<br />
<br />
o $DB->sql_compare_text($fieldname, $numchars=32) <br />
/// Returns the SQL text to be used to compare one TEXT (clob) column.<br />
/// with one VARCHAR column.<br />
o $DB->sql_order_by_text($fieldname, $numchars=32)<br />
/// Returns the SQL text to be used to order by one TEXT (clob) column.<br />
<br />
o $DB->sql_concat()<br />
/// Returns the proper SQL to do CONCAT between the elements passed.<br />
o $DB->sql_concat_join($separator="' '", $elements=array())<br />
/// Returns the proper SQL to do CONCAT between the elements passed using one separator.<br />
o $DB->sql_fullname($first='firstname', $last='lastname')<br />
/// Returns the proper SQL to concatenate $firstname and $lastname.<br />
<br />
o $DB->sql_isempty($tablename, $fieldname, $nullablefield, $textfield)<br />
/// Returns the proper SQL to know if one field is empty.<br />
o $DB->sql_isnotempty($tablename, $fieldname, $nullablefield, $textfield)<br />
/// Returns the proper SQL to know if one field is not empty.<br />
o $DB->sql_empty()<br />
/// Returns the empty string char used by every supported DB.<br />
</code><br />
<br />
==See also==<br />
<br />
* [[Development:DML exceptions|DML exceptions]]: New DML code is throwing exceptions instead of returning false if anything goes wrong<br />
* [[Development:DML drivers|DML drivers]]: Database drivers for new DML layer<br />
* [[Development:DML functions - pre 2.0|DML functions - pre 2.0]]: '''(deprecated!)''' For information valid before Moodle 2.0.<br />
* [[Development:DDL functions|DDL functions]]: Where all the functions used to handle DB objects ([[wikipedia:Data_Definition_Language|DDL]]) are defined.<br />
* [[Development:DB layer 2.0 examples|DB layer 2.0 examples]]: To see some code examples using various DML functions.<br />
* [[Development:DB layer 2.0 migration docs|DB layer 2.0 migration docs]]: Information about how to modify your code to work with the new Moodle 2.0 DB layer.<br />
* [[Development:DTL functions|DTL functions]]: Exporting, importing and moving of data stored in SQL databases<br />
<br />
[[Category:DB]]<br />
[[Category:XMLDB]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Broken/DML_functions&diff=78611Broken/DML functions2010-12-03T06:28:37Z<p>Bruno: /* Using Recordsets */ clearer english</p>
<hr />
<div>{{Moodle_2.0}}This page describes the functions available to access data in the Moodle database. You should '''exclusively''' use these functions in order to retrieve or modify database content because these functions provide a high level of abstraction and guarantee that your database manipulation will work against different RDBMSes.<br />
<br />
Where possible, tricks and examples will be documented here in order to make developers' lives a bit easier. Of course, feel free to clarify, complete and add more information to this documentation. It will be welcome, absolutely!<br />
<br />
== Main info ==<br />
<br />
'''Important note:''' All the functions shown on this page are for use in '''Moodle 2.0 upwards''', where we changed the [[Development:DB layer 2.0|DB layer]] to support some new features. If you need information for previous Moodle version, take a look to the [[Development:DML functions - pre 2.0|DML functions - pre 2.0]] page. For a detailed reference of changes, see the [[Development:DB layer 2.0 migration docs|migration docs]].<br />
<br />
* All the function calls on this page are public methods of the $DB global object, so you'll need to "import" it within your functions (not needed in global scripts) with one simple:<br />
<code php>global $DB;</code><br />
* All the $table parameters in the functions are meant to be the table name ''without'' prefixes.<br />
<code php>$user = $DB->get_record('user', array('id'=>'1');</code><br />
* When using the xxx_sql() functions, table names must be enclosed between curly braces.<br />
<code php>$user = $DB->get_record_sql('SELECT * FROM {user} WHERE id = ?', array(1));</code><br />
* All the $conditions parameters in the functions are arrays of fieldname=>fieldvalue elements.<br />
<code php>$user = $DB->get_record('user', array('firstname'=>'Martin', 'lastname'=>'Dougiamas'));</code><br />
* All the $params parameters in the functions are arrays of values used to fill placeholders in SQL statements. Both the question mark and named placeholders can be used. Note that named params '''must be unique''' even if the value passed is the same.<br />
<code php><br />
/// Question mark placeholders:<br />
$DB->get_record_sql('SELECT * FROM {user} WHERE firstname = ? AND lastname = ?', <br />
array('Martin', 'Dougiamas'));<br />
<br />
/// Named placeholders:<br />
$DB->get_record_sql('SELECT * FROM {user} WHERE firstname = :firstname AND lastname = :lastname',<br />
array('firstname'=>'Martin', 'lastname'=>'Dougiamas'));<br />
</code><br />
<br />
== The functions ==<br />
<br />
===Seeing how many records match a given criteria===<br />
<code php><br />
o $DB->count_records($table, array $conditions=null) <br />
/// Count the records in a table where all the given conditions met.<br />
o $DB->count_records_select($table, $select, array $params=null, $countitem="COUNT('x')") <br />
/// Count the records in a table which match a particular WHERE clause.<br />
o $DB->count_records_sql($sql, array $params=null) <br />
/// Get the result of a SQL SELECT COUNT(...) query.<br />
</code><br />
<br />
===Seeing if one record exists===<br />
<code php><br />
o $DB->record_exists($table, array $conditions=null) <br />
/// Test whether a record exists in a table where all the given conditions met.<br />
o $DB->record_exists_select($table, $select, array $params=null) <br />
/// Test whether any records exists in a table which match a particular WHERE clause.<br />
o $DB->record_exists_sql($sql, array $params=null) <br />
/// Test whether a SQL SELECT statement returns any records.<br />
</code><br />
<br />
===Getting a single record===<br />
<code php><br />
o $DB->get_record($table, array $conditions, $fields='*', $ignoremultiple=false) <br />
/// Get a single database record as an object where all the given conditions met.<br />
o $DB->get_record_select($table, $select, array $params=null, $fields='*', $ignoremultiple=false)<br />
/// Get a single database record as an object which match a particular WHERE clause.<br />
o $DB->get_record_sql($sql, array $params=null)<br />
/// Get a single database record as an object using a SQL statement.<br />
</code><br />
<br />
===Getting an array of records===<br />
<code php><br />
o $DB->get_records($table, array $conditions=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) <br />
/// Get a number of records as an array of objects where all the given conditions met.<br />
o $DB->get_records_select($table, $select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) <br />
/// Get a number of records as an array of objects which match a particular WHERE clause.<br />
o $DB->get_records_sql($sql, array $params=null, $limitfrom=0, $limitnum=0)<br />
/// Get a number of records as an array of objects using a SQL statement.<br />
<br />
o $DB->get_records_menu($table, array $conditions=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) <br />
/// Get the first two columns from a number of records as an associative array where all the given conditions met.<br />
o $DB->get_records_select_menu($table, $select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0)<br />
/// Get the first two columns from a number of records as an associative array which match a particular WHERE clause.<br />
o $DB->get_records_sql_menu($sql, array $params=null, $limitfrom=0, $limitnum=0)<br />
/// Get the first two columns from a number of records as an associative array using a SQL statement.<br />
<br />
o $DB->get_records_list($table, $field='', $values='', $sort='', $fields='*', $limitfrom='', $limitnum='') <br />
/// Get a number of records as an array of objects where one field match one list of values.<br />
</code><br />
<br />
===Getting a particular field value from one record===<br />
<code php><br />
o $DB->get_field($table, $return, array $conditions)<br />
/// Get a single field value from a table record where all the given conditions met.<br />
o $DB->get_field_select($table, $return, $select, array $params=null)<br />
/// Get a single field value from a table record which match a particular WHERE clause.<br />
o $DB->get_field_sql($sql, array $params=null)<br />
/// Get a single field value (first field) using a SQL statement.<br />
</code><br />
<br />
===Getting a particular field value from various records===<br />
<br />
<code php><br />
o $DB->get_fieldset_select($table, $return, $select, array $params=null)<br />
/// Selects records and return values of chosen field as an array which match a particular WHERE clause.<br />
o $DB->get_fieldset_sql($sql, array $params=null)<br />
/// Selects records and return values (first field) as an array using a SQL statement.<br />
</code><br />
<br />
===Setting a particular field in the database===<br />
<code php><br />
o $DB->set_field($table, $newfield, $newvalue, array $conditions=null)<br />
/// Set a single field in every table record where all the given conditions met.<br />
o $DB->set_field_select($table, $newfield, $newvalue, $select, array $params=null)<br />
/// Set a single field in every table record which match a particular WHERE clause.<br />
</code><br />
<br />
===Deleting Records===<br />
<code php><br />
o $DB->delete_records($table, array $conditions=null) <br />
/// Delete the records from a table where all the given conditions met.<br />
o $DB->delete_records_select($table, $select, array $params=null)<br />
/// Delete one or more records from a table which match a particular WHERE clause.<br />
</code><br />
<br />
===Inserting Records===<br />
<code php><br />
o $DB->insert_record($table, $dataobject, $returnid=true, $bulk=false) <br />
/// Insert a record into a table and return the "id" field if required.<br />
</code><br />
<br />
===Updating Records===<br />
<code php><br />
o $DB->update_record($table, $dataobject, $bulk=false)<br />
/// Update a record in a table.<br />
</code><br />
<br />
===Using Recordsets===<br />
<br />
Where the number of records to be retrieved from DB is high, the '''get_records_xxx()''' functions above are far from optimal, because they use to load all the records in memory at the same time. Under those circumstances, it's highly recommended to use this '''get_recordset_xxx()''' functions instead, which uses one nice mechanism to iterate over all the target records and save a lot of memory.<br />
<br />
Only one thing is '''absolutely important''': Don't forget to close the recordsets after using them! (This will free up a lot of resources in the RDBMS).<br />
<br />
Here is the general way to iterate over records using the '''get_recordset_xxx()''' functions:<br />
<br />
<code php><br />
if ($rs = $DB->get_recordset(....) {<br />
foreach ($rs as $record) {<br />
/// Do whatever you want with this record<br />
}<br />
$rs->close(); /// Don't forget to close the recordset!<br />
}<br />
</code><br />
<br />
And this is the list of available functions (100% paired with the get_records_xxx() above):<br />
<code php><br />
o $DB->get_recordset($table, array $conditions=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) <br />
/// Get a number of records as a moodle_recordset where all the given conditions met.<br />
o $DB->get_recordset_select($table, $select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) <br />
/// Get a number of records as a moodle_recordset which match a particular WHERE clause.<br />
o $DB->get_recordset_sql($sql, array $params=null, $limitfrom=0, $limitnum=0);<br />
/// Get a number of records as a moodle_recordset using a SQL statement.<br />
<br />
o $DB->get_recordset_list($table, $field='', $values='', $sort='', $fields='*', $limitfrom='', $limitnum='') <br />
/// Get a number of records as a moodle_recordset where one field matches one list of values.<br />
</code><br />
<br />
===Delegated transactions===<br />
<br />
* Please note some databases do not support transactions (such as the MyISAM MySQL database engine), however all server administrators are strongly encouraged to migrate to databases that support transactions (such as the InnoDB MySQL database engine).<br />
* Previous versions supported only one level of transaction. Since Moodle 2.0, the DML layer emulates delegated transactions that allow nesting of transactions.<br />
* Transactions should not be used much in Moodle core; they are intended for various plugins such as web services, enrol and auth plugins.<br />
* Some subsystems (such as messaging) do not support transactions because is it is not possible to rollback in external systems.<br />
<br />
A transaction is started by:<br />
<code php><br />
$transaction = $DB->start_delegated_transaction();<br />
</code><br />
<br />
and finished by:<br />
<code php><br />
$transaction->allow_commit();<br />
</code><br />
<br />
Usually a transaction is rolled back when an exception is thrown. <code>$transaction->rollback($ex);</code> must be used very carefully because it might break compatibility with databases that do not support transactions. Transactions cannot be used as part of expected code flow; they can be used only as an emergency protection of data consistency.<br />
<br />
See more details in [[Development:DB layer 2.0 delegated transactions]] or MDL-20625.<br />
<br />
===Helper Functions===<br />
<br />
In order have real cross-db compatibility, there are some helper functions used to build SQL fragments based on the DB Moodle is running. Using them we'll avoid conditional queries here and there and have those "incompatibilities" fixed once and for ever.<br />
<code php><br />
o $DB->sql_bitand($int1, $int2) <br />
/// Returns the SQL text to be used in order to perform one bitwise AND <br />
/// operation between 2 integers.<br />
o $DB->sql_bitnot($int1) <br />
/// Returns the SQL text to be used in order to perform one bitwise NOT <br />
/// operation with 1 integer.<br />
o $DB->sql_bitor($int1, $int2)<br />
/// Returns the SQL text to be used in order to perform one bitwise OR <br />
/// operation between 2 integers.<br />
o $DB->sql_bitxor($int1, $int2) <br />
/// Returns the SQL text to be used in order to perform one bitwise XOR <br />
/// operation between 2 integers.<br />
<br />
o $DB->sql_null_from_clause()<br />
/// Returns the FROM clause required by some DBs in all SELECT statements.<br />
<br />
o $DB->sql_ceil($fieldname)<br />
/// Returns the correct CEIL expression applied to fieldname.<br />
o $DB->sql_ilike()<br />
/// Returns the proper SQL to do LIKE in a case-insensitive way.<br />
o $DB->sql_length($fieldname)<br />
/// Returns the SQL text to be used to calculate the length in characters of one expression.<br />
o $DB->sql_modulo($int1, $int2)<br />
/// Returns the SQL text to be used in order to calculate module - remainder after division<br />
o $DB->sql_position($needle, $haystack)<br />
/// Returns the SQL for returning searching one string for the location of another.<br />
/// Note: If using placeholders BOTH in $needle and $haystack, they MUST be named placeholders.<br />
o $DB->sql_substr($expr, $start, $length=false)<br />
/// Returns the proper substr() SQL text used to extract substrings from DB.<br />
/// Note: This fuction has changed in Moodle 2.0 and now at least 2 params are mandatory.<br />
/// Note: Now it returns the whole SQL text to be used instead of only the function name.<br />
<br />
o $DB->sql_cast_char2int($fieldname, $text=false)<br />
/// Returns the SQL to be used in order to CAST one CHAR column to INTEGER.<br />
o $DB->sql_cast_char2real($fieldname, $text=false)<br />
/// Returns the SQL to be used in order to CAST one CHAR column to REAL number.<br />
<br />
o $DB->sql_compare_text($fieldname, $numchars=32) <br />
/// Returns the SQL text to be used to compare one TEXT (clob) column.<br />
/// with one VARCHAR column.<br />
o $DB->sql_order_by_text($fieldname, $numchars=32)<br />
/// Returns the SQL text to be used to order by one TEXT (clob) column.<br />
<br />
o $DB->sql_concat()<br />
/// Returns the proper SQL to do CONCAT between the elements passed.<br />
o $DB->sql_concat_join($separator="' '", $elements=array())<br />
/// Returns the proper SQL to do CONCAT between the elements passed using one separator.<br />
o $DB->sql_fullname($first='firstname', $last='lastname')<br />
/// Returns the proper SQL to concatenate $firstname and $lastname.<br />
<br />
o $DB->sql_isempty($tablename, $fieldname, $nullablefield, $textfield)<br />
/// Returns the proper SQL to know if one field is empty.<br />
o $DB->sql_isnotempty($tablename, $fieldname, $nullablefield, $textfield)<br />
/// Returns the proper SQL to know if one field is not empty.<br />
o $DB->sql_empty()<br />
/// Returns the empty string char used by every supported DB.<br />
</code><br />
<br />
==See also==<br />
<br />
* [[Development:DML exceptions|DML exceptions]]: New DML code is throwing exceptions instead of returning false if anything goes wrong<br />
* [[Development:DML drivers|DML drivers]]: Database drivers for new DML layer<br />
* [[Development:DML functions - pre 2.0|DML functions - pre 2.0]]: '''(deprecated!)''' For information valid before Moodle 2.0.<br />
* [[Development:DDL functions|DDL functions]]: Where all the functions used to handle DB objects ([[wikipedia:Data_Definition_Language|DDL]]) are defined.<br />
* [[Development:DB layer 2.0 examples|DB layer 2.0 examples]]: To see some code examples using various DML functions.<br />
* [[Development:DB layer 2.0 migration docs|DB layer 2.0 migration docs]]: Information about how to modify your code to work with the new Moodle 2.0 DB layer.<br />
* [[Development:DTL functions|DTL functions]]: Exporting, importing and moving of data stored in SQL databases<br />
<br />
[[Category:DB]]<br />
[[Category:XMLDB]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Broken/DML_functions&diff=78610Broken/DML functions2010-12-03T06:24:10Z<p>Bruno: /* Getting a single record */ get_record_sql syntax was incorrect</p>
<hr />
<div>{{Moodle_2.0}}This page describes the functions available to access data in the Moodle database. You should '''exclusively''' use these functions in order to retrieve or modify database content because these functions provide a high level of abstraction and guarantee that your database manipulation will work against different RDBMSes.<br />
<br />
Where possible, tricks and examples will be documented here in order to make developers' lives a bit easier. Of course, feel free to clarify, complete and add more information to this documentation. It will be welcome, absolutely!<br />
<br />
== Main info ==<br />
<br />
'''Important note:''' All the functions shown on this page are for use in '''Moodle 2.0 upwards''', where we changed the [[Development:DB layer 2.0|DB layer]] to support some new features. If you need information for previous Moodle version, take a look to the [[Development:DML functions - pre 2.0|DML functions - pre 2.0]] page. For a detailed reference of changes, see the [[Development:DB layer 2.0 migration docs|migration docs]].<br />
<br />
* All the function calls on this page are public methods of the $DB global object, so you'll need to "import" it within your functions (not needed in global scripts) with one simple:<br />
<code php>global $DB;</code><br />
* All the $table parameters in the functions are meant to be the table name ''without'' prefixes.<br />
<code php>$user = $DB->get_record('user', array('id'=>'1');</code><br />
* When using the xxx_sql() functions, table names must be enclosed between curly braces.<br />
<code php>$user = $DB->get_record_sql('SELECT * FROM {user} WHERE id = ?', array(1));</code><br />
* All the $conditions parameters in the functions are arrays of fieldname=>fieldvalue elements.<br />
<code php>$user = $DB->get_record('user', array('firstname'=>'Martin', 'lastname'=>'Dougiamas'));</code><br />
* All the $params parameters in the functions are arrays of values used to fill placeholders in SQL statements. Both the question mark and named placeholders can be used. Note that named params '''must be unique''' even if the value passed is the same.<br />
<code php><br />
/// Question mark placeholders:<br />
$DB->get_record_sql('SELECT * FROM {user} WHERE firstname = ? AND lastname = ?', <br />
array('Martin', 'Dougiamas'));<br />
<br />
/// Named placeholders:<br />
$DB->get_record_sql('SELECT * FROM {user} WHERE firstname = :firstname AND lastname = :lastname',<br />
array('firstname'=>'Martin', 'lastname'=>'Dougiamas'));<br />
</code><br />
<br />
== The functions ==<br />
<br />
===Seeing how many records match a given criteria===<br />
<code php><br />
o $DB->count_records($table, array $conditions=null) <br />
/// Count the records in a table where all the given conditions met.<br />
o $DB->count_records_select($table, $select, array $params=null, $countitem="COUNT('x')") <br />
/// Count the records in a table which match a particular WHERE clause.<br />
o $DB->count_records_sql($sql, array $params=null) <br />
/// Get the result of a SQL SELECT COUNT(...) query.<br />
</code><br />
<br />
===Seeing if one record exists===<br />
<code php><br />
o $DB->record_exists($table, array $conditions=null) <br />
/// Test whether a record exists in a table where all the given conditions met.<br />
o $DB->record_exists_select($table, $select, array $params=null) <br />
/// Test whether any records exists in a table which match a particular WHERE clause.<br />
o $DB->record_exists_sql($sql, array $params=null) <br />
/// Test whether a SQL SELECT statement returns any records.<br />
</code><br />
<br />
===Getting a single record===<br />
<code php><br />
o $DB->get_record($table, array $conditions, $fields='*', $ignoremultiple=false) <br />
/// Get a single database record as an object where all the given conditions met.<br />
o $DB->get_record_select($table, $select, array $params=null, $fields='*', $ignoremultiple=false)<br />
/// Get a single database record as an object which match a particular WHERE clause.<br />
o $DB->get_record_sql($sql, array $params=null)<br />
/// Get a single database record as an object using a SQL statement.<br />
</code><br />
<br />
===Getting an array of records===<br />
<code php><br />
o $DB->get_records($table, array $conditions=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) <br />
/// Get a number of records as an array of objects where all the given conditions met.<br />
o $DB->get_records_select($table, $select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) <br />
/// Get a number of records as an array of objects which match a particular WHERE clause.<br />
o $DB->get_records_sql($sql, array $params=null, $limitfrom=0, $limitnum=0)<br />
/// Get a number of records as an array of objects using a SQL statement.<br />
<br />
o $DB->get_records_menu($table, array $conditions=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) <br />
/// Get the first two columns from a number of records as an associative array where all the given conditions met.<br />
o $DB->get_records_select_menu($table, $select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0)<br />
/// Get the first two columns from a number of records as an associative array which match a particular WHERE clause.<br />
o $DB->get_records_sql_menu($sql, array $params=null, $limitfrom=0, $limitnum=0)<br />
/// Get the first two columns from a number of records as an associative array using a SQL statement.<br />
<br />
o $DB->get_records_list($table, $field='', $values='', $sort='', $fields='*', $limitfrom='', $limitnum='') <br />
/// Get a number of records as an array of objects where one field match one list of values.<br />
</code><br />
<br />
===Getting a particular field value from one record===<br />
<code php><br />
o $DB->get_field($table, $return, array $conditions)<br />
/// Get a single field value from a table record where all the given conditions met.<br />
o $DB->get_field_select($table, $return, $select, array $params=null)<br />
/// Get a single field value from a table record which match a particular WHERE clause.<br />
o $DB->get_field_sql($sql, array $params=null)<br />
/// Get a single field value (first field) using a SQL statement.<br />
</code><br />
<br />
===Getting a particular field value from various records===<br />
<br />
<code php><br />
o $DB->get_fieldset_select($table, $return, $select, array $params=null)<br />
/// Selects records and return values of chosen field as an array which match a particular WHERE clause.<br />
o $DB->get_fieldset_sql($sql, array $params=null)<br />
/// Selects records and return values (first field) as an array using a SQL statement.<br />
</code><br />
<br />
===Setting a particular field in the database===<br />
<code php><br />
o $DB->set_field($table, $newfield, $newvalue, array $conditions=null)<br />
/// Set a single field in every table record where all the given conditions met.<br />
o $DB->set_field_select($table, $newfield, $newvalue, $select, array $params=null)<br />
/// Set a single field in every table record which match a particular WHERE clause.<br />
</code><br />
<br />
===Deleting Records===<br />
<code php><br />
o $DB->delete_records($table, array $conditions=null) <br />
/// Delete the records from a table where all the given conditions met.<br />
o $DB->delete_records_select($table, $select, array $params=null)<br />
/// Delete one or more records from a table which match a particular WHERE clause.<br />
</code><br />
<br />
===Inserting Records===<br />
<code php><br />
o $DB->insert_record($table, $dataobject, $returnid=true, $bulk=false) <br />
/// Insert a record into a table and return the "id" field if required.<br />
</code><br />
<br />
===Updating Records===<br />
<code php><br />
o $DB->update_record($table, $dataobject, $bulk=false)<br />
/// Update a record in a table.<br />
</code><br />
<br />
===Using Recordsets===<br />
<br />
While the number of records to be retrieved from DB is high, the '''get_records_xxx()''' functions above are far from optimal, because they use to load all the records in memory at the same time. Under those circumstances, it's highly recommended to use this '''get_recordset_xxx()''' functions instead, which uses one nice mechanism to iterate over all the target records and save a lot of memory.<br />
<br />
Only one thing is '''absolutely important''': Don't forget to close the recordsets after using them! (This will free up a lot of resources in the RDBMS).<br />
<br />
Here is the general way to iterate over records using the '''get_recordset_xxx()''' functions:<br />
<br />
<code php><br />
if ($rs = $DB->get_recordset(....) {<br />
foreach ($rs as $record) {<br />
/// Do whatever you want with this record<br />
}<br />
$rs->close(); /// Don't forget to close the recordset!<br />
}<br />
</code><br />
<br />
And this is the list of available functions (100% paired with the get_records_xxx() above):<br />
<code php><br />
o $DB->get_recordset($table, array $conditions=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) <br />
/// Get a number of records as a moodle_recordset where all the given conditions met.<br />
o $DB->get_recordset_select($table, $select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) <br />
/// Get a number of records as a moodle_recordset which match a particular WHERE clause.<br />
o $DB->get_recordset_sql($sql, array $params=null, $limitfrom=0, $limitnum=0);<br />
/// Get a number of records as a moodle_recordset using a SQL statement.<br />
<br />
o $DB->get_recordset_list($table, $field='', $values='', $sort='', $fields='*', $limitfrom='', $limitnum='') <br />
/// Get a number of records as a moodle_recordset where one field matches one list of values.<br />
</code><br />
<br />
===Delegated transactions===<br />
<br />
* Please note some databases do not support transactions (such as the MyISAM MySQL database engine), however all server administrators are strongly encouraged to migrate to databases that support transactions (such as the InnoDB MySQL database engine).<br />
* Previous versions supported only one level of transaction. Since Moodle 2.0, the DML layer emulates delegated transactions that allow nesting of transactions.<br />
* Transactions should not be used much in Moodle core; they are intended for various plugins such as web services, enrol and auth plugins.<br />
* Some subsystems (such as messaging) do not support transactions because is it is not possible to rollback in external systems.<br />
<br />
A transaction is started by:<br />
<code php><br />
$transaction = $DB->start_delegated_transaction();<br />
</code><br />
<br />
and finished by:<br />
<code php><br />
$transaction->allow_commit();<br />
</code><br />
<br />
Usually a transaction is rolled back when an exception is thrown. <code>$transaction->rollback($ex);</code> must be used very carefully because it might break compatibility with databases that do not support transactions. Transactions cannot be used as part of expected code flow; they can be used only as an emergency protection of data consistency.<br />
<br />
See more details in [[Development:DB layer 2.0 delegated transactions]] or MDL-20625.<br />
<br />
===Helper Functions===<br />
<br />
In order have real cross-db compatibility, there are some helper functions used to build SQL fragments based on the DB Moodle is running. Using them we'll avoid conditional queries here and there and have those "incompatibilities" fixed once and for ever.<br />
<code php><br />
o $DB->sql_bitand($int1, $int2) <br />
/// Returns the SQL text to be used in order to perform one bitwise AND <br />
/// operation between 2 integers.<br />
o $DB->sql_bitnot($int1) <br />
/// Returns the SQL text to be used in order to perform one bitwise NOT <br />
/// operation with 1 integer.<br />
o $DB->sql_bitor($int1, $int2)<br />
/// Returns the SQL text to be used in order to perform one bitwise OR <br />
/// operation between 2 integers.<br />
o $DB->sql_bitxor($int1, $int2) <br />
/// Returns the SQL text to be used in order to perform one bitwise XOR <br />
/// operation between 2 integers.<br />
<br />
o $DB->sql_null_from_clause()<br />
/// Returns the FROM clause required by some DBs in all SELECT statements.<br />
<br />
o $DB->sql_ceil($fieldname)<br />
/// Returns the correct CEIL expression applied to fieldname.<br />
o $DB->sql_ilike()<br />
/// Returns the proper SQL to do LIKE in a case-insensitive way.<br />
o $DB->sql_length($fieldname)<br />
/// Returns the SQL text to be used to calculate the length in characters of one expression.<br />
o $DB->sql_modulo($int1, $int2)<br />
/// Returns the SQL text to be used in order to calculate module - remainder after division<br />
o $DB->sql_position($needle, $haystack)<br />
/// Returns the SQL for returning searching one string for the location of another.<br />
/// Note: If using placeholders BOTH in $needle and $haystack, they MUST be named placeholders.<br />
o $DB->sql_substr($expr, $start, $length=false)<br />
/// Returns the proper substr() SQL text used to extract substrings from DB.<br />
/// Note: This fuction has changed in Moodle 2.0 and now at least 2 params are mandatory.<br />
/// Note: Now it returns the whole SQL text to be used instead of only the function name.<br />
<br />
o $DB->sql_cast_char2int($fieldname, $text=false)<br />
/// Returns the SQL to be used in order to CAST one CHAR column to INTEGER.<br />
o $DB->sql_cast_char2real($fieldname, $text=false)<br />
/// Returns the SQL to be used in order to CAST one CHAR column to REAL number.<br />
<br />
o $DB->sql_compare_text($fieldname, $numchars=32) <br />
/// Returns the SQL text to be used to compare one TEXT (clob) column.<br />
/// with one VARCHAR column.<br />
o $DB->sql_order_by_text($fieldname, $numchars=32)<br />
/// Returns the SQL text to be used to order by one TEXT (clob) column.<br />
<br />
o $DB->sql_concat()<br />
/// Returns the proper SQL to do CONCAT between the elements passed.<br />
o $DB->sql_concat_join($separator="' '", $elements=array())<br />
/// Returns the proper SQL to do CONCAT between the elements passed using one separator.<br />
o $DB->sql_fullname($first='firstname', $last='lastname')<br />
/// Returns the proper SQL to concatenate $firstname and $lastname.<br />
<br />
o $DB->sql_isempty($tablename, $fieldname, $nullablefield, $textfield)<br />
/// Returns the proper SQL to know if one field is empty.<br />
o $DB->sql_isnotempty($tablename, $fieldname, $nullablefield, $textfield)<br />
/// Returns the proper SQL to know if one field is not empty.<br />
o $DB->sql_empty()<br />
/// Returns the empty string char used by every supported DB.<br />
</code><br />
<br />
==See also==<br />
<br />
* [[Development:DML exceptions|DML exceptions]]: New DML code is throwing exceptions instead of returning false if anything goes wrong<br />
* [[Development:DML drivers|DML drivers]]: Database drivers for new DML layer<br />
* [[Development:DML functions - pre 2.0|DML functions - pre 2.0]]: '''(deprecated!)''' For information valid before Moodle 2.0.<br />
* [[Development:DDL functions|DDL functions]]: Where all the functions used to handle DB objects ([[wikipedia:Data_Definition_Language|DDL]]) are defined.<br />
* [[Development:DB layer 2.0 examples|DB layer 2.0 examples]]: To see some code examples using various DML functions.<br />
* [[Development:DB layer 2.0 migration docs|DB layer 2.0 migration docs]]: Information about how to modify your code to work with the new Moodle 2.0 DB layer.<br />
* [[Development:DTL functions|DTL functions]]: Exporting, importing and moving of data stored in SQL databases<br />
<br />
[[Category:DB]]<br />
[[Category:XMLDB]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Broken/DML_functions&diff=78609Broken/DML functions2010-12-03T06:22:39Z<p>Bruno: /* Getting a single record */</p>
<hr />
<div>{{Moodle_2.0}}This page describes the functions available to access data in the Moodle database. You should '''exclusively''' use these functions in order to retrieve or modify database content because these functions provide a high level of abstraction and guarantee that your database manipulation will work against different RDBMSes.<br />
<br />
Where possible, tricks and examples will be documented here in order to make developers' lives a bit easier. Of course, feel free to clarify, complete and add more information to this documentation. It will be welcome, absolutely!<br />
<br />
== Main info ==<br />
<br />
'''Important note:''' All the functions shown on this page are for use in '''Moodle 2.0 upwards''', where we changed the [[Development:DB layer 2.0|DB layer]] to support some new features. If you need information for previous Moodle version, take a look to the [[Development:DML functions - pre 2.0|DML functions - pre 2.0]] page. For a detailed reference of changes, see the [[Development:DB layer 2.0 migration docs|migration docs]].<br />
<br />
* All the function calls on this page are public methods of the $DB global object, so you'll need to "import" it within your functions (not needed in global scripts) with one simple:<br />
<code php>global $DB;</code><br />
* All the $table parameters in the functions are meant to be the table name ''without'' prefixes.<br />
<code php>$user = $DB->get_record('user', array('id'=>'1');</code><br />
* When using the xxx_sql() functions, table names must be enclosed between curly braces.<br />
<code php>$user = $DB->get_record_sql('SELECT * FROM {user} WHERE id = ?', array(1));</code><br />
* All the $conditions parameters in the functions are arrays of fieldname=>fieldvalue elements.<br />
<code php>$user = $DB->get_record('user', array('firstname'=>'Martin', 'lastname'=>'Dougiamas'));</code><br />
* All the $params parameters in the functions are arrays of values used to fill placeholders in SQL statements. Both the question mark and named placeholders can be used. Note that named params '''must be unique''' even if the value passed is the same.<br />
<code php><br />
/// Question mark placeholders:<br />
$DB->get_record_sql('SELECT * FROM {user} WHERE firstname = ? AND lastname = ?', <br />
array('Martin', 'Dougiamas'));<br />
<br />
/// Named placeholders:<br />
$DB->get_record_sql('SELECT * FROM {user} WHERE firstname = :firstname AND lastname = :lastname',<br />
array('firstname'=>'Martin', 'lastname'=>'Dougiamas'));<br />
</code><br />
<br />
== The functions ==<br />
<br />
===Seeing how many records match a given criteria===<br />
<code php><br />
o $DB->count_records($table, array $conditions=null) <br />
/// Count the records in a table where all the given conditions met.<br />
o $DB->count_records_select($table, $select, array $params=null, $countitem="COUNT('x')") <br />
/// Count the records in a table which match a particular WHERE clause.<br />
o $DB->count_records_sql($sql, array $params=null) <br />
/// Get the result of a SQL SELECT COUNT(...) query.<br />
</code><br />
<br />
===Seeing if one record exists===<br />
<code php><br />
o $DB->record_exists($table, array $conditions=null) <br />
/// Test whether a record exists in a table where all the given conditions met.<br />
o $DB->record_exists_select($table, $select, array $params=null) <br />
/// Test whether any records exists in a table which match a particular WHERE clause.<br />
o $DB->record_exists_sql($sql, array $params=null) <br />
/// Test whether a SQL SELECT statement returns any records.<br />
</code><br />
<br />
===Getting a single record===<br />
<code php><br />
o $DB->get_record($table, array $conditions, $fields='*', $ignoremultiple=false) <br />
/// Get a single database record as an object where all the given conditions met.<br />
o $DB->get_record_select($table, $select, array $params=null, $fields='*', $ignoremultiple=false)<br />
/// Get a single database record as an object which match a particular WHERE clause.<br />
o $DB->get_record_sql($table, $sql, array $params=null)<br />
/// Get a single database record as an object using a SQL statement.<br />
</code><br />
<br />
===Getting an array of records===<br />
<code php><br />
o $DB->get_records($table, array $conditions=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) <br />
/// Get a number of records as an array of objects where all the given conditions met.<br />
o $DB->get_records_select($table, $select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) <br />
/// Get a number of records as an array of objects which match a particular WHERE clause.<br />
o $DB->get_records_sql($sql, array $params=null, $limitfrom=0, $limitnum=0)<br />
/// Get a number of records as an array of objects using a SQL statement.<br />
<br />
o $DB->get_records_menu($table, array $conditions=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) <br />
/// Get the first two columns from a number of records as an associative array where all the given conditions met.<br />
o $DB->get_records_select_menu($table, $select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0)<br />
/// Get the first two columns from a number of records as an associative array which match a particular WHERE clause.<br />
o $DB->get_records_sql_menu($sql, array $params=null, $limitfrom=0, $limitnum=0)<br />
/// Get the first two columns from a number of records as an associative array using a SQL statement.<br />
<br />
o $DB->get_records_list($table, $field='', $values='', $sort='', $fields='*', $limitfrom='', $limitnum='') <br />
/// Get a number of records as an array of objects where one field match one list of values.<br />
</code><br />
<br />
===Getting a particular field value from one record===<br />
<code php><br />
o $DB->get_field($table, $return, array $conditions)<br />
/// Get a single field value from a table record where all the given conditions met.<br />
o $DB->get_field_select($table, $return, $select, array $params=null)<br />
/// Get a single field value from a table record which match a particular WHERE clause.<br />
o $DB->get_field_sql($sql, array $params=null)<br />
/// Get a single field value (first field) using a SQL statement.<br />
</code><br />
<br />
===Getting a particular field value from various records===<br />
<br />
<code php><br />
o $DB->get_fieldset_select($table, $return, $select, array $params=null)<br />
/// Selects records and return values of chosen field as an array which match a particular WHERE clause.<br />
o $DB->get_fieldset_sql($sql, array $params=null)<br />
/// Selects records and return values (first field) as an array using a SQL statement.<br />
</code><br />
<br />
===Setting a particular field in the database===<br />
<code php><br />
o $DB->set_field($table, $newfield, $newvalue, array $conditions=null)<br />
/// Set a single field in every table record where all the given conditions met.<br />
o $DB->set_field_select($table, $newfield, $newvalue, $select, array $params=null)<br />
/// Set a single field in every table record which match a particular WHERE clause.<br />
</code><br />
<br />
===Deleting Records===<br />
<code php><br />
o $DB->delete_records($table, array $conditions=null) <br />
/// Delete the records from a table where all the given conditions met.<br />
o $DB->delete_records_select($table, $select, array $params=null)<br />
/// Delete one or more records from a table which match a particular WHERE clause.<br />
</code><br />
<br />
===Inserting Records===<br />
<code php><br />
o $DB->insert_record($table, $dataobject, $returnid=true, $bulk=false) <br />
/// Insert a record into a table and return the "id" field if required.<br />
</code><br />
<br />
===Updating Records===<br />
<code php><br />
o $DB->update_record($table, $dataobject, $bulk=false)<br />
/// Update a record in a table.<br />
</code><br />
<br />
===Using Recordsets===<br />
<br />
While the number of records to be retrieved from DB is high, the '''get_records_xxx()''' functions above are far from optimal, because they use to load all the records in memory at the same time. Under those circumstances, it's highly recommended to use this '''get_recordset_xxx()''' functions instead, which uses one nice mechanism to iterate over all the target records and save a lot of memory.<br />
<br />
Only one thing is '''absolutely important''': Don't forget to close the recordsets after using them! (This will free up a lot of resources in the RDBMS).<br />
<br />
Here is the general way to iterate over records using the '''get_recordset_xxx()''' functions:<br />
<br />
<code php><br />
if ($rs = $DB->get_recordset(....) {<br />
foreach ($rs as $record) {<br />
/// Do whatever you want with this record<br />
}<br />
$rs->close(); /// Don't forget to close the recordset!<br />
}<br />
</code><br />
<br />
And this is the list of available functions (100% paired with the get_records_xxx() above):<br />
<code php><br />
o $DB->get_recordset($table, array $conditions=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) <br />
/// Get a number of records as a moodle_recordset where all the given conditions met.<br />
o $DB->get_recordset_select($table, $select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) <br />
/// Get a number of records as a moodle_recordset which match a particular WHERE clause.<br />
o $DB->get_recordset_sql($sql, array $params=null, $limitfrom=0, $limitnum=0);<br />
/// Get a number of records as a moodle_recordset using a SQL statement.<br />
<br />
o $DB->get_recordset_list($table, $field='', $values='', $sort='', $fields='*', $limitfrom='', $limitnum='') <br />
/// Get a number of records as a moodle_recordset where one field matches one list of values.<br />
</code><br />
<br />
===Delegated transactions===<br />
<br />
* Please note some databases do not support transactions (such as the MyISAM MySQL database engine), however all server administrators are strongly encouraged to migrate to databases that support transactions (such as the InnoDB MySQL database engine).<br />
* Previous versions supported only one level of transaction. Since Moodle 2.0, the DML layer emulates delegated transactions that allow nesting of transactions.<br />
* Transactions should not be used much in Moodle core; they are intended for various plugins such as web services, enrol and auth plugins.<br />
* Some subsystems (such as messaging) do not support transactions because is it is not possible to rollback in external systems.<br />
<br />
A transaction is started by:<br />
<code php><br />
$transaction = $DB->start_delegated_transaction();<br />
</code><br />
<br />
and finished by:<br />
<code php><br />
$transaction->allow_commit();<br />
</code><br />
<br />
Usually a transaction is rolled back when an exception is thrown. <code>$transaction->rollback($ex);</code> must be used very carefully because it might break compatibility with databases that do not support transactions. Transactions cannot be used as part of expected code flow; they can be used only as an emergency protection of data consistency.<br />
<br />
See more details in [[Development:DB layer 2.0 delegated transactions]] or MDL-20625.<br />
<br />
===Helper Functions===<br />
<br />
In order have real cross-db compatibility, there are some helper functions used to build SQL fragments based on the DB Moodle is running. Using them we'll avoid conditional queries here and there and have those "incompatibilities" fixed once and for ever.<br />
<code php><br />
o $DB->sql_bitand($int1, $int2) <br />
/// Returns the SQL text to be used in order to perform one bitwise AND <br />
/// operation between 2 integers.<br />
o $DB->sql_bitnot($int1) <br />
/// Returns the SQL text to be used in order to perform one bitwise NOT <br />
/// operation with 1 integer.<br />
o $DB->sql_bitor($int1, $int2)<br />
/// Returns the SQL text to be used in order to perform one bitwise OR <br />
/// operation between 2 integers.<br />
o $DB->sql_bitxor($int1, $int2) <br />
/// Returns the SQL text to be used in order to perform one bitwise XOR <br />
/// operation between 2 integers.<br />
<br />
o $DB->sql_null_from_clause()<br />
/// Returns the FROM clause required by some DBs in all SELECT statements.<br />
<br />
o $DB->sql_ceil($fieldname)<br />
/// Returns the correct CEIL expression applied to fieldname.<br />
o $DB->sql_ilike()<br />
/// Returns the proper SQL to do LIKE in a case-insensitive way.<br />
o $DB->sql_length($fieldname)<br />
/// Returns the SQL text to be used to calculate the length in characters of one expression.<br />
o $DB->sql_modulo($int1, $int2)<br />
/// Returns the SQL text to be used in order to calculate module - remainder after division<br />
o $DB->sql_position($needle, $haystack)<br />
/// Returns the SQL for returning searching one string for the location of another.<br />
/// Note: If using placeholders BOTH in $needle and $haystack, they MUST be named placeholders.<br />
o $DB->sql_substr($expr, $start, $length=false)<br />
/// Returns the proper substr() SQL text used to extract substrings from DB.<br />
/// Note: This fuction has changed in Moodle 2.0 and now at least 2 params are mandatory.<br />
/// Note: Now it returns the whole SQL text to be used instead of only the function name.<br />
<br />
o $DB->sql_cast_char2int($fieldname, $text=false)<br />
/// Returns the SQL to be used in order to CAST one CHAR column to INTEGER.<br />
o $DB->sql_cast_char2real($fieldname, $text=false)<br />
/// Returns the SQL to be used in order to CAST one CHAR column to REAL number.<br />
<br />
o $DB->sql_compare_text($fieldname, $numchars=32) <br />
/// Returns the SQL text to be used to compare one TEXT (clob) column.<br />
/// with one VARCHAR column.<br />
o $DB->sql_order_by_text($fieldname, $numchars=32)<br />
/// Returns the SQL text to be used to order by one TEXT (clob) column.<br />
<br />
o $DB->sql_concat()<br />
/// Returns the proper SQL to do CONCAT between the elements passed.<br />
o $DB->sql_concat_join($separator="' '", $elements=array())<br />
/// Returns the proper SQL to do CONCAT between the elements passed using one separator.<br />
o $DB->sql_fullname($first='firstname', $last='lastname')<br />
/// Returns the proper SQL to concatenate $firstname and $lastname.<br />
<br />
o $DB->sql_isempty($tablename, $fieldname, $nullablefield, $textfield)<br />
/// Returns the proper SQL to know if one field is empty.<br />
o $DB->sql_isnotempty($tablename, $fieldname, $nullablefield, $textfield)<br />
/// Returns the proper SQL to know if one field is not empty.<br />
o $DB->sql_empty()<br />
/// Returns the empty string char used by every supported DB.<br />
</code><br />
<br />
==See also==<br />
<br />
* [[Development:DML exceptions|DML exceptions]]: New DML code is throwing exceptions instead of returning false if anything goes wrong<br />
* [[Development:DML drivers|DML drivers]]: Database drivers for new DML layer<br />
* [[Development:DML functions - pre 2.0|DML functions - pre 2.0]]: '''(deprecated!)''' For information valid before Moodle 2.0.<br />
* [[Development:DDL functions|DDL functions]]: Where all the functions used to handle DB objects ([[wikipedia:Data_Definition_Language|DDL]]) are defined.<br />
* [[Development:DB layer 2.0 examples|DB layer 2.0 examples]]: To see some code examples using various DML functions.<br />
* [[Development:DB layer 2.0 migration docs|DB layer 2.0 migration docs]]: Information about how to modify your code to work with the new Moodle 2.0 DB layer.<br />
* [[Development:DTL functions|DTL functions]]: Exporting, importing and moving of data stored in SQL databases<br />
<br />
[[Category:DB]]<br />
[[Category:XMLDB]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Usuari:Bruno_Vernier&diff=78533Usuari:Bruno Vernier2010-11-30T18:03:45Z<p>Bruno: New page: teacher in Vancouver, British Columbia , Canada</p>
<hr />
<div>teacher in Vancouver, British Columbia , Canada</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Migration_from_MyISAM_to_InnoDB&diff=78480Migration from MyISAM to InnoDB2010-11-30T00:34:49Z<p>Bruno: /* Difference between MyISAM and InnoDB */</p>
<hr />
<div>{{stub}}<br />
<br />
See [http://moodle.org/mod/forum/discuss.php?d=162871 Documentation for migration from MyISAM to InnoDB] for the current discussion which prompted the creation of this page. --[[User:Frank Ralf|Frank Ralf]] 11:41, 24 November 2010 (UTC)<br />
<br />
== MySQL Configuration ==<br />
Before attempting to change the table type, you should:<br />
* '''check InnoDB is enabled'''. Log in to MySQL and run the command [http://dev.mysql.com/doc/refman/5.1/en/show-engines.html SHOW ENGINES]. Make sure that support for InnoDB shows either "YES" or "DEFAULT".<br />
* '''set innodb_file_per_table if required'''. [http://dev.mysql.com/doc/refman/5.1/en/innodb-multiple-tablespaces.html This setting] can be useful for large installations, but it only affects newly created tables and can't be applied retrospectively.<br />
<br />
== Various Methods described in Moodle Forums (choose one)==<br />
* run the innodb script as a webpage http://www.YOUR_MOODLE_SITE/admin/innodb.php (there might be timeout issues on large databases and it only works with mysql)<br />
* use the CLI script in admin/cli/mysql_engine.php (requires access to shell, mysql only, and the config.php must only have one moodle instance, but has no timeout issues) <br />
* use PHPMyAdmin entering Structure view of a table and clicking Operations tab. Look for Storage Engine parameter. This is a tedious task due to the number of tables [http://moodle.org/mod/forum/discuss.php?d=162002]<br />
* perform a database dump (e.g. mysqldump moodle_database > dump.SQL), use an editor or sed/perl/awk command to find/replace , replacing MyISAM with InnoDB. Finally, restore back in the server. (e.g. mysql < dump.SQL or equivalent) <br />
<br />
== Difference between MyISAM and InnoDB ==<br />
* read [http://tag1consulting.com/MySQL_Engines_MyISAM_vs_InnoDB]<br />
* InnoDB is best for data integrity, not so good for searching large files, and uses up more CPU cycles and storage space than MyISAM equivalent <br />
* InnoDB is much younger than MyISAM but is becoming increasingly attractive ... but because it is more complex, some utilities written for MyISAM like mysqlhotcopy may not work<br />
* It is perfectly OK to select InnoDB for certain tables, and MyISAM for others (based on above criteria)<br />
[[fr:admin/innodb]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Migration_from_MyISAM_to_InnoDB&diff=78479Migration from MyISAM to InnoDB2010-11-30T00:33:27Z<p>Bruno: /* Various Methods described in Moodle Forums (choose one) */</p>
<hr />
<div>{{stub}}<br />
<br />
See [http://moodle.org/mod/forum/discuss.php?d=162871 Documentation for migration from MyISAM to InnoDB] for the current discussion which prompted the creation of this page. --[[User:Frank Ralf|Frank Ralf]] 11:41, 24 November 2010 (UTC)<br />
<br />
== MySQL Configuration ==<br />
Before attempting to change the table type, you should:<br />
* '''check InnoDB is enabled'''. Log in to MySQL and run the command [http://dev.mysql.com/doc/refman/5.1/en/show-engines.html SHOW ENGINES]. Make sure that support for InnoDB shows either "YES" or "DEFAULT".<br />
* '''set innodb_file_per_table if required'''. [http://dev.mysql.com/doc/refman/5.1/en/innodb-multiple-tablespaces.html This setting] can be useful for large installations, but it only affects newly created tables and can't be applied retrospectively.<br />
<br />
== Various Methods described in Moodle Forums (choose one)==<br />
* run the innodb script as a webpage http://www.YOUR_MOODLE_SITE/admin/innodb.php (there might be timeout issues on large databases and it only works with mysql)<br />
* use the CLI script in admin/cli/mysql_engine.php (requires access to shell, mysql only, and the config.php must only have one moodle instance, but has no timeout issues) <br />
* use PHPMyAdmin entering Structure view of a table and clicking Operations tab. Look for Storage Engine parameter. This is a tedious task due to the number of tables [http://moodle.org/mod/forum/discuss.php?d=162002]<br />
* perform a database dump (e.g. mysqldump moodle_database > dump.SQL), use an editor or sed/perl/awk command to find/replace , replacing MyISAM with InnoDB. Finally, restore back in the server. (e.g. mysql < dump.SQL or equivalent) <br />
<br />
== Difference between MyISAM and InnoDB ==<br />
* read [http://tag1consulting.com/MySQL_Engines_MyISAM_vs_InnoDB]<br />
* InnoDB is best for data integrity, not so good for searching large files, and uses up more CPU cycles and storage space than MyISAM equivalent <br />
* InnoDB is much younger than MyISAM but is becoming increasingly attractive ... but because it is more complex, some utilities written for MyISAM like mysqlhotcopy may not work<br />
<br />
[[fr:admin/innodb]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Migration_from_MyISAM_to_InnoDB&diff=78478Migration from MyISAM to InnoDB2010-11-30T00:24:10Z<p>Bruno: /* Various Methods described in Moodle Forums */</p>
<hr />
<div>{{stub}}<br />
<br />
See [http://moodle.org/mod/forum/discuss.php?d=162871 Documentation for migration from MyISAM to InnoDB] for the current discussion which prompted the creation of this page. --[[User:Frank Ralf|Frank Ralf]] 11:41, 24 November 2010 (UTC)<br />
<br />
== MySQL Configuration ==<br />
Before attempting to change the table type, you should:<br />
* '''check InnoDB is enabled'''. Log in to MySQL and run the command [http://dev.mysql.com/doc/refman/5.1/en/show-engines.html SHOW ENGINES]. Make sure that support for InnoDB shows either "YES" or "DEFAULT".<br />
* '''set innodb_file_per_table if required'''. [http://dev.mysql.com/doc/refman/5.1/en/innodb-multiple-tablespaces.html This setting] can be useful for large installations, but it only affects newly created tables and can't be applied retrospectively.<br />
<br />
== Various Methods described in Moodle Forums (choose one)==<br />
* run the innodb script as a webpage http://www.YOUR_MOODLE_SITE/admin/innodb.php (there might be timeout issues on large databases and it only works with mysql)<br />
* use the CLI script in admin/cli/mysql_engine.php (requires access to shell, mysql only, and the config.php must only have one moodle instance, but has no timeout issues) <br />
* use PHPMyAdmin entering Structure view of a table and clicking Operations tab. Look for Storage Engine parameter. This is a tedious task due to the number of tables [http://moodle.org/mod/forum/discuss.php?d=162002]<br />
* perform a database dump (e.g. mysqldump moodle_database > dump.SQL), use an editor or sed/perl/awk command to find/replace , replacing MyISAM with InnoDB. Finally, restore back in the server. (e.g. mysql < dump.SQL or equivalent) <br />
<br />
[[fr:admin/innodb]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Migration_from_MyISAM_to_InnoDB&diff=78477Migration from MyISAM to InnoDB2010-11-30T00:20:47Z<p>Bruno: /* Various Methods described in Moodle Forums */</p>
<hr />
<div>{{stub}}<br />
<br />
See [http://moodle.org/mod/forum/discuss.php?d=162871 Documentation for migration from MyISAM to InnoDB] for the current discussion which prompted the creation of this page. --[[User:Frank Ralf|Frank Ralf]] 11:41, 24 November 2010 (UTC)<br />
<br />
== MySQL Configuration ==<br />
Before attempting to change the table type, you should:<br />
* '''check InnoDB is enabled'''. Log in to MySQL and run the command [http://dev.mysql.com/doc/refman/5.1/en/show-engines.html SHOW ENGINES]. Make sure that support for InnoDB shows either "YES" or "DEFAULT".<br />
* '''set innodb_file_per_table if required'''. [http://dev.mysql.com/doc/refman/5.1/en/innodb-multiple-tablespaces.html This setting] can be useful for large installations, but it only affects newly created tables and can't be applied retrospectively.<br />
<br />
== Various Methods described in Moodle Forums==<br />
* run the innodb script as a webpage http://www.YOUR_MOODLE_SITE/admin/innodb.php (there might be timeout issues on large databases and it only works with mysql)<br />
* use the CLI script in admin/cli/mysql_engine.php (requires access to shell, mysql only, and the config.php must only have one moodle instance, but has no timeout issues) <br />
* use PHPMyAdmin entering Structure view of a table and clicking Operations tab. Look for Storage Engine parameter. This is a tedious task due to the number of tables [http://moodle.org/mod/forum/discuss.php?d=162002]<br />
* perform a database dump (e.g. mysqldump moodle_database > dump.SQL), use an editor or sed/perl/awk command to find/replace , replacing MyISAM with InnoDB. Finally, restore back in the server. (e.g. mysql < dump.SQL or equivalent) <br />
<br />
[[fr:admin/innodb]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Migration_from_MyISAM_to_InnoDB&diff=78476Migration from MyISAM to InnoDB2010-11-30T00:07:14Z<p>Bruno: /* Various Methods described in Moodle Forums */</p>
<hr />
<div>{{stub}}<br />
<br />
See [http://moodle.org/mod/forum/discuss.php?d=162871 Documentation for migration from MyISAM to InnoDB] for the current discussion which prompted the creation of this page. --[[User:Frank Ralf|Frank Ralf]] 11:41, 24 November 2010 (UTC)<br />
<br />
== MySQL Configuration ==<br />
Before attempting to change the table type, you should:<br />
* '''check InnoDB is enabled'''. Log in to MySQL and run the command [http://dev.mysql.com/doc/refman/5.1/en/show-engines.html SHOW ENGINES]. Make sure that support for InnoDB shows either "YES" or "DEFAULT".<br />
* '''set innodb_file_per_table if required'''. [http://dev.mysql.com/doc/refman/5.1/en/innodb-multiple-tablespaces.html This setting] can be useful for large installations, but it only affects newly created tables and can't be applied retrospectively.<br />
<br />
== Various Methods described in Moodle Forums==<br />
* run the innodb script as a webpage http://www.YOUR_MOODLE_SITE/admin/innodb.php (there might be timeout issues on large databases and it only works with mysql)<br />
* use the CLI script in admin/cli/mysql_engine.php (requires access to shell, mysql only, and the config.php must only have one moodle instance, but has no timeout issues) <br />
* use PHPMyAdmin entering Structure view of a table and clicking Operations tab. Look for Storage Engine parameter. This is a tedious task due to the number of tables [http://moodle.org/mod/forum/discuss.php?d=162002]<br />
<br />
[[fr:admin/innodb]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Migration_from_MyISAM_to_InnoDB&diff=78475Migration from MyISAM to InnoDB2010-11-30T00:06:11Z<p>Bruno: /* Various Methods described in Moodle Forums */</p>
<hr />
<div>{{stub}}<br />
<br />
See [http://moodle.org/mod/forum/discuss.php?d=162871 Documentation for migration from MyISAM to InnoDB] for the current discussion which prompted the creation of this page. --[[User:Frank Ralf|Frank Ralf]] 11:41, 24 November 2010 (UTC)<br />
<br />
== MySQL Configuration ==<br />
Before attempting to change the table type, you should:<br />
* '''check InnoDB is enabled'''. Log in to MySQL and run the command [http://dev.mysql.com/doc/refman/5.1/en/show-engines.html SHOW ENGINES]. Make sure that support for InnoDB shows either "YES" or "DEFAULT".<br />
* '''set innodb_file_per_table if required'''. [http://dev.mysql.com/doc/refman/5.1/en/innodb-multiple-tablespaces.html This setting] can be useful for large installations, but it only affects newly created tables and can't be applied retrospectively.<br />
<br />
== Various Methods described in Moodle Forums==<br />
* run the innodb script as a webpage http://www.mymoodle.com/admin/innodb.php (there might be timeout issues on large databases and it only works with mysql)<br />
* use the CLI script in admin/cli/mysql_engine.php (requires access to shell, mysql only, and the config.php must only have one moodle instance) <br />
* use PHPMyAdmin entering Structure view of a table and clicking Operations tab. Look for Storage Engine parameter. This is a tedious task due to the number of tables [http://moodle.org/mod/forum/discuss.php?d=162002]<br />
<br />
[[fr:admin/innodb]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Migration_from_MyISAM_to_InnoDB&diff=78474Migration from MyISAM to InnoDB2010-11-29T23:46:46Z<p>Bruno: /* Various Methods described in Moodle Forums */</p>
<hr />
<div>{{stub}}<br />
<br />
See [http://moodle.org/mod/forum/discuss.php?d=162871 Documentation for migration from MyISAM to InnoDB] for the current discussion which prompted the creation of this page. --[[User:Frank Ralf|Frank Ralf]] 11:41, 24 November 2010 (UTC)<br />
<br />
== MySQL Configuration ==<br />
Before attempting to change the table type, you should:<br />
* '''check InnoDB is enabled'''. Log in to MySQL and run the command [http://dev.mysql.com/doc/refman/5.1/en/show-engines.html SHOW ENGINES]. Make sure that support for InnoDB shows either "YES" or "DEFAULT".<br />
* '''set innodb_file_per_table if required'''. [http://dev.mysql.com/doc/refman/5.1/en/innodb-multiple-tablespaces.html This setting] can be useful for large installations, but it only affects newly created tables and can't be applied retrospectively.<br />
<br />
== Various Methods described in Moodle Forums==<br />
* use the CLI script in admin/cli/mysql_engine.php (requires access to shell, mysql only, and the config.php must only have one moodle instance) <br />
* use PHPMyAdmin entering Structure view of a table and clicking Operations tab. Look for Storage Engine parameter. This is a tedious task due to the number of tables [http://moodle.org/mod/forum/discuss.php?d=162002]<br />
<br />
[[fr:admin/innodb]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Migration_from_MyISAM_to_InnoDB&diff=78473Migration from MyISAM to InnoDB2010-11-29T23:44:52Z<p>Bruno: </p>
<hr />
<div>{{stub}}<br />
<br />
See [http://moodle.org/mod/forum/discuss.php?d=162871 Documentation for migration from MyISAM to InnoDB] for the current discussion which prompted the creation of this page. --[[User:Frank Ralf|Frank Ralf]] 11:41, 24 November 2010 (UTC)<br />
<br />
== MySQL Configuration ==<br />
Before attempting to change the table type, you should:<br />
* '''check InnoDB is enabled'''. Log in to MySQL and run the command [http://dev.mysql.com/doc/refman/5.1/en/show-engines.html SHOW ENGINES]. Make sure that support for InnoDB shows either "YES" or "DEFAULT".<br />
* '''set innodb_file_per_table if required'''. [http://dev.mysql.com/doc/refman/5.1/en/innodb-multiple-tablespaces.html This setting] can be useful for large installations, but it only affects newly created tables and can't be applied retrospectively.<br />
<br />
== Various Methods described in Moodle Forums==<br />
* use the CLI script in admin/cli/mysql_engine.php (requires access to shell, mysql only, and the config.php must only have one moodle instance) <br />
<br />
[[fr:admin/innodb]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=MNet&diff=78406MNet2010-11-29T01:05:18Z<p>Bruno: /* Setup */</p>
<hr />
<div>The network feature allows a Moodle administrator to establish a link with another Moodle, and to share some resources with the users of that Moodle. This features was introduced in Moodle 1.8.<br />
<br />
==Overview==<br />
The initial release of MNet is bundled with a Authentication Plugin, which makes single-sign-on between Moodles possible. A user with the username <em>jody</em> logs in to her Moodle server as normal, and clicks on a link that takes her to a page on another Moodle server. Normally, she would have only the privileges of a guest on the remote Moodle, but behind the scenes, single-sign-on has established a fully authenticated session for Jody on the remote site.<br />
<br />
'''WARNING:''' MNet requires the use of '''xmlrpc'''. Please go to your phpinfo page if you are interested in using this and search for --with-xmlrpc. If your php has not been compiled with xmlrpc then you need to address that first! At present it appears that PEAR xmlrpc will not work.<br />
[[Image:Administration Block Users Authentication MoodleNetwork.jpg|thumb|MNet setting in ''Admin > User > Authentication > Moodle Network]]<br />
<br />
==Security==<br />
The MNet feature requires that your server has the '''Curl''' and '''OpenSSL''' extensions installed. When you install or upgrade to Moodle 1.8, your system will generate a new OpenSSL certificate for encrypted communication with other Moodles, and will thereafter rotate encryption keys on a monthly basis (approx).<br />
<br />
Communication takes place over an XML-RPC transport, and the XML-RPC documents are wrapped first in an XMLDSIG (XML digital signature) envelope, and then in an XMLENC (XML encryption) envelope. The encryption all happens within PHP, and does not require an https (Apache SSL) server.<br />
<br />
References:<br />
*[http://www.w3.org/TR/xmldsig-core/ XML Digital Signatures]<br />
*[http://www.w3.org/TR/xmlenc-core/ XML Encryption]<br />
<br />
A special mode can be enabled which would allow a machine with a specified IP address to make calls to the XML-RPC layer without using either encryption or signature envelopes. This mode is provided to enable Moodle to communicate with other software systems in which the integration of signatures and encryption might be prohibitively difficult. It is not envisioned that unencrypted inter-Moodle networking will ever be enabled.<br />
<br />
==Peer to Peer Network==<br />
<br />
This is the basic layout of the system. It can be very useful to run one Moodle per faculty or departments, each with its own user management, and yet permit users to roam across the Moodle installs... subject to permissions of course. <br />
<br />
===Setup===<br />
<br />
The instructions will cover 2 Moodle installations: MoodleA and MoodleB. Both are installed correctly and have never had a Moodle Network configuration.<br />
<br />
Note: If you experience problems, ensure debugging is turned on in ''Site Administration > Server > Debugging''. Extra diagnostic messages may be displayed (particularly from Moodle 1.9.2)<br />
<br />
# Get them to talk to each other<br />
## Ensure ''Admin > Server > Environment'' indicates you have curl installed<br />
## If MoodleA and MoodleB are hosted in the same domain, ensure they have a different cookie prefix. Note that changing the cookie prefix will log you out! You can change the cookie prefix via ''Admin > Server > Session Handling''.<br />
## On both, go to ''Admin > Network > Settings'' and turn Networking ON.<br />
## On MoodleA go to ''Admin > Network > Peers'' - put the URL of MoodleB under "Add New Host" and click Add. The URL should include the directory where your Moodle code is located, for example ''www.mymoodle.org/moodle''.<br />
## Do the equivalent on MoodleB.<br />
# Get user roaming going<br />
## (skip this step for moodle 2.0 sites [http://moodle.org/mod/forum/discuss.php?d=141491] ) '' On both, go to ''Administration > Plugins > Authentication > Manage authentication'' in 2.0 onwards or ''Administration > Users > Authentication > Manage authentication'' in 1.9 and enable Moodle Network authentication plugin. Click on 'Settings' and enable auto_add_remote_users.''<br />
## On MoodleA go to ''Admin > Networking > (Manage) Peers'', click on 'MoodleB', and click on 'Services'. Enable SSO-IDP publish and subscribe, and SSO-SP publish and subscribe.<br />
## Do the equivalent on MoodleB.<br />
## On both, go to ''Admin > Users > Permissions > Define Roles'', only roles that have "Roam to a remote Moodle moodle/site:mnetlogintoremote" will be allowed to roam. Grant the privilege as appropriate.<br />
## On both, go to the homepage, and add the 'Network Servers' block.<br />
## To test, it is recommended to use a different browser (even on a different machine) that is logged in to neither. Login to MoodleA with a non-administrator account that has the permissions to roam. You should see the Network Servers block, and clicking on it you should go to MoodleB with a newly autocreated account. <br />
# Get remote enrolments going -- this is optional. It allows an administrator of MoodleB to enrol users that are "native" to MoodleB in remote courses in MoodleA, and viceversa.<br />
## On both, go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' in 2.0 onwards or ''Administration > Courses > Enrolments'' pre-2.0 and enable Moodle Network enrolment plugin (click Save). Click on 'Edit' and enable 'allow_allcourses' or select some courses or categories to be remotely enrolled.<br />
## On MoodleA go to ''Admin > Network > Peers'', click on 'MoodleB', and click on 'Services'. Enable Enrolment publish and subscribe.<br />
## Do the equivalent on MoodleB.<br />
## To use, in MoodleA go to ''Admin > Networking > Enrolments''. You will see MoodleB listed. Click on MoodleB and you will see a list of courses that MoodleB offers for remote enrolment. Select the course you want, and then enroll the users you want to that course.<br />
<br />
===Using it===<br />
<br />
==Connecting to a Mnet hub==<br />
A Mnet hub (do not confuse it with the [[Community hub]] project of Moodle 2.0) is a Moodle server that is configured to accept connections from other Moodle servers, and to provide a set of services to users of these other servers. This guideline will direct you to connect to a Mnet hub, assess the services it has to offer, and enable those services for your users.<br />
<br />
===Setup===<br />
# Get talking to the Hub<br />
## Ensure that the ''Admin > Server > Environment'' page indicates you have curl and openssl installed<br />
## Go to ''Admin > Network > Settings'' and turn Networking on<br />
## Go to ''Admin > Network > Peers'' and enter the URL of Mnet Hub under "Add New Host". Click <em>Add</em><br />
## The host details for the Mnet Hub should appear with the Site Name field already populated. Click <em>Save changes</em><br />
## The details will be written to your database and two new tabs will appear in this window: 'Services' and 'Logs'. Click <em>Services</em><br />
##A list of services will appear, each with a checkbox for 'publish' and 'subscribe'. Check the checkboxes for any services you want to publish or subscribe to<br />
<br />
===Using it===<br />
If the Mnet Hub has already enabled a service for you, there will be a tick alongside the appropriate checkbox, for example: if the Hub is <em>publishing</em> Moodle Networked Enrolment, then a tick will appear alongside the <em>subscribe</em> checkbox for this service. Note that in order to enable some functionality, prominently <em>single-sign-on</em>, you may have to <em>publish</em> a service, e.g. the <em>Identity Provider</em> service. The Mnet Hub will access this service on your Moodle, asking it to authenticate your users.<br />
# Enable Roaming<br />
## Subscribe to <em>SSO (Service Provider)</em> by checking the box<br />
## Publish <em>SSO (Identity Provider)</em> by checking the box<br />
## Click <em>Save changes</em><br />
## Go to ''Admin > Users > Permissions > Define Roles'', and grant the capability <em>Roam to a remote Moodle moodle/site:mnetlogintoremote</em> to an appropriate role<br />
## Go to ''Administration > Plugins > Authentication > Manage authentication'' in 2.0 onwards or ''Administration > Users > Authentication > Manage authentication'' in 1.9 and enable the <em>Moodle Network authentication</em> plugin<br />
## Go to your homepage, turn on editing, and add the 'Network Servers' block<br />
## Using a different web-browser, log on as a non-admin user who inhabits the role you granted the roaming capability to<br />
## Note that the Mnet Hub is listed in the Network Servers block on the homepage. Click on the link to that server<br />
## Some of your user details will be transferred to the Mnet Hub server, and a browsing session will be started for you as if you had logged on there directly<br />
# Enable Networked Enrolment<br />
## Return to the web browser you've been using as the site administrator<br />
## Go to ''Admin > Network > Peers'' and click on the entry for the Mnet Hub.<br />
## Click on the Services tab<br />
## Subscribe to <em>Moodle Networked Enrolment</em><br />
## Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' in 2.0 onwards or ''Administration > Courses > Enrolments'' pre-2.0 and enable the <em>Moodle Network enrolment</em> plugin. Click <em>Save changes</em><br />
## Click on <em>edit</em> to view the details for networked enrolments.<br />
## Go to ''Admin > Networking > Enrolments'' to see a list of Moodle servers that offer this service to you<br />
## Click on a server name to view a list of courses that the server offers to your users<br />
## Click on a course name, to view a list users that you can enrol in this course<br />
## Enrol users<br />
## Profit!<br />
<br />
==Running a Mnet hub==<br />
A Mnet hub is a regular Moodle site that runs in a special mode. As a Moodle Administrator, when you add another Moodle site to your list of network peers, your Moodle will contact that site to find out what it is called, and to request its public key for encrypted communication. Normally, the remote server will simply provide this information without making any record of the transaction.<br />
<br />
A Mnet hub is different. As soon as you add an entry for a Mnet hub to your system, the Mnet hub will create an entry for your server in its list of hosts, and may immediately begin to offer services to the users of your site.<br />
<br />
This section will guide you to set up a Mnet hub, and select services to offer to all comers.<br />
<br />
===Setup===<br />
# Enable Networking<br />
## Ensure that the ''Admin > Server > Environment'' page indicates you have curl and openssl installed<br />
## Go to ''Admin > Network > Settings'' and turn Networking on <br />
## Go to ''Admin > Network > Peers'' and tick the checkbox for <em>Register all hosts</em>. Click on <em>Save Changes</em><br />
## On the same page, the first entry in your list of hosts should be <em>All hosts</em>. Click this link<br />
## Click on <em>Services</em> and enable any services you want to offer to all comers<br />
<br />
==See also==<br />
<br />
* [[Moodle Network FAQ]]<br />
* [[Development:Moodle Network|Moodle Network development notes]]<br />
* Using Moodle [http://moodle.org/mod/forum/view.php?id=6976 MNet forum]<br />
* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=92749 Examples of how people are using Moodle networks] forum discussion<br />
<br />
[[Category:Authentication]]<br />
[[Category:Enrolment]]<br />
[[Category:MNet]]<br />
<br />
[[fr:Réseau Moodle]]<br />
[[ja:Moodleネットワーク]]<br />
[[es:Red Moodle]]<br />
[[cs:Síťové služby]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=MNet&diff=78405MNet2010-11-29T00:34:53Z<p>Bruno: /* Setup */</p>
<hr />
<div>The network feature allows a Moodle administrator to establish a link with another Moodle, and to share some resources with the users of that Moodle. This features was introduced in Moodle 1.8.<br />
<br />
==Overview==<br />
The initial release of MNet is bundled with a Authentication Plugin, which makes single-sign-on between Moodles possible. A user with the username <em>jody</em> logs in to her Moodle server as normal, and clicks on a link that takes her to a page on another Moodle server. Normally, she would have only the privileges of a guest on the remote Moodle, but behind the scenes, single-sign-on has established a fully authenticated session for Jody on the remote site.<br />
<br />
'''WARNING:''' MNet requires the use of '''xmlrpc'''. Please go to your phpinfo page if you are interested in using this and search for --with-xmlrpc. If your php has not been compiled with xmlrpc then you need to address that first! At present it appears that PEAR xmlrpc will not work.<br />
[[Image:Administration Block Users Authentication MoodleNetwork.jpg|thumb|MNet setting in ''Admin > User > Authentication > Moodle Network]]<br />
<br />
==Security==<br />
The MNet feature requires that your server has the '''Curl''' and '''OpenSSL''' extensions installed. When you install or upgrade to Moodle 1.8, your system will generate a new OpenSSL certificate for encrypted communication with other Moodles, and will thereafter rotate encryption keys on a monthly basis (approx).<br />
<br />
Communication takes place over an XML-RPC transport, and the XML-RPC documents are wrapped first in an XMLDSIG (XML digital signature) envelope, and then in an XMLENC (XML encryption) envelope. The encryption all happens within PHP, and does not require an https (Apache SSL) server.<br />
<br />
References:<br />
*[http://www.w3.org/TR/xmldsig-core/ XML Digital Signatures]<br />
*[http://www.w3.org/TR/xmlenc-core/ XML Encryption]<br />
<br />
A special mode can be enabled which would allow a machine with a specified IP address to make calls to the XML-RPC layer without using either encryption or signature envelopes. This mode is provided to enable Moodle to communicate with other software systems in which the integration of signatures and encryption might be prohibitively difficult. It is not envisioned that unencrypted inter-Moodle networking will ever be enabled.<br />
<br />
==Peer to Peer Network==<br />
<br />
This is the basic layout of the system. It can be very useful to run one Moodle per faculty or departments, each with its own user management, and yet permit users to roam across the Moodle installs... subject to permissions of course. <br />
<br />
===Setup===<br />
<br />
The instructions will cover 2 Moodle installations: MoodleA and MoodleB. Both are installed correctly and have never had a Moodle Network configuration.<br />
<br />
Note: If you experience problems, ensure debugging is turned on in ''Site Administration > Server > Debugging''. Extra diagnostic messages may be displayed (particularly from Moodle 1.9.2)<br />
<br />
# Get them to talk to each other<br />
## Ensure ''Admin > Server > Environment'' indicates you have curl installed<br />
## If MoodleA and MoodleB are hosted in the same domain, ensure they have a different cookie prefix. Note that changing the cookie prefix will log you out! You can change the cookie prefix via ''Admin > Server > Session Handling''.<br />
## On both, go to ''Admin > Network > Settings'' and turn Networking ON.<br />
## On MoodleA go to ''Admin > Network > Peers'' - put the URL of MoodleB under "Add New Host" and click Add. The URL should include the directory where your Moodle code is located, for example ''www.mymoodle.org/moodle''.<br />
## Do the equivalent on MoodleB.<br />
# Get user roaming going<br />
## (skip this step, it is deprecated [http://moodle.org/mod/forum/discuss.php?d=141491] ) '' On both, go to ''Administration > Plugins > Authentication > Manage authentication'' in 2.0 onwards or ''Administration > Users > Authentication > Manage authentication'' in 1.9 and enable Moodle Network authentication plugin. Click on 'Settings' and enable auto_add_remote_users.''<br />
## On MoodleA go to ''Admin > Networking > (Manage) Peers'', click on 'MoodleB', and click on 'Services'. Enable SSO-IDP publish and subscribe, and SSO-SP publish and subscribe.<br />
## Do the equivalent on MoodleB.<br />
## On both, go to ''Admin > Users > Permissions > Define Roles'', only roles that have "Roam to a remote Moodle moodle/site:mnetlogintoremote" will be allowed to roam. Grant the privilege as appropriate.<br />
## On both, go to the homepage, and add the 'Network Servers' block.<br />
## To test, it is recommended to use a different browser (even on a different machine) that is logged in to neither. Login to MoodleA with a non-administrator account that has the permissions to roam. You should see the Network Servers block, and clicking on it you should go to MoodleB with a newly autocreated account. <br />
# Get remote enrolments going -- this is optional. It allows administrator of MoodleB can enrol users that are "native" to MoodleB in courses in MoodleA, and viceversa.<br />
## On both, go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' in 2.0 onwards or ''Administration > Courses > Enrolments'' pre-2.0 and enable Moodle Network enrolment plugin (click Save). Click on 'Edit' and enable 'allow_allcourses' or select some courses or categories to be remotely enrolled.<br />
## On MoodleA go to ''Admin > Network > Peers'', click on 'MoodleB', and click on 'Services'. Enable Enrolment publish and subscribe.<br />
## Do the equivalent on MoodleB.<br />
## To use, in MoodleA go to ''Admin > Networking > Enrolments''. You will see MoodleB listed. Click on MoodleB and you will see a list of courses that MoodleB offers for remote enrolment. Select the course you want, and then enroll the users you want to that course.<br />
<br />
===Using it===<br />
<br />
==Connecting to a Mnet hub==<br />
A Mnet hub (do not confuse it with the [[Community hub]] project of Moodle 2.0) is a Moodle server that is configured to accept connections from other Moodle servers, and to provide a set of services to users of these other servers. This guideline will direct you to connect to a Mnet hub, assess the services it has to offer, and enable those services for your users.<br />
<br />
===Setup===<br />
# Get talking to the Hub<br />
## Ensure that the ''Admin > Server > Environment'' page indicates you have curl and openssl installed<br />
## Go to ''Admin > Network > Settings'' and turn Networking on<br />
## Go to ''Admin > Network > Peers'' and enter the URL of Mnet Hub under "Add New Host". Click <em>Add</em><br />
## The host details for the Mnet Hub should appear with the Site Name field already populated. Click <em>Save changes</em><br />
## The details will be written to your database and two new tabs will appear in this window: 'Services' and 'Logs'. Click <em>Services</em><br />
##A list of services will appear, each with a checkbox for 'publish' and 'subscribe'. Check the checkboxes for any services you want to publish or subscribe to<br />
<br />
===Using it===<br />
If the Mnet Hub has already enabled a service for you, there will be a tick alongside the appropriate checkbox, for example: if the Hub is <em>publishing</em> Moodle Networked Enrolment, then a tick will appear alongside the <em>subscribe</em> checkbox for this service. Note that in order to enable some functionality, prominently <em>single-sign-on</em>, you may have to <em>publish</em> a service, e.g. the <em>Identity Provider</em> service. The Mnet Hub will access this service on your Moodle, asking it to authenticate your users.<br />
# Enable Roaming<br />
## Subscribe to <em>SSO (Service Provider)</em> by checking the box<br />
## Publish <em>SSO (Identity Provider)</em> by checking the box<br />
## Click <em>Save changes</em><br />
## Go to ''Admin > Users > Permissions > Define Roles'', and grant the capability <em>Roam to a remote Moodle moodle/site:mnetlogintoremote</em> to an appropriate role<br />
## Go to ''Administration > Plugins > Authentication > Manage authentication'' in 2.0 onwards or ''Administration > Users > Authentication > Manage authentication'' in 1.9 and enable the <em>Moodle Network authentication</em> plugin<br />
## Go to your homepage, turn on editing, and add the 'Network Servers' block<br />
## Using a different web-browser, log on as a non-admin user who inhabits the role you granted the roaming capability to<br />
## Note that the Mnet Hub is listed in the Network Servers block on the homepage. Click on the link to that server<br />
## Some of your user details will be transferred to the Mnet Hub server, and a browsing session will be started for you as if you had logged on there directly<br />
# Enable Networked Enrolment<br />
## Return to the web browser you've been using as the site administrator<br />
## Go to ''Admin > Network > Peers'' and click on the entry for the Mnet Hub.<br />
## Click on the Services tab<br />
## Subscribe to <em>Moodle Networked Enrolment</em><br />
## Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' in 2.0 onwards or ''Administration > Courses > Enrolments'' pre-2.0 and enable the <em>Moodle Network enrolment</em> plugin. Click <em>Save changes</em><br />
## Click on <em>edit</em> to view the details for networked enrolments.<br />
## Go to ''Admin > Networking > Enrolments'' to see a list of Moodle servers that offer this service to you<br />
## Click on a server name to view a list of courses that the server offers to your users<br />
## Click on a course name, to view a list users that you can enrol in this course<br />
## Enrol users<br />
## Profit!<br />
<br />
==Running a Mnet hub==<br />
A Mnet hub is a regular Moodle site that runs in a special mode. As a Moodle Administrator, when you add another Moodle site to your list of network peers, your Moodle will contact that site to find out what it is called, and to request its public key for encrypted communication. Normally, the remote server will simply provide this information without making any record of the transaction.<br />
<br />
A Mnet hub is different. As soon as you add an entry for a Mnet hub to your system, the Mnet hub will create an entry for your server in its list of hosts, and may immediately begin to offer services to the users of your site.<br />
<br />
This section will guide you to set up a Mnet hub, and select services to offer to all comers.<br />
<br />
===Setup===<br />
# Enable Networking<br />
## Ensure that the ''Admin > Server > Environment'' page indicates you have curl and openssl installed<br />
## Go to ''Admin > Network > Settings'' and turn Networking on <br />
## Go to ''Admin > Network > Peers'' and tick the checkbox for <em>Register all hosts</em>. Click on <em>Save Changes</em><br />
## On the same page, the first entry in your list of hosts should be <em>All hosts</em>. Click this link<br />
## Click on <em>Services</em> and enable any services you want to offer to all comers<br />
<br />
==See also==<br />
<br />
* [[Moodle Network FAQ]]<br />
* [[Development:Moodle Network|Moodle Network development notes]]<br />
* Using Moodle [http://moodle.org/mod/forum/view.php?id=6976 MNet forum]<br />
* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=92749 Examples of how people are using Moodle networks] forum discussion<br />
<br />
[[Category:Authentication]]<br />
[[Category:Enrolment]]<br />
[[Category:MNet]]<br />
<br />
[[fr:Réseau Moodle]]<br />
[[ja:Moodleネットワーク]]<br />
[[es:Red Moodle]]<br />
[[cs:Síťové služby]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=MNet&diff=78404MNet2010-11-29T00:32:03Z<p>Bruno: /* Setup */</p>
<hr />
<div>The network feature allows a Moodle administrator to establish a link with another Moodle, and to share some resources with the users of that Moodle. This features was introduced in Moodle 1.8.<br />
<br />
==Overview==<br />
The initial release of MNet is bundled with a Authentication Plugin, which makes single-sign-on between Moodles possible. A user with the username <em>jody</em> logs in to her Moodle server as normal, and clicks on a link that takes her to a page on another Moodle server. Normally, she would have only the privileges of a guest on the remote Moodle, but behind the scenes, single-sign-on has established a fully authenticated session for Jody on the remote site.<br />
<br />
'''WARNING:''' MNet requires the use of '''xmlrpc'''. Please go to your phpinfo page if you are interested in using this and search for --with-xmlrpc. If your php has not been compiled with xmlrpc then you need to address that first! At present it appears that PEAR xmlrpc will not work.<br />
[[Image:Administration Block Users Authentication MoodleNetwork.jpg|thumb|MNet setting in ''Admin > User > Authentication > Moodle Network]]<br />
<br />
==Security==<br />
The MNet feature requires that your server has the '''Curl''' and '''OpenSSL''' extensions installed. When you install or upgrade to Moodle 1.8, your system will generate a new OpenSSL certificate for encrypted communication with other Moodles, and will thereafter rotate encryption keys on a monthly basis (approx).<br />
<br />
Communication takes place over an XML-RPC transport, and the XML-RPC documents are wrapped first in an XMLDSIG (XML digital signature) envelope, and then in an XMLENC (XML encryption) envelope. The encryption all happens within PHP, and does not require an https (Apache SSL) server.<br />
<br />
References:<br />
*[http://www.w3.org/TR/xmldsig-core/ XML Digital Signatures]<br />
*[http://www.w3.org/TR/xmlenc-core/ XML Encryption]<br />
<br />
A special mode can be enabled which would allow a machine with a specified IP address to make calls to the XML-RPC layer without using either encryption or signature envelopes. This mode is provided to enable Moodle to communicate with other software systems in which the integration of signatures and encryption might be prohibitively difficult. It is not envisioned that unencrypted inter-Moodle networking will ever be enabled.<br />
<br />
==Peer to Peer Network==<br />
<br />
This is the basic layout of the system. It can be very useful to run one Moodle per faculty or departments, each with its own user management, and yet permit users to roam across the Moodle installs... subject to permissions of course. <br />
<br />
===Setup===<br />
<br />
The instructions will cover 2 Moodle installations: MoodleA and MoodleB. Both are installed correctly and have never had a Moodle Network configuration.<br />
<br />
Note: If you experience problems, ensure debugging is turned on in ''Site Administration > Server > Debugging''. Extra diagnostic messages may be displayed (particularly from Moodle 1.9.2)<br />
<br />
# Get them to talk to each other<br />
## Ensure ''Admin > Server > Environment'' indicates you have curl installed<br />
## If MoodleA and MoodleB are hosted in the same domain, ensure they have a different cookie prefix. Note that changing the cookie prefix will log you out! You can change the cookie prefix via ''Admin > Server > Session Handling''.<br />
## On both, go to ''Admin > Network > Settings'' and turn Networking ON.<br />
## On MoodleA go to ''Admin > Network > Peers'' - put the URL of MoodleB under "Add New Host" and click Add. The URL should include the directory where your Moodle code is located, for example ''www.mymoodle.org/moodle''.<br />
## Do the equivalent on MoodleB.<br />
# Get user roaming going<br />
## (skip this step, it is deprecated [http://moodle.org/mod/forum/discuss.php?d=141491] ) '' On both, go to ''Administration > Plugins > Authentication > Manage authentication'' in 2.0 onwards or ''Administration > Users > Authentication > Manage authentication'' in 1.9 and enable Moodle Network authentication plugin. Click on 'Settings' and enable auto_add_remote_users.''<br />
## On MoodleA go to ''Admin > Network > Peers'', click on 'MoodleB', and click on 'Services'. Enable SSO-IDP publish and subscribe, and SSO-SP publish and subscribe.<br />
## Do the equivalent on MoodleB.<br />
## On both, go to ''Admin > Users > Permissions > Define Roles'', only roles that have "Roam to a remote Moodle moodle/site:mnetlogintoremote" will be allowed to roam. Grant the privilege as appropriate.<br />
## On both, go to the homepage, and add the 'Network Servers' block.<br />
## To test, it is recommended to use a different browser (even on a different machine) that is logged in to neither. Login to MoodleA with a non-administrator account that has the permissions to roam. You should see the Network Servers block, and clicking on it you should go to MoodleB with a newly autocreated account. <br />
# Get remote enrolments going -- this is optional. It allows administrator of MoodleB can enrol users that are "native" to MoodleB in courses in MoodleA, and viceversa.<br />
## On both, go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' in 2.0 onwards or ''Administration > Courses > Enrolments'' pre-2.0 and enable Moodle Network enrolment plugin (click Save). Click on 'Edit' and enable 'allow_allcourses' or select some courses or categories to be remotely enrolled.<br />
## On MoodleA go to ''Admin > Network > Peers'', click on 'MoodleB', and click on 'Services'. Enable Enrolment publish and subscribe.<br />
## Do the equivalent on MoodleB.<br />
## To use, in MoodleA go to ''Admin > Networking > Enrolments''. You will see MoodleB listed. Click on MoodleB and you will see a list of courses that MoodleB offers for remote enrolment. Select the course you want, and then enroll the users you want to that course.<br />
<br />
===Using it===<br />
<br />
==Connecting to a Mnet hub==<br />
A Mnet hub (do not confuse it with the [[Community hub]] project of Moodle 2.0) is a Moodle server that is configured to accept connections from other Moodle servers, and to provide a set of services to users of these other servers. This guideline will direct you to connect to a Mnet hub, assess the services it has to offer, and enable those services for your users.<br />
<br />
===Setup===<br />
# Get talking to the Hub<br />
## Ensure that the ''Admin > Server > Environment'' page indicates you have curl and openssl installed<br />
## Go to ''Admin > Network > Settings'' and turn Networking on<br />
## Go to ''Admin > Network > Peers'' and enter the URL of Mnet Hub under "Add New Host". Click <em>Add</em><br />
## The host details for the Mnet Hub should appear with the Site Name field already populated. Click <em>Save changes</em><br />
## The details will be written to your database and two new tabs will appear in this window: 'Services' and 'Logs'. Click <em>Services</em><br />
##A list of services will appear, each with a checkbox for 'publish' and 'subscribe'. Check the checkboxes for any services you want to publish or subscribe to<br />
<br />
===Using it===<br />
If the Mnet Hub has already enabled a service for you, there will be a tick alongside the appropriate checkbox, for example: if the Hub is <em>publishing</em> Moodle Networked Enrolment, then a tick will appear alongside the <em>subscribe</em> checkbox for this service. Note that in order to enable some functionality, prominently <em>single-sign-on</em>, you may have to <em>publish</em> a service, e.g. the <em>Identity Provider</em> service. The Mnet Hub will access this service on your Moodle, asking it to authenticate your users.<br />
# Enable Roaming<br />
## Subscribe to <em>SSO (Service Provider)</em> by checking the box<br />
## Publish <em>SSO (Identity Provider)</em> by checking the box<br />
## Click <em>Save changes</em><br />
## Go to ''Admin > Users > Permissions > Define Roles'', and grant the capability <em>Roam to a remote Moodle moodle/site:mnetlogintoremote</em> to an appropriate role<br />
## Go to ''Administration > Plugins > Authentication > Manage authentication'' in 2.0 onwards or ''Administration > Users > Authentication > Manage authentication'' in 1.9 and enable the <em>Moodle Network authentication</em> plugin<br />
## Go to your homepage, turn on editing, and add the 'Network Servers' block<br />
## Using a different web-browser, log on as a non-admin user who inhabits the role you granted the roaming capability to<br />
## Note that the Mnet Hub is listed in the Network Servers block on the homepage. Click on the link to that server<br />
## Some of your user details will be transferred to the Mnet Hub server, and a browsing session will be started for you as if you had logged on there directly<br />
# Enable Networked Enrolment<br />
## Return to the web browser you've been using as the site administrator<br />
## Go to ''Admin > Network > Peers'' and click on the entry for the Mnet Hub.<br />
## Click on the Services tab<br />
## Subscribe to <em>Moodle Networked Enrolment</em><br />
## Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' in 2.0 onwards or ''Administration > Courses > Enrolments'' pre-2.0 and enable the <em>Moodle Network enrolment</em> plugin. Click <em>Save changes</em><br />
## Click on <em>edit</em> to view the details for networked enrolments.<br />
## Go to ''Admin > Networking > Enrolments'' to see a list of Moodle servers that offer this service to you<br />
## Click on a server name to view a list of courses that the server offers to your users<br />
## Click on a course name, to view a list users that you can enrol in this course<br />
## Enrol users<br />
## Profit!<br />
<br />
==Running a Mnet hub==<br />
A Mnet hub is a regular Moodle site that runs in a special mode. As a Moodle Administrator, when you add another Moodle site to your list of network peers, your Moodle will contact that site to find out what it is called, and to request its public key for encrypted communication. Normally, the remote server will simply provide this information without making any record of the transaction.<br />
<br />
A Mnet hub is different. As soon as you add an entry for a Mnet hub to your system, the Mnet hub will create an entry for your server in its list of hosts, and may immediately begin to offer services to the users of your site.<br />
<br />
This section will guide you to set up a Mnet hub, and select services to offer to all comers.<br />
<br />
===Setup===<br />
# Enable Networking<br />
## Ensure that the ''Admin > Server > Environment'' page indicates you have curl and openssl installed<br />
## Go to ''Admin > Network > Settings'' and turn Networking on <br />
## Go to ''Admin > Network > Peers'' and tick the checkbox for <em>Register all hosts</em>. Click on <em>Save Changes</em><br />
## On the same page, the first entry in your list of hosts should be <em>All hosts</em>. Click this link<br />
## Click on <em>Services</em> and enable any services you want to offer to all comers<br />
<br />
==See also==<br />
<br />
* [[Moodle Network FAQ]]<br />
* [[Development:Moodle Network|Moodle Network development notes]]<br />
* Using Moodle [http://moodle.org/mod/forum/view.php?id=6976 MNet forum]<br />
* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=92749 Examples of how people are using Moodle networks] forum discussion<br />
<br />
[[Category:Authentication]]<br />
[[Category:Enrolment]]<br />
[[Category:MNet]]<br />
<br />
[[fr:Réseau Moodle]]<br />
[[ja:Moodleネットワーク]]<br />
[[es:Red Moodle]]<br />
[[cs:Síťové služby]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Calculated_question_improvements&diff=52128Calculated question improvements2009-03-06T06:35:36Z<p>Bruno: </p>
<hr />
<div>{{Calculated question dev docs}}<br />
I will use this page to describe the various improvements I am developping related to the calculated questions.<br />
The code of 1.8 with the QuickForm HTML structure offer a considerable improvement in the interface user over the preceeding versions.<br />
However at Université du Québec à Montréal, we moved from WebCT 4 to Moodle 1.6.3 in spring 2007 and will maintian this version for the next academic year. So exceptionnally, I will port down to 1.6 most of the improvements being made to the Moodle HEAD version.<br />
<br />
The following content of this page will be updated soon. <br />
<br />
==Working progress==<br />
{| border="1" cellpadding="2" cellspacing="0"<br />
|-<br />
!'''Improvements'''<br />
!HEAD<br />
!1.8<br />
!1.7<br />
!1.6<br />
|-<br />
|<br />
Moodle XML Import , Export<br />
|Done<br />
|Done<br />
|Done<br />
|Done<br />
|-<br />
|<br />
WebCT Import<br />
|Done<br />
|Done<br />
|Done<br />
|Done<br />
|-<br />
|<br />
Saving question at each step<br />
*remove use of $SESSION to store parameters<br />
|Done<br />
|Done<br />
|Done<br />
|Done<br />
|-<br />
|<br />
Allow save as new question<br />
*saving also the datasets and data items<br />
|Done<br />
|Done<br />
|TO DO<br />
|TO DO<br />
|-<br />
|<br />
Allow saving of multiple answers<br />
|Done<br />
|Done<br />
|Done<br />
|Done<br />
|-<br />
|<br />
Allow edition of multiple answers<br />
|Done<br />
|Done<br />
|READY<br />
|READY<br />
|-<br />
|<br />
Validation of user data before saving<br />
*For QuickForm redisplay with red text<br />
*Older version use notice when saving question->options so there is a return to editquestion <br />
|Done<br />
|Done<br />
|TESTING<br />
|TESTING<br />
|-<br />
|<br />
Allow addition and removal of dataitems by steps <br />
of 5,10,15, etc<br />
|TESTING<br />
|TESTING<br />
|TESTING<br />
|TESTING<br />
|-<br />
|<br />
larger field for formula <br />
<br />
|TO DO<br />
|TO DO<br />
|TO DO<br />
|TO DO<br />
|-<br />
|<br />
subquestions <br />
<br />
|TO DO<br />
|TO DO<br />
|TO DO<br />
|TO DO<br />
|-<br />
|}<br />
Possible steps are :<br />
* TO DO<br />
* CODED<br />
* TESTING<br />
* READY<br />
* Done i.e CVS and merged<br />
07/05/23<br />
<br />
==Foolproof and clearer creation process==<br />
Actually the creation or edition of calculated question is a three steps process ( 3 different pages) where the user can make errors that he cannot readily recuperate.<br />
* Identify the steps and renaming the save changes or continue buttons.<br />
* Using javascript to correct for errors or non valid values in each steps before going to the next step.[[Calculated question js validating forms]]<br />
* Creating buttons to access the previous steps for corrections.<br />
* Creating a table showing the variables used by the other calculated questions in the same category.<br />
* Allowing to create or delete data items by 1, 10, 20 etc in one step.<br />
<br />
<br />
==Moving calculated questions to another category==<br />
Actually the code (Moodle 1.7) for moving questions to another category means simply to change the category field in the database question record.<br />
Although this is correct for most questions types, this is not the right way to do it with calculated questions because the same category field is also used in the datasets records.<br />
A dataset can be shared by questions of the same category. <br />
To search if there is a already sharable dataset in a category, the parameters used are the dataset->name and the dataset->category.<br />
The possibilities are<br />
#All the dataset used by the question to be moved are reserved for this question (dataset->category=0). The calculated question can be moved to another category '''without restriction'''.This is the actual implementation.<br />
#At least one of the dataset used by the question to be moved is sharable (dataset->category = actual question category)<br />
## If '''all''' the sharable dataset are '''only''' used by the question to be moved, the calculated question can be selected to move to the other category .<br />
## If '''all''' the questions that are selected to be moved, and '''all''' the sharable datasets are only used by these questions to be moved, this set of questions can be selected to move to the other category .<br />
## In the case that there are questions not selected that could used a sharable dataset, this dataset cannot be moved in the another category.<br />
###Notify the user that another questions in the initial category share a parameter with this category.<br />
####The user can choose to cancel the move and select all the other questions (Case 2.2).<br />
####The user can choose to keep the question in the selected questions to be moved. In this case, the dataset should be duplicated when moving the another category.<br />
===Duplicate datasets?===<br />
If a similar sharable dataset already exists in the moveto category ( identical dataset->name and dataset->category = movetocategory).<br />
Notify the user and giving information on the<br />
#sharable dataset in selected questions to be moved <br />
#already existing sharable datasets in the move_to_category.<br />
The user should be able to select which dataset will be used in move_to_category.<br />
<br />
To implement these choices we need to add new functions in default questiontype class.<br />
===function movable_to_category(&$questions,$categoryid)===<br />
default return null <br />
$questions contain all the question records data for all the selected questions <br />
so that qtype implementation could test <br>if the selected questions satisfy option 2.2<br />
a $questions->notify can be added to be used by showbank.php and move_to_category.<br />
===function move_to_category($question,$tocategory)=== <br />
the default implementation should something like the actual code<br />
{<br />
if (!set_field('question', 'category', $tocategory->id, 'id', $question->id)) {<br />
error('Could not update category field');<br />
}<br />
return null;<br />
}<br />
the calculated question implementation should be able to duplicate the datasets in the new category<br />
<br />
==Improvements in general question editing interface==<br />
*Showing the text of the questions<br />
<br />
==Creation of a short (simple) calculated question==<br />
The actual calculated question allows for calculated params that can be shared by different problems.<br />
This could lead to a somewhat cloze used of calculated questions.However the questions cannot migrate individually to another category.<br />
A short calculated question that just allow for calculated parameters reserved for this question will allow use of this question in drag and drop cloze lesson.<br />
==Manipulating data items==<br />
Actual functions and propôsal for new ones for manipulating data items are discussed in [[Data_Item_Functions]]<br />
==Side effects to other modules==<br />
* Modification of the question type to allow moving of calculated question to another category.<br />
* Creation of general functions to standardize the import or export process.<br />
==Creation and modification of calculated questions==<br />
See the [[Development:Calculated question bugs and new features proposal]]<br />
<br />
See the [[Development:Calculated multiquestions proposal]]<br />
<br />
<br />
See the [[Calculated question actual 1.7 interface summary]]<br />
<br />
See the [[Calculated question 1.7 bugs solving proposal]]<br />
<br />
<br />
[[User:Pierre Pichet|Pierre Pichet]] August 2007 (WST)<br />
[[Developer_notes]]<br />
[[Calculated question creation developper docs]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Calculated_question_type_creation&diff=52127Calculated question type creation2009-03-06T06:19:26Z<p>Bruno: /* A more FULL PROOF code proposal */</p>
<hr />
<div>{{Calculated question dev docs}}<br />
I will use this page and the followings to describe the PHP code principal processes of the calculated question creation and see how it could be improved.<br />
==Calculated question parameters== <br />
Calculated question is an extended numerical question where parameters of a mathematical problems are generated and used to calculate the answer using a mathematical formula.<br />
<br />
So the answer parameter of a numerical question is replaced by the mathematical formula using the same answer database structure that the numerical question.<br />
<br />
The generated parameters are identified by a special format that is not used in a mathematical PHP equation {param} where the param name begins by a letter and can include alphanumerics symbol a-z A-Z _ 0-9 <br />
ex. {ad} {a_2} {a4_r} are valid parameter names <br />
{1a} {a+1} {a(0)} are invalid parameter names<br />
<br />
These parameters are transform in datasets defined by a min,max,decimal and generation mode.<br />
Using these datasets definitions a number of different values are generated (the dataset items) and used to generate different question instances where the parameters have different values although the question structure and answer formula are constant.<br />
<br />
==Creating a calculated question==<br />
Actually the creation of a calculated question is a three step process<br />
* '''Defining the common question parameters'''<br />
** Question name<br />
** Question text<br />
** answer formula, limit, units<br />
* '''Defining the dataset definitions range''' for each of them. The dataset definition ({params}) can be used in this new question only or could be used or add been already created by other questions in the question category in which the new question is created.<br />
question category is a set of questions that can contain various question types<br />
* '''Defining the dataset definitions parameters''' (min,max, decimal and generation mode and '''adding at least one data item''' for each dataset definitions<br />
Actually a set of all the data items is created when you click the add button<br />
<br />
* '''Saving''' the question parameters,dataset definitions parameters and data items.<br />
The real saving procedure is done when you '''add''' the '''first''' set of data items.<br />
Because in the actual code a calculated question needs that<br />
'''all''' these components be defined to be a '''valid''' calculated question,<br />
the saving is '''postponed''' until you click the '''add button''' to add the '''first''' set of data items.<br />
The parameters already entered are stored in the $Session object<br />
even if you click '''Saving changes''' at least<br />
'''twice''' <br />
1.'''Defining the common question parameters''' <br />
2.'''Defining the dataset definitions range''' steps.<br />
before adding your first set of data items.<br />
<br />
==Editing of a question==<br />
When you modify the an actual question, if you click '''Saving changes'''. the changes are saved in the database. <br />
==Creating a copy of a question==<br />
When you create a new question as a copy of an actual question , the ordinary parameters are copied but you havo to reconstruct the database sets and the database.<br />
==Moving a question to another category==<br />
When you move a question to another category, the ordinary parameters are copied but you havo to reconstruct the database sets and the database.If you come back to the initial category, the initial datasets are retrivied. There is a bug in the transfer related to the complex structure of the calculated questions.<br />
Correcting this bug is one of my priorities([[User:Pierre Pichet|Pierre Pichet]] 11:59, 21 August 2006 (CDT)).<br />
==A summary of the actual functions==<br />
See the [[Calculated question actual 1.7 interface summary]]<br />
<br />
==NOTHING is SAVED UNTIL you CLICK the ADD BUTTON==<br />
In the preceding Moodle version (<1.6), the user could click the BACK TO QUIZ EDITING button before adding a first data set item<br />
If the user at the third step click BACK TO QUIZ EDITING when NO dataset items added, <br />
he LOOSE all his work because the question general parameters where not solved.<br />
In the newer Moodle versions (1.65 beta,1.7, June 2006), the BACK TO QUIZ EDITING button does not appear unless there is at least one data set item.<br />
see [[Calculated question back to quiz button]]<br />
<br />
Because of this three steps procedure, the creation of a calculated question is a process which can abort easily if the user do not follow exactly all the three steps in the order the Moodle code expect them.<br />
Improvements to obtain a '''FOOLPROOF PROCESS''' are proposed in the next section.<br />
<br />
However, the teacher should always verify that for each added data item set, a valid answer, minimum and maximum value are obtained.<br />
Fortunately, at this step the newly created calculated question is already saved in the database and the user could go back and modify the question if necessary.<br />
<br />
==A more FOOLPROOF code proposal == <br />
See also [[Calculated question development| a proposed calculated question development]] in Developer notes <br />
<br />
[[Category:Developer|Calculated question type creation]]<br />
[[Category:Quiz]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Calculated_question_type_creation&diff=52126Calculated question type creation2009-03-06T06:19:07Z<p>Bruno: /* NOTHING is SAVED UNTIL you CLICK the ADD BUTTON */</p>
<hr />
<div>{{Calculated question dev docs}}<br />
I will use this page and the followings to describe the PHP code principal processes of the calculated question creation and see how it could be improved.<br />
==Calculated question parameters== <br />
Calculated question is an extended numerical question where parameters of a mathematical problems are generated and used to calculate the answer using a mathematical formula.<br />
<br />
So the answer parameter of a numerical question is replaced by the mathematical formula using the same answer database structure that the numerical question.<br />
<br />
The generated parameters are identified by a special format that is not used in a mathematical PHP equation {param} where the param name begins by a letter and can include alphanumerics symbol a-z A-Z _ 0-9 <br />
ex. {ad} {a_2} {a4_r} are valid parameter names <br />
{1a} {a+1} {a(0)} are invalid parameter names<br />
<br />
These parameters are transform in datasets defined by a min,max,decimal and generation mode.<br />
Using these datasets definitions a number of different values are generated (the dataset items) and used to generate different question instances where the parameters have different values although the question structure and answer formula are constant.<br />
<br />
==Creating a calculated question==<br />
Actually the creation of a calculated question is a three step process<br />
* '''Defining the common question parameters'''<br />
** Question name<br />
** Question text<br />
** answer formula, limit, units<br />
* '''Defining the dataset definitions range''' for each of them. The dataset definition ({params}) can be used in this new question only or could be used or add been already created by other questions in the question category in which the new question is created.<br />
question category is a set of questions that can contain various question types<br />
* '''Defining the dataset definitions parameters''' (min,max, decimal and generation mode and '''adding at least one data item''' for each dataset definitions<br />
Actually a set of all the data items is created when you click the add button<br />
<br />
* '''Saving''' the question parameters,dataset definitions parameters and data items.<br />
The real saving procedure is done when you '''add''' the '''first''' set of data items.<br />
Because in the actual code a calculated question needs that<br />
'''all''' these components be defined to be a '''valid''' calculated question,<br />
the saving is '''postponed''' until you click the '''add button''' to add the '''first''' set of data items.<br />
The parameters already entered are stored in the $Session object<br />
even if you click '''Saving changes''' at least<br />
'''twice''' <br />
1.'''Defining the common question parameters''' <br />
2.'''Defining the dataset definitions range''' steps.<br />
before adding your first set of data items.<br />
<br />
==Editing of a question==<br />
When you modify the an actual question, if you click '''Saving changes'''. the changes are saved in the database. <br />
==Creating a copy of a question==<br />
When you create a new question as a copy of an actual question , the ordinary parameters are copied but you havo to reconstruct the database sets and the database.<br />
==Moving a question to another category==<br />
When you move a question to another category, the ordinary parameters are copied but you havo to reconstruct the database sets and the database.If you come back to the initial category, the initial datasets are retrivied. There is a bug in the transfer related to the complex structure of the calculated questions.<br />
Correcting this bug is one of my priorities([[User:Pierre Pichet|Pierre Pichet]] 11:59, 21 August 2006 (CDT)).<br />
==A summary of the actual functions==<br />
See the [[Calculated question actual 1.7 interface summary]]<br />
<br />
==NOTHING is SAVED UNTIL you CLICK the ADD BUTTON==<br />
In the preceding Moodle version (<1.6), the user could click the BACK TO QUIZ EDITING button before adding a first data set item<br />
If the user at the third step click BACK TO QUIZ EDITING when NO dataset items added, <br />
he LOOSE all his work because the question general parameters where not solved.<br />
In the newer Moodle versions (1.65 beta,1.7, June 2006), the BACK TO QUIZ EDITING button does not appear unless there is at least one data set item.<br />
see [[Calculated question back to quiz button]]<br />
<br />
Because of this three steps procedure, the creation of a calculated question is a process which can abort easily if the user do not follow exactly all the three steps in the order the Moodle code expect them.<br />
Improvements to obtain a '''FOOLPROOF PROCESS''' are proposed in the next section.<br />
<br />
However, the teacher should always verify that for each added data item set, a valid answer, minimum and maximum value are obtained.<br />
Fortunately, at this step the newly created calculated question is already saved in the database and the user could go back and modify the question if necessary.<br />
<br />
==A more FULL PROOF code proposal == <br />
See also [[Calculated question development| a proposed calculated question development]] in Developer notes <br />
<br />
[[Category:Developer|Calculated question type creation]]<br />
[[Category:Quiz]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Marking_block&diff=25634Marking block2007-08-05T00:39:02Z<p>Bruno: </p>
<hr />
<div>__NOTOC__<br />
<br />
<br />
for moodle 1.8+ please read http://moodle.org/mod/data/view.php?d=13&rid=445<br />
<br />
the rest of this page concerns moodle 1.5 and 1.6 only<br />
<br />
<br />
<br />
==purpose:==<br />
* to allow teacher to quickly see what needs to be "marked" in '''ONLY''':<br />
# assignments<br />
# journals <br />
# lessons<br />
# forums<br />
<br />
The '''Marking''' block is a Moodle block add-on that provides a summary of activities awaiting grading. It includes a separate page that provides an alternate gradebook functionality tied to the marking block. This block is restricted to teachers and administrators.<br />
<br />
This block displays marking information for newly submitted, resubmitted, and overdue (activities past their defined close dates) activities. The marking page provides the same information and easy access to the grading functions for these activities.<br />
<br />
This block can also display a list of students below a certain grade level.<br />
<br />
The block can be configured to display a maximum number of students in each list and to set the grade level to display below.<br />
<br />
This directory uses custom code for all activities it summarizes. There are few common activity library functions that can perform the same operations, and thus any new activities to be added will need new code.<br />
<br />
==Installation==<br />
<br />
To install and use, unzip this file into your Moodle root directory making sure<br />
that you 'use folder names'. This will add a new block directory (marking) to<br />
your '/blocks' directory and some language files to your language directory.<br />
Once unzipped, visit your admin screen and configure the new block the way you<br />
want.<br />
<br />
===Setting up Marking block for Moodle 1.6+===<br />
<br />
* download block_marking_1.6x from http://moodle.org/mod/data/view.php?d=13&rid=445<br />
* unzip it in the root folder of your moodle directory<br />
* adjust the settings in '''admin / configureation /blocks / marking / settings menu'''<br />
<br />
==Usage==<br />
* set '''$CFG->block_marking_listnum =''' ''(some number other than the default 2)'' via the '''admin / configureation /blocks / marking / settings menu''' (the default is to show two activites needing marking per section (unmarked / resubmitted / unsubmitted.)<br />
** set it to a higher number to avoid the illusion that not all items are shown "to be marked" (or click on the "MORE" button instead)<br />
<br />
<br />
==Credits==<br />
<br />
The marking block has been designed and built with the contributions of the<br />
following people:<br />
* Fernando Oliviera - G8 First Nation Schools > original design concept of the marking page<br />
* Darren Smith - Egglescliffe School > orginal design concept of the marking block, and additional design of the marking page<br />
* Mike Churchward - churchward.ca (mike AT churchward DOT ca)> original technical design and development<br />
* Bruno Vernier - block packaging and some bug fixes<br />
<br />
==To do==<br />
<br />
* Make sure all strings are in language file<br />
* Allow configuration of each section (i.e. enable/disable 'below average list')<br />
* Create a local block library file and better compartmentalize functions<br />
<br />
==Links==<br />
* [http://download.moodle.org/download.php/modules/block_marking.zip Download]<br />
* [http://moodle.org/mod/forum/discuss.php?d=45432 Link to forum post with a lang/en file with all strings filled in]<br />
<br />
[[Category:Block (non-standard)]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Marking_block&diff=25633Marking block2007-08-05T00:38:21Z<p>Bruno: </p>
<hr />
<div>__NOTOC__<br />
<br />
<br />
for moodle 1.8+ please read http://moodle.org/mod/data/view.php?d=13&rid=445<br />
<br />
<br />
<br />
==purpose:==<br />
* to allow teacher to quickly see what needs to be "marked" in '''ONLY''':<br />
# assignments<br />
# journals <br />
# lessons<br />
# forums<br />
<br />
The '''Marking''' block is a Moodle block add-on that provides a summary of activities awaiting grading. It includes a separate page that provides an alternate gradebook functionality tied to the marking block. This block is restricted to teachers and administrators.<br />
<br />
This block displays marking information for newly submitted, resubmitted, and overdue (activities past their defined close dates) activities. The marking page provides the same information and easy access to the grading functions for these activities.<br />
<br />
This block can also display a list of students below a certain grade level.<br />
<br />
The block can be configured to display a maximum number of students in each list and to set the grade level to display below.<br />
<br />
This directory uses custom code for all activities it summarizes. There are few common activity library functions that can perform the same operations, and thus any new activities to be added will need new code.<br />
<br />
==Installation==<br />
<br />
To install and use, unzip this file into your Moodle root directory making sure<br />
that you 'use folder names'. This will add a new block directory (marking) to<br />
your '/blocks' directory and some language files to your language directory.<br />
Once unzipped, visit your admin screen and configure the new block the way you<br />
want.<br />
<br />
===Setting up Marking block for Moodle 1.6+===<br />
<br />
* download block_marking_1.6x from http://moodle.org/mod/data/view.php?d=13&rid=445<br />
* unzip it in the root folder of your moodle directory<br />
* adjust the settings in '''admin / configureation /blocks / marking / settings menu'''<br />
<br />
==Usage==<br />
* set '''$CFG->block_marking_listnum =''' ''(some number other than the default 2)'' via the '''admin / configureation /blocks / marking / settings menu''' (the default is to show two activites needing marking per section (unmarked / resubmitted / unsubmitted.)<br />
** set it to a higher number to avoid the illusion that not all items are shown "to be marked" (or click on the "MORE" button instead)<br />
<br />
<br />
==Credits==<br />
<br />
The marking block has been designed and built with the contributions of the<br />
following people:<br />
* Fernando Oliviera - G8 First Nation Schools > original design concept of the marking page<br />
* Darren Smith - Egglescliffe School > orginal design concept of the marking block, and additional design of the marking page<br />
* Mike Churchward - churchward.ca (mike AT churchward DOT ca)> original technical design and development<br />
* Bruno Vernier - block packaging and some bug fixes<br />
<br />
==To do==<br />
<br />
* Make sure all strings are in language file<br />
* Allow configuration of each section (i.e. enable/disable 'below average list')<br />
* Create a local block library file and better compartmentalize functions<br />
<br />
==Links==<br />
* [http://download.moodle.org/download.php/modules/block_marking.zip Download]<br />
* [http://moodle.org/mod/forum/discuss.php?d=45432 Link to forum post with a lang/en file with all strings filled in]<br />
<br />
[[Category:Block (non-standard)]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Web_services_API&diff=25212Web services API2007-07-19T06:30:03Z<p>Bruno: /* The server script */</p>
<hr />
<div>== Overview ==<br />
<br />
<br />
The Web Services API provides Moodle with a web service interface to allow exchange of data and information with other systems.<br />
<br />
For example,<br />
# Manage user data - send and retrieve the information,<br />
# Manage course enrolments - add/remove teachers and students,<br />
# Course management - create new courses based on templates,<br />
# Gradebook info - extract grades information from Moodle.<br />
<br />
==XML-RPC background==<br />
The XML-RPC service allows other servers to contact your Moodle server and request that it call a function. The Moodle server might do something, like create a user, or it might fetch some data and serve it back to your host.<br />
<br />
To communicate like this with another Moodle host, you'd normally use the Moodle Network [https://docs.moodle.org/en/Moodle_Network] features, but it's also possible for other kinds of program to contact your Moodle, using plain-old-XML-RPC, with Moodle Network's encryption or signed-message features.<br />
<br />
==The server script==<br />
* allow trusted sites to access web services by configuring '''admin/mnet/trustedhosts.php'''<br />
* start by pointing your browser to '''mnet/xmlrpc/server.php''' - this should show an XML error message<br />
* use POST data in this format:<br />
// $method is something like: "mod/forum/lib/forum_add_instance"<br />
// $params is an array of parameters. A parameter might itself be an array.<br />
// use only Whitelist characters that are permitted in a method name<br />
// The method name must not begin with a / - avoid absolute paths<br />
// A dot character . is only allowed in the filename, i.e. something.php<br />
* use '''mnet/xmlrpc/client.php''' to make remote xmlrpc calls<br />
<br />
==Things you can do==<br />
<br />
==See also==<br />
<br />
* Using Moodle [http://moodle.org/mod/forum/view.php?f=965 Web Services forum] <br />
<br />
[[Category:Developer|Web services API]]<br />
[[Category:Administrator]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Web_services_API&diff=25211Web services API2007-07-19T06:06:56Z<p>Bruno: /* The server script */</p>
<hr />
<div>== Overview ==<br />
<br />
<br />
The Web Services API provides Moodle with a web service interface to allow exchange of data and information with other systems.<br />
<br />
For example,<br />
# Manage user data - send and retrieve the information,<br />
# Manage course enrolments - add/remove teachers and students,<br />
# Course management - create new courses based on templates,<br />
# Gradebook info - extract grades information from Moodle.<br />
<br />
==XML-RPC background==<br />
The XML-RPC service allows other servers to contact your Moodle server and request that it call a function. The Moodle server might do something, like create a user, or it might fetch some data and serve it back to your host.<br />
<br />
To communicate like this with another Moodle host, you'd normally use the Moodle Network [https://docs.moodle.org/en/Moodle_Network] features, but it's also possible for other kinds of program to contact your Moodle, using plain-old-XML-RPC, with Moodle Network's encryption or signed-message features.<br />
<br />
==The server script==<br />
* allow trusted sites to access web services by configuring '''/admin/mnet/trustedhosts.php'''<br />
* start by pointing your browser to '''/mnet/xmlrpc/server.php''' - this should show an XML error message<br />
* use POST data in this format:<br />
// $method is something like: "mod/forum/lib/forum_add_instance"<br />
// $params is an array of parameters. A parameter might itself be an array.<br />
// use only Whitelist characters that are permitted in a method name<br />
// The method name must not begin with a / - avoid absolute paths<br />
// A dot character . is only allowed in the filename, i.e. something.php<br />
<br />
==Things you can do==<br />
<br />
==See also==<br />
<br />
* Using Moodle [http://moodle.org/mod/forum/view.php?f=965 Web Services forum] <br />
<br />
[[Category:Developer|Web services API]]<br />
[[Category:Administrator]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Web_services_API&diff=25210Web services API2007-07-19T05:56:24Z<p>Bruno: /* The server script */</p>
<hr />
<div>== Overview ==<br />
<br />
<br />
The Web Services API provides Moodle with a web service interface to allow exchange of data and information with other systems.<br />
<br />
For example,<br />
# Manage user data - send and retrieve the information,<br />
# Manage course enrolments - add/remove teachers and students,<br />
# Course management - create new courses based on templates,<br />
# Gradebook info - extract grades information from Moodle.<br />
<br />
==XML-RPC background==<br />
The XML-RPC service allows other servers to contact your Moodle server and request that it call a function. The Moodle server might do something, like create a user, or it might fetch some data and serve it back to your host.<br />
<br />
To communicate like this with another Moodle host, you'd normally use the Moodle Network [https://docs.moodle.org/en/Moodle_Network] features, but it's also possible for other kinds of program to contact your Moodle, using plain-old-XML-RPC, with Moodle Network's encryption or signed-message features.<br />
<br />
==The server script==<br />
* allow trusted sites to access web services by configuring '''/admin/mnet/trustedhosts.php'''<br />
* start by pointing your browser to '''/mnet/xmlrpc/server.php''' - this should show an XML error message<br />
<br />
// $method is something like: "mod/forum/lib/forum_add_instance"<br />
// $params is an array of parameters. A parameter might itself be an array.<br />
// use only Whitelist characters that are permitted in a method name<br />
// The method name must not begin with a / - avoid absolute paths<br />
// A dot character . is only allowed in the filename, i.e. something.php<br />
<br />
==Things you can do==<br />
<br />
==See also==<br />
<br />
* Using Moodle [http://moodle.org/mod/forum/view.php?f=965 Web Services forum] <br />
<br />
[[Category:Developer|Web services API]]<br />
[[Category:Administrator]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Web_services_API&diff=25209Web services API2007-07-19T05:54:40Z<p>Bruno: /* The server script */</p>
<hr />
<div>== Overview ==<br />
<br />
<br />
The Web Services API provides Moodle with a web service interface to allow exchange of data and information with other systems.<br />
<br />
For example,<br />
# Manage user data - send and retrieve the information,<br />
# Manage course enrolments - add/remove teachers and students,<br />
# Course management - create new courses based on templates,<br />
# Gradebook info - extract grades information from Moodle.<br />
<br />
==XML-RPC background==<br />
The XML-RPC service allows other servers to contact your Moodle server and request that it call a function. The Moodle server might do something, like create a user, or it might fetch some data and serve it back to your host.<br />
<br />
To communicate like this with another Moodle host, you'd normally use the Moodle Network [https://docs.moodle.org/en/Moodle_Network] features, but it's also possible for other kinds of program to contact your Moodle, using plain-old-XML-RPC, with Moodle Network's encryption or signed-message features.<br />
<br />
==The server script==<br />
* allow trusted sites to access web services by configuring '''/admin/mnet/trustedhosts.php'''<br />
* start by pointing your browser to '''/mnet/xmlrpc/server.php''' - this should show an XML error message<br />
<br />
// $method is something like: "mod/forum/lib/forum_add_instance"<br />
// $params is an array of parameters. A parameter might itself be an array.<br />
<br />
==Things you can do==<br />
<br />
==See also==<br />
<br />
* Using Moodle [http://moodle.org/mod/forum/view.php?f=965 Web Services forum] <br />
<br />
[[Category:Developer|Web services API]]<br />
[[Category:Administrator]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Web_services_API&diff=25208Web services API2007-07-19T05:33:02Z<p>Bruno: /* The server script */</p>
<hr />
<div>== Overview ==<br />
<br />
<br />
The Web Services API provides Moodle with a web service interface to allow exchange of data and information with other systems.<br />
<br />
For example,<br />
# Manage user data - send and retrieve the information,<br />
# Manage course enrolments - add/remove teachers and students,<br />
# Course management - create new courses based on templates,<br />
# Gradebook info - extract grades information from Moodle.<br />
<br />
==XML-RPC background==<br />
The XML-RPC service allows other servers to contact your Moodle server and request that it call a function. The Moodle server might do something, like create a user, or it might fetch some data and serve it back to your host.<br />
<br />
To communicate like this with another Moodle host, you'd normally use the Moodle Network [https://docs.moodle.org/en/Moodle_Network] features, but it's also possible for other kinds of program to contact your Moodle, using plain-old-XML-RPC, with Moodle Network's encryption or signed-message features.<br />
<br />
==The server script==<br />
* allow trusted sites to access web services by configuring '''/admin/mnet/trustedhosts.php'''<br />
* start by pointing your browser to '''/mnet/xmlrpc/server.php''' - this should show an XML error message<br />
<br />
==Things you can do==<br />
<br />
==See also==<br />
<br />
* Using Moodle [http://moodle.org/mod/forum/view.php?f=965 Web Services forum] <br />
<br />
[[Category:Developer|Web services API]]<br />
[[Category:Administrator]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Web_services_API&diff=25207Web services API2007-07-19T05:29:41Z<p>Bruno: /* The server script */</p>
<hr />
<div>== Overview ==<br />
<br />
<br />
The Web Services API provides Moodle with a web service interface to allow exchange of data and information with other systems.<br />
<br />
For example,<br />
# Manage user data - send and retrieve the information,<br />
# Manage course enrolments - add/remove teachers and students,<br />
# Course management - create new courses based on templates,<br />
# Gradebook info - extract grades information from Moodle.<br />
<br />
==XML-RPC background==<br />
The XML-RPC service allows other servers to contact your Moodle server and request that it call a function. The Moodle server might do something, like create a user, or it might fetch some data and serve it back to your host.<br />
<br />
To communicate like this with another Moodle host, you'd normally use the Moodle Network [https://docs.moodle.org/en/Moodle_Network] features, but it's also possible for other kinds of program to contact your Moodle, using plain-old-XML-RPC, with Moodle Network's encryption or signed-message features.<br />
<br />
==The server script==<br />
* start by pointing your browser to ''_http://your_domain/path_to_moodle'''''/mnet/xmlrpc/server.php'''<br />
<br />
==Things you can do==<br />
<br />
==See also==<br />
<br />
* Using Moodle [http://moodle.org/mod/forum/view.php?f=965 Web Services forum] <br />
<br />
[[Category:Developer|Web services API]]<br />
[[Category:Administrator]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Web_services_API&diff=25206Web services API2007-07-19T05:29:25Z<p>Bruno: /* The server script */</p>
<hr />
<div>== Overview ==<br />
<br />
<br />
The Web Services API provides Moodle with a web service interface to allow exchange of data and information with other systems.<br />
<br />
For example,<br />
# Manage user data - send and retrieve the information,<br />
# Manage course enrolments - add/remove teachers and students,<br />
# Course management - create new courses based on templates,<br />
# Gradebook info - extract grades information from Moodle.<br />
<br />
==XML-RPC background==<br />
The XML-RPC service allows other servers to contact your Moodle server and request that it call a function. The Moodle server might do something, like create a user, or it might fetch some data and serve it back to your host.<br />
<br />
To communicate like this with another Moodle host, you'd normally use the Moodle Network [https://docs.moodle.org/en/Moodle_Network] features, but it's also possible for other kinds of program to contact your Moodle, using plain-old-XML-RPC, with Moodle Network's encryption or signed-message features.<br />
<br />
==The server script==<br />
* start by pointing your browser to _''http://your_domain/path_to_moodle'''''/mnet/xmlrpc/server.php'''<br />
<br />
==Things you can do==<br />
<br />
==See also==<br />
<br />
* Using Moodle [http://moodle.org/mod/forum/view.php?f=965 Web Services forum] <br />
<br />
[[Category:Developer|Web services API]]<br />
[[Category:Administrator]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Web_services_API&diff=25205Web services API2007-07-19T05:28:51Z<p>Bruno: /* The server script */</p>
<hr />
<div>== Overview ==<br />
<br />
<br />
The Web Services API provides Moodle with a web service interface to allow exchange of data and information with other systems.<br />
<br />
For example,<br />
# Manage user data - send and retrieve the information,<br />
# Manage course enrolments - add/remove teachers and students,<br />
# Course management - create new courses based on templates,<br />
# Gradebook info - extract grades information from Moodle.<br />
<br />
==XML-RPC background==<br />
The XML-RPC service allows other servers to contact your Moodle server and request that it call a function. The Moodle server might do something, like create a user, or it might fetch some data and serve it back to your host.<br />
<br />
To communicate like this with another Moodle host, you'd normally use the Moodle Network [https://docs.moodle.org/en/Moodle_Network] features, but it's also possible for other kinds of program to contact your Moodle, using plain-old-XML-RPC, with Moodle Network's encryption or signed-message features.<br />
<br />
==The server script==<br />
* start by pointing your browser to hhttp://your_domain/path_to_moodle'''/mnet/xmlrpc/server.php'''<br />
<br />
==Things you can do==<br />
<br />
==See also==<br />
<br />
* Using Moodle [http://moodle.org/mod/forum/view.php?f=965 Web Services forum] <br />
<br />
[[Category:Developer|Web services API]]<br />
[[Category:Administrator]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Web_services_API&diff=25204Web services API2007-07-19T05:27:48Z<p>Bruno: /* The server script */</p>
<hr />
<div>== Overview ==<br />
<br />
<br />
The Web Services API provides Moodle with a web service interface to allow exchange of data and information with other systems.<br />
<br />
For example,<br />
# Manage user data - send and retrieve the information,<br />
# Manage course enrolments - add/remove teachers and students,<br />
# Course management - create new courses based on templates,<br />
# Gradebook info - extract grades information from Moodle.<br />
<br />
==XML-RPC background==<br />
The XML-RPC service allows other servers to contact your Moodle server and request that it call a function. The Moodle server might do something, like create a user, or it might fetch some data and serve it back to your host.<br />
<br />
To communicate like this with another Moodle host, you'd normally use the Moodle Network [https://docs.moodle.org/en/Moodle_Network] features, but it's also possible for other kinds of program to contact your Moodle, using plain-old-XML-RPC, with Moodle Network's encryption or signed-message features.<br />
<br />
==The server script==<br />
* start by pointing your browser to http://your_domain/path_to_moodle'''/mnet/xmlrpc/server.php'''<br />
<br />
==Things you can do==<br />
<br />
==See also==<br />
<br />
* Using Moodle [http://moodle.org/mod/forum/view.php?f=965 Web Services forum] <br />
<br />
[[Category:Developer|Web services API]]<br />
[[Category:Administrator]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Themes&diff=23278Themes2007-05-15T02:22:56Z<p>Bruno: /* Installing your own theme */</p>
<hr />
<div>{{Themes}}<br />
<br />
Moodle has a powerful '''themes''' system that allows for a variety of effects through the use of XHTML and CSS.<br />
<br />
* Themes may be [[Theme config|configured]] at site level, course level and/or user level.<br />
* Each page is individually-addressable via CSS, allowing you to pinpoint exact items.<br />
* Our CSS class naming system uses simple English, is consistent and easily understood.<br />
* New modules can tell Moodle what styles they need and automatically include these in the stylesheet.<br />
* Themes can be based on the ''standard'' theme, which is very plain but functional. You simply override styles you want to change by adding to the stylesheet in your own theme. This means that if you upgrade Moodle later and new styles are needed, your custom theme will still work without any changes, because the new classes will be defined in the ''standard'' theme.<br />
* Themes can also be based on any other theme. This allows you to easily create families of themes, or variations on a theme. For example you might create a spectrum of pastel shades for use in different courses, but with the same basic layout and logos. You may also want to create a family of differently-coloured themes for accessibility purposes.<br />
<br />
== Creating your own theme ==<br />
<br />
If you plan to work on your own theme please create a new one (with its own named subfolder) and use Moodle's [what] feature to base your theme on an existing theme such as ''standard''. If you just modify one of the delivered themes it will be overwritten by the next Moodle update.<br />
<br />
== Installing your own theme ==<br />
<br />
Once you have your own theme created, you should follow these steps to install it on your site:<br />
<br />
# Zip the theme folder using winzip or similar<br />
# Upload the .zip file into the theme folder moodle/themes/<br />
# Unzip<br />
# note: make sure the new theme folder and its contents are readable by the webserver. in Mac OS X, set Group and Other privileges to 'Read & Write' (select File> Get Info> Ownership & Permissions) otherwise Moodle may not be able to display the newly installed theme.<br />
# Choose your new theme from within Moodle Admin>Appearances>Themes (version 1.7 +). For older versions, the path is Moodle Admin>Configuration>Themes<br />
<br />
== Theme system changes across Moodle versions ==<br />
<br />
Moodle 1.5 themes are quite different from previous versions and so a [[Theme upgrade|theme upgrade]] is required. A theme upgrade is also required for the [[1.6 theme upgrade|transition from 1.5 to 1.6]], since the XHTML structure has been reworked for improved [[Accessibility|accessibility]].<br />
<br />
<br />
[[Category:Administrator]]<br />
[[Category:Developer]]<br />
[[Category:Themes]]<br />
<br />
[[es:Temas]]<br />
[[fr:Thèmes]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Themes&diff=23277Themes2007-05-15T02:21:45Z<p>Bruno: /* Installing your own theme */</p>
<hr />
<div>{{Themes}}<br />
<br />
Moodle has a powerful '''themes''' system that allows for a variety of effects through the use of XHTML and CSS.<br />
<br />
* Themes may be [[Theme config|configured]] at site level, course level and/or user level.<br />
* Each page is individually-addressable via CSS, allowing you to pinpoint exact items.<br />
* Our CSS class naming system uses simple English, is consistent and easily understood.<br />
* New modules can tell Moodle what styles they need and automatically include these in the stylesheet.<br />
* Themes can be based on the ''standard'' theme, which is very plain but functional. You simply override styles you want to change by adding to the stylesheet in your own theme. This means that if you upgrade Moodle later and new styles are needed, your custom theme will still work without any changes, because the new classes will be defined in the ''standard'' theme.<br />
* Themes can also be based on any other theme. This allows you to easily create families of themes, or variations on a theme. For example you might create a spectrum of pastel shades for use in different courses, but with the same basic layout and logos. You may also want to create a family of differently-coloured themes for accessibility purposes.<br />
<br />
== Creating your own theme ==<br />
<br />
If you plan to work on your own theme please create a new one (with its own named subfolder) and use Moodle's [what] feature to base your theme on an existing theme such as ''standard''. If you just modify one of the delivered themes it will be overwritten by the next Moodle update.<br />
<br />
== Installing your own theme ==<br />
<br />
Once you have your own theme created, you should follow these steps to install it on your site:<br />
<br />
# Zip the theme folder using winzip or similar<br />
# Upload the .zip file into the theme folder moodle/themes/<br />
# Unzip<br />
# note: make sure the new theme folder and its contents are readable by the webserver.<br />
if you are using Mac OS X, make sure that the files have Group and Other privileges set to 'Read & Write' (select File> Get Info> Ownership & Permissions) otherwise Moodle may not be able to display the newly installed theme.<br />
# Choose your new theme from within Moodle Admin>Appearances>Themes (version 1.7 +). For older versions, the path is Moodle Admin>Configuration>Themes<br />
<br />
== Theme system changes across Moodle versions ==<br />
<br />
Moodle 1.5 themes are quite different from previous versions and so a [[Theme upgrade|theme upgrade]] is required. A theme upgrade is also required for the [[1.6 theme upgrade|transition from 1.5 to 1.6]], since the XHTML structure has been reworked for improved [[Accessibility|accessibility]].<br />
<br />
<br />
[[Category:Administrator]]<br />
[[Category:Developer]]<br />
[[Category:Themes]]<br />
<br />
[[es:Temas]]<br />
[[fr:Thèmes]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Themes&diff=23276Themes2007-05-15T02:21:29Z<p>Bruno: </p>
<hr />
<div>{{Themes}}<br />
<br />
Moodle has a powerful '''themes''' system that allows for a variety of effects through the use of XHTML and CSS.<br />
<br />
* Themes may be [[Theme config|configured]] at site level, course level and/or user level.<br />
* Each page is individually-addressable via CSS, allowing you to pinpoint exact items.<br />
* Our CSS class naming system uses simple English, is consistent and easily understood.<br />
* New modules can tell Moodle what styles they need and automatically include these in the stylesheet.<br />
* Themes can be based on the ''standard'' theme, which is very plain but functional. You simply override styles you want to change by adding to the stylesheet in your own theme. This means that if you upgrade Moodle later and new styles are needed, your custom theme will still work without any changes, because the new classes will be defined in the ''standard'' theme.<br />
* Themes can also be based on any other theme. This allows you to easily create families of themes, or variations on a theme. For example you might create a spectrum of pastel shades for use in different courses, but with the same basic layout and logos. You may also want to create a family of differently-coloured themes for accessibility purposes.<br />
<br />
== Creating your own theme ==<br />
<br />
If you plan to work on your own theme please create a new one (with its own named subfolder) and use Moodle's [what] feature to base your theme on an existing theme such as ''standard''. If you just modify one of the delivered themes it will be overwritten by the next Moodle update.<br />
<br />
== Installing your own theme ==<br />
<br />
Once you have your own theme created, you should follow these steps to install it on your site:<br />
<br />
# Zip the theme folder using winzip or similar<br />
# Upload the .zip file into the theme folder moodle/themes/<br />
# Unzip<br />
# note: make sure the new theme folder and its contents are readable by the webserver.<br />
if you are using Mac OS X, make sure that the files have Group and Other privileges set to 'Read & Write' (select File> Get Info> Ownership & Permissions) otherwise Moodle may not be able to display the newly installed theme.<br />
# Choose your new theme from within Moodle Admin>Appearances>Themes (version 1.7 +). For older versions, the path is Moodle Admin>Configuration>Themes<br />
<br />
== Theme system changes across Moodle versions ==<br />
<br />
Moodle 1.5 themes are quite different from previous versions and so a [[Theme upgrade|theme upgrade]] is required. A theme upgrade is also required for the [[1.6 theme upgrade|transition from 1.5 to 1.6]], since the XHTML structure has been reworked for improved [[Accessibility|accessibility]].<br />
<br />
<br />
[[Category:Administrator]]<br />
[[Category:Developer]]<br />
[[Category:Themes]]<br />
<br />
[[es:Temas]]<br />
[[fr:Thèmes]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=tracksessionip&diff=22858tracksessionip2007-04-29T04:04:20Z<p>Bruno: </p>
<hr />
<div><br />
==Comments==<br />
* "It restricts a single session from changing IP, and this is mostly a debugging tool for a strange problem that we think is a PHP bug. It does not stop a single user from having more than one session."<br />
** Martin Langhoff in http://moodle.org/mod/forum/discuss.php?d=47271#217274<br />
* "suppose you logged in using a dial up connection. If you get disconnected and then reconnect, tracksessionip will not let you open pages even if you had your browser open."<br />
** Vikram Solia in http://moodle.org/mod/forum/discuss.php?d=32879#157645<br />
<br />
==Config.php==<br />
* to turn it on, go to config.php and uncomment:<br />
* $CFG->tracksessionip= True;<br />
<br />
// If this setting is set to true, then Moodle will track the IP of the<br />
// current user to make sure it hasn't changed during a session. This<br />
// will prevent the possibility of sessions being hijacked via XSS, but it<br />
// may break things for users coming using proxies that change all the time,<br />
// like AOL.<br />
<br />
==Alternative==<br />
* set dbsessions to "YES" so that sessions are stored in the db<br />
* non-recommended alternative method is to allow domain users write access to the sessions directory (see note at bottom of [[NTLM_authentication]])</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=tracksessionip&diff=22857tracksessionip2007-04-29T03:47:33Z<p>Bruno: </p>
<hr />
<div><br />
<br />
==Comments==<br />
* "It restricts a single session from changing IP, and this is mostly a debugging tool for a strange problem that we think is a PHP bug. It does not stop a single user from having more than one session."<br />
** Martin Langhoff in http://moodle.org/mod/forum/discuss.php?d=47271#217274<br />
* "suppose you logged in using a dial up connection. If you get disconnected and then reconnect, tracksessionip will not let you open pages even if you had your browser open."<br />
** Vikram Solia in http://moodle.org/mod/forum/discuss.php?d=32879#157645<br />
<br />
==Config.php==<br />
* to turn it on, go to config.php and uncomment:<br />
* $CFG->tracksessionip= True;<br />
<br />
// If this setting is set to true, then Moodle will track the IP of the<br />
// current user to make sure it hasn't changed during a session. This<br />
// will prevent the possibility of sessions being hijacked via XSS, but it<br />
// may break things for users coming using proxies that change all the time,<br />
// like AOL.</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=tracksessionip&diff=22856tracksessionip2007-04-29T03:42:35Z<p>Bruno: /* Config.php */</p>
<hr />
<div><br />
<br />
<br />
==Martin Langhoff==<br />
* "It restricts a single session from changing IP, and this is mostly a debugging tool for a strange problem that we think is a PHP bug. It does not stop a single user from having more than one session."<br />
* http://moodle.org/mod/forum/discuss.php?d=47271#217274<br />
<br />
==Config.php==<br />
* to turn it on, go to config.php and uncomment:<br />
* $CFG->tracksessionip= True;<br />
<br />
// If this setting is set to true, then Moodle will track the IP of the<br />
// current user to make sure it hasn't changed during a session. This<br />
// will prevent the possibility of sessions being hijacked via XSS, but it<br />
// may break things for users coming using proxies that change all the time,<br />
// like AOL.</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=tracksessionip&diff=22855tracksessionip2007-04-29T03:41:40Z<p>Bruno: </p>
<hr />
<div><br />
<br />
<br />
==Martin Langhoff==<br />
* "It restricts a single session from changing IP, and this is mostly a debugging tool for a strange problem that we think is a PHP bug. It does not stop a single user from having more than one session."<br />
* http://moodle.org/mod/forum/discuss.php?d=47271#217274<br />
<br />
==Config.php==<br />
* to turn it on, go to config.php and uncomment:<br />
* $CFG->tracksessionip= True;</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=tracksessionip&diff=22854tracksessionip2007-04-29T03:41:26Z<p>Bruno: </p>
<hr />
<div>[[category:admin]]<br />
<br />
<br />
==Martin Langhoff==<br />
* "It restricts a single session from changing IP, and this is mostly a debugging tool for a strange problem that we think is a PHP bug. It does not stop a single user from having more than one session."<br />
* http://moodle.org/mod/forum/discuss.php?d=47271#217274<br />
<br />
==Config.php==<br />
* to turn it on, go to config.php and uncomment:<br />
* $CFG->tracksessionip= True;</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=tracksessionip&diff=22853tracksessionip2007-04-29T03:40:54Z<p>Bruno: </p>
<hr />
<div>[[category:administrator]]<br />
<br />
<br />
==Martin Langhoff==<br />
* "It restricts a single session from changing IP, and this is mostly a debugging tool for a strange problem that we think is a PHP bug. It does not stop a single user from having more than one session."<br />
* http://moodle.org/mod/forum/discuss.php?d=47271#217274<br />
<br />
==Config.php==<br />
* to turn it on, go to config.php and uncomment:<br />
* $CFG->tracksessionip= True;</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=customscripts&diff=22779customscripts2007-04-26T20:35:40Z<p>Bruno: </p>
<hr />
<div>==Custom Scripts Mechanism==<br />
<br />
Any scripts that are called directly via a url (eg index.php, user/view.php) <br />
can now be customised by placing a file with the same name (including directories) in <br />
my_moodle_data_dir/customscripts<br />
For example:<br />
my_moodle_data_dir/customscripts/index.php; my_moodle_data_dir/customscripts/user/view.php<br />
<br />
* this is for people making short term changes to VISIBLE web pages in the moodle source code<br />
** need to check relative links ; for example: never require ../config.php<br />
** cannot add new files to customscripts folder because they are not accessible directly via web.<br />
** better to use cvs or cogito for long term management of customisations to moodle code<br />
<br />
* it seems to have been used extensively only by the [[Moodle_for_Mobiles]] project<br />
<br />
* to enable Custom Scripts, add $CFG->customscript=path/to/customscript/folder (see [[Configuration_file]])<br />
<br />
==references==<br />
* http://moodle.org/mod/forum/discuss.php?d=31895<br />
* http://tracker.moodle.org/secure/QuickSearch.jspa and type "customscripts"<br />
<br />
[[category:developper]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=customscripts&diff=22778customscripts2007-04-26T20:32:38Z<p>Bruno: </p>
<hr />
<div>==Custom Scripts Mechanism==<br />
<br />
Any scripts that are called directly via a url (eg index.php, user/view.php) <br />
can now be customised by placing a file with the same name (including directories) in <br />
my_moodle_data_dir/customscripts<br />
For example:<br />
my_moodle_data_dir/customscripts/index.php; my_moodle_data_dir/customscripts/user/view.php<br />
<br />
* this is for people making short term changes to VISIBLE web pages in the moodle source code<br />
** better to use cvs or cogito for long term management of customisations to moodle code<br />
<br />
* it seems to have been used extensively only by the [[Moodle_for_Mobiles]] project<br />
<br />
* to enable Custom Scripts, add $CFG->customscript=path/to/customscript/folder (see [[Configuration_file]])<br />
<br />
==references==<br />
* http://moodle.org/mod/forum/discuss.php?d=31895<br />
* http://tracker.moodle.org/secure/QuickSearch.jspa and type "customscripts"<br />
<br />
[[category:developper]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=customscripts&diff=22776customscripts2007-04-26T20:32:08Z<p>Bruno: </p>
<hr />
<div>==Custom Scripts Mechanism==<br />
<br />
Any scripts that are called directly via a url (eg index.php, user/view.php) <br />
can now be customised by placing a file with the same name (including directories) in <br />
my_moodle_data_dir/customscripts<br />
For example:<br />
my_moodle_data_dir/customscripts/index.php; my_moodle_data_dir/customscripts/user/view.php<br />
<br />
* this is for people making short term changes to VISIBLE web pages in the moodle source code<br />
** better to use cvs or cogito for long term management of customisations to moodle code<br />
<br />
* it seems to have been used extensively only by the [[Moodle_for_Mobiles]] project<br />
<br />
* to enable Custom Scripts, add $CFG->customscript=path/to/customscript/folder (see [[Configuration_file]])<br />
<br />
==reference==<br />
* http://moodle.org/mod/forum/discuss.php?d=31895<br />
* http://tracker.moodle.org/secure/QuickSearch.jspa and type "customscripts"<br />
<br />
[[category:developper]]</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=customscripts&diff=22775customscripts2007-04-26T20:28:53Z<p>Bruno: </p>
<hr />
<div>==Custom Scripts Mechanism==<br />
<br />
Any scripts that are called directly via a url (eg index.php, user/view.php) <br />
can now be customised by placing a file with the same name (including directories) in <br />
my_moodle_data_dir/customscripts<br />
For example:<br />
my_moodle_data_dir/customscripts/index.php; my_moodle_data_dir/customscripts/user/view.php<br />
<br />
* this is for people making short term changes to VISIBLE web pages in the moodle source code<br />
<br />
* it seems to have been used extensively only by the [[Moodle_for_Mobiles]] project<br />
<br />
* to enable Custom Scripts, add $CFG->customscript=path/to/customscript/folder (see [[Configuration_file]])<br />
<br />
==reference==<br />
* http://moodle.org/mod/forum/discuss.php?d=31895</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=customscripts&diff=22774customscripts2007-04-26T20:28:17Z<p>Bruno: </p>
<hr />
<div>==Custom Scripts Mechanism==<br />
<br />
Any scripts that are called directly via a url (eg index.php, user/view.php) can now be customised by placing a file with the same name (including directories) in my_moodle_data_dir/customscripts<br />
For example:<br />
my_moodle_data_dir/customscripts/index.php; my_moodle_data_dir/customscripts/user/view.php<br />
<br />
* this is for people making short term changes to VISIBLE web pages in the moodle source code<br />
<br />
* it seems to have been used extensively only by the [[Moodle_for_Mobiles]] project<br />
<br />
* to enable Custom Scripts, add $CFG->customscript=path/to/customscript/folder (see [[Configuration_file]])<br />
<br />
==reference==<br />
* http://moodle.org/mod/forum/discuss.php?d=31895</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Layout_course_editing&diff=15761Layout course editing2006-09-12T07:23:10Z<p>Bruno: </p>
<hr />
<div>==Course Layout Editor==<br />
__NOTOC__<br />
* allows graphical (quick) editing of course layout <br />
** move activities and sections around with javascript<br />
** add activities from other courses<br />
** move , add, delete activities and sideblocks<br />
<br />
* make a backup copy of the course/format/... that you wish to patch <br />
* unzip layout2.zip in that format folder <br />
* copy back the format.php from the backup'd folder<br />
* make the suggested patch in the README provided<br />
* a new link should appear when in "course edit" mode pointing to layout.php<br />
* Timothy Takemoto reports that it works fine in moodle 1.6 (although it is unchanged from moodle 1.5)<br />
<br />
<br />
todo: package in standard manner and upload in standard spot on moodle server, and include appropriate credits and licence notice<br />
<br />
==Layout Editor Version 1.6a==<br />
* Created by Audun Hauge, modified by Timothy Takemoto and packaged by Bruno Vernier (c) GPL 2005-2006<br />
** note: there are at least 2 minor forks of the original version for moodle 1.5<br />
** Bruno attempted to merge them for moodle 1.6 into this package<br />
** please let him have any new patches at bruno.vernier@gmail.com<br />
<br />
==Installation==<br />
# download from http://moodle.org/mod/data/view.php?d=13&rid=49<br />
# Unzip this file at the root folder of moodle source code<br />
# You will next need to MANUALLY add a link within your existing course formats to allow for the layout editor to be enabled. <br />
# edit course/format/'''whatever'''/format.php (or to skip this part, see tip at bottom of this page)<br />
# Look for the commented line '''/// Start main column''' and adjust it to appear as shown below.<br />
<br />
Change:<br />
/// Start main column<br />
echo '<td id="middle-column">';<br />
print_heading_block(get_string('weeklyoutline'), 'outline');<br />
<br />
<br />
To:<br />
/// Start main column<br />
echo '<td id="middle-column">';<br />
$extra = '';<br />
if (isediting($course->id)) {<br />
$extra = ' &nbsp; <a title="'.get_string('layout','layout').'"<br />
href="'.$CFG->wwwroot.'/course/layout/layout.php?id='.$course->id.'">'.<br />
get_string('layout','layout').'</a>';<br />
}<br />
print_heading_block(get_string('weeklyoutline').$extra, 'outline');<br />
<br />
'''note:''' if you are using "topics" or "social", change the''' get_string''' parameter in the line above to the same as in the original line<br />
<br />
<br />
==Using this Feature==<br />
* A link to the course layout editor will appear once editing has been turned on.<br />
* if you don't want to make the patch above, just create a bookmark like this:<br />
** (URL to your moodle site)'''/course/layout/layout.php?id='''(course id number)<br />
* The editor provides a simple to use click and drag interface to allow for a quick and simple adjustment of moodle course design and flow.</div>Brunohttps://docs.moodle.org/2x/ca/index.php?title=Marking_block&diff=15757Marking block2006-09-12T06:25:19Z<p>Bruno: </p>
<hr />
<div>__NOTOC__<br />
<br />
==purpose:==<br />
* to allow teacher to quickly see what needs to be "marked" in '''ONLY''':<br />
# assignments<br />
# journals <br />
# lessons<br />
# forums<br />
<br />
The '''Marking''' block is a Moodle block add-on that provides a summary of activities awaiting grading. It includes a separate page that provides an alternate gradebook functionality ties to the marking block. This block is restricted to teachers and administrators.<br />
<br />
This block displays marking information for newly submitted, resubmitted, and overdue (activities past their defined close dates) activities. The marking page provides the same information and easy access to the grading functions for these activities.<br />
<br />
This block cam also display a list of students below a certain grade level.<br />
<br />
The block can be configured to display a maximum number of students in each list and to set the grade level to display below.<br />
<br />
This directory uses custom code for all activities it summarizes. There are few common activity library functions that can perform the same operations, and thus any new activities to be added will need new code.<br />
<br />
==Installation==<br />
{{Moodle 1.5}}<br />
To install and use, unzip this file into your Moodle root directory making sure<br />
that you 'use folder names'. This will add a new block directory (marking) to<br />
your '/blocks' directory and some language files to your langage directory.<br />
Once unzipped, visit your admin screen and configure the new block the way you<br />
want.<br />
<br />
===setting up marking block for moodle 1.6+===<br />
{{Moodle 1.6}}<br />
* download block_marking_1.6x from http://moodle.org/mod/data/view.php?d=13&rid=445<br />
* unzip it in the root folder of your moodle directory<br />
* adjust the settings in '''admin / configureation /blocks / marking / settings menu'''<br />
<br />
==Usage==<br />
* set '''$CFG->block_marking_listnum =''' ''(some number other than the default 2)'' via the '''admin / configureation /blocks / marking / settings menu''' (the default is to show two activites needing marking per section (unmarked / resubmitted / unsubmitted.)<br />
** set it to a higher number to avoid the illusion that not all items are shown "to be marked" (or click on the "MORE" button instead)<br />
<br />
<br />
==Credits==<br />
<br />
The marking block has been designed and built with the contributions of the<br />
following people:<br />
* Fernando Oliviera - G8 First Nation Schools > original design concept of the marking page<br />
* Darren Smith - Egglescliffe School > orginal design concept of the marking block, and additional design of the marking page<br />
* Mike Churchward - churchward.ca (mike AT churchward DOT ca)> original technical design and development<br />
* Bruno Vernier - block packaging and some bug fixes<br />
<br />
==To do==<br />
<br />
* Make sure all strings are in language file<br />
* Allow configuration of each section (i.e. enable/disable 'below average list')<br />
* Create a local block library file and better compartmentalize functions<br />
<br />
==Links==<br />
* [http://download.moodle.org/download.php/modules/block_marking.zip Download]<br />
* [http://moodle.org/mod/forum/discuss.php?d=45432 Link to forum post with a lang/en file with all strings filled in]<br />
<br />
[[Category:Block (non-standard)]]</div>Bruno