Moodle APIs  3.8
Moodle 3.8.6 (Build: 20201109)
Files | Namespaces | Classes | Functions | Variables
repository_filesystem

Files

file  access.php
 Plugin capabilities.
 
file  cron_task.php
 A schedule task for file system repository cron.
 
file  lib.php
 File system repository data generator.
 
file  lib.php
 This plugin is used to access files on server file system.
 
file  provider.php
 Privacy Subsystem implementation for repository_filesystem.
 
file  tasks.php
 Definition of file system repository scheduled tasks.
 

Namespaces

 repository_filesystem\privacy
  
 
 repository_filesystem\task
  
 

Classes

class  repository_filesystem
 repository_filesystem class More...
 
class  repository_filesystem\privacy\provider
 Privacy Subsystem for repository_filesystem implementing null_provider. More...
 
class  repository_filesystem\task\cron_task
 
class  repository_filesystem_generator
 

Functions

 repository_filesystem_pluginfile ($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array())
 Generates and sends the thumbnail for an image in filesystem. More...
 

Variables

 $capabilities
 
 $tasks
 

Detailed Description

Function Documentation

◆ repository_filesystem_pluginfile()

repository_filesystem_pluginfile (   $course,
  $cm,
  $context,
  $filearea,
  $args,
  $forcedownload,
array  $options = array() 
)

Generates and sends the thumbnail for an image in filesystem.

Parameters
stdClass$coursecourse object
stdClass$cmcourse module object
stdClass$contextcontext object
string$fileareafile area
array$argsextra arguments
bool$forcedownloadwhether or not force download
array$optionsadditional options affecting the file serving
Return values
bool

Variable Documentation

◆ $capabilities

$capabilities
Initial value:
= array(
'repository/filesystem:view' => array(
'captype' => 'read',
'contextlevel' => CONTEXT_MODULE,
'archetypes' => array(
'coursecreator' => CAP_ALLOW,
'teacher' => CAP_ALLOW,
'editingteacher' => CAP_ALLOW,
'manager' => CAP_ALLOW
)
)
)

◆ $tasks

$tasks
Initial value:
= array(
array(
'classname' => '\repository_filesystem\task\cron_task',
'blocking' => 0,
'minute' => '*',
'hour' => '*',
'day' => '*',
'month' => '*',
'dayofweek' => '*'
)
)
CAP_ALLOW
const CAP_ALLOW
Allow permission, overrides CAP_PREVENT defined in parent contexts.
Definition: accesslib.php:115
CONTEXT_MODULE
const CONTEXT_MODULE
Course module context level - one instance for each course module.
Definition: accesslib.php:130