MoodleDocs - User contributions [en]

Development:Migrating to 2.0 checklist

2011-01-28T10:37:01Z

Jp76: /* General */

These are things that OU developers have found so far to check/do in code we're migrating from Moodle 1.9 to 2.0. All information on the detail of this checklist can be found elsewhere in Moodle Docs, and particularly from the [[Development:Migrating_contrib_code_to_2.0]]

Not all these things are essential for a rush job, but if you did all of them, then that'd be great. We should really mark each one with a priority of some sort!

Please add/edit this list!

==Database==

* Leave empty db/update.php file
* New $DB global objects with functions replace old db functions
* $DB parameters swapped to ?
* Add and strip slashes no longer required
* Remove use of ENUM and ENUMVALUES in install.xml file
* check use of sql_substr()
* Get_records() etc now always returning arrays, empty array in case of no records found.
* Db functions throw errors not return false on error
* DB functions offer strictness parameters e.g MUST_EXIST
* Update version.php numbers (esp required)

==Page display==

* New $OUTPUT header and footer functions
* Navigation links need to use $PAGE->navbar
* Make sure that you instantiate the moodle form before any call to $OUTPUT->header()
* Create a renderer
* Change the way image urls are displayed (not $CFG->pixpath any more)
* CSS changes
** Change styles.php to styles.css
** Change page id to new structure e.g. course-format-studyplan to page-course-view-studyplan

==Roles and Permissions:==

* array name to $capabilities in access.php
* Remove references to admin in access.php
* Rename legacy to archetypes in access.php
* Add manager archetype in access.php
* Ensure require_login as well as require_capability checks
* isguest() is depreicated, use !isloggedin() || isguestuser() instead

==Language strings==

* Rename language folder
* Change $a to {$a} in language files
* Change popup help files to _help lang strings and shorten
* Add $string[‘pluginname’] to lang file
* Add $string[‘pluginadministration’] to lang file

==Forms==

* Param_clean parameter type removed
* type required parameter for optional_and required_param
* Replace file form elements with new filepicker
* Replace htmleditor with editor form field type
* Change setHelpButton to addHelpButton. (You need to change the arguments, but the new ones are simpler.)

==General==

* Swap config_ files to edit and settings php files
* Fix whitespace & coding style
* rs_fetch_next_record($rs) is deprecated, in favour of the simple foreach($rs as $var). Calls to rs_close() must be replaced by $rs->close();
* Check functions deprecated list: https://docs.moodle.org/en/Development:Deprecated_functions_in_2.0
* Use print_error() or throw new moodle_exception not error()
* Replace all url strings e.g. in redirect() calls with moodle_url instances
* Move install/uninstall functions from lib to db/install.php, lib/uninstall.php
* Move images into pix folder (especially icon.gif), get path by calling $OUTPUT->pix_url('icon', 'local_whatever');
* Add 'supports' function in lib (modname_supports()) for modules (and blocks?).
* New Backup and Restore process - https://docs.moodle.org/en/Development:Backup_2.0_for_developers https://docs.moodle.org/en/Development:Restore_2.0_for_developers
* Add db/log.php file if you have log calls (see a code module code for example)

Development:Migrating to 2.0 checklist

2011-01-28T10:08:03Z

Jp76: Added backup and restore details

Development:Filters

2009-11-19T12:04:33Z

Jp76: Removed warning as bug no longer present in 1.9 (language strings work in filters)

<p class="note">'''Please note:''' This page contains information for developers. You may prefer to read the [[Filters| information about filters for teachers and administrators]].</p>

'''Filters''' allow for the for the automatic transformation of entered text into different, often more complex forms. For example the titles of [[Resources]] can automatically become hyperlinks that take you to the relevant resource, URLs pointing to [[mp3]] files can become [[Flash]] controls embedded in the webpage that let you pause and rewind the audio. The possibilities are endless and there are a number of standard filters included with Moodle and many more specialized filters contributed by the community.

==To create a filter==

To create a filter that removes all occurrences of the letter "x" - we'll call it "removex":

# Create a new folder inside Moodle's /filter/ folder, called "removex"
# Create a new PHP script file inside the folder you've just created - name it "filter.php"
# Write a new PHP function in this file, called "removex_filter()" which takes two parameters - a course ID and a piece of text to be filtered - and returns the processed text.

For our example the filter.php file would look like:

<code php>
<?php
function removex_filter($courseid, $text) {
return str_replace('x', '', $text);
}
?>
</code>

When trying this out, remember to make sure that you activate the filter in the [[Filters|filters administration screen]].

Also remember that text filtering functions, when activated, will be used intensively by the server, so you should optimise the filters as far as possible (cut down on database calls etc). Moodle caches the results of filtering to help with processing speed, but it's still worth being careful about your filter design.

Filters are applied to all text that is printed with the [[Development:Output functions|output functions]] format_text() or format_string(). One thing to keep in mind when designing the filter is that the function format_text() first applies other transformations (for example text_to_html() or replace_smilies()) before the strings are passed to your filter. The function format_string() on the other hand passes the string as it is.

==Adding a settings screen==

Moodle 1.6 added the options for filters to have their own settings screen. To do this perform the following steps:
* In the same folder as the filter create a file called '''filtersettings.php'''.
* Add admin_setting objects to the $settings page like this:
<code php>
$settings->add(new admin_setting_configcheckbox('filter_myfilter/mysetting',
get_string('mysetting', 'filter_myfilter'),
get_string('configmysetting', 'filter_myfilter'), 0));
</code>

In standard Moodle, the censor, mediaplugin and tex filters have good examples of what you need to do.

==A note on language strings==

As the sharp-eyed will have noticed in the last section, the language strings for your filter (if any) should go in the file filter/myfilter/lang/en_utf8/filter_myfilter.php, and can be accessed using
<code php>
get_string('mystring', 'filter_myfilter').
</code>

You can copy and paste the following to start your filter_myfilter.php file:
<code php>
<?php // $Id$
// Language string for filter/myfilter.

$string['filtername'] = 'My magic filter.';

</code>

==See also==

* [[Development:Filters 2.0]] The new version of these instructions for after Moodle 2.0 is released.
* [[Filters schema]] - a page containing some ideas and thoughts about modifications to the filters system
* [[Filters]]

[[Category:Developer|Filters]]
[[Category:Filter]]