Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 3.9.x will end* 10 May 2021 (12 months).
  • Bug fixes for security issues in 3.9.x will end* 8 May 2023 (36 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
/lib/classes/antivirus/ -> scanner.php (source)

[Source view]

Differences Between: [Versions 39 and 310] [Versions 39 and 311] [Versions 39 and 400] [Versions 39 and 401] [Versions 39 and 402] [Versions 39 and 403]

Base 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: 159 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

scanner:: (6 methods):
  __construct()
  get_config()
  get_scanning_notice()
  set_scanning_notice()
  scan_data()
  message_admins()


Class: scanner  - X-Ref

Base abstract antivirus scanner class.

__construct()   X-Ref
Class constructor.

return: void.

get_config($property)   X-Ref
Config get method.

param: string $property config property to get.
return: mixed

get_scanning_notice()   X-Ref
Get scanning notice.

return: string

set_scanning_notice($notice)   X-Ref
Set scanning notice.

param: string $notice notice to set.
return: void

scan_data($data)   X-Ref
Scan data.

By default it saves data variable content to file and then scans it using
scan_file method, however if antivirus plugin permits scanning data directly,
the method can be overridden.

param: string $data The variable containing the data to scan.
return: int Scanning result constants.

message_admins($notice)   X-Ref
Email admins about antivirus scan outcomes.

param: string $notice The body of the email to be sent.
return: void