Release version 2.0.0 - 2020-07-02.

michael-milette · Jul 3, 2020 · d87a45d · d87a45d
1 parent 6b5a9b8
commit d87a45d
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 16 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,7 +1,7 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [1.1.3] Dev - 2020-07-01
+## [2.0.0] 2020-07-01
 ### Added
 - New configurable setting to enable/disable escaped [{braces}] (e.g. for creating documentation). Default is enabled.
 - You can now escape tags so they are not processed by wrapping them in [{brackets}]. {{double-braces}} are no longer supported.
@@ -41,30 +41,34 @@ All notable changes to this project will be documented in this file.
 - Separator in menu above Request a Course link (part of {mycoursesmenu} tag).
 - New question to FAQ regarding setting filter priorities so that all enabled filters works together.
 ### Updated
+- Tested to be compatible with PHP 7.3 and 7.4.
+- Tested to be compatible with Moodle 3.9.
 - Read-only name and email address fields are now also disabled in {form...} templates.
 - Now checks moodle/course:request capability before creating Course Request link in {ifcourserequests}, {mycourses} and {mycoursemenu}
 - No longer identifies Guest users as being logged-in.
-- Documentation:FAQ info on how to translate built-in contact forms.
+- Documentation: FAQ info on how to translate built-in contact forms.
 - Documentation to reflect new functionality.
-- FAQ.
+- Updated FAQ.
 - .travis.yml and fixed issues.
-- Tested to be compatible with PHP 7.3 and 7.4.
 - Fixed example of Create Course menu item. Now creates a course in the current category.
 - Fixed {note} tag which was not working.
 ### Deprecated (no longer inluded)
 - You can no longer escape tags using {{double}} braces. This was causing issues with MathJAX. Bracket your [{tag}] instead.
 
 ### Important notes
 
-Some tags are indicated in this documentation as ALPHA may still require some development and are not guarantied to be implementaed or implemented in the same way in future releases. Please let us know if you think they are useful if they work for you or what changes you might like to see.
+Some tags, which are indicated in this documentation as ALPHA, may still require some development and are not guarantied to be implementaed or implemented in the same way in future releases. Please let us know if you think they are useful if they work for you or what changes you might like to see.
 
-These UI components are compatible with most Bootrap 4 based themes including:
+UI tags are compatible with most Bootrap 4 based themes for Moodle. They have been tested with:
 
 Academi, Adaptable, Aigne, Bandeau, Boost, Classic, Eguru, Enlight Lite, Fordson, Foundation, GCWeb, Klass, Moove, Roshni Lite and Trema.
 
-Not compatible with the following Moodle themes:
+They were found to be incompatible with the following Moodle themes:
 
-Boost Campus, Boost Learning, Boost Mgnific and Boost_Training.
+* Boost Campus
+* Boost Learning
+* Boost Mgnific
+* Boost_Training
 
 ## [1.1.0] - 2019-11-17
 ### Added

diff --git a/README.md b/README.md
@@ -2,8 +2,8 @@
 
 FilterCodes filter plugin for Moodle
 ====================================
-![PHP](https://img.shields.io/badge/PHP-v5.6%20%2F%20v7.0%20%2F%20v7.1%2F%20v7.2%2F%20v7.3-blue.svg)`
-![Moodle](https://img.shields.io/badge/Moodle-v2.7%20to%20v3.8.x-orange.svg)
+![PHP](https://img.shields.io/badge/PHP-v5.6%20%2F%20v7.0%20%2F%20v7.1%2F%20v7.2%2F%20v7.3%2F%20v7.4-blue.svg)`
+![Moodle](https://img.shields.io/badge/Moodle-v2.7%20to%20v3.9.x-orange.svg)
 [![GitHub Issues](https://img.shields.io/github/issues/michael-milette/moodle-filter_filtercodes.svg)](https://github.com/michael-milette/moodle-filter_filtercodes/issues)
 [![Contributions welcome](https://img.shields.io/badge/contributions-welcome-green.svg)](#contributing)
 [![License](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](#license)

diff --git a/filter.php b/filter.php
@@ -147,10 +147,11 @@ private function hasminarchetype($minarchetype) {
     }
 
     /**
-     * Checks a custom role filtered or not by context id
+     * Checks if a user has a custom role or not within the current context.
      *
-     * @param $roleshortname
-     * @param int $contextid
+     * @param string $roleshortname The role's shortname.
+     * @param integer $contextid The context where the tag appears.
+     * @return boolean True if user has custom role, otherwise, false.
      */
     private function hascustomrole($roleshortname, $contextid = 0) {
         $keytocheck = $roleshortname . '-' . $contextid;
@@ -1792,7 +1793,7 @@ function($matches) {
                 $changed = true;
             }
         }
-        
+
         // Tag: {help}{/help}.
         if (stripos($text, '{/help}') !== false) {
             static $help;

diff --git a/version.php b/version.php
@@ -25,8 +25,8 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-$plugin->version   = 2019111702;            // The current plugin version (Date: YYYYMMDDXX).
+$plugin->version   = 2020070100;            // The current plugin version (Date: YYYYMMDDXX).
 $plugin->requires  = 2014051200;            // Requires Moodle version 2.7.
 $plugin->component = 'filter_filtercodes';  // Full name of the plugin (used for diagnostics).
-$plugin->release   = '1.1.0';
+$plugin->release   = '2.0.0';
 $plugin->maturity = MATURITY_STABLE;