Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/lib/classes/antivirus/ -> manager.php (source)

[Source view]

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401]

Manager class for antivirus integration.

Copyright: 2015 Ruslan Kabalin, Lancaster University.
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 330 lines (14 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

manager:: (6 methods):
  get_enabled()
  scan_file()
  scan_data()
  get_antivirus()
  get_available()
  send_antivirus_messages()


Class: manager  - X-Ref

Class used for various antivirus related stuff.

get_enabled()   X-Ref
Returns list of enabled antiviruses.

return: array Array ('antivirusname'=>stdClass antivirus object).

scan_file($file, $filename, $deleteinfected)   X-Ref
Scan file using all enabled antiviruses, throws exception in case of infected file.

param: string $file Full path to the file.
param: string $filename Name of the file (could be different from physical file if temp file is used).
param: bool $deleteinfected whether infected file needs to be deleted.
return: void

scan_data($data)   X-Ref
Scan data steam using all enabled antiviruses, throws exception in case of infected data.

param: string $data The variable containing the data to scan.
return: void

get_antivirus($antivirusname)   X-Ref
Returns instance of antivirus.

param: string $antivirusname name of antivirus.
return: object|bool antivirus instance or false if does not exist.

get_available()   X-Ref
Get the list of available antiviruses.

return: array Array ('antivirusname'=>'localised antivirus name').

send_antivirus_messages(\core\antivirus\scanner $antivirus, string $incidentdetails)   X-Ref
This function puts all relevant information into the messages required, and sends them.

param: \core\antivirus\scanner $antivirus the scanner engine.
param: string $incidentdetails details of the incident.
return: void