Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-57476

Hooks into the file API

    XMLWordPrintable

Details

    • MOODLE_32_STABLE, MOODLE_33_STABLE, MOODLE_34_STABLE
    • MOODLE_34_STABLE
    • MDL-57476_file_callbacks
    • Hide

      Breakout your favorite editor. Add these lines to mod/forum/lib.php:

      function forum_create_file($file) {
      		 
          debugging('forum_create_file');
      		 
          var_dump($file);
      		 
      }
      		 
       
      		 
      function forum_update_file($newfile, $oldfile) {
      		 
          debugging('forum_update_file');
      		 
          if ($newfile->timemodified == $oldfile->timemodified) {
      		 
              throw new coding_exception('fail');
      		 
          }
      		 
          var_dump($newfile, $oldfile);
      		 
      }
      		 
       
      		 
      function forum_delete_file($file) {
      		 
          debugging('forum_delete_file');
      		 
          var_dump($file);
      		 
      }

      Drop the attached file_hooks_test.php into the root of your Moodle. Run file_hooks_test.php on the CLI, EG: php file_hooks_test.php

      You should see that the three forum hooks are called.

      Show
      Breakout your favorite editor. Add these lines to mod/forum/lib.php: function forum_create_file($file) { debugging('forum_create_file'); var_dump($file); }   function forum_update_file($newfile, $oldfile) { debugging('forum_update_file'); if ($newfile->timemodified == $oldfile->timemodified) { throw new coding_exception('fail'); } var_dump($newfile, $oldfile); }   function forum_delete_file($file) { debugging('forum_delete_file'); var_dump($file); } Drop the attached file_hooks_test.php into the root of your Moodle. Run file_hooks_test.php on the CLI, EG: php file_hooks_test.php You should see that the three forum hooks are called.

    Description

      We are building out a feature that we will eventually open source as a plugin, but it currently requires a patch into core Moodle. The patch is specifically around file deletion, EG: the plugin needs to know when any file has been deleted.

      Specifically, we had to patch \stored_file.delete method.

      We are hoping that we could get something into core that would be general purpose and likely have larger scope, EG: hooks for file updates, creates, etc.

      Unsure if these would be events or just API hooks. Looking for general feedback to see if this is at all possible or alternative solutions/proposals.

      Attachments

        Issue Links

          has been marked as being related by

          Task - A task that needs to be completed. Tasks usually refer to work that must be done outside the product. MDL-59708 Hooks into the file API (backport of MDL-57476)

          • Major - Major loss of function, incorrect output
          • Closed

          Improvement - An enhancement to an existing Moodle feature. MDL-59700 Add before_file_created hook to file API

          • Minor - Minor loss of function where workaround is possible
          • Closed
          will be (partly) resolved by

          New Feature - A new Moodle feature which has yet to be developed. MDL-46375 Move file-system specific components of file_storage and stored_file to new overridable API

          • Blocker - Blocks development and/or testing, prevents Moodle from running (applicable to bugs only)
          • Closed

          Activity

            People

              brudinie guy thomas
              bushido Mark Nielsen
              Mark Nielsen Mark Nielsen
              Andrew Lyons Andrew Lyons
              Ankit Agarwal Ankit Agarwal
              Matteo Scaramuccia, David Woloszyn, Huong Nguyen, Jake Dallimore, Meirza, Michael Hawkins, Raquel Ortega, Safat Shahin, Stevani Andolo
              Votes:
              0 Vote for this issue
              Watchers:
              8 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:
                13/Nov/17