MoodleDocs - User contributions [en]

Category:DevDocs Migration

2024-08-27T14:53:25Z

Andrewnicols: Reverted edits by Fox (talk) to last revision by Andrewnicols

Moodle is currently assessing options for improving Developer Documenation and resources.

As a part of this assessment we are also assessing alternatives to WikiMedia for this documentation and are migrating some of the content in this wiki into the systems we have under assessment.

To keep track of the pages that have been migrated, and to help consider how such a migration could be managed, we have created a new Category for the migration, as this will allow us to find and identify any documentation which has or has not been moved. In the event that we do adopt one of the systems that we are exploring it is hoped that we will also be able to make use of any transitioned documents, and apply any updates since the change was made.

More information on any changes will be announced at a later date.

Policy - Retroactive effects of completion settings

2024-05-07T05:21:09Z

Andrewnicols: This page contains very out-dated content.

{{Template:obsolete}}
== Summary ==

The question was:

Should past activity completions be retroactively affected by changes to settings?
That is, after a student completes an activity and it's marked as "completed-passed", "completed-failed", etc., might it later become "incomplete"?

This question was decided by by Martin Dougiamas on Tue Mar 25 per tracker issue MDL-39624. Dougiamas decided:

''Completion of an activity is final and not affected by future settings changes (unless you manually reset it and are warned loudly and students are informed).
''

Documentation of the reasoning, pro and con, is below as it was posted prior to the decision being made.

-----

As one example, a student might complete a Quiz, with a passing grade. The quiz is marked as completed-passed, which opens up a Certificate. The student prints the certificate and files it with regulators.
Six months later, the teacher decides that from now on the passing grade should be higher. The teacher changes the "grade to pass" setting. Should the student who completed and passed six months prior now
be marked as "failed", and their certificate revoked?

Two major categories of actions were mentioned, and two types of "intentions", or use-case scenarios, with different policies appearing reasonable depending on the type of
action and use-case or intention of the user. Actions can be a) changes to what a student has done , such as submitting or deleting an assignment or b) settings/requirements adjustments by the teacher.
Settings changes may be the result of two types of intentions - a decision that the new requirements should be different from the old, or a correction to an incorrect setting.

== Changes to what a student has done ==

Sam Marshall gave two examples suggesting that when there is a change to what a student has done, that could change the fact that something the student completed something.
<blockquote>
Example 1: If you just use 'on grade' completion, if a student does something and gets a grade, it will be marked complete. If the teacher then deletes their grade from gradebook, it will be marked incomplete again.

Example 2: In forum, if you set it to be complete after making 3 posts, and the student makes 3 posts, it will be marked complete. But if the teacher then deletes one of the posts, it will be marked incomplete again.

It could be argued that things should not be automatically 'un-completed' in this way (there are cases when both the above examples definitely seem appropriate, but it might be OK if the teacher had to manually un-complete them as well)
</blockquote>

No reasoning was posted with an opposing view on what should happen when changes are made to ''what a student has done''.

== Changes to settings ==

There are different opinions in regards to changes to settings, such as the grade required to pass. If a student completes an activity, such as passing a test, and some time later the "grade to pass" is changed, should their "completed-passed" be changed to "completed-failed", or should the changes apply "from now on"?

Per Ekström wrote:

<blockquote>
I would say, no.

As a student, you're given a deal; "Get a score of X or higher and you pass." If the bar is raised, and it's applied retroactively, then you are basicly breaking your end of the bargain. A pass is a pass no matter what, even if a teacher afterwards raise to 80%. ...

The most important thing with a grading system is that it's predictable and perceived fair. Retroactivity makes it everything but. Therefore I do not recommend it.
</blockquote>

Where Ekström uses the word "deal", common law uses the word "contract", and "breaking your end of the bargain" could be called "fraud".

Another example supporting this view was posted:
<blockquote>
Working as a private investigator without passing the required classes and staying up with continuing education is a crime. If I took the class and later the teacher changed the requirements and the system retroactively failed me, that would expose me, the student, to criminal charges.
</blockquote>

A different view was expressed by Tim Hunt:
<blockquote>
As a teacher, you are only human. Sometimes you make mistakes. You accidentally create a quiz with a passing grade of 90% (or forget to set the passing grade so it defaults ot 0%?). Then some students attempt the quiz and point out the mistake to you, so then you correct it to 80% and expect Moodle to automatically fix the completion state for students who already got between 80 and 90%.
</blockquote>

It was suggested that if the teacher knows they made a mistake and are correcting it, they can also correct the results of that mistake - manually changing passes to fails or vice-versa.

That is the open question - ''if settings/requirements are changed'', should Moodle automatically, retroactively change prior completions based on the new settings?

== Can changes for these two reasons be separated? (Not really.) ==

(sam marshall)

It will be technically difficult to separate the 'changing based on what a student has done' from 'changing settings'. I think we will need to make the behaviour consistent so that either of two rules applies:

OPTION B: Once a 'completed' or 'completed-passed' completion status is obtained, it should not change unless a teacher manually resets it.

OR (as supposedly true at present)

OPTION A: All completion statuses should change if the conditions or data changes.

(Note that I left completed-failed undefined because we want to let people retry things so it can't be 100% consistent this way...)

In other words I don't think we should attempt to treat 'changes in data' and 'changes in settings' as distinct situations that can be handled differently, as the page above might imply.

=== Example ===

Here's why I think it is impossible to treat the two cases (changes to actual data/user input vs changes to settings) as separate in general. Imagine that we are trying to do so (update 'completed' to 'not completed' for data changes, but not for setting changes). Consider this sequence:

1. In a forum, 3 posts are required for completion.

2. Student A makes 4 posts and is marked complete. Student B makes 3 posts and is marked complete.

3. Somebody changes the settings so that 5 posts are now required. (This is a settings change, so completion states aren't updated.)

4. Somebody deletes one of Student A's posts so that they now only have 3 posts. (This is a data change, so completion state is updated.)

In this situation, there has been a change to the data, so if we are treating those as separate then it is correct to potentially mark the student as not complete. But we do not store the historical values of all the setting, so we have to consider this according to current data; i.e. every time somebody gets a post deleted the system needs to check if they still have more than 5, and student A does not. As a result, student A would be marked 'not complete'.

This would be unfair because both students A and B have made 3 valid posts but B is still marked complete and A is not. (Note: In the current system, both A and B would have been marked incomplete at stage 3. In Option B, both A and B would remain complete; a student C who only made their posts after step 3 would have a disadvantage, but at least that's more easily understood i.e. when teachers change the settings they know they are making it harder for people from now on.)

[In other words, the new criteria would apply only to currently active students, and removing a post indicates activity. This would not be ideal, but it separating them may be better than the alternatives. - Ray Morris]

== See Also ==

[https://moodle.org/mod/forum/discuss.php?d=226129 Forum discussion of the question]

[https://tracker.moodle.org/browse/MDL-37993 Tracker issue which initiated the discussion]

SWF

2024-05-07T05:20:34Z

Andrewnicols: This page contains very out-dated content.

{{Template:obsolete}}
==SWF Activity Module==

The module documentation on this page is out of date. Please see the [[SWF Activity Module]] project site for up to date downloads, documentation and help.

I've moved the project code and documentation to Google Code: [http://code.google.com/p/swf-activity-module/ code.google.com/p/swf-activity-module/]

The most recent downloads and documentation are available there.

==What is the SWF Activity Module?==

The SWF Activity Module provides a comprehensive and flexible method for deploying Flash and Flex Framework learning applications as activities in a Moodle course.

==How does is work?==

===SWFObject===

The SWF Activity Module uses [http://code.google.com/p/swfobject/ SWFObject] as the default embed method for Flash and Flex Framework learning applications. The module also incorporates standard XHTML 1.0 strict object and embed code that functions if SWFObject fails for any reason, e.g. If the user has Javascript blocked in his/her browser.

Once installed, select SWF from an "Add an activity" list on a Moodle course page. The standard "Adding a new SWF to topic... " moodleform will appear. Help files are included in the SWF Activity Module in English and provide further details about the parameters. In this form you can set the following parameters:

===Required Parameters===
<pre>
* As with all Moodle activities, name and intro.
* SWF file
* Height
* Width
* Version
</pre>

===Optional Parameters===
<pre>
* AMF Interaction (Not yet implemented)
* XML file URL
* FlashVars #1
* FlashVars #2
* FlashVars #3
</pre>

===Advanced Parameters===
<pre>
* API Key (SWF Activity Module custom parameter)
* Align
* Auto Play
* Loop Playback
* Menu
* Quality
* Scale Mode
* Stage Align
* Window Mode
* Background
* Use Device Font
* Seamless Tabbing
* Allow Full Screen
* Allow Script Access
* Allow Networking
</pre>
You can find more details about these parameters in the [http://code.google.com/p/swfobject/wiki/documentation SWFObject Documentation].

==What features does it support?==

The SWF Activity Module automatically provides a deployed SWF learning activity application with the following data:
<pre>
* gateway - URL to gateway script for access to AMFPHP service library
* course - the current Moodle course that the user is accessing
* instance - Instance ID of the module
* swfid - The ID of the SWF learning activity application
* interaction - The ID of the SWF learning interaction data to consume (AMFPHP)
* moodledata - The URL to access the current moodledata course directory (file.php)
</pre>
It also supports a number of features, specific to Flash and Flex applications. They are:

===Flash Remoting (AMF)===

Flash Remoting is a method for Flash or Flex applications to communicate directly with server-side applications written in .NET, Java, PHP, Cold Fusion and Ruby on Rails. There are a number of open-source libraries for handling communication via Flash Remoting:

See [[AMF3]] for details on how to set up AMFPHP in Moodle and more information about Flash Remoting technologies.

===XML Data Loading===

XML is a native data type to ActionScript 3.0 therefore Flash and Flex Framework learning applications use E4X notation to manipulate XML data in a similar way to a multidimensional array. For more details, see [http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/ Adobe Actionscript 3.0 Language and Components Reference]. XML is also currently the most commonly used format for providing elearning data for learning interactions. The most commonly used format is [http://en.wikipedia.org/wiki/IMS_Global IMS]'s standard [http://en.wikipedia.org/wiki/QTI QTI] (Question and Test Interoperability specification) but basically any valid XML file with the appropriate data tree structure can be loaded into and consumed by a SWF file.

===FlashVars===

FlashVars is a method for passing string data into a SWF file. It is passed in from the printed HTML page that the SWF file is embedded in. It's ideally suited to very simple data sets such a vocabulary lists or series of numerical values. For learning activities such as hangman, crosswords, word searches, etc., FlashVars is simple, efficient and easy to use.

==What's Next?==

===Moodle Grades===

One of the most requested features for Flash and Flex Framework learning applications deployed in Moodle is for them to have the ability to record learners' activities in Moodle's Gradebook.

===AMFPHP===

The most powerful and flexible way for Flash and Flex Framework learning applications to interact with Moodle APIs, databases and web services is via Flash Remoting AKA [http://blogs.adobe.com/mikepotter/2006/12/amfphp_adds_amf.html AMF3], a communication protocol which is similar to JSON but much faster. It allows Flash and Flex Framework learning applications to directly call PHP methods and pass a number of different data types back and forth seamlessly.

For more details about using AMFPHP in Moodle, see [[AMF3]]

===Learning Interaction Data DB Structure===

A standardised DB table structure to store learning interaction data with a variety of methods to populate the tables with data, including Moodle forms, dynamic Flash or Flex Framework on-line forms.

Also, standalone Adobe AIR desktop GUI applications, which can store data locally using SQLite, to create and edit learning interactions and then upload them. Using Adobe AIR will also provide convenient backup of interaction data and a means to easily transfer and distribute learning interactions.

====swf_interactions fields====
<pre>
* id
* course
* name
* intro
* introformat
* amftable - Default is swf_interaction_data but this allows for further, more specialised tables to be used
* timecreated
* timemodified
</pre>

====swf_interaction_data fields====
<pre>
* id
* interaction - ID of interaction (id of swf_interactions)
* ordernum - Allow sequential ordering of rows
* amp3 - URL of answer MP3 file
* qmp3 - URL of quesition MP3 file
* smp3 - URL of additional MP3 file
* image - URL of image file
* video - URL of FLV file
* ptext - Paragraph text
* qtext - Question
* catext - Correct answers (for multiple choice, use pipe separator as delimiter)
* watext - Wrong answers (for multiple choice, use pipe separator as delimiter)
* timecreated
* timemodified
</pre>

==See Also==

* [[AMF3]] Flash Remoting for Moodle.
* [http://code.google.com/p/moodle-mplayer/ Media Player] Activity Module for deploying video in Moodle as an activity. Leverages the full range of functions of Jeroen Wijering's JW FLV Player.
* [http://matbury.com/ Matt Bury's website and Moodle] with demos of SWF Activity Module and Media Player modules.

Themes 2.0 overflow problems

2024-05-07T05:19:51Z

Andrewnicols: This page contains very out-dated content.

{{Template:obsolete}}

This document examines the overflow:hidden - fixed width problem currently plaguing several areas of Moodle 2.0 (as of October 26, 2010)

http://tracker.moodle.org/browse/MDL-24895 Has been created to track implementation of a solution

==The problem==

Content that is too wide for the main content area is not displayed correctly is obscured behind the side blocks or off-screen, and the browser doesn't scroll horizontally.

To see it, shrink your browser window and look at:

# http://moodle.org/mod/forum/discuss.php?d=32796 (large image: 15.748px × 3.893px)
# http://moodle.org/mod/forum/discuss.php?d=114746 (large table) --[[User:Frank Ralf|Frank Ralf]] 10:44, 27 October 2010 (UTC)

It is caused by '''oversized, unwrappable content''':

# Large images or other media of one form or another.
# Tables, any table that has numerous columns and/or large content in columns.
## Tabulated data
## Tables for internal layout (like the forum)
# Unwrappable content
## This is normally always user-entered text or images.
## Different browsers handle things differently.

==The technical description==

The cause is a combination of the fixed width that gets set on the core layout XHTML, and the overflow:hidden setting that is required by the layout.

The layout used in the base theme within Moodle is based on Matthew James Taylor's [http://matthewjamestaylor.com/blog/ultimate-3-column-holy-grail-pixels.htm Holy grail layout] which is an excellent layout, however (and it does state this in the description of the layout) wide content is a known problem.

This problem starts on the very first div that contains content within the body *<div id="page-content">....</div>* which has the following style:

<syntaxhighlight lang="css">
#page-content {
clear:both;
float:left;
overflow:hidden;
position:relative;
width:100%;
min-width:900px;
}
</syntaxhighlight>

Setting the width to 100% instantly boxes the displayable area to just the browsers internal display width, and then overflow:hidden ensures that any overflow is not visible.

This is required because the premise of this layout is to move everything out of the viewport and then move things back into the correct position and in doing this it goes as far as expanding content divs out to 200% width.

Because of this if we remove the width 100% and/or overflow hidden everything breaks because the page will ALWAYS expand beyond the browsers displayable area even if the content is easily displayed.

As far as I can see there is no way to avoid this problem while using this layout.

On the other hand there are very good reasons for using this layout:
* it is cross browser,
* columns are orderd 2,1,3 which is good for accessibility and search engine optimisation, and
* in EVERY other respect it works well

==Proposed solution 1 - Additional wrapper DIV ==

A couple of days ago I sat down with Martin and explained this to him and we looked into it and came up with the following three part solution:

# Wrap format_text output within a div with a class that allows us to manage overflow. The themes can then turn on overflow:auto for these areas to make sure that user content wraps correctly (eg forum post content).
# Convert places that use tables for layout to divs (eg forum posts) so that they wrap cleanly. Without this the large user content causes the table cells to grow too large, causing wrapping issues.
# Locate places where tables are likely to require horizontal scrolling and wrap them in divs with a class like `flexible-wrap` that sets an overflow:auto so that the table is scrollable if required.

===Advantages===

# A standard way for developers and themers to deal with these issues (can go in coding guidelines)
# Will remove the possibility for users to intentionally/accidentally destroy the interface by posting large content

===Possible problems===

# Because all format_text calls will be wrapped by this special div there might be regressions throughout Moodle - we will have to review the calls and possibly disable the new wrapping divs for some of them. (For example, quiz multiple choice options are processed by format_text, then output inside a Label. The wrapping div would break that horribly.)
# Some parts of Moodle can never be made to fit in a sensible width. For example the gradebook, and other reports.
# IE6/7 (and possibly IE 8/9?) render their scrollbars INSIDE an element rather than outside like most other browsers meaning that there is a *VERY* high chance there will be redundant scrollbars within some elements that don't actually require wrapping (on these browsers)
# Elements that require scrolling will have their own scrollbars and particularly in the case of tables this is likely to require scrolling the page vertically to locate the horizontal scrollbar, scrolling horizontally and then locating the desired row vertically again.
# Elements with a set width (e.g.style="width:2000px") greater than the content area will need to be wrapped in a div with the wrapping class as well.

==Proposed solution 2 - Source code order ==

Compromise, and use a 1, 3, 2 or 1, 2, 3 layout (with skip links for accessibility).

===Advantages===

# It can be made to work for all pages.
# We use a 1, 3, 2 at the OU, and it is reliable.

===Possible problems===

# Slightly less accessible (unless you are comparing with the current situation that actually chops off text for most users even before you start resizing fonts, and is therefore infinitely less accessible, of course).
# Hurts our pride to give up on a 2, 1, 3 layout.

==Proposed solution 3 - JavaScript ==

Add some JavaScript to the page, so that once everything has been laid out, it computes how wide the page needs to be to avoid truncation, and then changes the min-width: 900px to whatever width is needed to make the content fit.

===Advantages===

# Might be the easiest solution to implement.

===Possible problems===

# Ewwwwwww! This is clearly a horrible hack.
# JavaScript for layout is deeply evil.

==Proposed solution 4 - Admin theme ==

Use different page layouts for different needs. Admin/settings pages show very different content than the normal learning pages. All pages for admins and teachers where they change settings or edit content are shown with the admin theme. Two different page layouts would solve a lot of issues. In for example WordPress and Drupal the concept of the admin theme for admin/settings pages and the "nice" theme for content is standard.

# Use an "admin theme" with flexible width and a 1-2 layout for the admin and settings pages. The huge tables are mainly on the admin pages. Most table issues would be solved this way.
# Use the existing 2-1-3 fixed width layout for all learning pages.
# Change all tables in the forum layout and other modules if existent to div layouts.
# Create a filter to display a miniature of oversized media and open the original size in a bigger overlay on click. The maximum width can be a setting in the filter to fit different theme needs.

===Advantages===

# The pages with different needs get different layouts better fitting these needs.
# One optimized admin theme can be used with many different themes. Theme designers can focus on the content pages when they work on themes.
# The flexible width admin theme helps a lot when the content shall be displayed in any fixed width page layout.
# The different look of the admin theme signals: be careful - you are changing things which may seriously affect the system or the learning content.
# I use an flexible width admin theme I developed for some time now with all fixed width themes and solve the table width issues on admin/settings pages. It's always the same admin theme with very different content themes.

===Possible problems===

# The deeply nested forum threads issues are not solved with the admin theme.

==Opinions==

; Tim
: I vote for 2, or failing that 3. I think 1. will not work.

; Sam
: agree with Tim except I don't think 3 is likely to be reliable either.
: http://moodle.org/mod/cvsadmin/view.php?conversationid=5929

; Frank
: IMHO the only real problem is '''2.2.Tables for internal layout (like the forum)''' and possibly 3.2. (Which, by the way, only proves that tables for layout are a bad thing, [[User:Frank Ralf/Semantic HTML3]]). Any other ''oversized, unwrappable content'' will break the layout one way or another and should be the responsibility of the author. That said, I favor solution 2; any solution which requires JavaScript (3) only makes the situation even more complex. --[[User:Frank Ralf|Frank Ralf]] 14:41, 26 October 2010 (UTC)

; Urs
: I vote for 4.
: 3 is no option - from my experience using JavaScript to correct page issues breaks every once in a while.
: 2 does not solve the table width issue in fixed width themes.
: 1 seams to offer more problems than advantages.
: Please don't throw out the existing 2-1-3 page layout. In my opinion to skip it means much more than it "Hurts our pride to give up on a 2, 1, 3 layout.". By introducing an admin specific theme many issues can be solved. Additionally theme designers have less pages to work on.
: I thought all table based page layouts should have gone in Moodle 2.0.

==Chosen solution==
Thank you to everyone for your thoughts both in this discussion and the developers chat.

The solution that we will go with is as follows:

# An option will be added to format text that when set to true will wrap the text in a final div before returning it. This div will have a class with a predefined style so that large content is displayed with scrollbars if required, The option will be '''off by default''' but as part of the solution a review of format_text usage will be performed and the option turned on where required.
# Forum posts will be converted from using tables for layout to a div structure. I have already created a patch for this which is largely backwards compatible with existing themes and changes the forum posts structure as little as possible.
# A new '''report''' layout will be created, see the section below for details. A review all reports and uses of tables for pages where the new report layout should be implemented.

As well as the above tasks there will of course be the ongoing tasks of locating areas also affected by this problem and finding solutions on a case by case basis.

===The report layout===
The new layout won't use the 2,1,3 structure of existing layouts and won't be quite so accessible which isn't a big concern as we will only use it when there is no other option and in those few cases the content is normally not at all accessible anyway.

This layout will have one block region by default and will be a 1,2 layout (1=blocks, 2=content).

It is unfortunate that we need to move away from the 2,1,3 layout for the default themes (base, and standard) however after much deliberation it was decided that this was going to provide the most natural feel for most users.
This will only be done in this one layout and it will be stressed that this layout only be used where absolutely essential, in fact it will only be allowed in situations where the content is tabulated data that is likely to require it.
Anywhere tables have been used incorrectly will be converted as part of the ongoing tasks.

As part of the deliberations and trials with this there was also a report layout created that would be more accessible where the blocks were below the main content (block laid out horizontally as well). This layout whilst not used in the end will be preserved in a docs which I will link to after I write it.

Calendar API old

2024-05-02T01:37:09Z

Andrewnicols: This page contains very out-dated content.

{{Template:obsolete}}
This page documents the calendar API that existed before Moodle 3.3. For the API since then, see [[Calendar API]].

The Calendar API allows you to add and modify events in the calendar for user, groups, courses, or the whole site.

==Overview==

The Moodle [[:en:Calendar|Calendar]] collects and displays calendar events from everything users have access to.

If your plugin generates calendar events (such as due dates) then you need to add your events to the calendar.

==File locations==

All the calendar code is located in /calendar/lib.php. You need to include this file in your script if you intend to use it.

==The calendar_event class==

In general functionality of calendar_event() class are to create, update and delete events.

===Creating new event===
Creating new calendar event to database by defining some properties for the event.

If event hook is used, it will also call self::calendar_event_hook() to create event for the hook.
<syntaxhighlight lang="php">
calendar_event::create($properties)
</syntaxhighlight>

===Updating event===
Updating an existing event in database by providing at least an event id. If the event is a repeated events, the rest of series event will also be updated (depending on the properties value of repeateditall). This function could also be use to insert new event to database If the requested event is not exist in database. The optional parameter $checkcapability is use to check user's capability to edit/add event. By default $checkcapability parameter is set to true.

If event hook is used, it will also call self::calendar_event_hook() to update the hook event.
<syntaxhighlight lang="php">
calendar_event::update($data, $checkcapability = true)
</syntaxhighlight>

===Deleting event===
Deleting an existing event in database. The optional parameter $deleterepeated is use as indicator to remove the rest of repeated events. The default value for $deleterepeated is true. Deleting an event will also deleting all associated files related to the event's editor context.

If event hook is used, it will also call self::calendar_event_hook() to delete event for the hook.
<syntaxhighlight lang="php">
$calendar_event = new calendar_event($event_data);
$calendar_event->delete($deleterepeated = false)
</syntaxhighlight>

===Event hook===
The capability to use hook to perform specific action to calendar event. This requires setting up $CFG->calendar and include external calendar file in $CFG->dirroot .'/calendar/'. $CFG->calendar .'/lib.php').
<syntaxhighlight lang="php">
calendar_event_hook($action, array $args)
</syntaxhighlight>

==Functions==
List of function for calendar and calendar_event.

===Retrieve or print calendar's information===
<syntaxhighlight lang="php">
calendar_get_default_courses()
calendar_get_days()
calendar_get_starting_weekday()
calendar_day_representation($tstamp, $now = false, $usecommonwords = true)
calendar_time_representation($time)
calendar_wday_name($englishname)
calendar_days_in_month($month, $year)
calendar_get_link_href($linkbase, $d, $m, $y)
calendar_get_mini($courses, $groups, $users, $cal_month = false, $cal_year = false)
calendar_get_popup($is_today, $event_timestart, $popupcontent = '')
calendar_add_month($month, $year)
calendar_sub_month($month, $year)
calendar_get_module_cached(&$coursecache, $modulename, $instance)
calendar_get_course_cached(&$coursecache, $courseid)
calendar_print_month_selector($name, $selected)
</syntaxhighlight>

===Control calendar display===
<syntaxhighlight lang="php">
calendar_top_controls($type, $data)
calendar_filter_controls(moodle_url $returnurl)
calendar_preferences_button(stdClass $course)
calendar_set_filters(array $courseeventsfrom, $ignorefilters = false)
calendar_get_link_previous($text, $linkbase, $d, $m, $y, $accesshide = false)
calendar_get_link_next($text, $linkbase, $d, $m, $y, $accesshide = false)
</syntaxhighlight>

===Retrieve calendar_event information===
<syntaxhighlight lang="php">
calendar_get_allowed_types(&$allowed, $course = null)
calendar_add_event_allowed($event)
calendar_edit_event_allowed($event)
calendar_user_can_add_event($course)
calendar_show_event_type($type, $user = null)
calendar_set_event_type_display($type, $display = null, $user = null)
calendar_get_events($tstart, $tend, $users, $groups, $courses, $withduration = true, $ignorehidden = true)
calendar_events_by_day($events, $month, $year, &$eventsbyday, &$durationbyday, &$typesbyday, &$courses)
calendar_get_upcoming($courses, $groups, $users, $daysinfuture, $maxevents, $fromtime = 0)
calendar_get_block_upcoming($events, $linkhref = NULL)
calendar_format_event_time($event, $now, $linkparams = null, $usecommonwords = true, $showtime = 0)
calendar_add_event_metadata($event)
</syntaxhighlight>

==Examples==
The following are examples of using the basic calendar_event API in Moodle.

===Example to create new event===
Creating new calendar event for closing feedback date.
<syntaxhighlight lang="php">
$event = new stdClass;
$event->name = get_string('stop', 'feedback').' '.$feedback->name;
$event->description = format_module_intro('feedback', $feedback, $feedback->coursemodule);
$event->courseid = $feedback->course;
$event->groupid = 0;
$event->userid = 0;
$event->modulename = 'feedback';
$event->instance = $feedback->id;
$event->eventtype = 'feedbackcloses'; // For activity module's events, this can be used to set the alternative text of the event icon. Set it to 'pluginname' unless you have a better string.
$event->timestart = $feedback->timeclose;
$event->visible = instance_is_visible('feedback', $feedback);
$event->timeduration = 0;

calendar_event::create($event);
</syntaxhighlight>

===Updating existing calendar event===
Simple example of updating exiting event through moodle form.
<syntaxhighlight lang="php">
$eventid = required_param('id', PARAM_INT);
$event = calendar_event::load($eventid);

$data = $mform->get_data();
$event->update($data);
</syntaxhighlight>

===Deleting existing calendar event===
Simple example of deleting existing event from database.
<syntaxhighlight lang="php">
$eventid = required_param('id', PARAM_INT);
$event = calendar_event::load($eventid);
$event->delete($repeats);
</syntaxhighlight>

==See also==

* [[Core APIs]]
* [[:en:Calendar|Calendar user docs]]
* [[Calendar types]]

[[Category:API]]

Collaborate

2024-05-02T01:35:55Z

Andrewnicols: This page contains very out-dated content.

{{Template:WillNotMigrate}}
A module for integration with Blackboard Collaborate.

Now your users can join a Collaborate with the Ultra experience session from their Moodle class. They don't need to install Java or download and open Java-reliant files to their devices. The session opens in a new window or tab, depending on a their browser settings.

When you install and enable the module, your instructors can add Collaborate to their classes. They can create virtual classrooms, offices, and meeting spaces to engage their students in a more collaborative and interactive learning experience.

Visit [https://en-us.help.blackboard.com/Moodlerooms/Administrator/020_Manage_a_Site/050_External_Tools/010_Blackboard_Collaborate Blackboard's Help documentation on Collaborate] for more information

Code Cross-Reference

2024-05-02T01:35:32Z

Andrewnicols: This page contains very out-dated content.

{{Template:obsolete}}
There used to be a code cross-reference at http://xref.moodle.org (generated from the Moodle source code using [http://phpxref.sourceforge.net/ PPHPXref])

Unfortunately it can no longer be maintained on that server. If you create a replacement site please link to it from this page.

To have xref.moodle.org pointed to your site, please contact Martin Dougiamas via the http://moodle.com/helpdesk

'''Access the Moodle 1.8''' Code [http://72.15.209.135/index.html cross-reference here]

Testing strategy/The Moodle Testing Process

2024-05-01T23:17:34Z

Andrewnicols: This page contains very out-dated content.

{{Template:obsolete}}
{{Work in progress}}
=Methodologies in the Moodle Development Process=
Moodle has an established process for developing and integrating software. This section describes relevant testing methodology within the existing process.
The full [https://docs.moodle.org/dev/Process development]
life-cycle at Moodle is documented in detail [https://docs.moodle.org/dev/Releases#General_release_calendar elsewhere].
Moodle is currently developed using Agile methodologies including
Scrum. The following stages of development take place within this
life-cycle:

* Weekly integration cycle
* 3-weekly stable sprints
* 6-monthly major releases
* 3 minor releases between every major release

==Weekly (Continuous) Integration Cycle==
A manual testing phase of integration issues occurs towards
the end of the SDLC at Moodle during the Wednesday (AWST) testing
phase. This is the last possible chance Moodle gets to capture
regressions. Relying soley on this phase to capture regressions could result in the late discovery of regressions
during unguided exploratory testing and worse still the introduction
of regressions into Master. Discovery of issues late in the SDLC
prevents issues from being dealt with in a timely manner when
integrators, or even those writing the code, are able to resolve those issues relatively easily.

The processes described here ensure the bulk of
testing and the majority of responsibility for capturing regressions
does not lie with the Wednesday testing phase. Testing is performed as early in the SDLC as possible.
==New Unit Tests==
Creating unit tests prior to coding starts
the whole SDLC off with a focus on quality. If code isn't
considered complete until unit tests pass, then the code itself will
be of a high quality by the time it is implemented. This also creates a
repository of unit regression tests in an iterative manner while not
requiring of a great deal of extra effort to write those tests. As
these tests are added, they will provide early regression testing of
new code.

Unit tests in the PHPUnit framework are a requirement when submitting code to Moodle.

==Integration Steps==
===Step 1: GIT Pull to integration CI server===
When developers are ready to submit their code into the integration process, they set the status of the tracker issue to 'Ready for integration'. This in turn triggers the Jenkins CI job "Pre-check remote branch". This job performs the following tasks:
* Pull the changes to a local branch on the Integration CI Server.
** git reset --hard origin => so it is in the same status than the official git repository
** git pull => get the changes proposed by a developer
* Run checks on the code.
* Generate a results artefact that is sent to the developer.

Please note; each job begins by resetting the local git repository to the original state so the pulls are never permanent. This mitigates the risk posed by "collisions" as the purpose of this step is not to test for "collisions" between conflicting patches but to verify that code meets the required standard to proceed to peer review.
===Step 2: Peer Review===
Any code sent back to the developer at Peer Review, after any changes have been made, must be must pass step 1 again before re-review.
===Step 3: GIT Pull to integration===
Code passing peer review can be pulled from the developers repository to integration where, among other things, the main Jenkins integration jobs run. At this stage integrators also check for "collisions" and conflicts between submitted patches.
===Step 4: GIT Pull to Nightly Build Machine, performance and browser driven automation suite===
A set of regression tests are run at 2AM AWST Daily. These tests are scheduled to run automatically from the Moodle test automation framework and run on all supported platforms e.g. all databases MySQL, Oracle, MSSQL, PostgreSQL. The following tests are performed in this order:
# Moodle unit tests, including those submitted by developers.
# PerfComp performance comparison tests.
# Selenium acceptance tests, automated browser tests based upon the existing Moodle QA test suite.
===Step 5: Issue retest===
On Wednesday (AWST) the manual issue retesting is performed at Moodle HQ. Issue test steps must be clear and concise, allowing the issue to be recreated easily. Testing steps must go in the testing instructions field to prove that the bug is resolved. Areas of Moodle to investigate with extra exploratory testing should be entered here also.

==Stable Sprints and Point Releases==
Development work performed during stable sprints and point releases are subject to the stringent integration review and testing process described above.

==Major Releases and New Development==
The Moodle QA cycle is a user acceptance testing phase at the end of every 6 month development cycle and is a chance for the community to become directly involved in road testing the latest testing release.

In reality testing starts much earlier in the development process. All code submitted to Moodle has to pass through the integration process and normally does so in an incremental manner. Any additional testing to be undertaken for a Moodle release is tailored to what will be in that release and defined in the [https://docs.moodle.org/dev/2.4_Test_Plan current release test plan test plan ].

en/Mathjax docs changes

2024-05-01T23:14:47Z

Andrewnicols: This page contains very out-dated content.

{{Template:obsolete}}
In MDL-44780 the new Mathjax filter was turned on by default in Moodle 2.7. The following user documentation changes are suggested.

==https://docs.moodle.org/26/en/Performance_recommendations==

I would suggest a link to https://docs.moodle.org/26/en/Performance_settings at the end of the "Performance of different Moodle modules" section in the form of a link like "Click here for additional information on performance related Moodle settings".

==https://docs.moodle.org/26/en/Performance_settings==

There current text is...

Check your filters. Having too many filters active can have serious effects on server load, especially on lower-end systems. The number of active filters has a direct effect on the perceived latency of your site; that is the time taken for each page impression.

My suggestion is...

Check your filters. Having too many filters active can have serious effects on server load, especially on lower-end systems. The number of active filters has a direct effect on the perceived latency of your site; that is the time taken for each page impression. Check if any of the filters can be disabled. For example, if your site does not need to be able to display mathematical equations you can disable the Mathjax filter.

==Thanks==
Changes added to 2.7 docs, thanks. --[[User:Mary Cooch|Mary Cooch]] ([[User talk:Mary Cooch|talk]]) 20:15, 5 May 2014 (WST)

Community hub tests

2024-05-01T05:00:43Z

Andrewnicols: This page contains very out-dated content.

{{Template:obsolete}}
'''Note:''' This list is a work in progress. See [[QA testing]] if you'd like to help writing new QA tests and if you have any questions or comments on any aspect of our QA testing process, please post in the [http://moodle.org/mod/forum/view.php?id=56 Testing and QA forum].

This page lists community hub tests with links to corresponding QA tests.

If you'd like to help with Moodle testing, see [[QA testing]].

'''Requirement:''' for most of these tests you will need to have access to a site and a hub as administrator.

==Hub registration==
* MDLQA-123 Register a hub
* MDLQA-XX Update a hub
* MDLQA-124 Unregister a hub

==Site registration==
* MDLQA-125 Register a site
* MDLQA-XX Update a site
* MDLQA-126 Unregister a site

==Course publication==
* MDLQA-127 A teacher can advertise a course on a hub
* MDLQA-XX A teacher can update an advertised course
* MDLQA-128 A teacher can share a course on a hub
* MDLQA-129 A teacher can remove an advertised or shared course on a hub

==Community block==
* MDLQA-XX Add a course to the community block
* MDLQA-XX Download a course

[[Category:Functional testing]]

Main features

2024-05-01T04:59:07Z

Andrewnicols: Note about intent to not migrate this page to moodledev.io

{{Template:WillNotMigrate}}
The main features of the survey module are:

* branching based on answer given by the users
* mandatory question answer
* user entry validation
* capability based access to survey elements
* permissions for groups of users feeding the same surveys submission
* pluggable question types
* pluggable format types
* pluggable master templates
* pluggable reports

PHPXref

2024-05-01T04:57:20Z

Andrewnicols: This page contains very out-dated content.

{{Template:obsolete}}
{{stub}}

== What is PHPXref? ==

PHPXref is a developer tool that's designed to ease the process of working on large PHP projects by making it very fast and easy to browse the code documentation along with the code itself.

It works by scanning a project directory and translating the files it finds into readable cross-referenced HTML, simultaneously utilizing comments in the code to produce documentation to accompany it.

The result is a collection of plain HTML files that can be read using any browser, with no supporting software required. 
(see http://phpxref.sourceforge.net)

== Moodle and PHPXref ==

For the most up-to-date and detailed description of how the Moodle code works you can [http://xref.moodle.org browse the code online].

== Usage ==

Usually with PHPXref you can search for a class, functions, variables, constants and tables. When searching for a function (eg. get_records) you will reach a page wich lists where it id defined and where it is referenced, giving you a better idea of what it is used for.

PHP error logs

2024-05-01T04:56:39Z

Andrewnicols: This page contains very out-dated content.

{{Template:obsolete}}
PHP can be set up to log errors in a variety of different ways: two of these involve the use of the php.ini file and the ini_set command.

== How to enable and check PHP error logs==
PHP can be set up to log errors in a variety of different ways: two of these involve the use of the php.ini file and the ini_set command.
* '''Using the php.ini file''': The log settings are contained in the php.ini file stored on the server. If you don't know where that is, edit your Moodle ''config.php'' and add the following as the second line

phpinfo();

:then reload the web page. Look for the entry '''Configuration File (php.ini) Path'''.

:When you have located php.ini open it in your favorite text editor. Find the '''Error handling and logging''' section of the php.ini file. Make sure that both '''display_errors = On''', '''display_startup_errors = On''' and '''log_errors = On''' are present and uncommented. Check the value of '''error_log''' - this tells you the location of the file errors are logged to. If it is commented out then errors will be sent to the web server error log file. Remember, if you make any changes to this file you will need to restart the web server (or just reboot the server).

* '''Using ini_set commands''': If you are using Moodle 1.7 or higher, the previous steps are not enough. In those versions error logging parameters are dependant on certain administrative settings that you specify in the debugging section. The problem is that if you can't access the administrative pages, you can't set the debugging options. So the only way to modify them is by adding the following lines to your config.php file, just before the last line (the one containing a single'?>' , if present):

ini_set ('display_errors', 'on');
ini_set ('log_errors', 'on');
ini_set ('display_startup_errors', 'on');
ini_set ('error_reporting', E_ALL);
$CFG->debug = 30719; // DEBUG_ALL, but that constant is not defined here.

:This will enable the same settings specified above even if Moodle sets them otherwise.
:'''Important''': Remember to put them just before the last line of config.php.

Debug Mode for version 3.9:
@error_reporting(E_ALL | E_STRICT);
@ini_set('display_errors', '1');
$CFG->debug = (E_ALL | E_STRICT);
$CFG->debugdisplay = 1;

==Error Logs==

The default settings of the PHP Error Log file varies from OS to OS. The location of the error log file itself can be set manually in the php.ini file. On a Windows server, in IIS, it may be something like "'error_log = C:\log_files\php_errors.log'" in Linux it may be a value of "'/var/log/php_errors.log'". The php_errors.log file may be required to be manually created, which would mean that the ownership and rw permissions will need to be set accordingly.

==See also==
*[[:en:Installing Moodle|Installing Moodle]]
*[[:en:Installation FAQ|Installation FAQ]]

PHP FAQ

2024-05-01T04:56:16Z

Andrewnicols: Note about intent to not migrate this page to moodledev.io

{{Template:WillNotMigrate}}
== What is PHP? ==

PHP is a widely-used general-purpose scripting language that is especially suited for Web development and can be embedded into HTML.

== Where can I learn more about PHP? ==

=== Online resources: ===

* The [http://www.php.net official PHP Homepage] with documentation, tutorials, FAQ, etc.
* The [http://www.w3schools.com/PHP/DEfaULT.asP W3Schools PHP Tutorial] is a great way to learn about PHP by example.

=== Books: ===

* [http://books.google.de/books?id=iUfIqyAbIU4C&output=html PHP Cookbook] by David Sklar and Adam Trachtenberg.
* [http://www.manning.com/reiersol/ PHP in Action] by Dagfinn Reiersøl with Marcus Baker and Chris Shiflett. ([http://books.slashdot.org/article.pl?sid=08/01/23/1446243 Book review on Slashdot].)

== How is PHP used by Moodle? ==

* [[:en:Installing Moodle/Creating custom php.ini files|Installing Moodle/Creating custom php.ini files]]
* [[:en:PHP settings by Moodle version|PHP settings by Moodle version]]
* [[PHP error logs]]
* [http://moodle.org/mod/forum/search.php?notwords=Re:&id=5&subject=php.ini php.ini related discussions] in the Moodle forums

== Which version of PHP is required by Moodle? ==

* See [[:en:Installing_Moodle#Requirements|Installation requirements]].
* You can tell which version you are using by looking at [[:en:PHP info|PHP info]].

==How do I install PHP?==

Usually you don't have to install PHP at all, as normally it is installed alongside [[:en:Apache|Apache]] and [[:en:MySQL|MySQL]] in a combination known as AMP (see [[:en:Installing AMP|Installing AMP]] for details). If you run Moodle on hosted web space PHP is also usually installed already.

It is possible to build PHP from source - you might have to if you need a very new version for developing Moodle - however, it is quite challenging. PHP itself has many dependencies that you will need to obtain and build, some of which are also tricky to build from source (e.g. GD).

==How do I check the PHP configuration on my server?==
Run the [http://www.php.net/manual/en/function.phpinfo.php phpinfo()] command. It will display a whole lot of information about the current PHP configuration on your server.

You can also run this command from within Moodle. This option is available under
'''''Administration > Server > PHP info'''''.

The PHP info page provides information on the version of PHP your server is running, including PHP compilation options and extensions, server information, the PHP environment and OS version information.

If you have a problem with your Moodle site and ask for help in a Moodle.org forum, you may be asked to provide some information from this page.

See also [[:en:phpinfo|phpinfo]] and [http://www.php.net/manual/en/function.phpinfo.php PHP manual: phpinfo].

== See also: ==

* [[:en:Installing MSSQL for PHP|Installing MSSQL for PHP]]
* [[:en:Installing Oracle for PHP|Installing Oracle for PHP]]
* [[:en:Installing Postgres for PHP|Installing Postgres for PHP]]

[[Category:FAQ]]

Reference

2024-05-01T04:55:35Z

Andrewnicols: Note about intent to not migrate this page to moodledev.io

{{Template:WillNotMigrate}}
==This is the start of a few pages of largely version independent reference==

In the spirit of wiki and in response to the post here: http://moodle.org/mod/forum/discuss.php?d=205117

Go for it Guillermo.

Maybe start here, and later on add a category:Reference and see what happens. I've set a watch on, and I may do a page on JSON errors.

= Database =

I'll start writing here about database and utf8 issues, but I guess that the idea would be for this to be the main reference table of contents page so it then links to each main topic page.

== Basic concepts ==

=== Byte, character, character set, character encoding and collation ===

A byte (or octet) is the smallest unit of storage that can be allocated and, in almost all modern computers, it consists of 8 bits, where a bit can only have two values: 0 or 1.

A character is a symbol used in a writing system, such as a letter of the alphabet.

A character set, or a coded character set, refers to the set of characters and numbers, or code points, used to represent them. A code point can be understood as the position the character occupies in the set.

A character encoding, or a character encoding form, refers to how the code points are converted (encoded) into code values to be saved or stored in a computer.

Unicode is a character set developed to consistently encode, represent and handle text in most of the world's writing systems in use today. Unicode can be implemented by different character encodings, where the two most commonly used are UTF-8 and UTF-16:

* '''UTF-8''' is a variable-width character encoding that can represent every character in the Unicode character set. UTF-8 encodes each of the 1,112,064 code points in the Unicode character set using one to four bytes.
:* '''Note'''. MySQL utf8 Unicode character set uses a maximum of three bytes per multi-byte character (http://dev.mysql.com/doc/refman/5.5/en/charset-unicode-utf8.html).
* '''UTF-16''' is a variable-length character encoding for Unicode that uses one or two 16-bit code units, where each unit takes two 8-bit bytes, and the order of the bytes may depend on the byte order (endianness) of the computer architecture. To assist in recognizing the byte order of code units, UTF-16 allows a Byte Order Mark (BOM), a code unit with the hexadecimal value U+FEFF, to precede the first actual coded value.

Eventhough UTF-8 is the preferred character encoding nowadays, many others have been used, for example:

* '''ISO-8859-1''' (or Latin-1). A character encoding for the Latin script, where each character is encoded as a single 8-bit code value. This character-encoding scheme consists of 191 characters and it is used throughout The Americas, Western Europe, Oceania, and much of Africa. It is also commonly used in most standard romanizations of East-Asian languages.
* '''ISO-8859-15''' (or Latin-9). A character encoding similar to Latin-1, except that it substituted some rarely used characters with the euro sign and a few other letters.
* '''Shift JIS'''. A character encoding for the Japanese language.

To illustrate the concepts given above, the € (euro) character has a code point equal to 8364 (or U+20AC, in hexadecimal notation) in the Unicode character set. This code point can be stored in different ways, depending on the character encoding used:

{| class="wikitable"
! Character encoding
! Code value (hex)
|-
| '''ISO-8859-15'''
| A4
|-
| '''UTF-8'''
| E2 82 AC
|-
| '''UTF-16'''
| 20AC
|}

Finally, a Collation determines how data is sorted and how strings are compared to each other.

=== Encoding and decoding ===

One of the most important things one must keep in mind when working with databases (or files, for that matter) is to be aware of how characters (letters, numbers and non-alphanumeric characters) are actually being saved or encoded and how bytes (represented with hexadecimal values) are actually being interpreted or decoded.

'''Note'''. In a database, character encoding only applies to text type columns (e.g. CHAR, VARCHAR, TEXT).

For example, it is not enough to say that character “é” (small letter e with acute) has been saved in a text file, one also has to be aware of how was it encoded. Why? Because if it was encoded as Latin-1, the file will have one byte of hex value E9, but if it was encoded as UTF-8, the file would then have two bytes of hex value C3 and A9:

{| class="wikitable"
! Character
! Latin-1 hex value
! UTF-8 hex values
|-
| é
| E9
| C3 A9
|}

In the same way, it is not enough to say that an UTF-8 encoded character “é” is going to be read from a text file, because eventhough we might know that two bytes of hex value “C3 A9” will be read, if they are decoded (interpreted) as Latin-1, we will get characters Ã©, but if they are decoded as UTF-8, we would then get character “é”:

{| class="wikitable"
! Hex value
! Latin-1 characters
! UTF-8 character
|-
| C3 A9
| Ã©
| é
|}

Being aware of these two concepts will become relevant when trying to understand how data is encoded and decoded through the many database stages (source, client, server) in order to be saved or restored.

== MySQL ==

=== Character sets and collations ===

Until version 4.1, MySQL tables used the latin1 character set by default. From version 4.1, not only the concepts of "character set" and "collation" were introduced, but the character set by default (at the configuration file) was changed to utf8.

In MySQL, a character set is a set of symbols and encodings, and a collation is a set of rules for comparing characters in a character set.

'''Note'''. Eventhough in MySQL the term character set is used, it should actually be character encoding (charset).

The MySQL server supports multiple character sets, like ascii, koi8r, latin1, sjis and utf8. Each character set has at least one collation, however, as it may have many more, a default one is always defined for each character set.

{| class="wikitable"
! Character set
! Default collation
! Other collations
|-
| '''ascii'''
| ascii_general_ci
| ascii_bin
|-
| '''koi8r'''
| koi8r_general_ci
| koi8r_bin
|-
| '''latin1'''
| latin1_swedish_ci
| latin1_bin, latin1_general_ci, latin1_spanish_ci
|-
| '''sjis'''
| sjis_japanese_ci
| sjis_bin
|-
| '''utf8'''
| utf8_general_ci
| utf8_bin, utf8_unicode_ci, utf8_turkish_ci
|}

Collation names follow a convention: they start with the name of the character set with which they are associated, they usually include a language name, and they end with <tt style="color:#0000b0;">_ci</tt> (case insensitive), <tt style="color:#0000b0;">_cs</tt> (case sensitive), or <tt style="color:#0000b0;">_bin</tt> (binary). From this, is should be evident that two different character sets cannot have the same collation.

=== Character set variables ===

MySQL uses several “character set” type system variables that could be classified in three groups according to their use.

==== For data encoding ====

The following three determine the character encoding used to transform data as it flows from the client to the server and viceversa.

* <tt style="color:#0000b0;">character_set_client</tt>. This variable defines the character set used by the client and in which it sends statements to the server.
* <tt style="color:#0000b0;">character_set_connection</tt>. This variable defines the character set in which the server translates statements received from the client.
* <tt style="color:#0000b0;">character_set_results</tt>. This variable defines the character set in which the server returns query results to the client.

'''Note'''. For the <tt style="color:#0000b0;">character_set_connection</tt> variable there is also a related collation type variable: <tt style="color:#0000b0;">collation_connection</tt>.

==== As default values ====

The following two are used to determine the character encoding to be used when a database or a table is created, respectively.

* <tt style="color:#0000b0;">character_set_server</tt>. This variable defines the character set of a new schema when the database charset is not specified in the CREATE DATABASE statement.
* <tt style="color:#0000b0;">character_set_database</tt>. This variable defines the character set of a new table when the table charset is not specified in the CREATE TABLE statement.

'''Note'''. For these two variables there are also two related collation type variables: <tt style="color:#0000b0;">collation_server</tt> and <tt style="color:#0000b0;">collation_database</tt>, respectively.

==== Other uses ====

The following two have other uses.

* <tt style="color:#0000b0;">character_set_filesystem</tt>. This variable defines the character set used by the file system (names of directories or names of files).
* <tt style="color:#0000b0;">character_set_system</tt>. This variable defines the character set used to save metadata (data about data, for example, names of tables).

=== Default settings ===

The MySQL database server uses a very flexible scheme where default settings for character sets and collations can be set at four levels: Server, Database, Table and Column.

; Server
: The server charset and collation are used as default values for schema definitions when the database charset and collation are not specified in CREATE DATABASE statements.
: The server character set and collation can be determined from the values of the <tt style="color:#0000b0;">character_set_server</tt> and <tt style="color:#0000b0;">collation_server</tt> system variables.

; Database
: The database charset and collation are used as default values for table definitions when the table charset and collation are not specified in CREATE TABLE statements.
: The character set and collation for the default database can be determined from the values of the <tt style="color:#0000b0;">character_set_database</tt> and <tt style="color:#0000b0;">collation_database</tt> system variables.

; Table
: The table charset and collation are used as default values for column definitions when the column charset and collation are not specified in individual column definitions.
: The table character set and collation are MySQL extensions; therefore they do not exist in standard SQL.

; Column
: A character set and a collation may be specified for every character type column (that is, columns of type CHAR, VARCHAR, or TEXT).
: The column character set and collate clauses are standard SQL.

=== Configuration files ===

==== MySQL settings ====

All MySQL settings, both for the server and the client components, are defined under one configuration or option file: <tt style="color:#0000b0;">my.ini</tt> (Windows) or <tt style="color:#0000b0;">my.cnf</tt> (Linux), although many copies of this file might be read at startup.

Settings in the configuration file are divided in option groups, where each one contains the settings for: the server, all clients and each particular client:

{| class="wikitable"
! Settings for
! Option group
|-
| The server
| [mysqld], [server], etc.
|-
| All clients
| [client]
|-
| Each particular client
| [mysql], [mysqldump], [myisamchk], [mysqlhotcopy], etc.
|}

==== Database ====

For each database created, its character set and collation values are saved in a text file named <tt style="color:#0000b0;">db.opt</tt>, located in the corresponding database folder (''db_name'') under the ''datadir'' directory.

more C:\MySqlServer5.5\data\''db_name''\db.opt

Outputs something like:

default-character-set=latin1
default-collation=latin1_swedish_ci

When a database is first created, if the character set and collation options are not defined in the CREATE DATABASE statement, then they are taken from the server charset and collation values. These two values can be modified via the ALTER DATABASE statement.

=== Gathering information (1) ===

To run the commands given in this section, one has to have direct access to the MySQL server.

From here on it will be assumed that the server is already running. Also, for Windows users, commands must be entered from a Windows command (system) window.

==== Server and client ====

Running a particular program with the parameters <tt style="color:#0000b0;">--verbose --help</tt>:

mysqld --verbose --help
mysql --verbose --help
mysqldump --verbose --help

will list four pieces of information:

# The location of the configuration files.
# The option groups read by the program.
# The allowed options or variables (parameters) with their abreviations and descriptions.
# The default values of variables that can be set from the command line.

===== Location of the configuration files =====

Default options are read from the following files in the given order:

{| class="wikitable"
! OS
! The following groups are read
|-
| Windows
| ''WINDIR''\my.ini ''WINDIR''\my.cnf C:\my.ini C:\my.cnf ''INSTALLDIR''\my.ini ''INSTALLDIR''\my.cnf
|-
| Linux
| /etc/my.cnf /etc/mysql/my.cnf SYSCONFDIR/my.cnf $MYSQL_HOME/my.cnf
|}

'''Note'''. ''WINDIR'' is the Windows directory (e.g. C:\Windows) and ''INSTALLDIR'' is the MySQL installation directory (e.g. C:\MySqlServer5.5).

===== The option groups read =====

The option groups (in the configuration file) read by each program; for example:

{| class="wikitable"
! Program
! The following groups are read
|-
| mysqld
| mysqld server mysqld-5.5
|-
| mysql
| mysql client
|-
| mysqldump
| mysqldump client
|}

===== Allowed options (variables) =====

The variables accepted (in the command line) by the program, with their abreviations and descriptions; for example, the following are some of those listed for the <tt style="color:#0000b0;">mysql</tt> client program:

{| class="wikitable"
! Variable (option)
! Description
|-
| -D, --database=name
| Database to use.
|-
| --default-character-set=name
| Set the default character set.
|}

===== Variables and their values =====

The default values of variables that can be set from the command line for each program; for example, the following are some of those listed by the <tt style="color:#0000b0;">mysqld</tt> server program:

{| class="wikitable"
! Variable
! Default value
|-
| basedir
| C:/MySqlServer5.5/
|-
| character-set-server
| latin1
|-
| datadir
| C:\ MySqlServer5.5\Data\
|-
| date-format
| %Y-%m-%d
|-
| innodb
| ON
|-
| tmpdir
| C:\Tmp
|}

'''* Important note'''. The <tt style="color:#0000b0;">mysqld</tt> program lists the values of the variables that the server (based on its compiled-in defaults) will use; however, some of those values might change depending on the command line parameters given. For example, if the <tt style="color:#0000b0;">my.ini</tt> (or <tt style="color:#0000b0;">my.cnf</tt>) configuration file has the following lines:

[mysqld]
character-set-server=utf8

Then we will get a different value for variable <tt style="color:#0000b0;">character-set-server</tt> if we use the <tt style="color:#0000b0;">no-defaults</tt> parameter:

{| class="wikitable"
! Command
! Action
! Value of ''character-set-server''
|-
| <tt style="color:#0000b0;">mysqld --no-defaults --verbose --help</tt>
| Ignore the settings in any option files.
| <tt style="color:#0000b0;">latin1</tt>
|-
| <tt style="color:#0000b0;">mysqld --verbose --help</tt>
| Include the settings of any option files that it reads.
| <tt style="color:#0000b0;">utf8</tt>
|}

==== System values used by a running server ====

While the <tt style="color:#0000b0;">--help --verbose</tt> options of the MySQL server program (<tt style="color:#0000b0;">mysqld</tt>) show command line options and their default values, there are also other variables that can only be seen after the server has been started and that provide information about its operation.

To see what system values is using a running server, the <tt style="color:#0000b0;">mysqladmin</tt> program can be used with the <tt style="color:#0000b0;">variables</tt> option:

mysqladmin [-u root -p''your_password''] variables

The following are some of the variables and values listed:

{| class="wikitable"
! Variable_name
! Value
|-
| character_set_client
| latin1
|-
| character_set_connection
| latin1
|-
| collation_connection
| latin1_swedish_ci
|-
| connect_timeout
| 10
|}

==== Server status information ====

The server status information provided by the mysqladmin <tt style="color:#0000b0;">extended-status</tt> option is rather technical and so it will only be useful for DBAs (database administrators), however it is worth knowing how to display it:

mysqladmin [-u root -p''your_password''] extended-status

=== Gathering information (2) ===

The first step before trying to fix a character set or a collation problem in a database, table or column is to determine how are they actually defined. The aim of this section then, is to show how to get specific pieces of information about these components.

To run all the SQL queries shown in this section, one can work from:

* A mysql command window, in which case the mysql client program must be running:

mysql -u root -p''your_password''

Starts a mysql session:

mysql>

* The phpMyAdmin tool, through the “Run SQL query/queries on database ''db_name''” window.

==== Saving the output of a query into a file ====

As results from many commands might be a bit long to be analyzed from a window, it is useful to know how to send them into a file.

===== Windows =====

Use command <tt style="color:#0000b0;">tee</tt> to save the output of a query into a file, and command <tt style="color:#0000b0;">notee</tt> to stop writing into a file. These commands can only be run from a mysql command window.

For example:

mysql> tee e:/tmp/vars.out;
mysql> show variables;
mysql> notee;
Outfile disabled.

To determine into which file output is being written, just type <tt style="color:#0000b0;">tee</tt> by itself:

mysql> tee;
Currently logging to file 'e:/tmp/vars.out'

===== Unix =====

Use command <tt style="color:#0000b0;">pager</tt> to save the output of a query into a file, and command <tt style="color:#0000b0;">nopager</tt> to stop writing into a file. These commands can only be run from a mysql command window.

For example:

mysql> pager cat > /tmp/vars.out
mysql> show variables;
mysql> nopager;

===== phpMyAdmin =====

Once a query is run and the results are displayed, the <tt style="color:#0000b0;">Print view</tt> or the <tt style="color:#0000b0;">Print view (with full texts)</tt> links from the <tt style="color:#0000b0;">Query results operations</tt> section can be used to save them.

==== Basic server status information ====

The STATUS command will get basic status information from the server, like the current database in use, the server version, the TCP port or the characterset defined for the server, the database, the client and the connection. This command can only be run from a mysql command window.

mysql> STATUS;

Outputs something like:

Current database:
mysql Ver 14.14 Distrib 5.5.8, for Win32 (x86)
Connection id: 232
Current database:
Current user: root@localhost
SSL: Not in use
Using delimiter: ;
Server version: 5.5.8 MySQL Community Server (GPL)
Protocol version: 10
Connection: localhost via TCP/IP
Server characterset: latin1
Db characterset: latin1
Client characterset: latin1
Conn. characterset: latin1
TCP port: 3306
Uptime: 18 hours 25 min 38 sec

'''Note'''. If a database hasn’t been set active, the <tt style="color:#0000b0;">Db characterset</tt> variable will contain the global default, otherwise its value will reflect that of the selected database.

==== Server status information ====

The following will list the same variables as the <tt style="color:#0000b0;">mysqladmin extended-status</tt> command:

SHOW STATUS;

As the list of variables is quite long, the LIKE clause can be used to list only those that match.

==== System variables with their values ====

The following will list the same system variables as the <tt style="color:#0000b0;">mysqladmin variables</tt> command, plus a few more:

SHOW VARIABLES;

As the list of variables is quite long, the LIKE clause can be used to list only those that match.

To list all the <tt style="color:#0000b0;">character_set</tt> variables:

SHOW VARIABLES LIKE 'character_set\_%';

Outputs something like:

+--------------------------+-----------------------------------+
| Variable_name | Value |
+--------------------------+-----------------------------------+
| character_set_client | latin1 |
| character_set_connection | latin1 |
| character_set_database | latin1 |
| character_set_filesystem | binary |
| character_set_results | latin1 |
| character_set_server | latin1 |
| character_set_system | utf8 |
+--------------------------+-----------------------------------+

'''Note'''. If a database hasn’t been set active, the <tt style="color:#0000b0;">character_set_database</tt> variable will contain the global default, otherwise its value will reflect that of the selected database.

To list all the collations defined:

SHOW VARIABLES LIKE 'coll%';

Outputs something like:

+----------------------+-------------------+
| Variable_name | Value |
+----------------------+-------------------+
| collation_connection | latin1_swedish_ci |
| collation_database | latin1_swedish_ci |
| collation_server | latin1_swedish_ci |
+----------------------+-------------------+

==== Database ====

===== How was it created =====

The following command shows how a database (schema) was created (i.e., the complete CREATE DATABASE statement used to create it).

show create database ''db_name'';

Outputs something like:

CREATE DATABASE `test02` /*!40100 DEFAULT CHARACTER SET latin1 */

If a database was created with a specific character set and/or collation (i.e. it isn’t using the server’s default), the result will include the defined collation, for example:

CREATE DATABASE `temp01` /*!40100 DEFAULT CHARACTER SET latin1 COLLATE latin1_spanish_ci */

As mentioned before, when a database is created or when its character set and/or collation are modified, these two values are saved in the corresponding <tt style="color:#0000b0;">db.opt</tt> file.

===== Character set and collation =====

The following SQL statement gives both, the character set and collation of a schema (database).

SELECT schema_name, default_character_set_name "character_set", default_collation_name "collation"
FROM information_schema.schemata
WHERE schema_name = 'db_name';

Outputs something like:

+-------------+---------------+-------------------+
| schema_name | character_set | collation |
+-------------+---------------+-------------------+
| test02 | latin1 | latin1_swedish_ci |
+-------------+---------------+-------------------+

It is important to remember that these values only act as defaults to define the character set and the collation of newly created tables.

==== Tables and columns ====

A database must first be selected before trying to use the SHOW and DESCRIBE commands.

* From a mysql command window:
use ''db_name'';

* From phpMyAdmin, just select the database to be used.

===== Table, how was it created =====

The following command shows how a table was created.

SHOW CREATE TABLE ''tbl_name'';

Outputs something like:

CREATE TABLE `t1_latin` (
`userid` smallint(5) unsigned DEFAULT NULL,
`coll_swd` char(16) NOT NULL,
PRIMARY KEY (`coll_swd`)
) ENGINE=InnoDB DEFAULT CHARSET=latin1

If a particular table was created with a specific character set and/or collation (i.e. it isn’t using the database’s default), the result will include the defined collation both in the table definition and in each of the text type column definitions, for example:

CREATE TABLE `t3_latin` (
`userid` smallint(5) unsigned DEFAULT NULL,
`coll_swd` char(16) COLLATE latin1_spanish_ci NOT NULL,
`coll_spa` text COLLATE latin1_spanish_ci,
PRIMARY KEY (`coll_swd`)
) ENGINE=InnoDB DEFAULT CHARSET=latin1 COLLATE=latin1_spanish_ci

Furthermore, if a particular column was created with a specific character set and/or collation (i.e. it isn’t using the table’s default), the result will include the character set and collation definition in the respective column, for example:

CREATE TABLE `t2_latin` (
`userid` smallint(5) unsigned DEFAULT NULL,
`coll_gr1` char(16) CHARACTER SET latin1 COLLATE latin1_german1_ci NOT NULL,
PRIMARY KEY (`coll_gr1`)
) ENGINE=InnoDB DEFAULT CHARSET=latin1

===== Table, describe its structure =====

Either of the two following commands display a simple view of the structure of table.

DESCRIBE ''tbl_name'';

SHOW COLUMNS FROM ''tbl_name'';

Outputs something like:

+----------+----------------------+------+-----+---------+-------+
| Field | Type | Null | Key | Default | Extra |
+----------+----------------------+------+-----+---------+-------+
| userid | smallint(5) unsigned | YES | | NULL | |
| coll_swd | char(16) | NO | PRI | NULL | |
+----------+----------------------+------+-----+---------+-------+

The following command displays a more complete view of the structure of table.

SHOW FULL COLUMNS FROM ''tbl_name'';

Outputs something like:

+----------+----------------------+-------------------+------+-----+---------+-------+---------------------------------+---------+
| Field | Type | Collation | Null | Key | Default | Extra | Privileges | Comment |
+----------+----------------------+-------------------+------+-----+---------+-------+---------------------------------+---------+
| userid | smallint(5) unsigned | NULL | YES | | NULL | | select,insert,update,references | |
| coll_swd | char(16) | latin1_swedish_ci | NO | PRI | NULL | | select,insert,update,references | |
+----------+----------------------+-------------------+------+-----+---------+-------+---------------------------------+---------+

===== Table, index information =====

The following command lists the indexes (if there are any) on a table.

SHOW INDEX FROM ''tbl_name'';

Outputs something like:

+----------+------------+----------+--------------+-------------+-----------+-------------+----------+--------+------+------------+---------+---------------+
| Table | Non_unique | Key_name | Seq_in_index | Column_name | Collation | Cardinality | Sub_part | Packed | Null | Index_type | Comment | Index_comment |
+----------+------------+----------+--------------+-------------+-----------+-------------+----------+--------+------+------------+---------+---------------+
| t1_latin | 0 | PRIMARY | 1 | coll_swd | A | 4 | NULL | NULL | | BTREE | | |
+----------+------------+----------+--------------+-------------+-----------+-------------+----------+--------+------+------------+---------+---------------+

===== Table, character set and collation =====

The following SQL query displays the character set and collation of a table in a particular schema.

SELECT t.table_schema, t.table_name, ccsa.character_set_name "table_character_set", t.table_collation
FROM information_schema.`tables` t,
information_schema.`collation_character_set_applicability` ccsa
WHERE ccsa.collation_name = t.table_collation
AND t.table_schema = 'db_name'
AND t.table_name = 'tbl_name';

Outputs something like:

+--------------+------------+---------------------+-------------------+
| table_schema | table_name | table_character_set | table_collation |
+--------------+------------+---------------------+-------------------+
| test02 | t1_latin | latin1 | latin1_swedish_ci |
+--------------+------------+---------------------+-------------------+

To list the same information for all the tables in a particular schema, one only needs to remove the last AND clause from the previous query.

SELECT t.table_schema, t.table_name, ccsa.character_set_name "table_character_set", t.table_collation
FROM information_schema.`tables` t,
information_schema.`collation_character_set_applicability` ccsa
WHERE ccsa.collation_name = t.table_collation
AND t.table_schema = 'db_name';

Outputs something like:

+--------------+------------+---------------------+-------------------+
| table_schema | table_name | table_character_set | table_collation |
+--------------+------------+---------------------+-------------------+
| test02 | t1_latin | latin1 | latin1_swedish_ci |
| test02 | t2_latin | latin1 | latin1_swedish_ci |
+--------------+------------+---------------------+-------------------+

===== Tables, with different character set and collation =====

The following SQL query lists all tables in a particular schema that differ from a specific collation (e.g. latin1_swedish_ci).

SELECT t.table_schema, t.table_name, ccsa.character_set_name "table_character_set", t.table_collation
FROM information_schema.`tables` t,
information_schema.`collation_character_set_applicability` ccsa
WHERE ccsa.collation_name = t.table_collation
AND t.table_schema = 'db_name'
AND table_collation NOT LIKE 'latin1_swedish_ci';

Outputs something like:

+--------------+------------+---------------------+-----------------+
| table_schema | table_name | table_character_set | table_collation |
+--------------+------------+---------------------+-----------------+
| test03 | t1_default | utf8 | utf8_unicode_ci |
+--------------+------------+---------------------+-----------------+

===== Columns, displaying character data as hexadecimal values =====

Sometimes it is necessary to confirm how text type data (e.g. CHAR, VARCHAR, TEXT) is actually saved (encoded).

To do this, a SELECT query can be created with an <tt style="color:#0000b0;">HEX()</tt> function around the column to be checked.

For example, if we have the string “áéíóú” stored in column ''col_name'', the following query:

SELECT ''col_name'', HEX(''col_name'') FROM ''tbl_name'';

Would give the following output if the string was encoded in latin1:

+----------+---------------+
| ''col_name'' | HEX(''col_name'') |
+----------+---------------+
| áéíóú | E1E9EDF3FA |
+----------+---------------+

And it would give the following output if the string was encoded in utf8:

+----------+----------------------+
| ''col_name'' | HEX(''col_name'') |
+----------+----------------------+
| áéíóú | C3A1C3A9C3ADC3B3C3BA |
+----------+----------------------+

'''Note'''. In this example it is assumed that in each case the column is defined with the correct character set (latin1 and utf8, respectively).

===== Columns, character set and collation =====

The following SQL query displays the character set and collation of all text type (e.g. CHAR, VARCHAR, TEXT) columns in a particular table.

SELECT table_schema, table_name,
column_name, character_set_name "column_character_set", collation_name "column_collation",
data_type, column_type
FROM information_schema.columns
WHERE table_schema = 'db_name'
AND table_name = 'tbl_name'
AND data_type IN ('char', 'varchar', 'tinytext', 'text', 'mediumtext', 'longtext', 'enum', 'set');

Outputs something like:

+--------------+------------+-------------+----------------------+-------------------+-----------+-------------+
| table_schema | table_name | column_name | column_character_set | column_collation | data_type | column_type |
+--------------+------------+-------------+----------------------+-------------------+-----------+-------------+
| test02 | t1_latin | coll_swd | latin1 | latin1_swedish_ci | char | char(16) |
+--------------+------------+-------------+----------------------+-------------------+-----------+-------------+

To list the same information for all the tables in a particular schema, one only needs to remove the first AND clause from the previous query.

SELECT table_schema, table_name,
column_name, character_set_name "column_character_set", collation_name "column_collation",
data_type, column_type
FROM information_schema.columns
WHERE table_schema = 'db_name'
AND data_type IN ('char', 'varchar', 'tinytext', 'text', 'mediumtext', 'longtext', 'enum', 'set');

Outputs something like:

+--------------+------------+-------------+----------------------+-------------------+-----------+-------------+
| table_schema | table_name | column_name | column_character_set | column_collation | data_type | column_type |
+--------------+------------+-------------+----------------------+-------------------+-----------+-------------+
| test02 | t1_latin | coll_swd | latin1 | latin1_swedish_ci | char | char(16) |
| test02 | t2_latin | coll_gr1 | latin1 | latin1_german_ci | char | char(16) |
+--------------+------------+-------------+----------------------+-------------------+-----------+-------------+

===== Columns, with different character set and collation =====

The following SQL query displays all text type (e.g. CHAR, VARCHAR, TEXT) columns in all tables of a particular database, that differ from a specific collation (e.g. latin1_swedish_ci).

SELECT table_schema, table_name,
column_name, character_set_name "column_character_set", collation_name "column_collation",
data_type, column_type
FROM information_schema.columns
WHERE table_schema = 'db_name'
AND data_type IN ('char', 'varchar', 'tinytext', 'text', 'mediumtext', 'longtext', 'enum', 'set')
AND collation_name NOT LIKE 'latin1_swedish_ci';

Outputs something like:

+--------------+------------+-------------+----------------------+-------------------+-----------+-------------+
| table_schema | table_name | column_name | column_character_set | column_collation | data_type | column_type |
+--------------+------------+-------------+----------------------+-------------------+-----------+-------------+
| test02 | t2_latin | coll_gr1 | latin1 | latin1_german1_ci | char | char(16) |
+--------------+------------+-------------+----------------------+-------------------+-----------+-------------+

To display the same information, but only for a specific table, an extra AND clause can be added to the SQL query:

SELECT table_schema, table_name,
column_name, character_set_name "column_character_set", collation_name "column_collation",
data_type, column_type
FROM information_schema.columns
WHERE table_schema = 'db_name'
AND table_name = 'tbl_name'
AND data_type IN ('char', 'varchar', 'tinytext', 'text', 'mediumtext', 'longtext', 'enum', 'set')
AND collation_name NOT LIKE 'latin1_swedish_ci';

=== Dumping a database ===

To backup or transfer databases to another SQL server, MySQL includes a client program called <tt style="color:#0000b0;">mysqldump</tt>. This program generates a text file with a series of SQL statements to recreate the original database, its tables and the corresponding data.

Basically, the <tt style="color:#0000b0;">mysqldump</tt> program can be run in one of the following ways:

{| class="wikitable"
! Command
! Action
|-
| mysqldump [options] db_name [tbl_name ...]
| dumps database, a table or a series of tables
|-
| mysqldump [options] --databases db_name ...
| dumps a series of databases
|-
| mysqldump [options] --all-databases
| dumps all databases
|}

This program is simple to use, but it is important to be familiar with a few of its options, as using a wrong setting could lead to corrupted data.

==== Options ====

===== --default-character-set =====

The <tt style="color:#0000b0;">--default-character-set</tt> option defines ''charset_name'' as the default character set.

This is one of the most critical options, as it specifies:

# The file character encoding to be used or how the file is going to be encoded: as column values from the database are read, they are converted to the character set specified by this option before being saved in the dump file (see, Encoding and decoding).
# The ''default_character_set'' for the SET NAMES statement when the <tt style="color:#0000b0;">--skip-set-charset</tt> or the <tt style="color:#0000b0;">--no-set-names</tt> options are not used.

For example, the following command:

mysqldump --default-character-set=latin1 ''db_name'' -r backup.sql

would generate a latin1 encoded dump file; whereas either of the following:

mysqldump --default-character-set=utf8 ''db_name'' -r backup.sql
mysqldump ''db_name'' -r backup.sql

would generate a utf8 encoded dump file.

'''Note'''. If a character set is not specified (as shown in the last example), <tt style="color:#0000b0;">mysqldump</tt> will use utf8 by default (versions lower than 4.1.2 use latin1 by default).

===== --set-charset =====

The <tt style="color:#0000b0;">--set-charset</tt> option adds a SET NAMES ''default_character_set'' statement to the output. This option is enabled by default.

As the SET NAMES ''character_set'' statement is equivalent to the following three statements:

SET character_set_client = ''character_set'';
SET character_set_results = ''character_set'';
SET character_set_connection = ''character_set'';

the SET NAMES statement specifies the character set to be used (during the restore of the dump file) by the client to send SQL statements to the server, and the character set that the server should use for sending results back to the client (see, For data encoding).

Since this option is enabled by default, the following command:

mysqldump --default-character-set=latin1 ''db_name'' -r backup.sql

would add the following conditional comments at the beginning of the dump file:

/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
/*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;
/*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */;
/*!40101 SET NAMES latin1 */;

and the following at the end:

/*!40101 SET CHARACTER_SET_CLIENT=@OLD_CHARACTER_SET_CLIENT */;
/*!40101 SET CHARACTER_SET_RESULTS=@OLD_CHARACTER_SET_RESULTS */;
/*!40101 SET COLLATION_CONNECTION=@OLD_COLLATION_CONNECTION */;

where the "SET NAMES latin1" command will instruct the <tt style="color:#0000b0;">mysql</tt> program to use, send and receive data encoded in latin1.

===== --skip-set-charset =====

The <tt style="color:#0000b0;">--skip-set-charset</tt> option is used to disable the <tt style="color:#0000b0;">--set-charset</tt> option, which is enabled by default.

===== --no-set-names (-N) =====

The <tt style="color:#0000b0;">--no-set-names</tt> is equivalent to <tt style="color:#0000b0;">--skip-set-charset</tt>, and so this option disables the <tt style="color:#0000b0;">--set-charset</tt> option: it indicates that a SET NAMES ''default_character_set'' should not be added to the output.

===== --complete-insert (-c) =====

The <tt style="color:#0000b0;">--complete-insert</tt> option indicates to use complete INSERT statements that include column names.

For example, the following command:

mysqldump -c ''db_name'' -r backup.sql

would create an INSERT statement that includes the names of the columns:

INSERT INTO `t1_latin` (`id`, `string`) VALUES (1,'text1'),(2,' text2');

But the following command:

mysqldump ''db_name'' -r backup.sql

would create an INSERT statement without the names of the columns:

INSERT INTO `t1_latin` VALUES (1,'text1'),(2,'text2');

===== --extended-insert (-e) =====

The <tt style="color:#0000b0;">--extended-insert</tt> indicates to use a multiple-row INSERT syntax that include several VALUES lists. This results in smaller dump files and faster inserts when the file is reloaded. This option is enabled by default.

Since this option is enabled by default, the following command:

mysqldump ''db_name'' -r backup.sql

would create an INSERT statement that includes all the records to be added:

INSERT INTO `t1_latin` VALUES (1,'text1'),(2,'text2');

===== --skip-extended-insert =====

The <tt style="color:#0000b0;">--skip-extended-insert</tt> disables the <tt style="color:#0000b0;">--extended-insert</tt> option, which is enabled by default.

For example, the following command:

mysqldump --skip-extended-insert ''db_name'' -r backup.sql

would create multiple INSERT statements, one for each record added:

INSERT INTO `t1_latin` (`id`, `string`) VALUES (1,'text1');
INSERT INTO `t1_latin` (`id`, `string`) VALUES (2,'text2');

===== --result-file (-r) =====

The <tt style="color:#0000b0;">--result-file</tt> option directs output to a given file.

Since this option prevents newline characters from being converted to carriage return/newline sequences, it should be used when working in a Windows environment:

mysqldump ''db_name'' -r backup.sql

instead of using ">" to redirect output to a file:

mysqldump ''db_name'' > backup.sql

===== --single-transaction =====

The <tt style="color:#0000b0;">--single-transaction</tt> option issues a BEGIN SQL statement before dumping data from the server, and it should be used with transactional tables (like InnoDB).

Since this option and the <tt style="color:#0000b0;">--lock-tables</tt> option are mutually exclusive, the <tt style="color:#0000b0;">--skip-lock-tables</tt> option should also be used prior to using the <tt style="color:#0000b0;">--single-transaction</tt> option:

mysqldump --skip-lock-tables --single-transaction ''db_name'' -r backup.sql

===== --opt =====

The <tt style="color:#0000b0;">--opt</tt> option is shorthand for the following:

{| class="wikitable"
! Command
! Action
|-
| --add-drop-table
| Add a DROP TABLE statement before each CREATE TABLE statement.
|-
| --add-locks
| Surround each table dump with LOCK TABLES and UNLOCK TABLES statements.
|-
| --create-options
| Include all MySQL-specific table options in CREATE TABLE statements.
|-
| --disable-keys
| For each table, surround the INSERT statements with statements to disable and enable keys.
|-
| --extended-insert
| Use multiple-row INSERT syntax that include several VALUES lists.
|-
| --lock-tables
| Lock all tables before dumping them.
|-
| --quick
| Retrieve rows for a table from the server a row at a time.
|-
| --set-charset
| Add SET NAMES default_character_set to the output.
|}

Since all of these options are enabled by default, the <tt style="color:#0000b0;">--opt</tt> option is also enabled by default.

===== --skip-opt =====

The <tt style="color:#0000b0;">--skip-opt</tt> disables the <tt style="color:#0000b0;">--opt</tt> option, which is enabled by default.

===== --add-drop-database =====

The <tt style="color:#0000b0;">--add-drop-database</tt> option adds a DROP DATABASE statement before each CREATE DATABASE statement.

===== --add-drop-table =====

The <tt style="color:#0000b0;">--add-drop-table</tt> option adds a DROP TABLE statement before each CREATE TABLE statement.

==== Internal structure of a dump file ====

A dump file usually consists of three different elements: comments, conditional comments and SQL statements.

===== Comments =====

Comments are completely ignored by the <tt style="color:#0000b0;">mysql</tt> client program and only serve to describe what follows. Comments have the following structure:

-- ''comment''

For example:

-- MySQL dump 10.13 Distrib 5.5.8, for Win32 (x86)

===== Conditional comments =====

Conditional comments are used to hide SET commands or SQL statements from older versions of <tt style="color:#0000b0;">mysql</tt> (used to restore a dump file). Conditional comments have the following structure:

/*!''five digit version number'' SET|SQL statement */

For example, the following line, which contains two conditional comments:

CREATE DATABASE /*!32312 IF NOT EXISTS*/ `test04` /*!40100 DEFAULT CHARACTER SET latin1 */;

would be interpreted differently by each <tt style="color:#0000b0;">mysql</tt> version:

{| class="wikitable"
! mysql versions
! would read it as
|-
| < 3.23.12
| CREATE DATABASE `test04`;
|-
| >= 3.23.12 and < 4.1.0
| CREATE DATABASE IF NOT EXISTS `test04`;
|-
| >=4.1.0 (4.01.00)
| CREATE DATABASE IF NOT EXISTS `test04` DEFAULT CHARACTER SET latin1;
|}

Conditional comments usually set some variables at the beginning of a block and reset them at the end.

About the variable syntax of the SET command:

* The string <tt style="color:#0000b0;">@@''variable_name''</tt> can refer to a session value or a global value:
** When being refered, MySQL returns the session value if it exists and the global value otherwise.
** When being set (e.g. <tt style="color:#0000b0;">SET @@variable_name=value</tt>), it always refers to the session value.
* The string <tt style="color:#0000b0;">@variable_name</tt> refers to a user variable.
* When a variable doesn't have a modifier, it is a session variable.

===== SQL statements =====

The actual SQL statements, for example:

USE `''db_name''`;
DROP TABLE IF EXISTS `''tbl_name''`;

== Useful tools ==

The tools listed here are useful when working with database dumps and character encodings.

=== Windows ===

==== SuperEdi ====

[http://www.wolosoft.com/en/superedi/ SuperEdi] is a text editor that supports Unicode UTF-8, UTF-16 and many locale-specific encodings.

Download: [http://www.wolosoft.com/files/SuperEdi-4.3.3.exe SuperEdi].

==== HxD hexeditor ====

[http://mh-nexus.de/en/ HxD hexeditor] is a fast free hex editor that can open files of any size.

Download: [http://mh-nexus.de/downloads/HxDSetupEN.zip HxD hexeditor].

==== Super Sed ====

[http://sed.sourceforge.net/grabbag/ssed/ Super Sed] is a heavily enhanced version of <tt style="color:#0000b0;">sed</tt> (a stream editor used to perform basic text transformations on an input stream).

Download: [http://sed.sourceforge.net/grabbag/ssed/sed-3.62.zip Super Sed].

==== LibIconv ====

GNU [http://gnuwin32.sourceforge.net/packages/libiconv.htm LibIconv] is an encoding conversion library.

Download: [http://gnuwin32.sourceforge.net/downlinks/libiconv.php LibIconv complete package].

Download zip files (only the bin folder has to be extracted from both files):

* [http://gnuwin32.sourceforge.net/downlinks/libiconv-bin-zip.php LibIconv binaries].
* [http://gnuwin32.sourceforge.net/downlinks/libiconv-dep-zip.php LibIconv dependencies].

==== Charco ====

[http://www.marblesoftware.com/Marble_Software/Charco.html Charco] is a character set conversion tool used to recode character sets, much like iconv on Linux does, but in a more portable way and with a GUI for easy-of-use. Charco supports the most common character set encodings found on Windows, OS X and Linux, including a full complement of UTF-encodings. Charco also has a batch processing mode.

Download: [http://www.marblesoftware.com/downloads/windows/Charco%20for%20Windows.zip Charco].

Required code upgrades

2024-05-01T04:54:52Z

Andrewnicols: This page contains very out-dated content.

{{Template:obsolete}}
This page lists all changes that may be needed to be done in 3rd party modules and other integration code.

=Moodle 2.0=

Note to developrs: please keep adding more info here ;-)

==Mandatory==

===New Data Manipulation Layer (DML)===
* All database calls must be updated - new bound parameters syntax, magic quotes not used any more, see [https://docs.moodle.org/en/Development:DB_layer_2.0_migration_docs DB layer 2.0 migration].

===File API===
It consists of [https://docs.moodle.org/en/Development:File_API three parts]:
# file storage - modules can not access the course files anymore, they must store alll files in own area
# file browsing - each module/plugin defines what files are browsable and acessible
# file serving - each plugin/module is responsible for file sending though pluginfile.php

* Handling of files in backup/restore needs to be fully rewritten too.
* File uploading in formslib fully rewritten - old API should not be used

===Upgrade code===
* Upgrade allowed only from 1.9.x (upgrade of contrib modules does not do version tests yet)
* Backup/restore must use new DDL API.
* Concurrent upgrades are now prevented.

=== Messaging reimplemented ===
Mailing and notifications from modules needs to be updated (not finished yet)

==Optional==

* [https://docs.moodle.org/en/Development:Portfolio_API Portfolio integration]
* [https://docs.moodle.org/en/Development:Conditional_activities Conditional activities]

==Other changes==
These changes might affect some unsupported core code customisations. Modules and other plugins should not be affected.

* rewritten course category sorting

== See also: ==
* [[Migrating contrib code to 2.0]]
* [[User:Frank Ralf/Experience of converting a module to Moodle 2]]

Styling and customising the dock

2024-05-01T04:53:53Z

Andrewnicols: This page contains very out-dated content.

{{Template:obsolete}}
{{Template:Themes}}

The dock was an addition to Moodle 2.0, it allows the user to move blocks from the flow of the page onto a special bar that is displayed in a constant position on the side of the page by default.

The dock is not supported by all themes. It is not supported in the default theme "Boost" for Moodle 3.2.

This document looks at how to style the dock using CSS, as well as how to customise or manipulate it within JavaScript.

==Styling the dock==
Styling the dock is really no different to styling anything else within a web site however there are a couple of things that may slow you down and reading the following document may help you in your understanding of how the dock works and how you should go about styling it.

The following items are things that you should be aware of before starting to style the dock:
# When a block is docked the dock attempts to ensure that existing styles for the block are still applied by adding the standard block '''.block_''blockname'''''. Because of this trick we don't need to look at the actual content of a docked item it will always be the same as the block.
# The dock remembers what blocks are docked by saving the user's choices within the database using AJAX calls. This can be looked at to minimise display jumping within a theme's layoutfile. Read on to learn how.
# The dock uses CSS classes to transition the different states. These CSS classes control things such as the whether the dock is visible, whether the panel is visible, and how we know which item is being viewed. Read the section on [[#State_classes|state classes]] to learn more about these.
# The structure of the dock is built entirely by JavaScript. Because of this you will need a tool such as FireBug to inspect it within a page as it won't be there until JavaScript has run.
# Although the base theme doesn't support the dock it does contain some core CSS to structure the dock by default.

So lets get started and look at the structure.
===The structure of the dock===
[[Image:Dock.structure.201005.png|300px|thumb|Dock structure]]
The first image to the right graphically describes the hierarchical structure of the dock. The first thing you will notice about this image is that it doesn't describe what each element is for. It is just to illustrate the html structure without at styles or transformation.

So what are the important elements here?

; div#dock.dock.dock_left_vertical : This is the bar on the left. Positioned by default to be fixed position in the top left hand corner of the screen and 30px wide.
; div.dockeditem_container : This box contains all of the buttons which when clicked or hovered over will display the docked item. Or more technically causing the docked item panel to be shown.
; div#dock_item_x.dockeditem : This represents one of possibly several docked item buttons containing the title of the docked item. There are two things to note about this element: First it is repeated for every docked item. Second the x within the id is the item instance and should not be used for styling.
; div.controls : This contains any special controls for the dock and by default is displayed at the bottom of the dock. As of Moodle 2 Preview Release the only control here is to undock all docked items.
; div#dockeditempanel : This is the panel in which docked items are shown. Although it is within the dock is it positioned outside of the page relative to the button for the item it is currently showing. This element is based loosely off the YUI3 overlay.

===The layout of the dock===
[[Image:Dock.layout.201005.png|300px|thumb|Dock layout]]
The second image on the right shows the layout of these elements within the standard theme.

'''So what has gone on here?'''
First up ignore the bright colours and margins. I have put these colours in simply to highlight everything and ensure there is space between elements so I can show them apart.

; div#dock : So immediately you notice that the dock is in the top left of the screen and the is fixed width. This is achieved by setting a strict with of 30px and setting the position of the ''#dock'' to fixed. The reason that everything is within the one ''#dock'' element is because it makes positioning everything very simple, now that we have set the position of ''#dock'' we don't need to worry about anything other than the panel which we'll get to shortly. You should also note that because of the strict width and position you need to be careful when applying styles to this element as it can have nasty effects on everything else.

; div.dockeditem_container : Next you should notice that the ''.dockeditem_container'' doesn't extend to the bottom of the dock. Because there is not special positioning here it is behaving as div's normally do and this is the perfect place to really start styling your dock.

; div.controls : After that within the structure we have ''div.controls''. This element is positioned absolutely at the bottom of the dock, is 100% wide (so the full width of the dock) and uses ''text-align:center'' to ensure that the controls are centred.

; div.dockeditem : Simply representing a button that can be hovered over or clicked to display the docked item the only important thing to note about this is that you should change the cursor to a pointer so that it is clear you can interact with it.

; div#dockeditempanel : After ''#dock'' this is the most serious element in the dock. This element will contain the docked item and needs to positioned to the left of the dock and at the same height as the title of the item that is being displayed. Luckily you don't need to worry about the top position of the element that will be automatically adjusted by JavaScript however you will need to push the element to the left. This can be done easily by setting the position of the element to relative, and then setting left to 100%. Note you shouldn't style this element unless you know what you are doing, like the main dock element the smallest change can cause some terrible effects.

; div.dockeditempanel_container : This element is there specifically to give you the themer an easy place to start styling the panel.

; div.dockeditempanel_hd : This element contains the title of the docked item plus controls to undock or close it.

; div.dockeditempanel_bd : Contains is the main content area for the panel.

===State classes===
There are several state classes that the dock makes use of to achieve things such as the visibility of the dock, visibility of the panel, and which item is active.
The following table illustrates where these state classes are used.
{| class="wikitable"
! Element
! Class
! Description
! Default CSS
|-
|body
|has_dock
|This class is added to the body element when the dock is visible.
|Margin-left: 30px
|-
|#dock
|nothingdocked
|This class is added to the dock when there is nothing docked.
|visibility: hidden; display: none;
|-
|#dock
|.dock_''position''_''style''
|A special class is added to describe the docks desired position e.g. dock_left_vertical
|
|-
|.dockeditem
|activeitem
|This class is added to the item that is currently being shown.
|Change the background colour
|-
|.dockeditem
|firstdockitem
|This class is added to the first dock item.
|
|-
|.dockeditem h2
|filterrotate
|Added when the title is being rotated by an IE filter [Internet Explorer only]
|
|-
|#dockeditempanel
|dockitempanel_hidden
|Added to the panel when it is not being shown.
|visibility: hidden; display: none;
|-
|#dockeditempanel
|oversized_content
|Added when the panel required scrolling to show everything.
|Set the overflow method
|}

===Layout file changes===
There is only one thing that you need to make sure of within your layout files if you are creating your own. You need to add the class ''block-region'' to all of the block region div's as shown below.
<syntaxhighlight lang="php">
<div id="region-post" class="block-region">
<div class="region-content">
<?php echo $OUTPUT->blocks_for_region('side-post') ?>
</div>
</div>
</syntaxhighlight>
Whilst there is nothing else you '''need''' to change within your layout files there one other thing that you may want to do.

Because the dock is loaded entirely by JavaScript you will notice a visual jump on the page if all of the blocks within a region have been docked. This is because the dock shrinks sections that have been completely docked so that they don't wast page space.

Within you layout files you can check whether a section has been completely docked and then if it has set the body classes so that it is shrunk when the page is delivered.

I'm going to assume that you have all read the [[Themes 2.0 creating your first theme]]. If you haven't go read it now.
So now that you've created your first theme think back to the code you wrote at the top of your layout files that checks whether a page has block regions pre and post. The code was as follows:
<syntaxhighlight lang="php">
$hassidepre = $PAGE->blocks->region_has_content('side-pre', $OUTPUT);
$hassidepost = $PAGE->blocks->region_has_content('side-post', $OUTPUT);
</syntaxhighlight>
Right below these two lines we are going to add two more:
<syntaxhighlight lang="php">
$showsidepre = ($hassidepre && !$PAGE->blocks->region_completely_docked('side-pre', $OUTPUT));
$showsidepost = ($hassidepost && !$PAGE->blocks->region_completely_docked('side-post', $OUTPUT));
</syntaxhighlight>
What we have here is two variables that tell use whether we should show the block regions pre and post. The verbal interpretation of this string is to say ''We will show this side if this side has content and if there is at least one block that has not been docked.'' and we repeat it for each side.

Now that we know for each region that it has content and that we should show it we need some way to tell the page what block regions to show.
This is achieved by adding special classes to the body element of the page as follows:
; side-pre-only : This gets added to the body if we only want to show the block region pre.
; side-post-only : Just like side-pre-only except for the post region.
; content-only : This gets added if don't want to show either block region.
By default we want to show both regions so we don't need to add any class for this.
So how to do this in PHP?
<syntaxhighlight lang="php">
$bodyclasses = array();
if ($showsidepre && !$showsidepost) {
$bodyclasses[] = 'side-pre-only';
} else if ($showsidepost && !$showsidepre) {
$bodyclasses[] = 'side-post-only';
} else if (!$showsidepost && !$showsidepre) {
$bodyclasses[] = 'content-only';
}
</syntaxhighlight>
What we have here is three if-else statements, of which either one or none will be true.
# The first if statement says if we want to show the pre region but not the post region add the class ''side-pre-only''
# The second if statement says if we want to show the post region but not the pre region add the class ''side-post-only''
# The third class says if we don't want to display either region add the class ''content-only''

Now that we know which class we want to add to the body element we need to do so. This can be done as follows:
<syntaxhighlight lang="php">
<body id="<?php echo $PAGE->bodyid ?>" class="<?php echo $PAGE->bodyclasses.' '.join(' ', $bodyclasses) ?>">
</syntaxhighlight>
You'll notice this is very similar to the body tag you wrote in your first theme, however we have added
<syntaxhighlight lang="php">
join(' ', $bodyclasses)
</syntaxhighlight>
This php command simply concatenates each body class putting a space between each.

Now the final thing to do is make sure that we don't show a block region if we don't have content for it. This can be done by adding if statements around each block region as follows:
<syntaxhighlight lang="php">
<?php if ($hassidepre) { ?>
<div id="region-pre" class="block-region">
<div class="region-content">
<?php echo $OUTPUT->blocks_for_region('side-pre') ?>
</div>
</div>
<?php } ?>

<?php if ($hassidepost) { ?>
<div id="region-post" class="block-region">
<div class="region-content">
<?php echo $OUTPUT->blocks_for_region('side-post') ?>
</div>
</div>
<?php } ?>
</syntaxhighlight>
For each if statement we are saying ''If this region has content display it.'' You'll notice that here we are using ''$hasside...'' instead of ''$showside...'' this is because we want to add them if they have content even if they won't be shown. Otherwise the dock won't be able to find them and you simply won't see the block.

Having made the above changes if you now look at the layout files for the base theme you start to notice that they are looking very similar and indeed they are. If at any point you get stuck or don't know how to proceed have a look at the base themes layout files and see how its done there.

===The core CSS===
As mentioned in the key points at the start of this document the base theme although not supporting the dock does contain structural CSS that ensure the dock is functional on all themes that choose to support it.
Lets look at the CSS within ''theme/base/style/dock.css'', this is the core structural CSS for the dock.
<syntaxhighlight lang="css">
/* Put a margin on the body if the dock is shown */
body.has_dock {margin-left:30px;}
</syntaxhighlight>
Well this is very simple, if the dock is being shown apply a 30px margin to the body. This is done to ensure that the dock doesn't overlap the body.

<syntaxhighlight lang="css">
/** For the dock itself */
#dock {width:30px;position:fixed;top:0px;left:0px;height:100%;background-color:#FFF;border-right:1px solid #000;z-index:11000;}
#dock.nothingdocked {visibility: hidden;display:none;}
</syntaxhighlight>
These two rules style the dock itself. Note the second rule is only applied when nothing is docked in which case we will hide the empty dock.

<syntaxhighlight lang="css">
#dock .dockeditem .firstdockitem {margin-top:1em;}
#dock .dockeditem .dockedtitle {border-bottom:1px solid #000;border-top:1px solid #000;cursor:pointer;}
#dock .dockeditem .dockedtitle h2 {font-size:0.8em;line-height:100%;text-align:center;}
#dock .dockeditem .dockedtitle .filterrotate {margin-left:8px;}
</syntaxhighlight>
The four rules above style the buttons that will show the docked items. Each docked item has one. The styles being used here arn't doing anything to special other than setting the cursor to pointer so that it is recognised as an actionable element.

<syntaxhighlight lang="css">
#dock .controls {position:absolute;bottom:1em;text-align:center;width:100%;}
#dock .controls img {cursor:pointer;}
</syntaxhighlight>
Very simply this bit of CSS. It is positioning the controls for the dock at the bottom centre of the dock.

<syntaxhighlight lang="css">
/** For the panel the docked blocks are shown in */
#dockeditempanel {min-width:200px;position:relative;z-index:12000;left:100%;}
#dockeditempanel.dockitempanel_hidden {display:none;}
</syntaxhighlight>
These two lines are applied to the docked item panel's base element and are VERY important to the operation of the dock. They ensure that when shown the panel is top the left of the dock and that when it is not being displayed it is not visible.

<syntaxhighlight lang="css">
#dockeditempanel .dockeditempanel_content {background-color:#fff;border:1px solid #000;z-index:12050;}
#dockeditempanel .dockeditempanel_bd {overflow:auto;width:auto;}
#dockeditempanel .dockeditempanel_bd .block_docked {margin:10px;}
#dockeditempanel .dockeditempanel_hd {border-bottom:1px solid #000;text-align:right;}
#dockeditempanel .dockeditempanel_hd h2 {display:inline;margin:0;padding-right:1em;}
#dockeditempanel .dockeditempanel_hd .commands {display:inline;}
#dockeditempanel .dockeditempanel_hd .commands img {margin-right:2px;vertical-align:middle;}
</syntaxhighlight>
The above lines of CSS are used to style the internal content of the panel. Note the styles for the block will be applied as if it were not docked.

And that is it!

Whilst things don't look to difficult when styling things if you don't think carefully about where you are applying styles you can quickly dig yourself a big hole. I would suggest going slowly at first when applying more styles and making sure you don't apply too many styles to the base elements #dock and #dockeditempanel.

==Customising the dock==
This section of the document looks at how to customise the dock using JavaScript.

It was recognised early on during the development of the dock that it probably won't suit everyone's needs, nor would it appeal to everyone. Because of this during development and the frequent revisions that were occurring during Moodle 2.0s development there was always a focus on ensuring the dock was customisable and that someone with a bit of time on their hands and a good knowledge of JavaScript could hack it to bits and make it into the tool they desired.

This document doesn't go into the full details of how to customise the dock but should get anyone keen started quickly. Those who fear JavaScript should leave now!

===Getting started===
The dock is written to make use of YUI3 and all the functionality that it has to offer, the main dock object both looks for specific callback functions and adds manages and fires several important events. At the same time it is also object orientated JavaScript which has the advantage in JavaScript of allowing subsequent JavaScript events to redefine methods of the object.

This allows you the theme designer to write JavaScript to customise the dock in two fashions. The first through events and callbacks. The second through manually overriding the methods the dock uses.

We will look into these two methods in the subsequent sections of this document, for the time being what you need to learn about is the JavaScript structure of the dock.

First all of the code for the dock within Moodle 2.0 is located within the file '''moodle/blocks/dock.js''' and can be viewed online through the CVS repository[http://cvs.moodle.org/moodle/blocks/dock.js?view=markup]

There are three main objects that get used for the dock:
# First up is of course the dock, which is namespaced to M.core_dock.dock. It is instantiated only once per page and is essentially a static object that manages and operates the dock plus everything on it.
# Second is a generic block class. Every block on the page gets instantiated as a generic block unless it has a more specific class (that should extend the generic block class). This generic block class is responsible for moving a block between the dock and its normal block position. It is namespaced to M.core_dock.generic_block.
# The third class is the dock item class which is used to represent an item on the dock. It is responsible for showing the item when required and handles the events that the dock + user trigger. I can hear you asking now why not just add this functionality to the generic block class? because this keeps it open for things other than blocks to be docked.

As well as the above three classes there are some important class objects and properties that you should also be aware of as you may want to work with them when customising the dock.
; M.core_dock.Y : Is a YUI instance for use with the dock.
; M.core_dock.nodes.dock : Is the façade for the dock itself (#dock) and is a YUI3 Node instance.
; M.core_dock.getPanel() : This will return the panel that is used to display docked item within. It is stored locally through M.core_dock.nodes.panel however as it is not initialised until it is required you should always use the getPanel method.

The following are other important notes about the dock that you should read and understand before customising the dock.
# The dock emulates the YUI3 '''on''' method for listening to events. Because the dock requires initialisation which may occur through module dependencies we needed a method of exposing the dock to events prior to initialisation and this is it. It ensures that if you attach events to the dock before it is initialised everything still works fine.
# Both the dock and the item class inherit from Y.EventTarget and publish several events.
# The dock is designed to work both on old and modern browsers and as such there are several places where we branch based on browser and version.
# The generic block class should never be added to for the needs of a single block. Only things that are generic to all blocks should be added to this class. Independent needs should be handled by creating a block specific class that extends the generic block class. The navigation and settings blocks do this currently.

===Extending the dock through events===
Under construction

===Using custom methods for the dock===
Under construction

==See also==

* [[Making a horizontal dock]]

Turnitin errors

2024-05-01T04:53:22Z

Andrewnicols: Note about intent to not migrate this page to moodledev.io

{{Template:WillNotMigrate}}
This is a list of the Turnitin Codes, and their descriptions.

== Success States 1-99 ==
*1 General Success State, no errors
*10 FID 1, FCMD 1 – successful, send to login
*11 FID 1, FCMD 2 – successful, do not send to login
*20 FID 2, FCMD 1 – successful, send to login
*21 FID 2, FCMD 2 – successful, do not sent to login
*30 FID 3, FCMD 1 – successful, send to login
*31 FID 3, FCMD 2 – successful, do not send to login
*40 FID 4, FCMD 1,5 – successful, redirect user to assignment creation/modification page
*41 FID 4, FCMD 2 – successful
*42 FID 4, FCMD 3 – successful
*43 FID 4, FCMD 4 – successful
*50 FID 5, FCMD 1 – successful, redirect user to submission page
*51 FID 5, FCMD 2 - successful
*60 FID 6, FCMD 1 - successful
*61 FID 6, FCMD 2 - successful
*70 FID 7, FCMD 1,2 – successful
*70 FID 12, FCMD 1 – successful, redirect to administrator statistics page
*71 FID 8, FCMD 2 - successful
*72 FID 10, FCMD 2 - successful
*73 FID 11, FCMD 2 – successful
*74 FID 0 – successful
*75 FID 9, FCMD 2 - successful

== Data Errors 100-199 ==
*100 Primary account ID missing from URL
*101 No HTTPS - the URL was not transmitted via HTTPS
*102 GMT missing from URL
*103 GMT malformed - the date/time in the URL is bad
*104 Email missing from URL
*105 Email address is not between 5-75 characters
*106 Email address contains whitespace
*107 Email address in URL is malformed
*108 Password in URL contained whitespace
*109 Diagnostic value in URL is bad
*110 MD5 missing from URL
*111 fcmd missing from URL
*112 User first name missing from URL or incorrect length
*113 User last name missing from URL or incorrect length
*114 Class title missing from URL, or not between 5-50 characters
*115 Password is not between 6-12 characters
*116 fid missing from URL, or does not reference existing function
*117 User type missing from URL or is not valid
*118 encrypt value in URL is bad or missing
*119 Paper author’s first name missing or incorrect length
*120 Paper author’s last name missing or incorrect length
*121 Paper title missing – Please make sure to include a paper title before submitting your paper
*122 Paper type missing or invalid
*123 Assignment title missing or incorrect length
*124 ObjectID missing
*125 Password is required for function
*126 Date start and date due is required for function
*127 If one unique ID is used, they must all be used
*128 The class end date parameter is not in the right format. Please make sure that the format is in YYYMMDD.”
*140 Undocumented, but appears to occur when assignment title is too long. Should probably return either 2302 or 123 in this situation.
*141 "The value for the a date parameter is invalid"

== Turnitin Database Errors 200-299 ==
*200 Primary account ID for Turnitin not activated to use the API
*201 IP address validation range for Turnitin not configured
*202 Primary account entry not active in Turnitin database
*203 MD5 key missing from Turnitin database
*204 Class does not exist in Turnitin database. Please contact you instructor for further details.
*205 Database error verifying class
*206 Assignment does not exist in Turnitin database for this class. The assignment may have been deleted.
*207 Database error verifying assignment
*208 User is not enrolled in class
*209 Database error verifying user’s enrollment in class
*210 User password does not match user email
*211 Database error verifying objectID
*212 objectID does not exist for this user
*213 objectID does not belong to this user
*214 Filename does not exist for this paper
*215 This primary account ID is not authorized to use this product
*216 Student limit for this account has been reached. Cannot join student to this class.
*217 The product for this account has expired. Please contact your sales agent to renew the product
*218 Database Error inserting unique ID into the database ''(Note: This may happen on a new install of Moodle if the mdl_assignment ID's clash with turnitin assignment ID's in the previous installation. Fix this by increasing the autoincrement for mdl_assignment in the new installation to a number greater than the maximum ID in the old Moodle)''
*219 Unique user id in the database does not match submitted uid
*220 More than one class exists with this title and unique ids must be used in this case
*221 More than one assignment exists with this title and unique ids must be used in this case
*222 User is associated with a different external uid. If you have another user account with the same email address as the user account you are currently using, that could be the cause of the problem. Please try modifying the email address for your current user account to a unique email address and try again.
*223 Cannot verify Blackboard user’s identity within Turnitin. Missing Blackboard user id
*224 Could not verify user as primary instructor for this course
*225 Database error checking if student can view reports
*226 The class you are trying to update could not be found. Please check to make sure that the class exists.
*227 The class you are trying to update has an assignment which ends after the class end date you have specified. Please change you class end date or modify the assignment.
*228 The assignment with the assignment id that you entered does not belong to the class with the class id you entered. Please check to make sure that you are not using a duplicate assignment id.
*229 There was an error creating the rollover assignment.
*230 You have been dropped from this class on the Turnitin end by your instructor. Please contact your instructor if you think you are receiving this message in error.
*231 There was an error processing your request: please try your action again. Please contact the Turnitin helpdesk if the problem persists.
*232 Grademark is currently inactive for this account.
*233 There was an error accessing this Turnitin Assignment because it was created via Course Copy, Snapshot, or some other process, and the original Turnitin Assignment could not be found.
*234 Could not find class with the given unique ID or title.
*235 Could not find assignment with the given assignment ID or title.
*236 Could not retrieve assignment info with the given information.
*237 Could not retrieve grade for the given object.
*238 Could not find user with the given userid or email.
*239 There was an error disabling Anonymous Marking for this submission.
*240 Migrating of this product is not supported.
*241 The user does not have the specified role in the class.
*242 There was an error with the attached file, please make sure it follows the proper format.
*243 The attached file is not a CSV file.
*244 The number of files you have selected exceeds the 500 file maximum for bulk download. Please make sure that the number of files you select for bulk download does not exceed 500 files.
*245 The objectIDs that were provided do not all belong to the same assignment.
*246 The compression process cannot begin because the students you selected do not have GradeMark files.
*247 We are compressing a file you previously requested for download. When this compression is complete, you may request another file for download.
*248 The class you have selected has been deleted.
*250 Submission Error: There was an error building up the user session data to submit the paper. Please verify the user information being used.

== Inconsistency Errors 300-399 ==
*300 Your IP address does not fall within the range of accepted IP addresses as specified by your Turnitin account administrator. Please check with your Turnitin account administrator if your IP address needs to be added as an accepted IP address.
*301 Date/time expired – GMT timestamp used in MD5 calculation is off. API calls must have a GMT within 60 minutes of the current GMT
*302 MD5 not authenticated - the MD5 in the URL does not match the MD5 calculated

== Function Errors 400-499 ==
*400 Creating new user failed
*401 Unauthorized access - user exists, but does not belong to correct primary account ID or sub-account ID, do not execute function
*402 User is not an instructor, must be an instructor to run this function
*403 User is not a student, must be a student to run this function
*404 FCMD is not valid
*405 Class title is not unique
*406 Creating new class failed in fid 2
*407 Student failed to join or log in to a class in fid 3
*408 Attempt to join new user to account failed
*409 Function requires POST request
*410 Function requires GET request
*411 Creating/Updating/Deleting assignment failed in fid 4
*412 Assignment title is not unique
*413 Error while trying to save the paper
*414 Originality report not generated yet in fid 6, fcmd 1
*415 Originality score not available yet in fid 6, fcmd 2
*416 Error checking if submission existed for user
*417 Error trying to change user password
*418 Error trying to delete submission
*419 Could not create a new assignment. An assignment with this title already exists for this class and instructor. Please change the assignment title.
*420 Error trying to build up session data for user/class
*421 Error trying to retrieve paper submission info for assignment
*422 Updating user information failed
*423 Updating user information failed because user email was changed to an address that is already associated with an account
*424 Updating class title failed
*425 Error trying to sync grades between servers
*426 Error trying to sync roster between servers
*427 Unable to establish web services session with remove webct server
*428 Unable to create WebCT gradebook column for assignment
*429 Web services parameters error
*430 (This is a general webservices error – there could be a number of different messages that come with it)
*431 Error trying to connect back to the Blackboard web service.
*432 Students are not allowed to view reports in this assignment
*434 The start time you specified is invalid or not formatted correctly (YYYY-MM-DD HH:MM:SS).
*435 Error trying to grade submission.
*436 Institution repository is not available for this account, please change the submit_papers_to parameter to either 0 (no repository) or 1 (standards repository).
*437 The account administrator has set that all papers must be submitted to a repository, please change the submit_papers_to parameter.
*438 Error trying to set submissions to be stored in a standard repository. The account is using its own private institutional node. Please change the submit_papers_to parameter.
*439 The institutional check is not available for this account. Please set the institution_check parameter to 0
*440 Please specify an email for the new instructor for this course.
*441 New instructor specified doesn’t exist, please create the user first.
*442 New Instructor is not joined to this account, please join them to the account first.
*443 Anonymous Marking is enabled for this assignment. Cannot download file until after the assignment post date.
*444 Usage of this account is not currently high enough to generate meaningful statistics. If you would like more information or would like to see these statistics any way, please contact your Turnitin sales representative.
*445 User login failed.
*446 Session ID missing from URL
*447 Error trying to set user as an instructor for the class.
*448 Error migrating this account to another product.
*449 Error removing user from class.
*450 Cannot remove user from class because the user is the only instructor for the class.
*451 Error initiating GradeMark Bulk Download.

== Paper Submission Errors 1000-1099 ==
*1000 The due date for this assignment has passed. Please see your instructor to request a late submission.
*1001 You may not submit a paper to this assignment until the assignment start date
*1002You may not submit a paper to this assignment because the Plagiarism Prevention product is unavailable
*1003You have reached the maximum limit of 10 papers for the InSite demo account
*1004Paper author’s first name missing or incorrect length in URL
*1005Paper author’s last name missing or incorrect length in URL
*1006Paper title missing
*1007The file you have uploaded is too big (TurnItIn site has a note that file size may not exceed 10.48576Mb)
*1008No file uploaded! Please make sure that you have attached the file that you wish to submit before sending the request
*1009Invalid file type! Valid file types are MS Word, Acrobat PDF, Postscript, Text, HTML, WordPerfect (WPD) and Rich Text Format. Please make sure the format of your file is one of the valid file types.
*1010You must submit more than 100 characters of non-whitespace
*1011The paper you are tyring to submit is incorrectly formatted. There seems to be spaces between each letter in your paper. Please try submitting again or contact our helpdesk if the problem persists.
*1012Paper length exceeds limits
*1013You must submit more than 20 words of text
*1014You must select an enrolled student as the author of this paper
*1015You have already submitted a paper to this assignment. Please contact your instructor to request a resubmission
*1016This student has already submitted a paper to this assignment. Please delete the original paper before submitting a new one.
*1017Paper author's first name missing or incorrect length in URL
*1018Paper author's last name missing or incorrect length in URL
*1019Paper title exceeds maximum of 200 characters
*1020 This document cannot be accepted because it contains characters from a character set that is not supported.
*1021 You have already submitted a paper to this assignment. Please contact your instructor to request a resubmission.
*1022 This student has already submitted a portfolio item to this assignment. Please delete the original portfolio item before submitting a new one.
*1023 We're sorry, but we could not read the PDF you submitted. Please make sure that the file is not password protected and contains selectable text rather than scanned images.
*1024 The paper you are tyring to submit does not meet our cirteria for a legitimate paper. Please try submitting again or contact our helpdesk if the problem persists.

== Assignment Creation Errors 2025-2324 ==
*2025 The class name must be between 5-200 characters
*2026 The class enrollment password must be between 4-12 characters
*2027 There was an error processing your request
*2028 The class end date must be within 6 months of the start date
*2029 The end date for this class must occur on or after today
*2030 The end date for this class must occur on or after the start date
*2031 The end date for this class must occur at least 3 months after the start date
*2032 There was an error updating the class end date
*2035 There was an error processing your request
*2036 There was an error processing your request
*2100 User first name missing from URL
*2101 User last name missing from URL
*2102 Email is missing. Please make sure that your email address has been set
*2108 The email address needs to conform to Internet Standard RFC822
*2109 The email address needs to have a fully qualified domain name.
*2110 We only allow email addressses with 5-75 characters
*2111 The email address cannot contain white space
*2112 Please make sure you are entering a valid email address. The email address you enter can only contain letters, numbers, and the symbols _ (underscore), - (dash), . (period), ' (apostrophe), and + (plus).”
*2300 You have entered an invalid date!
*2301 You must select a rubric set to user with remediation
*2302 The assignment title must be between 2-100 characters
*2303 The assignment must have a point value between 0 and 1000
*2304 The assignment instructions must be less than 1000 characters
*2305 The start date for this assignment must occur on or after today
*2306 The due date for this assignment must occur on or after the start date
*2307 The due date for this assignment must occur within 6 months of the start date
*2308 When creating your assignment, the post date must occur on or before the class end date. The class end date in Turnitin is by default set to 6 months from the day the class was created. The class end date can be chaned in the class update area in Turnitin
*2309 When creating your assignment, please make sure that the post date is on or after the due date of the assignment
*2310 You must specify a point value for this assignment because this class is using distributed grading
*2314 When modifying your assignment, please make sure that the post date is on or after the due date of the assignment
*2315 There was an error processing your request
*2316 There was an error processing your request
*2317 There was an error processing your request
*2318 You cannot change the search targets because papers have already been submitted to this assignment. You must create a new assignment if you would like to change the search targets
*2319 There was an error processing your request
*2320 There was an error processing your request
*2321 When excluding small matches by word, you must enter a positive number
*2324 When excluding small matches by percentage, you must enter a number between 1 and 100

----

Turnitin

2024-05-01T04:52:54Z

Andrewnicols: This page contains very out-dated content.

{{Template:obsolete}}
==Development Plan for Turnitin Plagiarism plugin==
===Current Features in Released code===
* Integrated with Advanced upload and single upload assignment types.
* capability moodle/course:enableturnitin to give teachers to use TII submission.
* Teachers will be able to "enable" the TII submission when creating a new Advanced Assignment Type.
* TII originality Score, and Full report will only be available to Teachers via the submissions page.
* all files uploaded to the assignment will be submitted to TII via cron
* Originality score/Full report will be checked for availability via cron.
* Display some "disclaimer" type text to the student when TII is enabled to explain that the assignment will be automatically submitted to TII
Add the ability for teachers to elect who/when a originality score and or full report is available to:
* As soon as the report is back
* After the due date of the assignment
* Add options to admin pages to set what settings are the default for TII settings within modules.

===Stuff that would be nice to do at some point, but is not currently funded===
* add the functionality to the Online assignment type
* add the functionality to the discussion forum uploads
* add the functionality for files uploaded via html editor(essay questions etc)

From The University of Waikato
* Provide option for to not store assignment submissions on the Tii database and what to check/compare them against (as per Tii 'Allow other papers to be checked against submission' option)
* Better error display to students so they are informed if a file is not valid or long enough etc
* ‘keep alive’ type communication when a lecturer is viewing a report to prevent Tii website timeout

Wiki 2.0.3 Files

2024-05-01T02:16:32Z

Andrewnicols: This page contains very out-dated content.

{{Template:obsolete}}
This page specs for cleaning up file handling in wiki 2. See MDL-26739 for details.

==File management page==
Create a new tab in wiki main page, named "Files", the Files page will display all files shared in current wiki instance. Users with manage files capability will see "Manage files" button under the files tree view, click the button will take users to moodle file manager.
[[Image:Wiki_Files_Tab.jpg]]

==Wiki editors==

Nwiki and creole wiki editors will have a new select to choose existing files from shared area.

[[Image:Wiki_Editor.jpg]]

==File handling==

What to do about weblib methods with lots of arguments

2024-05-01T02:14:24Z

Andrewnicols: This page contains very out-dated content.

{{Template:obsolete}}
{{Moodle 2.0}}

{{Work in progress}}

In Moodle 2.0, all the functions in lib/weblib.php that are to do with generating output are being replaced by methods in lib/outputlib.php.

This is a chance to clean up the API. For example, we have already decided that all these methods will return a string, rather than giving a choice of outputting the HTML immediately via a $output parameter.

(Just to reassure you: We will make new versions of all the old weblib functions in deprecatedlib.php, that implement the old API in terms of the new methods, so you existing code will not break.)

==The problem==

While some of the weblib functions are quite sensible. For example:
<syntaxhighlight lang="php">
function print_box($message, $classes='generalbox', $ids='', $return=false) {
</syntaxhighlight>
some of them are ridiculous:
<syntaxhighlight lang="php">
function choose_from_menu ($options, $name, $selected='', $nothing='choose', $script='',
$nothingvalue='0', $return=false, $disabled=false, $tabindex=0,
$id='', $listbox=false, $multiple=false, $class='') {
</syntaxhighlight>
Suppose you want to create a <select> menu with a particular class attribute. You have to pass all 13 arguments, most of them just the default value, just to be able to pass class.

We should look for a better way to handle these methods with a lot of parameters.

Fortunately, there is a precedent. Here is the print_table function:
<syntaxhighlight lang="php">
/**
* Print a nicely formatted table.
*
* @param array $table is an object with several properties.
* <ul>
* <li>$table->head - An array of heading names.
* <li>$table->align - An array of column alignments
* <li>$table->size - An array of column sizes
* <li>$table->wrap - An array of "nowrap"s or nothing
* <li>$table->data[] - An array of arrays containing the data.
* <li>$table->width - A percentage of the page
* <li>$table->tablealign - Align the whole table
* <li>$table->cellpadding - Padding on each cell
* <li>$table->cellspacing - Spacing between cells
* <li>$table->class - class attribute to put on the table
* <li>$table->id - id attribute to put on the table.
* <li>$table->rowclass[] - classes to add to particular rows. (space-separated string)
* <li>$table->colclass[] - classes to add to every cell in a particular colummn. (space-separated string)
* <li>$table->summary - Description of the contents for screen readers.
* <li>$table->headspan can be used to make a heading span multiple columns.
* <li>$table->rotateheaders - Causes the contents of the heading cells to be rotated 90 degrees.
* </ul>
* @param bool $return whether to return an output string or echo now
* @return boolean|string depending on $return
*/
function print_table($table, $return=false) {
</syntaxhighlight>

That is, we just pass in one object which has all the necessary information as properties, many of which are optional. Should we use this approach for more functions?

On this page I explore this idea by rewriting the choose_from_menu function.

==Code to create a menu==

===Simple example===

====Old code====

A simple example (from backup/restore_form.html).
<syntaxhighlight lang="php">
choose_from_menu($gradebook_history_options, "restore_gradebook_history",
$restore_gradebook_history, "");
</syntaxhighlight>

====New code====

<syntaxhighlight lang="php">
$menu = new moodle_select_menu;
$menu->options = $gradebook_history_options;
$menu->name = 'restore_gradebook_history';
$menu->selectedoption = $restore_gradebook_history;
echo $OUTPUT->select_menu($menu);
</syntaxhighlight>

===Complex example===

====Old code====

A complex example (from mod/assignment/lib.php)
<syntaxhighlight lang="php">
choose_from_menu($options, 'outcome_'.$n.'['.$userid.']',
$outcome->grades[$submission->userid]->grade, get_string('nooutcome', 'grades'),
'', 0, false, false, 0, 'menuoutcome_'.$n);
</syntaxhighlight>

====New code====

<syntaxhighlight lang="php">
$menu = new moodle_select_menu;
$menu->options = $options;
$menu->name = 'outcome_'.$n.'['.$userid.']';
$menu->selectedoption = $outcome->grades[$submission->userid]->grade;
$menu->nothinglabel = get_string('nooutcome', 'grades');
$menu->id = 'menuoutcome_'.$n;
echo $OUTPUT->select_menu($menu);
</syntaxhighlight>

Although the new code is longer, I think it is much easier to see which parameters we have set (to non-default values).

==Code behind the scenes==

The remainder of this page is a bit out-of-date following some discussions which caused me to change some details above, however it is basically right.

===Old code===

The implementation of choose_from_menu is
<syntaxhighlight lang="php">
/**
* Given an array of values, output the HTML for a select element with those options.
*
* Normally, you only need to use the first few parameters.
*
* @param array $options The options to offer. An array of the form
* $options[{value}] = {text displayed for that option};
* @param string $name the name of this form control, as in <select name="..." ...
* @param string $selected the option to select initially, default none.
* @param string $nothing The label for the 'nothing is selected' option. Defaults to get_string('choose').
* Set this to '' if you don't want a 'nothing is selected' option.
* @param string $script if not '', then this is added to the <select> element as an onchange handler.
* @param string $nothingvalue The value corresponding to the $nothing option. Defaults to 0.
* @param boolean $return if false (the default) the the output is printed directly, If true, the
* generated HTML is returned as a string.
* @param boolean $disabled if true, the select is generated in a disabled state. Default, false.
* @param int $tabindex if give, sets the tabindex attribute on the <select> element. Default none.
* @param string $id value to use for the id attribute of the <select> element. If none is given,
* then a suitable one is constructed.
* @param mixed $listbox if false, display as a dropdown menu. If true, display as a list box.
* By default, the list box will have a number of rows equal to min(10, count($options)), but if
* $listbox is an integer, that number is used for size instead.
* @param boolean $multiple if true, enable multiple selections, else only 1 item can be selected. Used
* when $listbox display is enabled
* @param string $class value to use for the class attribute of the <select> element. If none is given,
* then a suitable one is constructed.
* @return string|void If $return=true returns string, else echo's and returns void
*/
function choose_from_menu ($options, $name, $selected='', $nothing='choose', $script='',
$nothingvalue='0', $return=false, $disabled=false, $tabindex=0,
$id='', $listbox=false, $multiple=false, $class='') {

if ($nothing == 'choose') {
$nothing = get_string('choose') .'...';
}

$attributes = ($script) ? 'onchange="'. $script .'"' : '';
if ($disabled) {
$attributes .= ' disabled="disabled"';
}

if ($tabindex) {
$attributes .= ' tabindex="'.$tabindex.'"';
}

if ($id ==='') {
$id = 'menu'.$name;
// name may contaion [], which would make an invalid id. e.g. numeric question type editing form, assignment quickgrading
$id = str_replace('[', '', $id);
$id = str_replace(']', '', $id);
}

if ($class ==='') {
$class = 'menu'.$name;
// name may contaion [], which would make an invalid class. e.g. numeric question type editing form, assignment quickgrading
$class = str_replace('[', '', $class);
$class = str_replace(']', '', $class);
}
$class = 'select ' . $class; /// Add 'select' selector always

if ($listbox) {
if (is_integer($listbox)) {
$size = $listbox;
} else {
$numchoices = count($options);
if ($nothing) {
$numchoices += 1;
}
$size = min(10, $numchoices);
}
$attributes .= ' size="' . $size . '"';
if ($multiple) {
$attributes .= ' multiple="multiple"';
}
}

$output = '<select id="'. $id .'" class="'. $class .'" name="'. $name .'" '. $attributes .'>' . "\n";
if ($nothing) {
$output .= ' <option value="'. s($nothingvalue) .'"'. "\n";
if ($nothingvalue === $selected) {
$output .= ' selected="selected"';
}
$output .= '>'. $nothing .'</option>' . "\n";
}

if (!empty($options)) {
foreach ($options as $value => $label) {
$output .= ' <option value="'. s($value) .'"';
if ((string)$value == (string)$selected ||
(is_array($selected) && in_array($value, $selected))) {
$output .= ' selected="selected"';
}
if ($label === '') {
$output .= '>'. $value .'</option>' . "\n";
} else {
$output .= '>'. $label .'</option>' . "\n";
}
}
}
$output .= '</select>' . "\n";

if ($return) {
return $output;
} else {
echo $output;
}
}
</syntaxhighlight>

===New code===

My new implementation of moodle_core_renderer::select_menu is
<syntaxhighlight lang="php">
/**
* Output a <select> menu.
*
* You can either call this function with a single moodle_select_menu argument
* or, with a list of parameters, in which case those parameters are sent to
* the moodle_select_menu constructor.
*
* @param moodle_select_menu $selectmenu a moodle_select_menu that describes
* the select menu you want output.
* @return string the HTML for the <select>
*/
public function select_menu($selectmenu) {
if ($selectmenu->nothinglabel) {
$options = array($selectmenu->nothingvalue => $selectmenu->nothinglabel) +
$selectmenu->options;
} else {
$options = $selectmenu->options;
}

$attributes = array(
'name' => $selectmenu->name,
'id' => $selectmenu->id,
'class' => $selectmenu->get_classes_string(),
'onchange' => $selectmenu->script,
);
if ($selectmenu->disabled) {
$attributes['disabled'] = 'disabled';
}
if ($selectmenu->tabindex) {
$attributes['tabindex'] = $tabindex;
}

if ($selectmenu->listbox) {
if (is_integer($selectmenu->listbox)) {
$size = $selectmenu->listbox;
} else {
$size = min($selectmenu->maxautosize, count($options));
}
$attributes['size'] = $size;
if ($selectmenu->multiple) {
$attributes['multiple'] = 'multiple';
}
}

$html = $this->output_start_tag('select', $attributes) . "\n";
foreach ($options as $value => $label) {
$attributes = array('value' => $value);
if ((string)$value == (string)$selectmenu->selectedvalue ||
(is_array($selectmenu->selectedvalue) && in_array($value, $selectmenu->selectedvalue))) {
$attributes['selected'] = 'selected';
}
$html .= ' ' . $this->output_tag('option', $attributes, s($label)) . "\n";
}
$html .= $this->output_end_tag('select') . "\n";

return $html;
}
</syntaxhighlight>

The moodle_select_menu class is little more than a stdClass. The main reason to have it is that it lets us PHPdoc the various fields. However note that moodle_core_renderer::select_menu will work fine if you pass a stdClass with the right fields.
<syntaxhighlight lang="php">
/**
* This class hold all the information required to describe a <select> menu that
* will be printed by {@link moodle_core_renderer::select_menu()}. (Or by an overrides
* version of that method in a subclass.)
*
* All the fields that are not set by the constructor have sensible defaults, so
* you only need to set the properties where you want non-default behaviour.
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*/
class moodle_select_menu extends moodle_html_component {
/**
* @var array the choices to show in the menu. An array $value => $label.
*/
public $options;
/**
* @var string the name of this form control. That is, the name of the GET/POST
* variable that will be set if this select is submmitted as part of a form.
*/
public $name;
/**
* @var string the option to select initially. Should match one
* of the $options array keys. Default none.
*/
public $selectedvalue;
/**
* @var string The label for the 'nothing is selected' option.
* Defaults to get_string('choosedots').
* Set this to '' if you do not want a 'nothing is selected' option.
*/
public $nothinglabel = null;
/**
* @var string The value returned by the 'nothing is selected' option. Defaults to 0.
*/
public $nothingvalue = 0;
/**
* @var boolean set this to true if you want the control to appear disabled.
*/
public $disabled = false;
/**
* @var integer if non-zero, sets the tabindex attribute on the <select> element. Default 0.
*/
public $tabindex = 0;
/**
* @var mixed Defaults to false, which means display the select as a dropdown menu.
* If true, display this select as a list box whose size is chosen automatically.
* If an integer, display as list box of that size.
*/
public $listbox = false;
/**
* @var integer if you are using $listbox === true to get an automatically
* sized list box, the size of the list box will be the number of options,
* or this number, whichever is smaller.
*/
public $maxautosize = 10;
/**
* @var boolean if true, allow multiple selection. Only used if $listbox is true.
*/
public $multiple = false;
/**
* @deprecated
* @var string JavaScript to add as an onchange attribute. Do not use this.
* Use the YUI even library instead.
*/
public $script = '';
}
</syntaxhighlight>

===New support code===

Note that the moodle_core_renderer::select_menu code depends on this code in moodle_renderer_base:
<syntaxhighlight lang="php">
class moodle_renderer_base {
// ...

protected function output_tag($tagname, $attributes, $contents) {
return $this->output_start_tag($tagname, $attributes) . $contents .
$this->output_end_tag($tagname);
}
protected function output_start_tag($tagname, $attributes) {
return '<' . $tagname . $this->output_attributes($attributes) . '>';
}
protected function output_end_tag($tagname) {
return '</' . $tagname . '>';
}
protected function output_empty_tag($tagname, $attributes) {
return '<' . $tagname . $this->output_attributes($attributes) . ' />';
}

protected function output_attribute($name, $value) {
if ($value || is_numeric($value)) { // We want 0 to be output.
return ' ' . $name . '="' . $value . '"';
}
}
protected function output_attributes($attributes) {
$output = '';
foreach ($attributes as $name => $value) {
$output .= $this->output_attribute($name, $value);
}
return $output;
}
protected function output_class_attribute($classes) {
return $this->output_attribute('class', implode(' ', $classes));
}
}
</syntaxhighlight>

==See also==

* [[Navigation 2.0 implementation plan]]

Quality assurance

2024-05-01T02:10:22Z

Andrewnicols: This page contains very out-dated content.

{{Template:obsolete}}
{{Template:Work in progress}}[[Category:Quality Assurance]]

==What is Quality assurance (QA)?==

QA is generally one of the last stages of the software development. However QA can start even before the developers write any code. From the functional specification and use case, a QA test plans writer writes test cases, usually one test case per use case. Once the test cases are written, QA testers will test the software following these test cases. When they find a bug, they will report the issue in the tracker. Once all test cases have been completed, the QA manager can review the results to determine how ready the software is for release. A test case management system may be used for managing test cases and reviewing results.

==QA objective==

The goals of QA testing are to:

# Bring more clarity and thoroughness to the process of testing a new Moodle release.
# Ensure that all significant functionality has been tested before a new version is released.
# Give people a new way to easily contribute to the Moodle project.

A major version is ready for release when there are:
* < 1% open blocker issues
* < 5% open critical issues
* < 20% open major issues

Also, all test cases should have been written/updated for new features and all test cases marked as 'Passed'.

A successful QA cycle assures all major Moodle functionality has been tested.

==The QA cycle==

=== Setting a QA cycle ===

Test cases should be created in the tracker then updated for each new QA cycle. Ideally, poeple writing/updating the functional specs would write/update test cases at the same time. Alternatively a 'Cannot be run test' case status could be used when a tester cannot run a test case because the feature changed. This would alert the QA manager that the test case needs to be updated.

=== Running a QA cycle ===

Testers will choose a feature to test (with status 'Not run' or 'To retest').

* If the tester finds a blocker/critical/major issue, the test case is set to 'Failed'. The tester then writes a bug issue and links the test case to the bug issue. Once the bug is fixed, the bug fixer changes the test case status from 'Failed' to 'To retest'.
* If the bug is minor and the feature is working, the tester still writes a bug issue and still links the test case to the bug issue. However, the test case status may be set to 'Passed'.

== Validating a QA cycle ==

The test case management system needs to display:
* The number of failed, passed, not run, to retest test case issues for a particular version or component
* The number of critical/major issues for a specific version or component

The QA manager can review these results to determine how ready the software is for release.

==For further consideration==

Need to be identify the time cost of writing test cases, preparing a QA cycle (updating test cases, getting a new QA system ready for testing) and running all test cases.

Additional questions:
*When should a QA cycle be run?
*What functional specs/use cases do we have?
*Who can write test cases?
*Who can run test cases?
*Do we need test data?

Jerome's ideas/notes:
* it would be good to identify the different kind of Moodledocs: User Manuals, Function Specifications, Technical Specifications, Requirements, ... due to the wiki collaborative aspect, it is understandable that sometimes documents are a mix of User Manual, Functional and Technical specs. Maybe could we create these specific category: User Manuals, Function Specifications, Technical Specifications, Requirements
* There is a lack of detailed functional specifications and Use Cases => at this moment only developers and highly experimented users would be able to write test cases with missing use cases.
* Moodle doesn't have deadline. It is released when it will be ready. However we have to take care about no-end QA phase.
* there are many experimented users who can test Moodle.
* some people/companies using Moodle probably have already written test plans, test cases, maybe even use cases.
* need documentation on how to write a test case and how to run test cases. Need also document for QA manager (setting a QA cycle, read the result, managing the QA cycle)
* write an easy-to-read Quality Engineering section in Moodledocs (include Code Testing as well).
* we could create a testing program as Netbeans [http://qa.netbeans.org/processes/cat/65/index.html]
* create a Moodle package including test data for people testing in local
* We don't have a long build process, so smoke testing could seem not required. However it could be good to have it if we create a testing program.

==Jira as Test Case Management System==
The main reason to use Jira as Test Case Management System is that the Moodle community is familiar with. It will also be easy to link test case issues to bug issues.
* The search tool of Jira will provide the QA results.
* we will create a main issue containing thousand of sub-tasks. These subtasks will be the test cases. Then for every new QA cycle we will clone this main issue. Need to identify how to change subtask version quickly/easily.
* re-write the ''Jira as a Test Case Management Software documentation'' [https://docs.moodle.org/en/Jira_as_a_Test_Case_Management_Software]

==Other QA from popular open-source projects==
* Netbeans wrote specification tests [http://wiki.netbeans.org/TestSpecifications]. They have a QA program [http://qa.netbeans.org/processes/cat/65/index.html]
* Firefox use an integrated testcase management and QA tool called Litmus [https://litmus.mozilla.org/]. An example of a test case: [https://litmus.mozilla.org/show_test.cgi?id=5036]. They've got more than 7000 test cases.
* OpenOffice has a QA page [http://qa.openoffice.org/ooQAReloaded/ooQA-ManualTesting.html]. I found it a bit a hassle to navigate into these pages. Make some succinct documentation for Moodle QA tester in order to start quickly and easily.

[[Category:Quality Assurance]]

SimpleTest conversion

2024-04-30T16:28:18Z

Andrewnicols:

{{Template:obsolete}}
{{Moodle 2.3}}

=Overview=
Moodle 2.3 switched to PHPUnit as the recommended unit testing framework. SimpleTest support will be completely removed from Moodle 2.4.

The migration is pretty straightforward:
# create new test file in `xxx/tests/yyy_test.php`
# copy contents of the old test file
# replace <syntaxhighlight lang="php">extends UnitTestCase</syntaxhighlight> with <syntaxhighlight lang="php">extends basic_testcase</syntaxhighlight> and <syntaxhighlight lang="php">extends UnitTestCaseUsingDatabase</syntaxhighlight> with <syntaxhighlight lang="php">extends advanced_testcase</syntaxhighlight>
# move constructor code to setUp()
# fix setUp() and tearDown() to be protected
# fix assert syntax
# add <syntaxhighlight lang="php">$this->resetAfterTest();</syntaxhighlight> in advanced test cases that modify database
# add missing <syntaxhighlight lang="php">global $CFG;</syntaxhighlight> for includes outside of testcase classes
# Usages of <syntaxhighlight lang="php">$UNITTEST->running</syntaxhighlight> must be replaced with <syntaxhighlight lang="php">PHPUNIT_TEST</syntaxhighlight>

Usually the tests using database can be significantly simplified, the performance in PHPUnit is also a lot better.

The old SimpleTest execution page is hidden in 2.3, if you want to execute the old tests go to http://www.example.com/admin/tool/unittest/index.php page on your server.

=Assert differences=

{| class="wikitable"
|-
! SimpleTest
! PHPUnit
! Notes
|-
| <syntaxhighlight lang="php">$this->assertEqual($expected, $actual)</syntaxhighlight>
| <syntaxhighlight lang="php">$this->assertEquals($expected, $actual)</syntaxhighlight>
|
|-
| <syntaxhighlight lang="php">$this->assertNotEqual($expected, $actual)</syntaxhighlight>
| <syntaxhighlight lang="php">$this->assertNotEquals($expected, $actual)</syntaxhighlight>
|
|-
| <syntaxhighlight lang="php">$this->assertWithinMargin($expected, $actual, $margin)</syntaxhighlight>
| <syntaxhighlight lang="php">$this->assertEquals($expected, $actual, '', $margin)</syntaxhighlight>
|
|-
| <syntaxhighlight lang="php">$this->assertIdentical($expected, $actual)</syntaxhighlight>
| <syntaxhighlight lang="php">$this->assertSame($expected, $actual)</syntaxhighlight>
|
|-
| <syntaxhighlight lang="php">$this->assertNotIdentical($expected, $actual)</syntaxhighlight>
| <syntaxhighlight lang="php">$this->assertNotSame($expected, $actual)</syntaxhighlight>
|
|-
| <syntaxhighlight lang="php">$this->assertTrue($actual)</syntaxhighlight>
| <syntaxhighlight lang="php">$this->assertTrue((bool)$actual)</syntaxhighlight> <syntaxhighlight lang="php">$this->assertNotEmpty($actual)</syntaxhighlight>
| SimpleTest converts parameter to bool
|-
| <syntaxhighlight lang="php">$this->assertFalse($actual)</syntaxhighlight>
| <syntaxhighlight lang="php">$this->assertFalse((bool)$actual)</syntaxhighlight> <syntaxhighlight lang="php">$this->assertEmpty($actual)</syntaxhighlight>
| SimpleTest converts parameter to bool
|-
| <syntaxhighlight lang="php">$this->assertIsA($actual, 'classname')</syntaxhighlight>
| <syntaxhighlight lang="php">$this->assertInstanceOf('classname', $actual)</syntaxhighlight>
| objects instances only
|-
| <syntaxhighlight lang="php">$this->assertIsA($actual, 'array')</syntaxhighlight>
| <syntaxhighlight lang="php">$this->assertEquals('array', gettype($actual))</syntaxhighlight>
| arrays only
|-
| <syntaxhighlight lang="php">$this->assertPattern($pattern, $string)</syntaxhighlight>
| <syntaxhighlight lang="php">$this->assertRegExp($pattern, $string)</syntaxhighlight>
|
|-
| <syntaxhighlight lang="php">$this->assertNoPattern($pattern, $string)</syntaxhighlight>
| <syntaxhighlight lang="php">$this->assertNotRegExp($pattern, $string)</syntaxhighlight>
|
|-
| <syntaxhighlight lang="php">$this->expectException(true)</syntaxhighlight>
| <syntaxhighlight lang="php">$this->setExpectedException('exception_classname')</syntaxhighlight>
| alternatively use phpdocs: @expectedException exception_classname
|-
| <syntaxhighlight lang="php">$this->expectError()</syntaxhighlight>
| <syntaxhighlight lang="php">$this->setExpectedException('PHPUnit_Framework_Error')</syntaxhighlight>
| alternatively use phpdocs: @expectedException PHPUnit_Framework_Error
|-
| various HTML expectations
| <syntaxhighlight lang="php">$this->assertTag()</syntaxhighlight>
|
|}

=SimpleTest emulation=
Some original SimpleTests can be executed directly via PHPUnit with minimal modifications (try adding global $CFG for includes outside of test case class).

[[Category:Unit testing]]

Sprint

2024-04-30T16:27:51Z

Andrewnicols: Note about intent to not migrate this page to moodledev.io

{{Template:obsolete}}
A Moodle sprint is a designated time e.g. a weekend in which developers (and in future also testers and documentation writers) keep each other company whilst working on Moodle.

==Sprint participation==

To take part in the sprint as a developer, simply choose a feature in Moodle 2.0 which needs finishing, or some 2.0 bugs which need fixing, then when you have time during the sprint period, get coding! Remember to drop by our Jabber developer chat room and/or #moodle on freenode at some point and let others know what you’re working on.

Note that the sprint is not organised in the sense that nobody will be told what to do! Developers with CVS access may continue what they are currently working on, and developers without access can post patches and comments in the tracker.

Useful filters: [http://tracker.moodle.org/secure/IssueNavigator.jspa?mode=hide&requestId=10825 Easy bugs 2.0], [http://tracker.moodle.org/secure/IssueNavigator.jspa?mode=hide&requestId=10727 Unresolved 2.0.x (all)]

Details on how to take part in a sprint as a tester or a documentation writer will follow soon.

==Upcoming sprints==

The first ever Moodle 2.0 sprint will be held on Saturday and Sunday 20-21 March 2010 - see [http://moodle.org/mod/forum/discuss.php?d=146083 Moodle 2.0 sprint this weekend].

Further sprints will be announced soon. Testers and documentation writers will be warmly welcomed to sprints after the release of Moodle 2.0 beta.

Rationale

2024-04-30T16:27:14Z

Andrewnicols: Note about intent to not migrate this page to moodledev.io

{{Template:obsolete}}
The idea standing after the development of this module is to provide answers to the more frequent requirements of end users.

Their frequent requirements are:
==at element level==
* possibility to add custom question type matching specific needs
* question predefined value
* question level validation
* reduce, as much as possible, the range of possible answers
* mandatory questions
* have some typographic option to display elements in different ways
* tools to quickly reuse set a specific questions that never change in each survey
==at survey level==
* conditional branching
* force the user to provide a his/her own answer
* subset of questions available to teachers ONLY
* include permission management for groups of users submitting surveys in behalf of the same institution
* use captcha
* allow/deny submitted survey modification (including deletion)
* allow a backup copy of submitted surveys each time they are modified in order to preserve their history
* speed up form fill as much as it is possible

==at report level==
* possibility to add custom reports
* export of submitted surveys

Prototypes

2024-04-30T16:26:24Z

Andrewnicols: Note about intent to not migrate this page to moodledev.io

{{Template:obsolete}}
This page provides links to prototype sites demonstrating new features that will be included in coming versions of Moodle.

''We would love to hear what you think of these new features! After exploring the sites, please post your feedback in the [https://moodle.org/mod/forum/view.php?id=8052 Future major features forum].''

== New projects and prototype site demonstrations ==
=== Calendar usability improvements ===
{| class="wikitable" border="1"
|-
| Description
| As part of the UX improvements for Moodle 4.0, we are working on updates to the calendar.

The main aims for this project are to make the calendar, calendar block and subscription management more intuitive, easier to use and improve accessibility.
|-
| Project Tracker
| [https://tracker.moodle.org/browse/MDL-71770 Tracker epic containing all related issues]
|-
| Prototype
| [https://calendartest.prototype.moodledemo.net/ Calendar usability improvements demo]
|-
| Target Version
| 4.0
|}
=== Course creation improvements ===
{| class="wikitable" border="1"
|-
| Description
| As part of the UX improvements for Moodle 4.0, we are working on making the like easier on creating and editing courses.

The main aims for this project are to improve the user experience of creating and editing courses in Moodle helping teachers to create and organize their courses. Adding new cool features like course index will allow teachers an easy way to view course structure, add new sections and activities, reorganize them and so on.
|-
| Project Tracker
| [https://tracker.moodle.org/browse/MDL-70907 Tracker epic containing all related issues]
|-
| Prototype
| [https://createcourse.prototype.moodledemo.net/ Course creation improvements demo]
|-
| Target Version
| 4.0
|}
=== Navigation update ===
{| class="wikitable" border="1"
|-
| Description
| We are updating the navigation around Moodle.

The main aim is to reduce the cognitive load associated with navigating around a Moodle site. For anyone that is new to using our LMS, there are a lot of settings that are immediately present and possibly not relevant. We are going through and improving the layout of the navigation from the front page all the way to how different activities are displaying settings and buttons.
|-
| Project Tracker
| [https://tracker.moodle.org/browse/MDL-69588 Tracker epic containing all related issues]
|-
| Prototype
| [https://navigation.prototype.moodledemo.net/ Navigation prototype demo]
|-
| Target Version
| 4.0
|}
=== Timeline block improvements ===
{| class="wikitable" border="1"
|-
| Description
| As part of the UX improvements for Moodle 4.0, we are working on improving the timeline block.

The main aims for this project are to improve the layout of information within the timeline block to make it easier to extract important information, replace pagination with "show more" (lazy-loading) functionality, and to provide bug fixes that improve the overall usability of the block.
|-
| Project Tracker
| [https://tracker.moodle.org/browse/MDL-72274 Tracker epic containing all related issues]
|-
| Prototype
|[https://calendartest.prototype.moodledemo.net/ Timeline improvements demo](Note: The timeline features are demonstrated on the same Moodle site as the calendar improvements mentioned above).
|-
| Target Version
| 4.0
|}
=== Site admin presets ===
{| class="wikitable" border="1"
|-
| Description
| As part of the UX improvements for Moodle 4.0, we are working on helping administrators to enable/disable features and plugins easily to simplify their Moodle sites.

The main aim is to adapt and integrate the [https://moodle.org/plugins/block_admin_presets third-party plugin "Admin presets"], created by David Monllaó and maintained by developers from [https://pimenko.com/ Pimenko].
|-
| Project Tracker
| [https://tracker.moodle.org/browse/MDL-72111 Tracker epic containing all related issues]
|-
| Prototype
| [https://siteadminpresets.prototype.moodledemo.net/ Site admin presets demo]
|-
| Target Version
| 4.0
|}
 
== How to contribute ==
=== [[File:logo moodle.png|frameless|100px]] Moodle User Experience (UX) Forums ===
{| class="wikitable" border="1"
|-
| Description
| As part of the UX 4.0 release, the UX team are establishing a presence on the Moodle.org platform in order to collaborate and communicate with the wider Moodle Community.
We're looking forward to working with you and sharing what we learn and what we do!
|-
| More
| User Experience Forum [https://moodle.org/course/view.php?id=17248 Want to shape the Moodle future with us?].
|-
| Project Tracker
| Moodle UX 4.0 [https://tracker.moodle.org/projects/UX/issues/ tracker issues and epics]
|-
| Prototypes
| [https://www.figma.com/proto/A4d9WOUVxCqS93mvXVCr8P/4.0-UX-Demo?node-id=2394%3A15559&viewport=727%2C769%2C0.07944665849208832&scaling=scale-down 4.0 Desktop Navigation UX Project]
[https://www.figma.com/proto/A4d9WOUVxCqS93mvXVCr8P/4.0-UX-Demo?node-id=2392%3A11210&viewport=1413%2C310%2C0.31215807795524597&scaling=scale-down 4.0 Mobile Navigation UX Project]
|-
| Target Version
| 4.0
|}
=== [[File:logo_moodle_tracker.jpg|frameless|100px]] Moodle Tracker ===
{| class="wikitable" border="1"
|-
| Description
| This is where we record and manage all issues related to Moodle and related systems.
It's not just for developers! :-) All users should use this system to report problems or new ideas for Moodle and help us make it better.
|-
| More
| Moodle Tracker [https://tracker.moodle.org/secure/Dashboard.jspa Want to shape the Moodle future with us?].
|}
=== [[File:mua-logo-small-onblue.png|frameless|100px]] Moodle Users Association ===
{| class="wikitable" border="1"
|-
| Description
| MUA's mission is to support the growth of Moodle by providing a strong and united voice to users, giving direction and resources for new developments.
|-
| More
| Join MUA [https://moodle.org/course/view.php?id=17248 Shape the future of Moodle today.].
|}
 
 
== [[File:logo_moodle_dev.jpg|frameless|100px]] Other Moodle demo sites ==
=== QA Moodle Demo ===
{| class="wikitable" border="1"
|-
| Description
| It is updated daily at 13:00 UTC with the latest fixes for testers to test and do a final check for any problems.
Every hour (on the hour) the database and files are reset.
|-
| Moodle Version
| The latest Moodle dev release!
|-
|-
| Site
| '''[https://qa.moodledemo.net/ qa.moodledemo.net/]'''
|}
=== School Moodle Demo ===
{| class="wikitable" border="1"
|-
| Description
| This demonstration site gives you the opportunity to explore Moodle in action as a manager, teacher, student, parent or privacy officer with realistic content.
This site is reset every hour on the hour so anything you "break" will get fixed.
|-
| Moodle Version
| The latest Moodle stable release!
|-
|-
| Site
| '''[https://school.moodledemo.net/ school.moodledemo.net/]'''
|}
=== Sandbox Moodle Demo ===
{| class="wikitable" border="1"
|-
| Description
| This site is a plain installation of Moodle using the Boost theme.
This site is reset to its blank state every hour, on the hour.
|-
| Moodle Version
| The latest Moodle stable release!
|-
|-
| Site
| '''[https://sandbox.moodledemo.net/ sandbox.moodledemo.net/]'''
|}
 
==See also==
* [[Roadmap]] - for an overview of new features planned for the next release
* [[Releases]] - for all official releases of Moodle, grouped by branch in reverse chronological order

PublicPrivate

2024-04-30T16:25:33Z

Andrewnicols: Note about intent to not migrate this page to moodledev.io

{{Template:WillNotMigrate}}
== Executive Summary ==

This page will spec out the features of Public/Private.

Public/Private is a means whereby any resource/activity within moodle can be made private to only members of that course, or public and available to anyone that visits that site (including guests).

A practical use for this feature is making the syllabus public so that potential students can shop around for classes, but the rest of the course material is private and only available to the members of that course.

== Database structures ==
Below are the fields that are added to the already existing table.

=== course ===

{| border="1" cellpadding="2" cellspacing="0"
|'''Field'''
|'''Type'''
|'''Default'''
|'''Info'''

|-
|'''groupautoassign'''
|BIGINT(10)
|0
|Group id to auto-assign members of the course.

|-
|'''grouppublicprivate'''
|TINYINT(1)
|0
|Whether public/private is enabled for that course.
|}

=== groups_members ===

{| border="1" cellpadding="2" cellspacing="0"
|'''Field'''
|'''Type'''
|'''Default'''
|'''Info'''

|-
|'''type'''
|VARCHAR(36)
|NULL
|This field indicates whether the user was auto-assigned to a group, or not. (as opposed to manually added)
|}

== Overview of module communication ==

=== Setup ===
Setup is very simple. Once moodle is installed, All that needs to take place before using Public/Private is going into Administration->Miscellaneous->Experimental, and check both "Enable groupings", and "Enable Public/Private"

Now, create a course like normal, and add either a resource or activity to that course. The default behavior should be that when a resource or activity is added, it will read "(Private Course Material)" next to it, and have an extra icon: a lock. If that lock icon is pressed, the "(Private Course Material)" text will disapear, and an open-lock icon will replace the closed-lock icon. This indicates that the course is now unlocked, and available to everyone.

'''Ubuntu Server Install'''
'''19 April, 2010'''

Installation on an Ubuntu Server running Moodle 1.9.7+

These steps can be followed on an Ubuntu server to install this Mod:

1. Make sure that you have "patch" installed using '''sudo apt-get install patch''' or the Synaptic Packet Manager if you are in a GUI environment.

2. Download the compressed Public/Private file.

3. Uncompress the archive to your home directory.

4. Copy the file '''public_private.patch''' to the root directory of your moodle installation.

5. Execute the command '''sudo patch -p0 < public_private.patch''' from the command line, WHILE IN THE ROOT DIRECTORY OF MOODLE.

6. You must now manually copy several icons to whatever Moodle theme you are using. The pictures are located in your uncompressed archive, which you put in your home directory in Step 2. Move the files in the '''pix/t''' and '''pix/i''' folders to the corresponding folders of your currently used theme. The theme is located in the '''theme''' folder of the root directory of Moodle.

7. You should now be ready to go to Moodle, and click on NOTIFICATIONS. Agree to install Public Private.

8. Save all the default configuration settings.

9. Enable GROUPINGS in the Site Administrations->Miscellaneous->Experimental.

10. Any new courses will now have Public/Private enabled.

'''NOTES:''' Step 5 produced a large number of error output for me, but still worked. The package I downloaded was for Moodle 1.9.5, and I am using 1.9.7+, so that may explain the discrepancies.

'''More Notes:''' You should '''NOT''' need to unpack the archive into your root web folder, nor will you need the other files in the archive. All you need are the three icon pictures, and the file public_private.patch from the compressed archive.

=== How it Works - Behind the Scenes ===

==== When a course is created: ====
#course members group is created
#private course material grouping is created
#course members group gets assigned to private course material
#all enrollees of that course are assigned to the course members group

==== When a resource/activity is added: ====
#groupmembersonly field is set to 1
#groupingid field is set to the grouping id that corresponds to the Private Course Material grouping for that particular course

==== When the closed lock icon is clicked: ====
#course material togles from being private->public
#groupmembersonly field is set to 0
#groupingid field is set to 0

==== When the closed lock icon is clicked: ====
#groupmembersonly field is set to 1
#groupingid field is set to the grouping id that corresponds to the Private Course Material grouping for that particular course

=== Code: Make Private ===
The below code demonstrates how to make a forum private. The same technique can be applied for any course module.

$grouping_id = groups_get_grouping_publicprivate($COURSE->id);
$course_module = get_record("course_modules", "instance", $forum->id, "course", $COURSE->id);
set_coursemodule_groupingid($course_module->id, $grouping_id);
set_coursemodule_groupmembersonly($course_module->id,1);

=== Code: Make Public ===
The below code demonstrates how to make a forum public. The same technique can be applied for any course module.
$grouping_id = groups_get_grouping_publicprivate($COURSE->id);
$course_module = get_record("course_modules", "instance", $forum->id, "course", $COURSE->id);
set_coursemodule_groupingid($course_module->id, 0);
set_coursemodule_groupmembersonly($course_module->id,0);

Policy on Moodle Partner discussions

2024-04-30T16:24:47Z

Andrewnicols: Note about intent to not migrate this page to moodledev.io

{{Template:WillNotMigrate}}
Note: The policy on Moodle Partner discussions is now part of the '''[https://moodle.org/mod/page/view.php?id=7080 Moodle.org site policy]'''.

==See also==

*[[:Forums code of conduct]]

[[Category:Moodle.org]]

Patch

2024-04-30T16:24:19Z

Andrewnicols:

{{Template:WillNotMigrate}}
A patch, sometimes also called a diff, is a file that shows what changes have been made to a file, or group of files. They are a common way for developers to exchange changes to software. For practical instructions see:

* [[How_to_create_a_patch|How to create a patch]]
* [[How_to_apply_a_patch|How to apply a patch]]

For more information about the patch format, read on. Here is a simple sample patch file:

<pre><nowiki>
Index: lang/en_utf8/quiz.php
===================================================================
RCS file: /cvsroot/moodle/moodle/lang/en_utf8/quiz.php,v
retrieving revision 1.57.2.10
diff -u -r1.57.2.10 quiz.php
--- lang/en_utf8/quiz.php 29 May 2007 17:47:25 -0000 1.57.2.10
+++ lang/en_utf8/quiz.php 25 Jun 2007 12:58:34 -0000
@@ -252,7 +255,6 @@
$string['indivresp'] = 'Responses of Individuals to Each Item';
$string['info'] = 'Info';
$string['introduction'] = 'Introduction';
-$string['invalidcategory'] = 'Category ID is invalid';
$string['invalidnumericanswer'] = 'One of the answers you entered was not a valid number.';
$string['invalidnumerictolerance'] = 'One of the tolerances you entered was not a valid number.';
$string['invalidsource'] = 'The source is not accepted as valid.';
@@ -375,8 +377,10 @@
$string['questiontypesetupoptions'] = 'Setup options for question types:';
$string['quiz:attempt'] = 'Attempt quizzes';
$string['quiz:deleteattempts'] = 'Delete quiz attempts';
+$string['quiz:emailconfirmsubmission'] = 'Receive own quiz submission notification';
+$string['quiz:emailnotifysubmission'] = 'Receive student quiz submission notifications';
$string['quiz:grade'] = 'Grade quizzes manually';
-$string['quiz:ignoretimelimits'] = 'Ignores time limit on quizzes';
+$string['quiz:ignoretimelimits'] = 'Ignores time limit on quizs';
$string['quiz:manage'] = 'Manage quizzes';
$string['quiz:preview'] = 'Preview quizzes';
$string['quiz:view'] = 'View quiz information';
</nowiki></pre>

At the top it says which file is being affected. Changes to several files can be included in one patch. Lines added are shown with a '+', lines removed are shown with a '-', lines changed are shown as the old line being removed and the new one added.

Patch files are good because they only show the changed parts of the file. This has two advantages: it easy to understand the change; and if other parts of the same files change between the patch being made an being used, there is no problem, the patch will still apply.

Note that there are several slight variants of the patch format. The example above is a 'unified' patch, which is now the standard.

==See also==

* [[How_to_create_a_patch|How to create a patch]]
* [[How_to_apply_a_patch|How to apply a patch]]

Moodle IDE

2024-04-30T16:23:02Z

Andrewnicols: Note about intent to not migrate this page to moodledev.io

{{Template:WillNotMigrate}}
== [http://download.moodle.org/download.php/ide/Moodle-IDE-Setup.exe Moodle IDE (1.0.6)]==
'''Student Developer:''' [[User:Grady Laksmono|Grady Laksmono]]

'''Mentor:''' Petr Skoda and Anthony Borrow

Google Summer of Code 2008

https://docs.moodle.org/en/Student_projects/Moodle_IDE

* Community feedback [http://moodle.org/mod/forum/discuss.php?d=102197 forum discussion]
'''Features'''
* Create a Moodle project
* Apache, MySQL, and PHP (XAMPP)
* XDebug
* Moodle CVS
* Splashscreen
* Moodle Browser
* Checkstyle
* Installer

== Workspace Environment ==

1. Install '''''Java SE''''' (http://java.sun.com/javase/downloads/index.jsp) if you don't have it installed

2. Run '''''Moodle-IDE-Setup.exe'''''

3. Run '''''Moodle IDE.exe''''' as Administrator ('''''Right click → Run as Administrator''''')

4. '''''Workspace Launcher''''' dialog box shows up, '''''check mark Use this as the default and do not ask again''''', leave everything else as default, then click '''''OK'''''

'''''!NOTE'''''
''Default Workspace configuration is needed if you don't want to configure Virtual Server''.

4. '''''File → New → Other...''''', then '''''Moodle → Moodle Project''''', then '''''click Next'''''

5. If you have the local zip package (from http://download.moodle.org/) that you wanted to use, then '''''Browse''''' for '''''Moodle zip package''''' for Moodle field. Otherwise, '''''click on the drop down list''''' on the '''''Download Moodle''''' and select '''''the version''''' that you wanted to download, '''''the IDE will download and unpacks the package in the project folder'''''.

6. Name the project (e.g. 19stable, Moodle 1.9, or MoodleWorld)

7. Click '''''Finish'''''

'''''!NOTE'''''

''It will take a while for the IDE to either unpacks the Moodle package or Download the Moodle then unpacks it. In general, if you chose to download the Moodle, then the process should take longer than if you have the local Moodle package because the IDE will download the Moodle package first before unpacking it to the project folder in the workspace.''

== Installing Moodle ==
Press the '''''orange X''''' button in the toolbar to run XAMPP (Apache, PHP, and MySQL).

[[Image:XAMPP_Start.jpg]]

'''''!NOTE'''''

If you have previously installed Apache on your computer, and have it running, then you will see red error messages when you're trying to run XAMPP. The solution is to stop your previously installed Apache through '''''Control Panel → Administration → Sevices, find Apache''''' that is currently running, '''''Right Click''''', select '''''Stop''''', then run XAMPP through Moodle IDE.

1. Right click '''''install.php''''' in the project

2. Select '''''Open Moodle Browser'''''

3. Create a single database for Moodle to store all it's tables in (or choose an existing database).

4. Install Moodle

'''''OR'''''

1. Open a web browser

2. Go to '''''http://localhost/<Project Name>/moodle/install.php'''''

3. Create a single database for Moodle to store all it's tables in (or choose an existing database).

4. Install Moodle

== CVS ==
1. Click the '''''Moodle icon''''' (located on the CVS Respository view panel)'''''→ CVS Dialog Box'''''

[[Image:CVS_Location.jpg]]

2. Drop down arrow for the Host (already pre-populated with Moodle hosts)

3. Drop down arrow for the Repository Path (already pre-populated with Moodle repository path)

4. Username, drop down arrow for annonymous, or use yours if you have one (already pr-populated with anonymous)

'''''!NOTE'''''

''Password for annonymous user is blank''

5. Password

6. Click '''''Finish'''''

== XDebug ==

=== Debugging Script ===

1. '''''Right click''''' in the gutter and selecting '''''Toggle Breakpoint'''''

[[Image:Debug_toggle_breakpoint.png]]

You should see a blue dot appear to signify where the breakpoint is. Now change to the Debug Perspective. '''''Window→ Open Perspective → Debug''''' Now we can configure our XDebug Debug Profile. We will only need to do this once per project.

2. Specify the PHP Interpreter Path, go to '''''Window → Preferences → PHPeclipse → XDebug''''', if you're using the default Moodle IDE's installation, the Interpreter path should be '''''C:\Moodle IDE\xampp\php\php.exe'''''

[[Image:Window_Preference_PHPeclipse_XDebug_Interpreter.jpg]]

3. Click on the '''''OK''''' button.

=== XDebug Debug Profile ===

Now that we have configured XDebug, we need to create a debug configuration. This will tell Eclipse how to start the debugger for your project. To do this, select '''''Open Debug Dialog''''' from the '''''Run drop down menu'''''. You will be presented with a list of items which you can debug. '''''Double click on the entry titled PHP XDebug Script'''''. This will create a new configuration and allow you to specify the necessary options. You can provide a name for your debug configuration, and then '''''you must specify the filename which should be executed for debugging purposes'''''. In this case, the filename that I created for testing purpose is named xdebug.php.

[[Image:Debug_Dropdown_OpenDebugDialog_XDebugRemoteScript.jpg]]

[[Image:Debug_Dropdown_OpenDebugDialog_XDebugScript.jpg]]

Once you have selected a configuration name and have chosen an identification string, '''''click on the Pathmap tab''''. In the pathmap tab, you specify how Eclipse translates local path names to remote path names. To map a path, click on the New button to create a new map. ''''If your web server is located on the same system that Eclipse is running on, both of these paths will be the same.'''' In either case, under '''''Local Path''''' enter the path to the root of your project on the machine that Eclipse is running on. In '''''Remote Path''''', enter the path to the root of your project on the machine the web server is running on.

[[Image:Debug_Dropdown_OpenDebugDialog_XDebugRemoteScript_Pathmap.jpg]]

4. Once you have specified the proper pathmap, '''''press the Debug button''''' to begin the debugger.

Now in your browser you will need to '''''start the XDEBUG_SESSION''''', so type in the following

'''''http://localhost/<Project Name>/moodle/<File Name>.php?XDEBUG_SESSION_START=<Ide Identification String>'''''

The debugger should stop at the breakpoint that we set earlier.

'''''!NOTE'''''

''Starting XDEBUG_SESSION can be done by '''Right clicking the file → Open Moodle Browser → Append the ?XDEBUG_SESSION_START=<Ide Identification String> to the URL'''''

''I created xdebug.php that contains a loop for testing purposes. But in general, the file will be much bigger such that it will take longer for XDebug to complete its debugging process.''

[[Image:XDebug_Initial.jpg]]

=== Open the Debugger Perspective ===

5. Press the '''''Open Perspective''''' button

[[Image:OpenPerspective_Button.jpg]]

6. Select '''''Other...''''', '''''Open Perspective''''' dialog box will pop up

[[Image:OpenPerspective_Other.jpg]]

7. Select '''''Debug'''''

[[Image:OpenPerspective_Other_Debug.jpg]]

8. Click '''''OK''''', debug perspective will be displayed

[[Image:DebuggerView.jpg]]

== Checkstyle ==
1. '''''Right click''''' on any PHP file that you want to check

2. Select '''''PHP Checkstyle'''''

3. Report will be displayed

'''Reference'''

https://docs.moodle.org/en/Development:Coding#Coding_style

== Screenshots ==
=== Moodle IDE 1.0.6 ===
[[Image:Environment.jpg]]

[[Category:GSOC]]

== Source code ==
Extract the following .jars located in the eclipse's plugin directory to obtain the source codes:
* org.moodle_<version>.jar
* net.sourceforge.phpeclipse.externaltools_<version>.jar

Libraries Organization

2024-04-30T16:19:48Z

Andrewnicols: Note about intent to not migrate this page to moodledev.io

{{Template:WillNotMigrate}}
{{Moodle 2.0}}
This document defines standard library structures to keep Moodle readable and organised.

= Structure =

There are several standard locations for library code in Moodle.

==Simple core library==

If the widget feature is a very simple core library with no GUI scripts (like formslib) then do it like this:

====lib/widgetlib.php====

::This contains the main library functions. New ones should always implement these as a class.

====lib/widget====

::Any supporting files for this library can go in this sub-directory. This directory should not contain any GUI scripts and files from here should NOT be directly included in Moodle code.

==Plugins and complex core libraries==

If the feature has some GUI scripts then it should have its own directory (eg like blog, comment, mod/forum, local/widget etc) and then this is always applies:

====widget/classes====
::for classes that will be used by scripts in widget directory. See [[Automatic class loading]] for more information.

====widget/lib.php====
::the main library file for the module containing functions that are either required by core code (eg forum_cron()), or simply being made available to other Moodle code (eg comment/lib.php). Generally there will be no capability checks in these functions.
====\component\external classes (previously widget/externallib.php files)====
::for functions and classes implementing external interface for use by third-party systems like web services, and may also be used by other modules in Moodle. These functions are a very stable API and implement full capability checking.

= Refactoring of old code =

This is some code that was refactored in 2.0 to fit the above guidelines.

==Groups==

===currently in group/lib.php===
* groups_add_member($grouporid, $userorid)
* groups_remove_member($grouporid, $userorid)
* groups_create_group($data, $editform=false, $editoroptions=null)
* groups_create_grouping($data, $editoroptions=null)
* groups_update_group($data, $editform=false)
* groups_update_grouping($data, $editoroptions=null)
* groups_delete_group($grouporid)
* groups_delete_grouping($groupingorid)
* groups_delete_group_members($courseid, $userid=0, $showfeedback=false)
* groups_delete_groupings_groups($courseid, $showfeedback=false)
* groups_delete_groups($courseid, $showfeedback=false)
* groups_delete_groupings($courseid, $showfeedback=false)
* groups_get_possible_roles($context)
* groups_get_potential_members($courseid, $roleid = null, $orderby = 'lastname,firstname')
* groups_parse_name($format, $groupnumber)
* groups_assign_grouping($groupingid, $groupid)
* groups_unassign_grouping($groupingid, $groupid)
* groups_get_members_by_role($groupid, $courseid, $fields='u.*', $sort='u.lastname ASC', $extrawheretest='', $whereparams=array())
* groups_calculate_role_people($rs, $context)

===currently in lib/grouplib.php===
* groups_group_exists($groupid)
* groups_get_group_name($groupid)
* groups_get_grouping_name($groupingid)
* groups_get_group_by_name($courseid, $name)
* groups_get_grouping_by_name($courseid, $name)
* groups_get_group($groupid, $fields='*', $strictness=IGNORE_MISSING)
* groups_get_grouping($groupingid, $fields='*', $strictness=IGNORE_MISSING)
* groups_get_all_groups($courseid, $userid=0, $groupingid=0, $fields='g.*')
* groups_get_user_groups($courseid, $userid=0)
* groups_get_all_groupings($courseid)
* groups_is_member($groupid, $userid=null)
* groups_has_membership($cm, $userid=null)
* groups_get_members($groupid, $fields='u.*', $sort='lastname ASC')
* groups_get_grouping_members($groupingid, $fields='u.*', $sort='lastname ASC')
* groups_get_course_groupmode($course)
* groups_get_activity_groupmode($cm, $course=null)
* groups_print_course_menu($course, $urlroot, $return=false)
* groups_print_activity_menu($cm, $urlroot, $return=false, $hideallparticipants=false)
* groups_get_course_group($course, $update=false)
* groups_get_activity_group($cm, $update=false)
* groups_get_activity_allowed_groups($cm,$userid=0)
* groups_course_module_visible($cm, $userid=null)

=== New group/lib.php ===
* groups_add_member($grouporid, $userorid)
* groups_remove_member($grouporid, $userorid)
* groups_create_group($data, $editform=false, $editoroptions=null)
* groups_create_grouping($data, $editoroptions=null)
* groups_update_group($data, $editform=false)
* groups_update_grouping($data, $editoroptions=null)
* groups_delete_group($grouporid)
* groups_delete_grouping($groupingorid)
* groups_delete_group_members($courseid, $userid=0, $showfeedback=false)
* groups_delete_groupings_groups($courseid, $showfeedback=false)
* groups_delete_groups($courseid, $showfeedback=false)
* groups_delete_groupings($courseid, $showfeedback=false)
* groups_assign_grouping($groupingid, $groupid)
* groups_unassign_grouping($groupingid, $groupid)
* groups_get_members_by_role($groupid, $courseid, $fields='u.*', $sort='u.lastname ASC', $extrawheretest='', $whereparams=array())
* groups_group_exists($groupid)
* groups_get_group_name($groupid)
* groups_get_grouping_name($groupingid)
* groups_get_group_by_name($courseid, $name)
* groups_get_grouping_by_name($courseid, $name)
* groups_get_group($groupid, $fields='*', $strictness=IGNORE_MISSING)
* groups_get_grouping($groupingid, $fields='*', $strictness=IGNORE_MISSING)
* groups_get_all_groups($courseid, $userid=0, $groupingid=0, $fields='g.*')
* groups_get_user_groups($courseid, $userid=0)
* groups_get_all_groupings($courseid)
* groups_is_member($groupid, $userid=null)
* groups_has_membership($cm, $userid=null)
* groups_get_members($groupid, $fields='u.*', $sort='lastname ASC')
* groups_get_grouping_members($groupingid, $fields='u.*', $sort='lastname ASC')
* groups_get_course_groupmode($course)
* groups_get_activity_groupmode($cm, $course=null)
* groups_get_course_group($course, $update=false)
* groups_get_activity_group($cm, $update=false)
* groups_get_activity_allowed_groups($cm,$userid=0)
* groups_print_course_menu($course, $urlroot, $return=false)
* groups_print_activity_menu($cm, $urlroot, $return=false, $hideallparticipants=false)
* groups_course_module_visible($cm, $userid=null)

=== New group/locallib.php ===
groups_get_possible_roles($context) 
groups_get_potential_members($courseid, $roleid = null, $orderby = 'lastname,firstname') 
groups_parse_name($format, $groupnumber) 
groups_calculate_role_people($rs, $context) 

==Users==

===Currently in lib/datalib.php ===
* get_users($get=true, $search='', $confirmed=false, array $exceptions=null, $sort='firstname ASC', $firstinitial='', $lastinitial='', $page='', $recordsperpage='', $fields='*', $extraselect='', array $extraparams=null) New for triage
* get_users_confirmed()New for triage
* get_users_listing($sort='lastaccess', $dir='ASC', $page=0, $recordsperpage=0, $search='', $firstinitial='', $lastinitial='', $extraselect='', array $extraparams=null)New for triage
* search_users($courseid, $groupid, $searchtext, $sort='', array $exceptions=null)New for triage
* user_accesstime_log($courseid=0)New for triage
* user_can_create_courses()New for triage

===Currently in user/profile/lib.php ===
* profile_user_record($userid) New for triage
* profile_load_data(&$user)New for triage

===Currently in lib/moodlelib.php ===
authenticate_user_login($username, $password) 
calculate_user_dst_table($from_year = NULL, $to_year = NULL, $strtimezone = NULL) 
check_user_preferences_loaded($time = null) 
complete_user_login($user, $setcookie=true) 
create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) 
create_user_record($username, $password, $auth='manual') 
delete_user($user) 
get_complete_user_data($field, $value, $mnethostid=null) 
get_user_directories($only_non_empty=true, $legacy=false) 
get_user_fieldnames() 
get_user_preferences($name=NULL, $default=NULL, $otheruserid=NULL) 
get_user_timezone($tz = 99) 
get_user_timezone_offset($tz = 99) 
get_users_from_config($value, $capability) 
guest_user() 
hash_internal_user_password($password) 
is_restored_user($username) 
isguestuser($user=NULL) 
isloggedin() 
make_user_directory($userid, $test=false) 
mark_user_preferences_changed($userid) 
set_user_preference($name, $value, $otheruserid=NULL) 
set_user_preferences($prefarray, $otheruserid=NULL) 
truncate_userinfo($info) 
unset_user_preference($name, $otheruserid=NULL) 
update_internal_user_password(&$user, $password) 
update_user_login_times() 
update_user_record($username, $authplugin) 
user_not_fully_set_up($user) 
user_preference_allow_ajax_update($name, $paramtype) 
userdate($date, $format = '', $timezone = 99, $fixday = true) 
usergetdate($time, $timezone=99) 
usergetmidnight($date, $timezone=99) 
usertime($date, $timezone=99) 
usertimezone($timezone=99) 
validate_internal_user_password(&$user, $password) 

=== Move to lib/deprecatedlib.php ===
* create_user_record($username, $password, $auth='manual')
* update_user_record($username, $authplugin)
* get_complete_user_data($field, $value, $mnethostid=null)

=== New user/lib.php ===
* user_create_user($user)
* user_delete_user($user)
* user_update_user($user)
* user_get_user($user)

* get_user_preferences($name=NULL, $default=NULL, $otheruserid=NULL)
* set_user_preference($name, $value, $otheruserid=NULL)
* set_user_preferences($prefarray, $otheruserid=NULL)
* unset_user_preference($name, $otheruserid=NULL)
* guest_user()
* isguestuser($user=NULL)
* isloggedin()
* is_restored_user($username)
* complete_user_login($user, $setcookie=true)

=== New user/locallib.php ===
authenticate_user_login($username, $password) 
check_user_preferences_loaded($time = null) 
create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) 
get_user_directories($only_non_empty=true, $legacy=false) 
get_user_fieldnames() 
get_users_from_config($value, $capability) 
hash_internal_user_password($password) 
make_user_directory($userid, $test=false) 
mark_user_preferences_changed($userid) 
truncate_userinfo($info) 
update_internal_user_password(&$user, $password) 
update_user_login_times() 
user_not_fully_set_up($user) 
user_preference_allow_ajax_update($name, $paramtype) 
validate_internal_user_password(&$user, $password) 

=== New lib/timelib.php ===

userdate($date, $format = '', $timezone = 99, $fixday = true) 
usergetdate($time, $timezone=99) 
usergetmidnight($date, $timezone=99) 
usertime($date, $timezone=99) 
usertimezone($timezone=99) 
calculate_user_dst_table($from_year = NULL, $to_year = NULL, $strtimezone = NULL) 
get_user_timezone($tz = 99) 
get_user_timezone_offset($tz = 99)

Automatic class loading

2024-04-30T16:19:22Z

Andrewnicols: Note about intent to not migrate this page to moodledev.io

{{Template:WillNotMigrate}}
{{Moodle 2.6}}

This document describes how to use the functionality of the automatic classloader provided by Moodle.

==Class naming==

To be discoverable by the Moodle automatic classloader, classes must adhere to some class naming and location rules:

* Sit under the '''classes''' directory of every component:
** '''/lib/classes/''' for core component (core).
** '''SUBSYSTEMDIR/classes/''' for subsystem (core_subsystem).
** '''PLUGINDIR/classes/''' for plugins (plugintype_plugin).
:::Note: The list of valid subsystems and plugin types with their corresponding directories [https://github.com/moodle/moodle/blob/master/lib/components.json can be found in code].
* One class file for each class.
* Autoloading is always [[Frankenstyle|Frankenstyle-based]] and it will be important part of the discovery.
* It provides autoloading of both:
** '''Frankenstyle namespaced classes''', where the component name is the namespace ('''\core_user\example''' or '''\mod_forum\example'''). This is the [[Coding style#Namespaces|actual way]] to add new classes to Moodle.
** '''Frankenstyle prefixed classes''', where the component name is the prefix of the class ('''core_user_example''' or '''mod_forum_example'''). This is now considered deprecated and only should be used for existing code or APIs not supporting autoloading.
:::Note: Since June 2020 the later is deprecated, see MDLSITE-6087 for more information.

== Frankenstyle namespaced classes ==

PHP namespaces are designed to improve code organisation in your projects. Directory structure in classes/ is matching the namespace structure. Main details about their implementation:

* Actual, preferred.
* [[Frankenstyle]] Namespaces:
** Core classes must use the '''namespace core'''.
** Subsystem classes must use the '''namespace core_subsystem'''.
** Plugin classes must use the '''namespace plugintype_pluginname'''
** File names will be the class names (plus the php extension).
*** e.g. Class '''\mod_forum\some_class''' is stored in file '''mod/forum/classes/some_class.php'''
*** e.g. Class '''\core\frankenstyle''' is stored in file '''lib/classes/frankenstyle.php'''
** For more details about valid first and second level namespaces see [[Coding_style#Rules_for_level1]].

=== Code examples (namespaced) ===

<syntaxhighlight lang="php">
<?php

namespace core\event;

// file lib/classes/event/base.php

class base {
}
</syntaxhighlight>

<syntaxhighlight lang="php">
<?php

namespace mod_forum\event;

// file mod/forum/classes/event/post_read.php

class post_read extends \core\event\base {

}
</syntaxhighlight>

<syntaxhighlight lang="php">
<?php

// in any file

\mod_forum\event\post_read::create($post->id, ...)->trigger();

</syntaxhighlight>

== Frankenstyle prefixed classes (deprecated)==

Main details about their implementation:

* Deprecated, only for BC and not autoloaded stuff.
* [[Frankenstyle]] Prefixes:
** Core classes must start with the prefix '''core_'''.
** Subsystem classes must start with the prefix '''core_subsystem'''.
** Plugin classes must start with the prefix '''plugintype_pluginname'''
** File names will be the class names '''without the prefix''' (plus the php extension).
*** e.g. Class '''mod_forum_some_class''' is stored in file '''mod/forum/classes/some_class.php'''
*** e.g. Class '''core_frankenstyle''' class is stored in '''lib/classes/frankenstyle.php'''

=== Code Examples (prefixed)===

Example of autoloaded class in forum module:

<syntaxhighlight lang="php">
<?php
// file mod/forum/classes/some_class.php

class mod_forum_some_class {

}
</syntaxhighlight>

<syntaxhighlight lang="php">
<?php
// file mod/forum/lib.php

// no require_once() necessary here

$instance = new mod_forum_some_class();

</syntaxhighlight>

<syntaxhighlight lang="php"><?php

// in any file

if (class_exists('mod_forum_some_class')) {
// do something
}
</syntaxhighlight>

== Backwards compatibility ==

There are no known issues that could cause backwards incompatibility, however it is strongly recommended to use the classes subdirectory only for classes that are included automatically.

== Performance and developer mode ==

Class autoloading improves performance and reduces memory footprint. Location of all classes is automatically stored in class map cache, the cache is updated automatically before upgrade or installation, during cache reset and in developer mode.

There is only one inconvenience - if you add new class or remove it you need to do one of the following:
* visit yourserver/admin/index.php
* purge caches
* or add '''$CFG->debug = (E_ALL | E_STRICT);''' to your config.php

Otherwise the new class would not be found.

== See also ==

* [[Frankenstyle]]
* [[Automatic Class Loading Proposal]]

[[Category:Plugins]]

Development talk:Wiki requirements

2024-04-30T16:18:23Z

Andrewnicols: Note about intent to not migrate this page to moodledev.io

{{Template:WillNotMigrate}}
What about wrapping the already existing bits of Moodle together to create a new wiki (oh, no...not another wiki) My thinking is that we already have the following tools:

* a "standard" markup (Markdown)
* several ways to store attachments/images/binary files in various modules
* filters for multimedia, Latex, Math and the like.

Could these instances be refactored and refined then called from the wiki parser? This would avoid re-inventing the wheel(s) and simplify maintanence of system. I guess I'm suggesting a "plugin" mechanism where each of these tools could be added to Moodle and then assembled to form the wiki rather than create a monolithic and eventually cumbersome script. If all wiki pages are simply text, the wiki script will just dole out portions of each page to the proper tool. I'm imagining these tools could be used everywhere in Moodle, rather than being specific to the wiki...kind of following the unix philosophy of assembling several simpler tools to perform complicated tasks. Looking at Martin D's post outlining the must-have features, he alludes to this approach when discussing Mediawiki. Posts in other discussions have as well.

Regarding feature ideas, I would recommend folks look at Uniwakka. This "academically oriented" wiki engine has some great possibilities including support for MathML (better than latex filter for sophisticated maths?), Latex, chemistry (a personal favorite), and bibliographies; it exports/imports OpenOffice documents directly and exports Latex versions of the pages. Veeerryy nice!

Thoughts?

~Steve
----
These are interesting thougts Steve, in fact it was my fisrt idea twio years ago when I longed to develop tools for the current wiki. But teh coding and features of the current wiki convinced me that we needed a new wiki from scratch. I vbeliebe that the aproach you propose can be implemented once we have the [[Dfwiki module]] up and official.

By the way we are already working on a wiki parser compilant with mediawiki, comming soon .

Ludo - DFWikiteam
----

The features I find myself often missing in the current Moodle Wiki are:

* editable sections/sub-pages
* in history: ability to compare two arbitrary versions

These are things I have grown used to in MediaWiki.

In the markup department I'd like to see:

* at minimum: a basic wiki-like markup as the default
* optionally: ability to define your own markup
* optionally 2: ability to define what if the default markup

I find that most cases people will use the default markup. I don't use the Markdown format although I hear great things about it from people who do use it. I wouldn't want to make the users at our site transfer to Markdown, when I didn't even mention it in the basic training sessions they participated in.

~Jussi

I have used a number of different wiki systems and some of them with students. I've tried [http://www.twiki.org/ TWiki] and found that students with no knowledge of html take to it quite readily (and do understand the wiki way of makinglinks). I use different versions of [http://www.tiddlywiki.com/ Tiddlywiki] but the markup drives me bonkers (eg because links use | you cannot encluse a URL inside a table). I have also helped faculty use the Moodle wiki (Moodle v 1.5.1) for class but what I don't like about it is the html editor approach. A student actually managed to crunch the wiki at one point with mangled html code pasted in from MS Word which was then edited! My favourite and what I consider to be the most flexible markup system is [http://www.centeredwork.com/xilize2/index.html Xilize] which at version 2 is powerful strong. There's a plugin for Jedit which I use to create web pages.

Personally, I hope that the Moodle wiki behaves more like a 'traditional' wiki with CamelCase links and a default markup system that's easy to comprehend and orthogonal (I don't much like the accent on quotes in Markdown).

For me the selling point of Moodle wiki for use in a course is the flexibility of access control -- one can configure it to be individual access or group access, etc etc. If it defaulted to a wiki like markup and were more stable (especially with Postgres back end) I and many faculty would be happy campers.

~Markpea 25 Jan 2006

I think you should either put the same information that you find in this link or the link itself in the wiki part of the documentation. I needed to know about the markup used in Moodle's wiki, and it would be nice if it were laid out right here.

I didn't know if it were more appropriate to link to this previous documentation, or if it would be better to re-create it.

[http://moodle.org/help.php?module=wiki&file=howtowiki.html /moodle.org help, how to wiki]

Thank you,
atw

== New wiki (old)issue list ==
This list is very old, we (dfwikiteam) have commented.
Rigth now (may 07) the nwiki development plans are
being worked out in the [[NWiki roadmap]] page. --[[User:Ludo (Marc Alier)|Ludo (Marc Alier)]] 09:40, 3 June 2007 (CDT)
# '''There is no userid column in the wiki_pages table (author char-string instead). Must be supported in migration too.''' userid has been there since June06
# '''There is no intro and introformat in the wiki table.'''. I can't remember when Eloy Lafuente added these two columns... A long, long time ago...
# '''In the upgrade from wiki to dfwiki, as there aren't userids, my wiki-pages were assigned to "guest". Once more, userid seems to be critical.'''. Solved. We are using userids. In case of mismatching, we assign the page to the current user.
# '''Wikis having different wiki_entries (group or user ones) have no support in new wiki (only one simultaneous line of versions is available?) so we get a lot of duplicate version errors with data-lost of such pedagogical feature! Or am I losing anything? With only groupid and version in the UK of the table, old student wikis can fit in the new one. Once more, userid!''' Solved UNIQUE KEY `wiki_pages_uk` (`pagename`, `version`, `dfwiki`, `groupid`, `userid`, `ownerid`).
# '''Search doesn't work for diacritics. And/or match is performed with case matching (I think).''' Search has some bugs. We hae to improve it. Minor priority.
# '''Search seems to work against titles and contents always (no matter the checkbox was selected or no). Perhaps it's due to that usage of globals? Ah! After a second try I saw that such checkbox is to decide to show the details of the search in the body of the page. Perhaps the title should be changed to be a bit more clear? Something like "show results page" and some sort of nice help...''' I don't think so. I'll review it.
# '''The useful "What links here" block isn't available.''' Now it is.
# '''Wiki backup and restore don't support individual activities!''' Why not? Where is the problem?
# '''Wikis aren't included in the backup/restore at all!''' Backup/Restore are working correctly. We have not noticed any bug.
# '''Blocks system. Would be difficult to migrate to core block system?''' Migrated in May06.
# '''UTF-8 migration always get teacher_main_language() and it should get page author language! If we know the author responsible for the version, we must look for their original encoding instead of using the teacher one! Similar to forum_posts (if I'm not wrong). And we should know the user: userid again! ;-)''' I'm gonna take a look to this.
# '''In the wiki_pages table there is one "dfwiki" field. Should be "wikiid". Such name doesn't sound ok. (although it's possible that migation become painful, so we can change it in the future...).''' I know. Pain! It will be changed with the API integration.
# '''dfwiki is inside a lot of places in code. It should go out (although it's possible that migation become painful, so we can change it in the future...).''' Yes, variables, comments... We have to clean it out.
# '''globals, globals, globals usage should be out. Just request parameters filtered with xxxx_param() functions.''' There is only a big one. We are making it smaller every day.
# '''Attachment storage (as I've seen in the old-new migration script) seems to be a bit special with a lot of "dfwikiXXXX" dirs generated.''' I made a script to rename all these dirs.
# '''The old-new migration script seems to be twice, once under the wikimigrate dir (the used one) and under the mod directory (unused?).''' I gonna bet for duplicated code...

This summer three of us will apply a re-engineering process to adapt NWiki to Moodle standards, solve incoherences and improve architecture.

Docs wiki upgrade testing

2024-04-30T16:15:38Z

Andrewnicols: Note about intent to not migrate this page to moodledev.io

{{Template:WillNotMigrate}}
==Testing checklist==

# Log in and log out
# Edit a page and check that the edit appears in the page history and recent changes
# Create a new page and check that it appears in the recent changes
# Ensure email notification of watched pages is enabled, watch a page, log in as a different user and edit the watched page then check that an email is received
# Delete a page and check that it is shown in the deletion log
# Upload a file and check that it is shown in my contributions and in the upload log
# Edit my preferences and check that changes are saved
# Check a page diff and try rolling back an edit

[[Category:Documentation]]

Bootstrap 2

2024-04-30T16:14:23Z

Andrewnicols: Note about intent to not migrate this page to moodledev.io

{{Template:WillNotMigrate}}
{{Themes}}
== Overview ==

Moodle 3.2 includes a theme based on the latest version of [[Bootstrap]] - Bootstrap 4. This page talks about the previous themes which were based on Bootstrap 2.

Bootstrap 2 (http://getbootstrap.com/2.3.2) is a "sleek, intuitive, and powerful front-end framework for faster and easier web development".

Moodle now has 3 themes (bootstrapbase, clean and more) that build upon the best practices, documentation, tools and resources that Bootstrap 2 provides.

If you're new to Bootstrap we'd suggest starting by reading through the documentation. Not only is it well written and informative, it uses Bootstrap itself and so is a live demonstration too.

http://getbootstrap.com/2.3.2/getting-started.html

A common complaint about Bootstrap is that all Bootstrap-built sites look the same, since people like the defaults so much they just don't bother to change them. It is however not designed to be a final look, just a platform to build on. Some examples of what can be done can be found at http://builtwithbootstrap.com/ and http://expo.getbootstrap.com (Note that some of these examples may use Bootstrap 3. Then the code of these examples won't work on themes that use bootstrap 2.3.2)

== Features ==

=== Responsive design ===

A key feature of Bootstrap is responsive design. This means that the look of the page changes based on the width of your screen and allows you to alter the presentation so that iPhones, iPads, Netbooks & Desktops get subtly (or radically) different views of the same page.

http://getbootstrap.com/2.3.2/scaffolding.html#responsive

=== Less ===

Bootstrap's stylesheets are written in a variant of CSS called LESS. It is possible to use Bootstrap without LESS as they provide the compiled output as CSS too, but for integration with existing Moodle HTML it is (at least currently) necessary for Moodle Bootstrap's core styles to be compiled after any changes. See the [[LESS]] page for more on this.

=== Glyphicons ===

Bootstrap provides an set of icons called Glyphicons. These are not used for the core Moodle icons as there aren't enough suitable icons to cover Moodle's needs. But they are available for use in content by applying simple CSS classes via the HTML editor. (Note in the next version of Bootstrap this "icon sprite" is replaced with an icon font. It is hoped that Moodle can merge it's SVG icons into this font and all icons will be applied in the same manner)

http://getbootstrap.com/2.3.2/base-css.html#icons

=== Grids ===

Bootstrap uses CSS grids where previously web developers would have used floats (or before that tables). A key feature of grids is that they can "collapse" at smaller widths and so items that would be in a row will appear as a single column on smaller devices like iPhones.

http://getbootstrap.com/2.3.2/scaffolding.html#fluidGridSystem

=== Layouts ===

The core Bootstrap theme uses a "Fluid Grid System". (Note that in the next version of Bootstrap, there is only one grid system and it is fluid, though it is no longer called that since it is the only grid system.)

Moodle and PHP 7.0 details

2024-04-30T16:10:55Z

Andrewnicols: Note about intent to not migrate this page to moodledev.io

{{Template:obsolete}}
[[Moodle and PHP]] / 7.0 details

==Changes in engine==

There are multiple small changes that may require action from developers. They include but not limited to:
* invalid class, interface and trait names (null, int, string, bool, true, false, resource, object, mixed, numeric)
* handling of indirect variables, properties, and methods (for example, <syntaxhighlight lang="php">$foo->$bar['baz']</syntaxhighlight> is not going to work the same in php5 and php7)
* <syntaxhighlight lang="php">foreach</syntaxhighlight> no longer changes the internal array pointer

For a complete list see http://php.net/manual/en/migration70.incompatible.php and https://github.com/tpunt/PHP7-Reference#changes

For PHP 7.1 see http://php.net/manual/en/migration71.incompatible.php

https://github.com/sstalle/php7cc is a handy tool for checking your code.

==Exception and Throwable==

In PHP7 engine errors can be caught using <syntaxhighlight lang="php">try {} catch (Throwable $e) {}</syntaxhighlight>. In PHP5 they were either warnings or fatal errors. Throwable is a new interface that Exception implements, which means that these new exceptions are NOT caugh by <syntaxhighlight lang="php">try {} catch (Exception $e) {}</syntaxhighlight> in both PHP5 in PHP7. This is great, allows to treat engine errors nicely and usually backward-compatible.

Why is it a separate topic then? '''Because error handling in Moodle is not standard'''. Moodle developers have already thought that it would be nice to catch engine errors same way as exceptions and implemented a workaround. This change in PHP7 conflicts with Moodle error handling. Here is an example:

<syntaxhighlight lang="php">
function f(stdClass $a) {}
try {
f(0);
} catch (Exception $e) {
echo "Caught exception: ".get_class($e)."\n";
}
echo "hello, world!\n";
</syntaxhighlight>

'''Output'''
* '''PHP5 by itself:''' PHP Catchable fatal error: Argument 1 passed to f() must be an instance of stdClass, integer given, called in - on line 4 and defined in - on line 2
* '''PHP5 + moodle:''' Caught exception: coding_exception. '''hello, world!'''
* '''PHP7 by itself:''' Fatal error: Uncaught TypeError: Argument 1 passed to f() must be an instance of stdClass, integer given, called in on line 4 and defined in
* '''PHP7 + moodle:''' Fatal error: Uncaught TypeError: Argument 1 passed to f() must be an instance of stdClass, integer given, called in on line 4 and defined in.

So this change in moodle means that the code after the try-catch that would be executed in PHP5 is skipped in PHP7. This can be quite critical.

'''Why is it happening?''' We call in lib/setup.php <syntaxhighlight lang="php">set_error_handler('default_error_handler', E_ALL | E_STRICT);</syntaxhighlight> and inside the handler convert the fatal catchable errors into coding_exception. coding_exception is a class extending Exception and it gets caught properly. PHP7 no longer triggers an error, it throws a TypeError which implements Throwable but it does not extend Exception and does not get caught in this example.

The best solution:
<syntaxhighlight lang="php">
function f(stdClass $a) {}
try {
f(0);
} catch (Exception $e) {
echo "Caught exception: ".get_class($e)."\n";
} catch (Throwable $e) {
echo "Caught throwable: ".get_class($e)."\n";
}
echo "hello, world!\n";
</syntaxhighlight>

'''Output:'''
* '''PHP5 + moodle:''' Caught exception: coding_exception. '''hello, world!'''
* '''PHP7 + moodle:''' Caught throwable: TypeError '''hello, world!'''

Note here that <syntaxhighlight lang="php">catch (Throwable $e)</syntaxhighlight> will be ignored in PHP5 because there is no interface/class with the name Throwable. Using non-existing class name in "catch" does not produce any warnings or errors. If we were writing code for PHP7 only we could remove <syntaxhighlight lang="php">catch (Exception $e)</syntaxhighlight> because all exceptions will be caught by Throwable. But we want to make our code work on both PHP5 and PHP7. See also MDL-52284 for related changes that were made in Moodle core.

'''How it can affect plugins?''' Plugins that call <syntaxhighlight lang="php">eval()</syntaxhighlight> inside try/catch may need to change the code similar to how we did in MDL-52333 . Also if your plugin also calls <syntaxhighlight lang="php">set_error_handler()</syntaxhighlight> you may step on the same error.

'''Tip:''' Try to avoid <syntaxhighlight lang="php">catch (Exception $e)</syntaxhighlight> at all, instead catch specific exceptions (dml_exception, moodle_exception, etc.)

==Constructors==

PHP4-style constructors (method with the same name as class) became deprecated in PHP7. Moodle has a lot of code that was written before PHP5 and lots of constructors were not modified later because they continued to work fine. There are also lots of 3rd party libraries that were also using the PHP4-style constructor. Quite a few of issues in MDL-50565 epic are related to the constructor changes.

'''How Moodle addressed it:''' There are now two methods in each class that used to have PHP4-style constructor - one is called __construct() and another is called the same as the class name and inside it calls <syntaxhighlight lang="php">self::__construct(...)</syntaxhighlight>. Starting from Moodle 3.1 the second one gets deprecated and displays debugging message.

Why not just replace the method name with __construct()? The reason is that if some plugin extends this class, it may call <syntaxhighlight lang="php">parent::parentclassname()</syntaxhighlight> in its constructor. This would end in fatal error if we did not leave the php4-style constructor. Good thing is that having method with the same name as the class name does not show any warnings in PHP7 if the __construct() is also present in the same class.

'''What plugin developers should do?''' First of all, make sure that all your classes have proper constructors. Second, make sure that you don't call parent constructors with the old style, for example <syntaxhighlight lang="php">parent::moodleform()</syntaxhighlight> or <syntaxhighlight lang="php">parent::HTML_QuickForm_input()</syntaxhighlight>

'''Good to know:''' This code will work in ANY moodle version:
<syntaxhighlight lang="php">
class myform extends moodleform {
public function __construct() {
parent::__construct(); // In 2.9 where moodleform::__construct did not yet exist this will call moodleform::moodleform() .
}
}
</syntaxhighlight>

Remember, even if you don't care about PHP7 support by your plugin you must change the way you are calling parent constructors. Otherwise you will see debugging messages starting from Moodle 3.1

==Manually installing Memcached==
REMI repository now have fresh PHP 7.1 RPMs for [https://rpms.remirepo.net/enterprise/7/debug-php71/x86_64/repoview/ php-pecl-memcached]

(Was running the following commands on RedHat 7)

php-memcached version 3.0.0b1

libmemcached version 1.0.16

* git clone https://github.com/php-memcached-dev/php-memcached/
* git checkout -b php7 origin/php7
* yum install php70u-devel zlib-devel libmemcached-devel
* phpize & ./configure & make & make install
* Added a new /etc/php.d/20-memcached.ini (with the following line: extension=memcached.so)
* systemctl restart php-fpm
* yum install memcached
* systemctl enable memcached
* systemctl start memcached
* Now, setup Moodle as you usually would...

(Was running the following commands on Ubuntu 16.04)
* git clone https://github.com/php-memcached-dev/php-memcached/
* git checkout -b php7 origin/php7
* (sudo) apt-get install php7.0-dev zlib1g-dev libmemcached-dev
* phpize & ./configure & make & make install
* Added a new "(sudo) vim /etc/php/7.0/mods-available/memcached.ini" (with the following line: extension=memcached.so)
* Link above to php-fpm relevant modules folders: "(sudo) ln -s /etc/php/7.0/mods-available/memcached.ini /etc/php/7.0/fpm/conf.d/20-memcached.ini"
* Link above to php-cli relevant modules folders: "(sudo) ln -s /etc/php/7.0/mods-available/memcached.ini /etc/php/7.0/cli/conf.d/20-memcached.ini"
* (sudo) systemctl restart php7.0-fpm
* (sudo) apt-get install memcached
* (sudo) systemctl enable memcached
* (sudo) systemctl start memcached
* Now, setup Moodle as you usually would...

New docs theme

2024-04-30T16:09:43Z

Andrewnicols: Note about intent to not migrate this page to moodledev.io

{{Template:WillNotMigrate}}
This page describes page edits required following the deployment of the the new docs theme.

* Create MediaWiki:MoodleDocsVersionLinks
* Edit MediaWiki:Actions
* For main pages containing blocks as for [[:en:Main page]], edit and amend divs

OAuth2 Services

2024-04-30T16:05:26Z

Andrewnicols: Note about intent to not migrate this page to moodledev.io

{{Template:WillNotMigrate}}
{{Template:Work in progress}}
= OAuth 2 Services =
{{Moodle 3.3}}

Moodle 3.3 adds support for OAuth 2 services in core which can be used by any plugins to provide authenticated access to external services either as the current user, or using a system account.

OAuth 2 services are used for example, to provide a "Login using Google/Microsoft/Facebook" feature on the login page, and then to share that authenticated session with repositories like Google Drive and Office 365 without having to re-authenticate.

OAuth 2 services can be used by plugins even if they do not use them on the login page, and it's possible to login to multiple services at the same time.

== Login ==

The steps required to enable login using an OAuth 2 service are:

1. Create the OAuth 2 Service using the administration page at "Site administration -> Server -> OAuth 2 Services". There are templates available to create a pre-configured OAuth 2 service for Google, Office 365 and Facebook or you can manually enter all the required details for a custom OAuth 2 service.

2. Register a new application with the OAuth 2 Service provider. Instructions for how to do this with Google, Office 365 and Facebook are listed below.

3. Enter the Client ID and Secret into the configuration page for the OAuth 2 service in Moodle.

4. Enable the OAuth 2 Authentication module.

=== Open ID Connect ===

Open ID Connect is a standard for OAuth 2 login services that makes it easier to setup a working login system. If the service you are setting up is Open ID Connect compliant, you will only have to enter the base url for the service, and Moodle will discover all the other information required by requesting the "discovery document" which is expected to exist at <issuer base url>/.well-known/openid-configuration.

=== How do I get a clientid and secret? ===

The client ID and secret are created outside of Moodle when setting up the OAuth provider. Instructions for prominent OAuth 2 providers are linked here.

* [[OAuth2_Services_Setup_Project_In_Google|Setup Project In Google]]
* [[OAuth2_Services_Setup_Project_In_Microsoft|Setup Project In Microsoft]]
* [[OAuth2_Services_Setup_Project_In_Facebook|Setup Project In Facebook]]
* [[OAuth2_Services_Setup_Project_In_LinkedIn|Setup Project In LinkedIn]]

OAuth2 Services Setup Project In Microsoft

2024-04-30T16:05:04Z

Andrewnicols: Note about intent to not migrate this page to moodledev.io

{{Template:WillNotMigrate}}
=== Setup App In Microsoft ===

To setup an OAuth 2 client with Microsoft, first we need to login to the [[https://apps.dev.microsoft.com/#/appList Microsoft Application Console]] and create a new app.

[[Image:microsoft-1-create-new.png|none|frame|Create new project]]

Note: If you have previously registered Applications with an older API your Application Console may look different. In this case you should create a new "Converged Application".

[[File:microsoft-1-1-alternate-app-page.png|none|frame|Create new project with older APIs enabled]]

Choose a good name as this is what is shown to users when they are asked to approve the permissions.

[[File:microsoft-2-name-it.png|none|frame|Name it]]

Next you have to add a platform to your application.

[[File:microsoft-3-add-platform.png|none|frame|Add platform]]

Choose "Web platform"

[[File:microsoft-3.1-web-platform.png|none|frame|Web platform]]

Uncheck the "Allow Implicit Flow" checkbox and set the callback URL. The callback URL should point to "your Moodle site URL + /admin/oauth2callback.php". If your Moodle site was available at https://lemon.edu/ the callback URL would be https://lemon.edu/admin/oauth2callback.php. It is important that your Moodle site uses https and not http. Microsoft will not allow the callback url if it is not using https.

[[File:microsoft-4-platform-settings.png|none|frame|Platform settings]]

Make sure the "Microsoft Graph Permissions" section contains the "User.Read" permission.

[[File:microsoft-5-permissions.png|none|frame|Permissions]]

Set the options for the consent screen.

[[File:microsoft-6-consent.png|none|frame|Consent]]

Save all the details and then generate a new password.

[[File:microsoft-7-new-password.png|none|frame|Generate a new password]]

Enter the password in Moodle as the "Client secret" and the Application ID as the "Client id".

[[File:microsoft-8-got-it.png|none|frame|Got it]]

[[OAuth2 Services|Back to OAuth 2 Services]]

OAuth2 Services Setup Project In LinkedIn

2024-04-30T16:04:51Z

Andrewnicols: Note about intent to not migrate this page to moodledev.io

{{Template:WillNotMigrate}}
=== Setup App in LinkedIn ===

To setup an OAuth 2 client with LinkedIn, first we need to login to the [[https://developer.linkedin.com/ LinkedIn Developers page]] and create a new app.

[[File:linkedin-1-new-app.png|none|frame|New App]]

Enable the r_basicprofile and r_emailaddress permissions and enter the OAuth 2 authorized redirect URL. This is your site url followed by /admin/oauth2callback.php (e.g. for a Moodle site of https://teach.me/moodle/ the callback url should be https://teach.me/moodle/admin/oauth2callback.php)

[[File:linkedin-2-configure-app.png|none|frame|Configure App]]

Make sure you save your changes and record your client id and client secret.

Now you have configured your LinkedIn App - you can add the required information to Moodle.

LinkedIn does not have a "template" in Moodle so we will need to configure it as a "Custom OAuth 2 Service". From the "Site administration > Server > OAuth 2 services" page click on "Create new custom service".

Use "LinkedIn" as the name (This is displayed on the login page).

Enter your client id and secret for the LinkedIn App that you created earlier.

For the "Scopes included in a login request" and "Scopes included in a login request for offline access" use "r_basicprofile r_emailaddress" which means fetch basic profile information as well as the users email address.

Enter a url to a logo image.

Check the box for "Show on login page".

Save the details and you should be returned to the list of OAuth 2 Services.

We still need to provide information on the mappings between linked in user fields and moodle fields as well as the URL's to access the LinkedIn APIs.

First we will setup the API URL's.

Click on the "Configure Endpoints" icon for the LinkedIn service.

Add 3 endpoints as listed below.

<syntaxhighlight lang="php">
userinfo_endpoint https://api.linkedin.com/v1/people/~:(id,email-address,first-name,last-name,picture-url)?format=json

authorization_endpoint https://www.linkedin.com/oauth/v2/authorization

token_endpoint https://www.linkedin.com/oauth/v2/accessToken
</syntaxhighlight>

Now we need to add the mapping from LinkedIn user fields to Moodle user fields. From the list of OAuth services click on the "Configure user field mappings" icon.

Add the following user field mappings:

<syntaxhighlight lang="php">
firstName firstname
lastName lastname
emailAddress username
emailAddress email
pictureUrl picture
</syntaxhighlight>

The final step is to make sure the OAuth 2 authentication plugin is enabled and you should now be able to login with LinkedIn.

[[OAuth2 Services|Back to OAuth 2 Services]]

OAuth2 Services Setup Project In Google

2024-04-30T16:04:34Z

Andrewnicols: Note about intent to not migrate this page to moodledev.io

{{Template:WillNotMigrate}}
=== Setup Project In Google ===

To setup an OAuth 2 client with Google, first we need to login to the [[https://console.developers.google.com/ Google Developers Console]] and create a new project.

Create a new project using the menu at the top of the page.

[[File:google-1-create-new.png|none|frame|Create new project]]

Call the new project whatever you like, this name is not shown to users when they are asked to authorise this application.

[[File:google-2-create-new-modal.png|none|frame|Name the project]]

Select "credentials" from the menu on the left.

[[File:google-3-credentials.png|none|frame|Switch to credentials page]]

Setup the consent screen for your application. This is where you provide the public information that is shown to users when they are asked to authorise your application. Setting a product name is the minimum information that is required, but the more information you provide here - the more confidence users will have when granting this authorisation.

[[File:google-4-consent.png|none|frame|Setup consent screen]]

Now you can create some client credentials. Switch to the credentials tab and create a new OAuth client ID.

[[File:google-5-oauth-credentials.png|none|frame|Create an OAuth Client ID]]

Setup the credentials for a Web Application. The most important setting here is to set the callback URL. This must be set to "your moodle site url + /admin/oauth2callback.php". If your moodle site was accessible at https://lemon.edu/ then this callback URL should be set to https://lemon.edu/admin/oauth2callback.php

[[File:google-6-web-application-credentials.png|none|frame|Set the callback URL]]

When you have saved the information on this page, Google will give you the client ID and client secret that you need to enter into Moodle.

[[File:google-7-oauth-details.png|none|frame|Got my secrets!]]

Finally we have to enable the Drive API (if we want to use the google drive repository or file converter plugins).

[[File:google-8-library.png|none|frame|View the Library tab]]

[[File:google-9-select-drive.png|none|frame|Select Drive API]]

[[File:google-10-enable-drive.png|none|frame|Enable the API]]

[[OAuth2_Services|Back to OAuth 2 Services]]

OAuth2 Services Setup Project In Facebook

2024-04-30T16:04:12Z

Andrewnicols: Note about intent to not migrate this page to moodledev.io

{{Template:WillNotMigrate}}
=== Setup App in Facebook ===

To setup an OAuth 2 client with Facebook, first we need to login to the [[https://developers.facebook.com/apps Facebook for Developers Apps page]] and create a new app.

[[File:facebook-1-new-app.png|none|frame|New App]]

Enter the name for the new App and choose a category (Education?).

[[File:facebook-2-name.png|none|frame|Name it]]

Go to the app basic settings and set the app icon, and the URLs to your privacy policy and terms of service.

[[File:facebook-3-basic-settings.png|none|frame|Basic settings]]

Add the "Facebook Login" product to the app.

[[File:facebook-4-add-product.png|none|frame|Add a product]]

Configure the OAuth settings. Set the callback URL to "your site url + /admin/oauth2callback.php". If your moodle site is available at https://lemon.edu/ then the callback URL should be set to "https://lemon.edu/admin/oauth2callback.php". Enable the Web OAuth Login but for best security disable all other types of login.

[[File:facebook-5-oauth-settings-v2.png|none|frame|OAuth settings]]

Go to App Review and make your App public.

[[File:facebook-6-public.png|none|frame|Make it public]]

Finally go to the basic settings and get the App ID and App secret and enter them in Moodle as the Client ID and Client Secret.

[[OAuth2 Services|Back to OAuth 2 Services]]

HTML editor 2.0

2024-04-30T16:02:38Z

Andrewnicols: Note about intent to not migrate this page to moodledev.io

{{Template:obsolete}}
{{Moodle_2.0}}This page details the specification of the HTML editor in Moodle 2.0.

[[Image:HTML editor toolbar 2 0 a.png|center|frame|HTML editor for 2.0 (April 2010)]]
== What we want ==
Ticket MDL-11113 discusses most issues.
=== Requirements ===
* Integration - With Moodle (smileys, different formats, etc.) with a minimum of changes, cleaning up current code as much as possible
* Compatibility - With web browsers (mostly FF, IE, Safari, Opera)
* Standard - Outputs valid XHTML code
* Accessibility - Is it 100% keyboard accessible? Is it usable in JAWS? Etc.
* Configurability - Possibility to make it show different options and buttons according to the user, the context, etc.
* Support - Developed by an active community that will support it for a long time.

=== Features ===
Some features that should be evaluated:
* Handling of Word documents
* HTML code direct editing
* Highlighting (not text background color, with "set-on" operation--Word style)
* Image uploading
* Mathematical formulas/equation editing
* Possible to turn it on and off on demand (on the page) without losing (possibly modified) content (see [http://wiki.moxiecode.com/examples/tinymce/installation_example_07.php this TinyMCE example of this])
* Right-to-left text input
* Smileys (has to be possible to use the Moodle list of smileys)
* Special characters
* Tables
* Themeable (possible to make a theme that fits with Moodle's)

=== Wishes ===
* Make it possible to change to a different editor (provided someone comes up with the necessary code to "plug it" in Moodle)
* Possible to run many instances on the same page (see MDL-11101 in tracker)
* Fix [http://tracker.moodle.org/secure/IssueNavigator.jspa?reset=true&pid=10011&resolution=-1&component=10070&sorter/field=summary&sorter/order=ASC&sorter/field=resolution&sorter/order=ASC&sorter/field=status&sorter/order=ASC&sorter/field=priority&sorter/order=DESC all the bugs] related to the HTML editor
* Submit drafts in the background, using ajax.

== Possibilities and evaluation ==
* [http://en.wikipedia.org/wiki/Comparison_of_WYSIWYG_HTML_editors Comparison of WYSIWYG HTML editors on Wikipedia]
* [http://tinymce.moxiecode.com/ TinyMCE]: [http://wiki.moxiecode.com/index.php/TinyMCE:Compatibility Compatibility], [http://wiki.moxiecode.com/index.php/TinyMCE:Index Documentation], [http://tinymce.moxiecode.com/example_full.php?example=true Demo]
* [http://www.fckeditor.net/ FCKeditor]: [http://docs.fckeditor.net/FCKeditor_3.x/Design_and_Architecture/Browsers_Compatibility Compatibility] [http://docs.fckeditor.net/ Documentation], [http://www.fckeditor.net/demo Demo]
* [http://xinha.webfactional.com/ Xinha]: [http://xinha.webfactional.com/wiki/Documentation Documentation], [http://xinha.webfactional.com/wiki/Examples Demo]
* [http://developer.yahoo.com/yui/editor/ Yahoo RTE]: [http://developer.yahoo.com/yui/docs/module_editor.html Documentation], [http://developer.yahoo.com/yui/examples/editor/index.html Demo],
As of 16 April 2008, the preference goes to TinyMCE.

== Plan of action ==

See: MDL-11113 and MDL-14739

* Get latest TinyMCE in HEAD before 13 May 2008 so that work can be done there (done, MDL-14739)
* Have the XHTML profile active by default in TinyMCE (done)
* Attack each Moodle plugin in turn, keeping modifications to TinyMCE code base as modular and minimal as possible

=== Plugins to write ===
Some plugins will have to be written for each editor to make integration with Moodle possible. These should be as abstracted as possible, to make as much code as possible common between each. Since editors will be located under /lib/editor, let's store this common code under /lib/editormod.

* File browser: the file browser (especially with the [[File API]]) will be Moodle specific
* Emoticons (smileys): Moodle defines its own list of emoticons, we need to make sure the editors use these consistently
* Language files: Moodle has a lot more languages than any editors, and some strings will be Moodle-specific. We need a way to make for each editor to use Moodle strings, reusing as many existing strings as possible, and using lang/xx/editor.php for the rest.
* Equation editor: there is [[DragMath_equation_editor| ongoing work]] to get [http://www.dragmath.bham.ac.uk/ Dragmath] working in Moodle, making a common plugin could be a nice improvement
* Multilang: all editors need to support multilang properly.

It also may be possible to use Moodle's CSS files to define editors themes/skins, this needs investigation

'''Editor-specific information:'''
* TinyMCE makes it possible to have [http://tinymce.moxiecode.com/punbb/viewtopic.php?pid=9317#p9317 self-registering plugins], that don't need to be under it's /plugins folder (and so could be in a moodle-specific folder).
* FCKeditor [http://docs.fckeditor.net/FCKeditor_2.x/Developers_Guide/Customization/Plug-ins needs to have its plugins in a specific place].

=== Change in formats ===

There is a bug (MDL-4868) about Markdown not being converted to HTML when using the HTML editor (after creating a post with Markdown).

This really applies to all non-HTML formats.

Proposal: whenever the HTML editor is used to edit existing non-HTML text, we convert the text to HTML for use in the editor. Saving the changes will save the text (and format) as HTML.

Although we are losing some information, we feel it's an acceptable tradeoff against overall usability, particularly as the HTML editor works on a wider range of browsers and we make XHTML compliance a requirement.

== See also ==

* [[Using the File API in Moodle forms]]

== Links to forum discussions, tracker, docs, etc. ==
* [http://tracker.moodle.org/browse/MDL-11113 MDL-11113 - Get a fully working HTML editor in Moodle]
* [[Moodle-specific customisations to the HTML editor]]

Using Moodle General developer forum discussions:
* [http://moodle.org/mod/forum/discuss.php?d=88382 TinyMCE3 Integration]
* [http://moodle.org/mod/forum/discuss.php?d=93475 XINHA has started to support Opera and Safari]
* [http://moodle.org/mod/forum/discuss.php?d=76912 What is the current position with the HTML editor?]
* [http://moodle.org/mod/forum/discuss.php?d=96160 The most important decision on editor integration]

[[Category:Editing text]]
[[Category:Files]]

HQ component teams

2024-04-30T16:01:53Z

Andrewnicols: Note about intent to not migrate this page to moodledev.io

{{Template:obsolete}}
HQ component teams are responsible for triaging the issues in a number of components, planning the roadmap of issues to be worked on and should be consulted as part of the peer review process for all issues relating to their components.

The current list of component teams is:

'''Andrew, Mick, Simey, Shamim, Jun, Dongsheng, Huong'''

Accessibility, Administration, Automated functional tests (behat), Calendar, Email, Forum, Groups, HTML Editor (Atto), HTML Editor (TinyMCE), Installation, Logging, Privacy, Questions, Quiz, RSS, Security Alert, Unit tests, User Tours

'''Adrian, Mihail, Peter, Jake, Mathew'''

Assignment, Assignment (2.2), Backup, Backup: IMS-CC, Blocks, Blog, Book, Competencies, Database activity module, External, Tool (IMS-LTI), Filepicker, Glossary, IMS-CP resource type, Lesson, LTI provider, Other, Ratings, Reports, Repositories, Resource, SCORM

'''Carlos, Sara, Amaia, Victor, Ferran'''

Badges, Activity completion, Caching, Cohorts, Content bank, Course, Course completion, Dashboard (My home), Enrolments, Feedback, Global search, H5P, HTML and CSS, Libraries, Licensing, Maths filters, phpdoc, Plagiarism, Portfolio, Roles / Access, Survey, Survey 2, Tags, Tasks, Themes, Unknown, User management, Wiki (2.x), Workshop

'''Helen, David'''

Documentation, Hub, Language, Translation

HQ Planning 2.9

2024-04-30T16:00:46Z

Andrewnicols: Note about intent to not migrate this page to moodledev.io

{{Template:WillNotMigrate}}
This page lists the projects we are initially planning to work on for the Moodle 2.9 dev cycle. The goal for this cycle is to work on 2 major projects in parallel, and give these projects enough time to become fully mature and stable, and only then to choose some smaller projects to plan, spec and build depending on the time remaining.

== Navigation improvements ==

Specification: [[Navigation overhaul specification]]

Summary - the linked specification above details a major overhaul of the navigation in Moodle. It is intended to be worked on over several release cycles. The scope for this cycle is to work on the pages that should sit in the "User context".

Work already completed:
* [[Navigation_overhaul_specification#A_user_menu|User Menu]]
* [[Navigation_overhaul_specification#Revisiting_'My_home'_page|Revisiting 'My home' page]]

Work in scope for this release cycle:
* [[Navigation_overhaul_specification#User_context|Consistent user context page layout]]
* [[Navigation_overhaul_specification#User_preferences_page|User preferences page]]
* [[Navigation_overhaul_specification#A_new_profile_page|A new profile page]]
* [[Navigation_overhaul_specification#My_grades|A new "My grades" page]]
* [[Navigation_overhaul_specification#Handling_of_course_profiles|Handling of course profiles]]
* [[Navigation_overhaul_specification#Navigation_block_2|Remove "My profile" node from navigation block (And remove my profile settings)]]

Phases:
* Mockup
** Build a full clickable mockup (no code) simulating the final result of all pages affected by the work in scope for this release cycle.
** Promote the mockup in the forums, with Martin and others to get their early input on the changes.
** Iterate the mockup based on suggestions from Martin and the community
* Update specifications
** Based on the feedback from the mockup, update the Navigation overhaul specification with design changes and technical details required to begin work
* Implementation
** Create an Epic and an initial set of tasks to complete for this project. This list of tasks should include internal (complete feature) reviews within the team and performance reviews
** Work on the issues in the Epic until they are 100% complete

== Outcomes improvements ==

== More projects ==
More projects will be added here, but not until we are satisfied that one of the projects listed above is fully complete and we have the time/resources to work on an additional project.

Acceptance testing/Migrating from Behat 2.5 to 3.x in Moodle

2024-04-30T15:59:31Z

Andrewnicols: Note about intent to not migrate this page to moodledev.io

{{Template:WillNotMigrate}}

== Migrating from Behat 2.5 to 3.x in Moodle ==

[http://docs.behat.org/en/v3.0/ Behat 3] brings a lot of extensibility and modularity for the price of backward compatibility break. This guide describes several issues you might face when updating your plugin acceptance test to the latest Moodle 3.1@dev version.

=== Config variables ===
====behat_profiles====
Most of the configuration for a behat profile can be set in $CFG->behat_profiles. This configuration parameter is available since Moodle 2.9.6, Moodle 3.0.4, and Moodle 3.1.

Here is a quick example that changes the browser from the default firefox to chrome on Linux systems (note that you have to have the [http://www.seleniumhq.org/download/ Chrome web driver installed] in your system path)

<syntaxhighlight lang="php">
$CFG->behat_profiles = [
'default' => [
'browser' => 'chrome',
'extensions' => [
'Behat\MinkExtension' => [
'selenium2' => [
'browser' => 'chrome',
]
]
]
]
];
</syntaxhighlight>
The settings available here include the browser name, tags, webdriver configuration, and capabilities:
<syntaxhighlight lang="php">
$CFG->behat_profiles = array(
'phantomjs' => array(
'browser' => 'phantomjs',
'tags' => '~@_file_upload&&~@_alert&&~@_bug_phantomjs',
'wd_host' => 'http://127.0.0.1:4443/wd/hub',
'capabilities' => array(
'platform' => 'Linux',
'version' => 2.1
)
)
);
</syntaxhighlight>

In certain situations more advanced configuration is required - for example specification of a proxy server to use. This configuration must be specified in $CFG->behat_config.
Note: If a value is specified in both behat_config, and behat_profiles, the version in behat_profiles will take precedence

==== behat_config ====
Structure of $CFG->behat_config has been modified and you should now use
<syntaxhighlight lang="php">
$CFG->behat_config = array(
'phantomjs' => array(
'suites' => array (
'default' => array(
'filters' => array(
'tags' => '~@_file_upload&&~@_alert&&~@_bug_phantomjs'
),
),
),
'extensions' => array(
'Behat\MinkExtension' => array(
'selenium2' => array(
'browser' => 'phantomjs',
'wd_host' => "http://127.0.0.1:4443/wd/hub"
)
)
)
),
);
</syntaxhighlight>
=== Formats and outputs ===
html and failed outputs are not maintained by behat. We are planning to include [https://github.com/dutchiexl/BehatHtmlFormatterPlugin BehatHTMLFormatter plugin] maintained by Neal Vanmeert and write our custom failed formatter. Changes required to use formatter and outputs are
====Single option per formatter====
Multiple formats should be sent as separate options with respective output option
<syntaxhighlight lang="php">
vendor/bin/behat --config /PATH/FOR/BEHAT_DATAROOT/behatrun/behat/behat.yml --format=moodle_progress --out=/PATH/TO/SAVE/progress.txt --format=moodle_screenshot --out=/PATH/TO/SAVE/SCREENSHOT_DIR
</syntaxhighlight>
====Terminal output is std====
For output to terminal use std
<syntaxhighlight lang="php">
vendor/bin/behat --config /PATH/FOR/BEHAT_DATAROOT/behatrun/behat/behat.yml --format=moodle_progress --out=std
</syntaxhighlight>
====Formatter can be used once====
One formatter is supported for each run. Means if you want to output progress to file and terminal then it is not supported. You need to use 2 different formatter like moodle_progress and progress
<syntaxhighlight lang="php">
vendor/bin/behat --config /PATH/FOR/BEHAT_DATAROOT/behatrun/behat/behat.yml --format=moodle_progress --out=std --format=progress --out=/PATH/TO/SAVE/progress.txt
</syntaxhighlight>
====Custom formatters====
Following custom formatter are supported
# '''moodle_progress''': Prints Moodle branch information and dots for each step.
# '''moodle_list''': List all scenarios.
# '''moodle_stepcount''': List all features with total steps in each feature file. Used for parallel run.
# '''moodle_screenshot''': Take screenshot and core dump of each step. With following options you can dump either or both.
## --format-settings '{"formats": "image"}'**: will dump image only
## --format-settings '{"formats": "html"}'**: will dump html only.
## --format-settings '{"formats": "html,image"}'**: will dump both.
## --format-settings '{"formats": "html", "dir_permissions": "0777"}'**

=== Running test ===
====Rerun option doesn't accept filepath====
Rerun should be used without the filepath, as the failed scenarios are now cached by behat and rerun.
<syntaxhighlight lang="php">
vendor/bin/behat --config /PATH/FOR/BEHAT_DATAROOT/behatrun/behat/behat.yml
exitcode=${PIPESTATUS[0]}
if [ "${exitcode}" -ne 0 ]; then
vendor/bin/behat --config /PATH/FOR/BEHAT_DATAROOT/behatrun/behat/behat.yml --rerun
fi
</syntaxhighlight>
====Rerun for parallel run====
Rerun file is cached with a unique key which is generated using input arguments. As in parallel run they all are same, the rerun file gets overwritten by the last failing run. To avoid this:
# Add 3 profiles in your config for each run say: firefox_1, firefox_2, firefox_3 for 3 parallel runs
# use --profile="firefox_{runprocess} --replace="{runprocess}" options for run.php
::: NOTE: [https://github.com/Behat/Behat/issues/859 Behat issue] have been waiting for this to be resolved by including basepath to generate the unique key.

====Exit code for parallel run is bitmasked====
Exit code is now '''bitmasked''' contains pass/fail information of each run in every bit (starting from 0th bit). Example: If you have 3 parallel runs, out of which Run 1 and 3 failed. Then exit code will be 5 (0b0101). This will help to identify which runs need to be executed again for avoiding random failures.
:: If you want to use specific path where failed scenarios should be saved for rerun then you can set the following config:
<syntaxhighlight lang="php">
$CFG->behat_config = array(
'default' => array(
'testers' => array(
'rerun_cache' => '/home/rajesh/Desktop/rerun'
),
),
);
</syntaxhighlight>

=== Failed output ===
'''Failed output is different''': Failed output display step and line in file where it failed and not the scenario line number.

=== Changes required in context file ===
====Custom chained steps support====
Chained steps are not supported by Behat 3. We have added support for custom chained step via moodle-behat-extension, but planning to depreciate this in future. To make your context backward compatible you should replace chained steps with the api calls in your context. Example the following chained steps
<syntaxhighlight lang="php">
$steps = array(
new Given('I click on "' . get_string('login') . '" "link" in the ".logininfo" "css_element"'),
new Given('I set the field "' . get_string('username') . '" to "' . $this->escape($username) . '"'),
new Given('I set the field "' . get_string('password') . '" to "'. $this->escape($username) . '"'),
new Given('I press "' . get_string('login') . '"')
);
</syntaxhighlight>
can be replaced with
<syntaxhighlight lang="php">
// Click on login link.
$this->execute('behat_general::i_click_on_in_the',
array(get_string('login'), 'link', '.logininfo', 'css_element'));
// Enter username and password.
$this->execute('behat_forms::i_set_the_field_to', array('Username', $this->escape($username)));
$this->execute('behat_forms::i_set_the_field_to', array('Password', $this->escape($username)));
// Press log in button.
$this->execute('behat_forms::press_button', get_string('login'));
</syntaxhighlight>

====TableNode====
Table Node class has changed and requires following modifications:
# TableNode constructor has changed, and it requires least empty array().
# addRow() api is deprecated, if you are modifying rows then save that in an array and create a new TableNode()
<syntaxhighlight lang="php">
$rows = $options->getRows();
$newrows = array();
foreach ($rows as $k => $data) {
$newrows[$k] = strtr($data, "äåö", "aao");
}
$modifiedtable = = new TableNode($newrows);
</syntaxhighlight>

====Named selectors are depreciated====
Named selector is deprecated, you should either use '''named_exact''' or '''named_partial'''
<syntaxhighlight lang="php">
$this->find('named_partial', array('link', get_string('hide')), $nohideexception, $activitynode);
</syntaxhighlight>

[[Category:Behat]]

AMOS manual

2024-04-30T15:57:14Z

Andrewnicols: Note about intent to not migrate this page to moodledev.io

{{Template:WillNotMigrate}}
This page is now located in the user docs: [[:en:AMOS manual|AMOS manual]]

gsoc2014 proposal jayesh

2024-04-30T15:56:30Z

Andrewnicols: Note about intent to not migrate this page to moodledev.io

{{Template:WillNotMigrate}}
{{Infobox Project
|name = New Question Type
|state = In Progress
|tracker =
|discussion = [https://moodle.org/mod/forum/discuss.php?d=259503 Forum Discussion]
|assignee = [https://moodle.org/user/view.php?id=1580475&course=5 Jayesh Anandani]
|documentation =
}}

GSOC
 '14

==Personal Information==

Full name: Jayesh Anandani

Email: jayeshanandani@gmail.com

University: U.V. Patel College of Engineering.

Graduation Date: June 2014

Major: Computer Engineering

Location: Ahmedabad,Gujarat,India

Time-zone: UTC+5.30

IRC nick: jcool

CV/Resume URL: http://in.linkedin.com/in/jayeshanandani

Open Source experience: I started my open source journey with Moodle. It has been 1 year since I started to explore about open source. I continue to contribute to Moodle and currently started development with Cakephp and Drupal.

==Project Information==

===Project Description:===

The project aims to create some new question types and make enhancements to the existing ones to make it more easy for Teachers to create a Question.

====Question Types====

1. '''Ordering Question Type:'''

The Ordering question type is based on OU's qtype_ddwtos. The thing with OU’s qtype_ddwtos is it does not grant partial marks for out of order answers.

'''Example:'''

1.) Student gets order right as per the actual answer. In this case default marks are awarded to students.

eg: 1,2,3,4 => Full marks.

2.) Students gets order a little different from actual answer. In this case no marks are awarded to students.

eg: 4,1,2,3=>0 marks

The Ordering question type will allow students to score partial marks even if their response is out of order.

'''Example:'''

1.) Student gets order right as per the actual answer. In this case default marks are awarded to students.

eg: 1,2,3,4 => 4 marks (Default marks set by teacher)

2.) Students gets order a little different from actual answer. In this case partial marks are awarded to students.

eg: 4,1,2,3=>3 marks (Partial marks will be deducted as per set by teacher.Partial marks are 1 in this case)

3.) Students gets order entirely different from actual answer. In this case no marks are allocated.

eg: 4,3,1,2=>2 marks (2 elements are out of order so 2*partial marks will be deducted)

4.) Students gets order entirely different from actual answer. In this case no marks are allocated.

eg: 4,3,2,1=>0 marks

'''Question Editing form:'''

Create/Edit Question UI

The image above shows question form for Ordering question type. The form provides various options for teachers.They can be listed as:

1. A teacher can provide choices as shown in question form there by allocating default marks and partial marks separately.

2. The order of answer will be the order in which teacher enters choices. Teacher can also select on how to display choices. Choices can be displayed either vertically or horizontally.

3. There will be option for shuffling the answer apart from which it will include options like multiple feedback and multiple tries.

4. The default marks will be provided to students if the order of answer matches exactly with the actual order. In case the order of answers given by student is different from actual order , then according to answer provided the partial marks will be deducted from default marks.

'''Question that user will see:'''

Question View

The image above shows preview of Ordering question type. In this case students have been allocated 4 choices which they need to reroder and arrange as per Question text. The order in which boxes are rearranged is taken as order of answer and marks are awarded accordingly.

'''Database for Question type''': Database

2. '''Search Question Type:'''

The main idea behind this question type is to highlight the words from given question.

'''Example:''' Find the verb in : He ran too fast.

Student just need to click on “ran” word and submit. The system will automatically grade the answers.

If they accidently click on another word and want to get that word unselected, they need to press clear button which will undo their last selection. If they want everything selected to be cleared they need to click on clear all button.

'''Question Editing form:'''

Create/Edit Question Form

The image above shows question form for Search question type. The form provides various options for teachers.They can be listed as:

1. A teacher just needs to enter the question. The answers will be wrapped in delimiter that teacher selects.

2. A teacher can select delimiter from the options provided.

3. A teacher can also use combined feedback and multiple tries for their question if they wish too.

'''Question that user will see:'''

Question View

The image above shows preview of Search Question type that students will see. They just need to click on word and the word will get highlighted. If they want to undo the last selection they can click on clear button which will undo their last selection. If they wish to undo all changes made they can click on clear all which will clear all their selections. System will automatically grade the question according to the words highlighted.

'''Database for Question type:''' Database

3. '''DDClassify Question Type:'''

This question type will help teachers to create groups in questions as per their requirement. Here students will have a set of words that they need to drag into different areas to classify them. The order in which words are dragged and dropped will of be no importance.Students responses will be processed on basis of response in each group.

'''Question Editing form:'''

Create/Edit Question Form

The image shows question form for DDClassify. The teacher can add groups and provide options for same. Marks for each group can also be defined along with default marks. Default marks will be awarded if all groups are correct and group marks will be deducted from default marks if a students gets one group wrong.

This question type will also have facility for multiple tries and combine feedback.

'''Question that user will see:'''

Question view

Image shows how question will be seen by students. Students will be shown various groups as per created by teacher. Options for all groups will be shown below. The order in which options are dragged and dropped in to each group depends upon settings made by teacher while creating the form. If student’s get all answers in all groups correct then they will be awarded with default marks or else partial marks will be deducted from default marks as per the user’s answer. Partial marks are deducted when a student has answered a group in a wrong manner.

'''Database for Question type:''' Table-1 Table-2 Table-3

4. '''Image Puzzle Question Type:'''

This question type is based on Image puzzle Question type developed by Itamar Tzadok.This question type was developed way back in 2012 and it was great work done.

I tried and tested the same on latest versions of Moodle but it wasn't working. It wasn't able to render image that teachers insert while creating question

I plan to make some enhancements to this question type which will include working of it on latest Moodle versions, provide missing functionalities like: Feedback settings,import export and it will have additional feature called Interactive settings.

'''Question Editing form:'''

Create/Edit Question Form

The image above shows question form for Image Puzzle question type. The form provides various options for teachers.They can be listed as:

1. A teacher can select an image to insert,define defaults marks and hint marks.Hint marks are defined in order to deduct marks from default marks if students uses the hint provided by the teacher.

2. A teacher can select size of the image that will be shown to students.

3. A teacher can select into how many rows and cols must the image be divided into. There is a drop-down provided for that which provides options for Easy, Medium and Hard which will automatically break image into columns and rows. The value for this options will be fixed and cannot be altered by teachers. If he/she wish to specify number of columns and rows manually they can use the textbox to enter the value if their choice. In such case the drop down will be disabled.

4. A teacher can also provide the facility of Interactive hints. The hints entered by teachers will be visible to students on their question screen. When the students want to use the hints they will click on button to view hints and hints set by teachers will be visible to them.

5. A teacher can also use combined feedback and multiple tries for their question if they wish too.

'''Question that user will see:'''

1. Question View shows how question will look like when it is displayed to students.

2. Partial Correct Answer: If students are able to arrange some of pieces in right order then they will be awarded with partial marks.

3. Correct Answer: If students are able to arrange all pieces in right order then they will be awarded with full marks.

'''Database for Question type:''' Database

5. '''DD_Marker Question Type:'''

This question type is based on OU's qtype_ddmarker. The thing with OU’s qtype_ddmarker is it does not fetch location for the markers placed on image automatically.In order to move the marker to a particular location teacher need to specify the location of the marker manually.

The enhancement of this question type will allow teachers to move marker throughout the image by mouse. The type of marker the teacher selects and the position at which the marker is placed , system will automatically fetch location of that marker and fill the coordinates text box for the same. Teacher can manually edit the coordinates if they want to or they can just move around marker to get a perfect location.

'''Question Editing form:'''

The question form will remain same as it was before.It will involve code change which will help teacher to move markers with the help of mouse.

Question that user will see:

It resembles to the view that ddmarker renders.

'''Database for Question type:''' It will remain same.

==Expected Deliverables==

Timeline (break down by every week of GSoC):

19 May: Start working with Search Question type.

26 May: Test the working of Search Question type and start with Ordering Question type.

02 June: Test the working of Ordering Question type and start with DDClassify Question type.

09 June: Test the working of DDClassify Question type.Release beta version of all 3 question types for review from Moodlers.

16 June: Start documentation for all 3 question types,solve bugs if any and improve on question types as per suggestion from Moodlers.

23 June: Mid term submission

30 June: Start working on Image Puzzle question type.

07 July: Test the working of Image Puzzle question type and start working on modification of Drag and drop marker Question type.

14 July: Test the working of revised Drag and drop marker Question type.Scrub the code and make sure it’s error free.

21 July: Release the first beta version of Image Puzzle Question type and revised Drag and drop marker Question type code to get reviews from Moodlers.

28 July: Look around for some new functionalities.

04 Aug: Start writing documentation about the question types developed and its working.

11 Aug: Prepare for Final submission. Review code again to make sure it follows Moodle coding standards.

18 Aug: Final submission

==Bugs==
Provided patches for: MDL-26120 , MDL-39054, MDL-39029, MDL-39155, MDL-43265, MDL-39074, MDL-39527

Issues Created:
MDL-40271, MDL-39527, MDL-39716, MDL-39074, CONTRIB-4870, CONTRIB-4864

Duplicates found:

MDL-37478, MDL-37110, MDL-23456

==Work/Internship experience==

===Experience from past Google Summer of Code===
I was intern at Google Summer of Code 2013 under Moodle. It was my first Google Summer of Code and it was excellent one.Choosing a project (Self-Assessment activity using Question Bank) beyond my capabilities was a good choice made as I worked hard for open source, linux, and got very much used to the world of open source.If a few months back somebody asked me about open source I could only manage to reply free software with source.I knew something like it existed but nothing more than that.The world of Open Source was like a parallel universe, I knew it was there but nothing beyond that. Also I learned how to manage my code using git, and from that time onwards I used git for almost all my daily tasks. Things ended happily, as I completed my project before time and I also carried out many tests in order to ensure its quality, and also got good reviews from the community. I still actively maintain the module I developed.

===Current Google Summer of Code===
I have got past experience in Moodle and it will be easy for me to develop a new project as I am familiar with coding standards of Moodle. Along with that this project requires some knowledge on how question engine and Moodle forms works. As my last year project I had used question engine and Moodle forms to develop the project, I am pretty much familiar with working of same.

==Time per week==
I will be able to dedicate 60+hours a week. As my graduation is near to end I don’t have any work left. I will be free all day long and will focus only on projects. There are no other summer plans.

==About Me==
I am a 4th year Computer Engineering student at U.V Patel College Of Engineering. I love to play cricket and badminton.
“Never give up on what you really want to do. The person with big dreams is more powerful than the one with all the facts.”
I program in my free time and have a fairly good understanding of C, PHP, HTML, CSS and can paddle around with Java and Python.

==Why Moodle==
I always have loved the whole idea of teaching and sharing knowledge. Since I started my engineering my primary field of interest was programming and playing around with the web.
Moodle provides me the perfect platform to showcase my two interests through the idea "E-learning".

== Credits ==

'''Mentors''': [https://moodle.org/user/profile.php?id=8026&course=5 Jean-Michel Vedrine] & [https://moodle.org/user/view.php?id=93821&course=5 Tim Hunt].

== Forum Discussions ==

[https://moodle.org/mod/forum/discuss.php?d=259503 Forum Discussion]

== Daily Blog ==

== See also ==

* [[GSOC/2014|Moodle GSoC projects for 2014]]
* [[GSOC|Moodle GSoC Overview page]]
* [https://docs.moodle.org/dev/Projects_for_new_developers#New_question_types Orignal Idea]

[[Category:GSOC]]
[[Category:Project]]

The OU PMatch algorithm

2024-04-19T14:47:16Z

Andrewnicols:

{{Template:WillNotMigrate}}
{{Note|The Open University's Pattern Match question type is available from [https://moodle.org/plugins/qtype_pmatch the Moodle plugins database].}}

This is an algorithm that the OU hopes to turn into a Moodle question type.

The code for the existing Java implementation can be seen at https://openmark.dev.java.net/source/browse/openmark/trunk/src/om/helper/PMatch.java?view=markup.

The following attempts to be a logical description of the algorithm. That is, it describes what the result of matching an expression against a string. It does not describe the best way to determine that result efficiently. Implementing these rules in full generality is very hard to do efficiently. It is more important that common expressions can be matched efficiently against typical strings, than that complex edge cases perform well.

A small selection of typical pmatch expressions can be seen at the end of the document, in the [[#A small selection of unit tests|section on unit test cases]].

==Inputs==

The algorithm takes three inputs. Typically it takes a particular string (that is, a student's response) and matches it against a number of different pmatch expressions using a particular set of options.

===Overall match options===

; ignorecase : (boolean)
; sentencedividers : (list of char) defaults to just '.'
; worddividers : (list of char) defaults to all the characters that match \s from PCRE (http://www.php.net/manual/en/regexp.reference.escape.php).
; checkspellings : (boolean)
; extradictionarywords : (list of words) defaults to the list (i.e. ie. e.g. eg. etc.) You will note from this list that dictionary words can include sentence or word dividers, and in this case, they characters do not function as divider characters.

===The string to match===

A string of Unicode characters.

===A pmatch expression===

See below.

==Parsing the input string==

1. If ignorecase is true, convert the string to lower case using a unicode-aware algorithm (textlib in Moodle).

2. Search the string for extradictionarywords, and mark any sentencedividers and worddividers characters within those words, so they are no longer considered to be divider characters. Also mark any '.' characters that appear between two digits as non-dividers. They are assumed to be decimal points.

3. The whole response is treated as a single string. Any sentencedividers are only considered in proximity checks. Following (2) the positions of sentence dividers should now be known.

4. Trim any worddividers characters from each of those strings, and split them on runs of consecutive worddividers.

Thus the input string has been converted to a list of lists of words.

==Checking spellings==

It is assumed we have access to some dictionary (Moodle provides aspell). Words in the parsed input string can be checked against that dictionary and the extradictionarywords from the options. Words that are in neither the dictionary nor extradictionarywords can be reported as misspelled words.

==Expression syntax and meaning==

Before evaluating a pmatch expression, all runs of consecutive white-space should be replaced by a single space. (That is preg_replace('/\s+/', ' ', $expression);) In addition, white-space is ignored either side of the '(' and ')' of 'not', 'all', 'any' and 'match*', and either side of the ',' in 'all' and 'any'.

I describe the algorithm in a top-down way. You may prefer to read the description from the bottom up.

A pmatch expression, when applied to a string, evaluates to a boolean. The expression can be made up from the following parts:

===not===

not( <pmatch_expression> )

is a pmatch expression that is true if <pmatch_expression> is false, and false if <pmatch_expression> is true.

===all===

all( <pmatch_expression1> , <pmatch_expression2> , ... )

is a pmatch expression that is true if all of <pmatch_expression1> , <pmatch_expression2> and so on are true. Accepts two or more sub-expressions.

===any===

any( <pmatch_expression1> , <pmatch_expression2> , ... )

is a pmatch expression that is true if any one of <pmatch_expression1> , <pmatch_expression2> and so on are true. Accepts two or more sub-expressions.

===match_...===

match_''options''( <word_sequence> )

or

match( <word_sequence> )

is true if, using the specified options, the <word_sequence> matches the string. This is defined below.

Recognised options:
; c : allow any number of extra characters in a word in the string.
; m2 : allow two misspellings of the following types when the word_with_wildcards contains 8 or more non-wildcard characters. For shorter word_with_wildcards, treat as '''m'''.
; m : allow any one misspelling of the following types.
; mx : allow one extra character in the word in the string when matching against a word_with_wildcards, providing the word_with_wildcards contains 3 or more non-wildcard characters.
; mf : allow one fewer character in the word in the string when matching against a word_with_wildcards, providing the word_with_wildcards contains 4 or more non-wildcard characters.
; mr : allow one letter in the word in the string to differ from the equivalent letter in the word_with_wildcards, providing the word_with_wildcards contains 4 or more non-wildcard characters.
; mt : allow two neighbouring letters in the word in the string to be transposed when matching against a word_with_wildcards, providing the word_with_wildcards contains 4 or more non-wildcard characters.
; o : allow the words in the string to be an any order. See the definition of the ' ' (space) joiner below.
; w : allow the string to contain extra words in addition to the ones matched by the expression.
; p0, p1, p2, p3 or p4 : set the proximity for the '_' joiner below. The default is 2 if no p''n'' option is given.

Different options can be run together in any order. For example match_omfxp2w. In the case where there are no options, the _ must be omitted.

c cannot be used at the same time as any m option.

==Matching word_sequences==

This is the fundamental part of the pmatch algorithm.

===word_sequence===

A word_sequence comprises one or more word_alternatives separated by joiners.

<word_alternative1> <joiner1> <word_alternative2> <joiner2> <word_alternative3>...

The word_sequence matches the string if each word_alternative can be made to match a different word or words in the string in such a way that satisfies the constraints imposed by the joiners. In addition, if the 'w' match option is not given, all words in the string must be matched by one of the word_alternatives.

There are two possible joiners:

; ' ' : (space) Both the word_alternatives must be present in the string. If the 'o' option is not given, then the last word matched by the first word_alternative must come before the first word matched by the second word_alternative.
; '_' : Both the word_alternatives must be present in the string. The last word matched by the first word_alternative must come before the first word matched by the second word_alternative (even if the 'o' option is used). There must be no more than 'proximity' other words between the last word matched by the first word_alternative and the first word matched by the second word_alternative. All the words matched by both word_alternatives must be within the same sentence.

===word_alternative===

A word_alternative comprises one or more word_patterns, separated by '|' characters.

<word_pattern1> '|' <word_pattern2> ...

A word alternative matches a word or words in the string if any one of the word_patterns matches that set of words.

There may be more than one way for the word_alternative to match a word or words the string. All possible matches must be considered when trying to find a way to make a word_sequence match a string.

===word_pattern===

A word pattern is either a

<word_with_wildcards>

or a

<bracket_expression>

===bracket_expression===

A bracket expression two or more simple_alternatives separated by joiners enclosed in square brackets.

'[' <simple_alternative1> <joiner1> <simple_alternative2> ... ']'

A bracket_expression matches a set of words in the string, providing each simple_alternative matches a different word in the string. The joiners mean the same as in a word_sequence with two exceptions:
# we are now joining simple_alternatives rather than word_alternatives, and
# If there is a '_' joiner before or after the word_alternative of which this bracket_expression is a part, then the ' ' joiner must match the simple_alternatives in order. That is, the 'o' option is disabled within bracket_expressions when they are part of a proximity match.

===simple_alternative===

A simple alternative is one or more word_with_wildcards separated by '|' characters.

<word_with_wildcards1> '|' <word_with_wildcards2> ...

A simple_alternative matches a particular word in the string providing one or more of the word_with_wildcards do.

===word_with_wildcards===

This is a sequence of ordinary characters with * and ? wildcards. * stands for any string of zero or more characters. ? stands for any single character.

If the ignorecase option is true, then all the characters in the word_with_wildcards are converted to lower case when the expression is parsed (using a Unicode-safe conversion function like Moodle's textlib).

Characters that have a special meaning in pmatch ('(', ')', ' ', '_', '|', '[', ']', '?', '*' and '\') can be matched as literal characters by escaping them with a \ in the word_with_wildcards.

A word_with_wildcards matches a word in the string providing there is some transformation of the word in the string according to the permitted m and c options that makes the word match the pattern.

One word_with_wildcards may match any number of words in the string. All possible matches must be considered.

==Suggested PHP API==

This seems like a natural design to me, based on the typical usage of testing one string against several expressions.

Note the methods for validating expressions that the teacher types into the editing form when creating questions.

<syntaxhighlight lang="php">
/**
* Options that control the overall way the matching is done.
*/
class pmatch_options {
/** @var boolean */
public $ignorecase;

/** @var string of sentence divider characters. */
public $sentencedividers = '.';

/** @var string of word diveder characters. */
public $worddividers = " \f\n\r\t";

/**
* @var array of words to recognise. These words may include sentence or
* word divider characters.
*/
public $extradictionarywords = array('e.g.', 'eg.', 'etc.', 'i.e.', 'ie.');
}

/**
* Represents a string that is ready for matching, and provides the method to
* match expressions against it.
*/
class pmatch_parsed_string {
/**
* Constructor.
* @param string $string the string to match against.
* @param pmatch_options $options the options to use.
*/
public function __construct($string, pmatch_options $options);

/**
* Test this string with a given pmatch expression.
* @param pmatch_expression $expression the expression to use.
* @return boolean whether this string matches the expression.
*/
public function matches(pmatch_expression $expression);

/**
* @return boolean returns true if any word is misspelt.
*/
public function is_spelt_correctly();

/**
* @return array all the distinct misspelt words.
*/
public function get_spelling_errors();

/**
* @return pmatch_options the options that were used to construct this object.
*/
public function get_options();
}

/**
* Represents a pmatch_expression.
*/
class pmatch_expression {
/**
*
* @param string $string the string to match against.
* @param pmatch_options $options the options to use.
*/
public function __construct($string, pmatch_options $options);

/**
* @return boolean returns false if the string passed to the constructor
* could not be parsed as a valid pmatch expression.
*/
public function is_valid();

/**
* @return string description of the syntax error in the expression string
* if is_valid returned false. Otherwise returns an empty string.
*/
public function get_parse_error();

/**
* @return pmatch_options the options that were used to construct this object.
*/
public function get_options();

/**
* @return string the expression, exactly as it was passed to the constructor.
*/
public function get_original_expression_string();

/**
* @return string a nicely formatted version of the expression.
*/
public function get_formatted_expression_string();
}
</syntaxhighlight>

==Simple usage example==

<syntaxhighlight lang="php">
$matchoptions = new pmatch_options();
$string = new pmatch_parsed_string('Oil is lighter', $matchoptions);
if (!$string->is_spelt_correctly()) {
// Do something.
}
$expression = new pmatch_expression('
all(
any(
match_mw(great*|high|higher|more|bigger|heavier|heavy dens*|[specific gravity]|sg than_water),
match_mw(dens*|[specific gravity]|sg great*|high|higher|more|bigger|heavier|heavy than_water),
match_mw(dens* water < dens* oil),
),
not(match_w(than_oil))
)
', $matchoptions);
if (!$expression->is_valid()) {
// Do something.
}
$matches = $string->matches($expression);
</syntaxhighlight>

==A small selection of unit tests==

These should serve to clarify the some of the rules above. They assume the suggested API above.

Note that these are a tiny subset of all the tests I would write if I had to implement this algorithm.

Also note that there are far too many tests here that assert true, without corresponding tests that are similar but assert false.

<syntaxhighlight lang="php">
class pmatch_test {
protected function match($string, $expression, $options = null) {
if (is_null($options)) {
$options = new pmatch_options();
}
$string = new pmatch_parsed_string($string, $options);
$expression = new pmatch_expression($expression, $options);
return $string->matches($expression);
}

public function test_pmatch() {
// Tests from the original pmatch documentation.
$this->assertTrue('tom dick harry', 'match(tom dick harry)'); // This is the exact match.
$this->assertTrue('thomas', 'match_c(tom)'); // Extra characters are allowed anywhere within the word.
$this->assertTrue('tom dick and harry', 'match_w(dick)'); // Extra words are allowed anywhere within the sentence.
$this->assertTrue('harry dick tom', 'match_o(tom dick harry)'); // Any order of words is allowed.
$this->assertTrue('rick', 'match_m(dick)'); // One character in the word can differ.
$this->assertTrue('rick and harry and tom', 'match_mow(tom dick harry)');
$this->assertTrue('dick and harry and thomas', 'match_cow(tom dick harry)');
$this->assertTrue('arthur harry and sid', 'match_mow(tom|dick|harry)'); // Any of tom or dick or harry will be matched.
$this->assertTrue('tomy harry and sid', 'match_mow(tom|dick harry|sid)'); // The pattern requires either tom or dick AND harry or sid.
$this->assertTrue('tom was mesmerised by maud', 'match_mow([tom maud]|[sid jane])'); // The pattern requires either (tom and maud) or (sid and jane).
$this->assertTrue('rick', 'match(?ick)'); // The first character can be anything.
$this->assertTrue('harold', 'match(har*)'); // Any sequence of characters can follow 'har'.
$this->assertTrue('tom married maud sid married jane', 'match_mow(tom_maud)'); // Only one word is between tom and maud.
$this->assertFalse('maud married tom sid married jane', 'match_mow(tom_maud)'); // The proximity control also specifies word order and over-rides the 'o' matching option.
$this->assertFalse('tom married maud sid married jane', 'match_mow(tom_jane)'); // Only two words are allowed between tom and jane.
$this->assertTrue('tom married maud', 'match_mow(tom|thomas marr& maud)');
$this->assertTrue('maud marries thomas', 'match_mow(tom|thomas marr& maud)');
$this->assertTrue('tom is to marry maud', 'match_mow(tom|thomas marr& maud)');
$this->assertTrue('tempratur', 'match_m2ow(temperature)'); // Two characters are missing.
$this->assertTrue('temporatur', 'match_m2ow(temperature)'); // Two characters are incorrect; one has been replaced and one is missing.

// These tests come from questions Tim had to ask Phil when writing this specification.
$this->assertTrue('cat toad frog', 'match(cat_[toad|newt frog]|dog)');
$this->assertTrue('cat newt frog', 'match(cat_[toad|newt frog]|dog)');
$this->assertTrue('cat dog', 'match(cat_[toad|newt frog]|dog)');
$this->assertTrue('cat dog', 'match(cat_[toad|newt frog]|dog)');
$this->assertTrue('x cat x x toad frog x', 'match_w(cat_[toad|newt frog]|dog)');
$this->assertTrue('x cat newt x x x x x frog x', 'match_w(cat_[toad|newt frog]|dog)');
$this->assertTrue('x cat x x dog x', 'match_w(cat_[toad|newt frog]|dog)');
$this->assertFalse('A C B D', 'match([A B]_[C D])');
$this->assertFalse('B C A D', 'match_o([A B]_[C D])');
$this->assertTrue('A x x x x B C D', 'match_ow([A B]_[C D])');
$this->assertFalse('B x x x x A C D', 'match_ow([A B]_[C D])'); // _ requires the words in [] to match in order.
$this->assertFalse('A B C', 'match_ow([A B]_[B C])');

// Tests of the misspelling rules.
$this->assertTrue('test', 'match(test)');
$this->assertFalse('tes', 'match(test)');
$this->assertFalse('testt', 'match(test)');
$this->assertFalse('tent', 'match(test)');
$this->assertFalse('tets', 'match(test)');

$this->assertTrue('test', 'match_mf(test)');
$this->assertTrue('tes', 'match_mf(test)');
$this->assertFalse('testt', 'match_mf(test)');
$this->assertFalse('tent', 'match_mf(test)');
$this->assertFalse('tets', 'match_mf(test)');
$this->assertFalse('te', 'match_mf(tes)');

// and so on.
}
}
</syntaxhighlight>

TinyMCE

2024-04-19T14:46:19Z

Andrewnicols:

{{Template:obsolete}}
{{Moodle 2.0}}

TinyMCE is an opensource javascript text editor from Moxiecode released under the LGPL licence. TinyMCE ''was'' the default text editor from Moodle 2.0 to Moodle 2.6.
From Moodle 2.7 onwards, it is replaced by [[Atto]]. In previous Moodle versions, it maybe used a replacement for the [[HTML editor]].

==TinyMCE spell check==
TinyMCE has Google Spell (default), Pspell or PSpellShell as its spell checking engines. The engine can be changed for a Moodle site in ''Site administration > Plugins > Text editors> TinyMCE or via Text editors> Manage and the settings link.

== Tips and Tricks ==

=== Use as a plugin ===
In pre 2.0 Moodles, some plugins are Moodle-specific and need to be maintained separately.

*Tip: TinyMCE plugins code should be compressed using a [http://javascriptcompressor.com java script compressor].

===Generate PDF files from HTML toolbar===
Creates an icon for PDF files.
*[http://moodle.org/mod/data/view.php?d=13&rid=1627 Generate PDF files from HTML] is a Modules and plugins database page for downloads and more information.

==See also==

* [http://www.youtube.com/watch?v=xJE6UhqnyjU HTML editor in Moodle 2.0 video]
*[http://moodle.org/mod/data/view.php?d=13&rid=1119 Integration: TinyMCE integration] in the Modules and plugins database for pre 2.0 sites
*[http://tinymce.moxiecode.com/ tinyMCE homepage]
*[http://moodle.org/mod/forum/discuss.php?d=107550 Moodle 1.9 + TinyMCE - clean port]

[[Category:HTML editor]]