Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
- Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
- PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
/lib/classes/antivirus/ -> scanner.php (source)
Differences Between: [Versions 310 and 402] [Versions 311 and 402] [Versions 39 and 402] [Versions 400 and 402] [Versions 401 and 402]
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: | 251 lines (9 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
scanner:: (9 methods):
__construct()
get_config()
get_scanning_notice()
set_scanning_notice()
scan_data()
message_admins()
get_incident_details()
get_messages()
get_virus_found_message()
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, $format = FORMAT_PLAIN, $eventname = 'errors') X-Ref |
| This function pushes given messages into the message queue, which will be sent by the antivirus manager. param: string $notice The body of the email to be sent. param: string $format The body format. param: string $eventname event name return: void |
| get_incident_details($file = '', $filename = '', $notice = '', $virus = true) X-Ref |
| Return incident details param: string $file full path to the file param: string $filename original name of the file param: string $notice notice from antivirus param: string $virus if this template is due to a virus found. return: string the incident details |
| get_messages() X-Ref |
| Getter method for messages queued by the antivirus scanner. return: array |
| get_virus_found_message() X-Ref |
| Getter method for the antivirus message displayed in the exception. return: array array of string and component to pass to exception constructor. |
