core\antivirus\manager Class Reference

Class used for various antivirus related stuff. More...

Static Public Member Functions
static	get_antivirus ($antivirusname)
	Returns instance of antivirus. More...
static	get_available ()
	Get the list of available antiviruses. More...
static	scan_data ($data)
	Scan data steam using all enabled antiviruses, throws exception in case of infected data. More...
static	scan_file ($file, $filename, $deleteinfected)
	Scan file using all enabled antiviruses, throws exception in case of infected file. More...

Detailed Description

Class used for various antivirus related stuff.

Copyright

2015 Ruslan Kabalin, Lancaster University.

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

get_antivirus()

static core\antivirus\manager::get_antivirus (   $antivirusname )

static

Returns instance of antivirus.

Parameters

string

$antivirusname

name of antivirus.

Return values

object|bool

antivirus instance or false if does not exist.

get_available()

static core\antivirus\manager::get_available ( )

static

Get the list of available antiviruses.

Return values

array

Array ('antivirusname'=>'localised antivirus name').

scan_data()

static core\antivirus\manager::scan_data (   $data )

static

Scan data steam using all enabled antiviruses, throws exception in case of infected data.

Parameters

string

$data

The varaible containing the data to scan.

Exceptions

core::antivirus::scanner_exception

If data is infected.

Return values

void

scan_file()

static core\antivirus\manager::scan_file (   $file,   $filename,   $deleteinfected  )

static

Scan file using all enabled antiviruses, throws exception in case of infected file.

Parameters

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

Exceptions

core::antivirus::scanner_exception

If file is infected.

Return values

void

---

The documentation for this class was generated from the following file:

• lib/classes/antivirus/manager.php