Init

classes/condition.php

@@ -15,7 +15,7 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- *
+ * Condition class
  *
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  *
@@ -24,3 +24,104 @@
  * @author    Luuk Verhoeven
  **/
 
+namespace availability_ipaddress;
+
+use core_availability\info;
+
+defined('MOODLE_INTERNAL') || die;
+
+/**
+ * Class condition
+ *
+ * @package   availability_ipaddress
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @copyright 2019-05-14 Mfreak.nl | LdesignMedia.nl - Luuk Verhoeven
+ */
+class condition extends \core_availability\condition {
+
+    /**
+     * @var string
+     */
+    protected $ip_addresses = '';
+
+    /**
+     * Determines whether a particular item is currently available
+     * according to this availability condition.
+     *
+     * If implementations require a course or modinfo, they should use
+     * the get methods in $info.
+     *
+     * The $not option is potentially confusing. This option always indicates
+     * the 'real' value of NOT. For example, a condition inside a 'NOT AND'
+     * group will get this called with $not = true, but if you put another
+     * 'NOT OR' group inside the first group, then a condition inside that will
+     * be called with $not = false. We need to use the real values, rather than
+     * the more natural use of the current value at this point inside the tree,
+     * so that the information displayed to users makes sense.
+     *
+     * @param bool $not        Set true if we are inverting the condition
+     * @param info $info       Item we're checking
+     * @param bool $grabthelot Performance hint: if true, caches information
+     *                         required for all course-modules, to make the front page and similar
+     *                         pages work more quickly (works only for current user)
+     * @param int  $userid     User ID to check availability for
+     *
+     * @return bool True if available
+     */
+    public function is_available($not, info $info, $grabthelot, $userid) {
+        // Check if the setting is enabled.
+
+        // Check if ip-address matches
+
+
+        return false;
+    }
+
+    /**
+     * Obtains a string describing this restriction (whether or not
+     * it actually applies). Used to obtain information that is displayed to
+     * students if the activity is not available to them, and for staff to see
+     * what conditions are.
+     *
+     * The $full parameter can be used to distinguish between 'staff' cases
+     * (when displaying all information about the activity) and 'student' cases
+     * (when displaying only conditions they don't meet).
+     *
+     * If implementations require a course or modinfo, they should use
+     * the get methods in $info.
+     *
+     * The special string <AVAILABILITY_CMNAME_123/> can be returned, where
+     * 123 is any number. It will be replaced with the correctly-formatted
+     * name for that activity.
+     *
+     * @param bool $full Set true if this is the 'full information' view
+     * @param bool $not  Set true if we are inverting the condition
+     * @param info $info Item we're checking
+     *
+     * @return string Information string (for admin) about all restrictions on
+     *   this item
+     * @throws \coding_exception
+     */
+    public function get_description($full, $not, info $info) {
+        return get_string('require_condition', 'availability_ipaddress');
+    }
+
+    /**
+     * Obtains a representation of the options of this condition as a string,
+     * for debugging.
+     *
+     * @return string Text representation of parameters
+     */
+    protected function get_debug_string() {
+        // TODO: Implement get_debug_string() method.
+    }
+
+    /**
+     * Saves tree data back to a structure object.
+     *
+     * @return \stdClass Structure object (ready to be made into JSON format)
+     */
+    public function save() {
+        // TODO: Implement save() method.
+    }
+}

classes/frontend.php

@@ -15,7 +15,7 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- *
+ * Front-end class
  *
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  *
@@ -24,3 +24,36 @@
  * @author    Luuk Verhoeven
  **/
 
+namespace availability_ipaddress;
+defined('MOODLE_INTERNAL') || die;
+
+/**
+ * Class frontend
+ *
+ * @package   availability_ipaddress
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @copyright 2019-05-14 Mfreak.nl | LdesignMedia.nl - Luuk Verhoeven
+ */
+class frontend extends \core_availability\frontend {
+
+    /**
+     * @return array
+     */
+    protected function get_javascript_strings() {
+        return ['requires_app', 'requires_notapp', 'label_access'];
+    }
+
+    /**
+     * Decides whether this plugin should be available in a given course. The
+     * plugin can do this depending on course or system settings.
+     *
+     * @param \stdClass     $course  Course object
+     * @param \cm_info      $cm      Course-module currently being edited (null if none)
+     * @param \section_info $section Section currently being edited (null if none)
+     *
+     * @return bool True if there are completion criteria
+     */
+    protected function allow_add($course, \cm_info $cm = null, \section_info $section = null) {
+        return true;
+    }
+}

lang/en/availability_ipaddress.php

@@ -15,7 +15,7 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- *
+ * EN language file.
  *
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  *
@@ -23,4 +23,6 @@
  * @copyright 2019-05-14 Mfreak.nl | LdesignMedia.nl - Luuk Verhoeven
  * @author    Luuk Verhoeven
  **/
- 
+$string['pluginname'] = 'IP address';
+$string['title'] = 'IP address';
+$string['description'] = 'Restrict access by ip-address';

version.php

@@ -15,12 +15,19 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- *
+ * Version information
  *
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  *
- * @package   moodle-availability_ipaddress
+ * @package   availability_ipaddress
  * @copyright 2019-05-14 Mfreak.nl | LdesignMedia.nl - Luuk Verhoeven
  * @author    Luuk Verhoeven
  **/
 
+defined('MOODLE_INTERNAL') || die();
+
+$plugin->component = 'availability_ipaddress';
+$plugin->version = 2019051400;
+$plugin->release = 'v3.5.0';
+$plugin->requires = 2018120300;
+$plugin->maturity = MATURITY_BETA;

yui/src/form/meta/form.json

@@ -0,0 +1,10 @@
+{
+  "moodle-availability_ipaddress-form": {
+    "requires": [
+      "base",
+      "node",
+      "event",
+      "moodle-core_availability-form"
+    ]
+  }
+}