Inheritance diagram for ilVirusScannerSetupConfig:

Collaboration diagram for ilVirusScannerSetupConfig:

Public Member Functions
	__construct (string $virus_scanner, ?string $path_to_scan, ?string $path_to_clean, ?string $icap_host, ?string $icap_port, ?string $icap_service_name, ?string $icap_client_path)

	getVirusScanner ()

	getPathToScan ()

	getPathToClean ()

	getIcapHost ()

	getIcapPort ()

	getIcapServiceName ()

	getIcapClientPath ()

Data Fields
const	VIRUS_SCANNER_NONE = "none"

Protected Member Functions
	toLinuxConvention (?string $p)

Protected Attributes
string	$virus_scanner

string	$path_to_scan = null

string	$path_to_clean = null

string	$icap_host = null

string	$icap_port = null

string	$icap_service_name = null

string	$icap_client_path = null

Private Attributes
const	VIRUS_SCANNER_SOPHOS = "sophos"

const	VIRUS_SCANNER_ANTIVIR = "antivir"

const	VIRUS_SCANNER_CLAMAV = "clamav"

const	VIRUS_SCANNER_ICAP = "icap"

Detailed Description

Definition at line 23 of file class.ilVirusScannerSetupConfig.php.

Constructor & Destructor Documentation

◆ __construct()

ilVirusScannerSetupConfig::__construct	(	string	$virus_scanner,
		?string	$path_to_scan,
		?string	$path_to_clean,
		?string	$icap_host,
		?string	$icap_port,
		?string	$icap_service_name,
		?string	$icap_client_path
	)

Definition at line 45 of file class.ilVirusScannerSetupConfig.php.

      {
        $scanners = [
            self::VIRUS_SCANNER_NONE,
            self::VIRUS_SCANNER_SOPHOS,
            self::VIRUS_SCANNER_ANTIVIR,
            self::VIRUS_SCANNER_CLAMAV,
            self::VIRUS_SCANNER_ICAP
        ];
        if (!in_array($virus_scanner, $scanners)) {
            throw new InvalidArgumentException(
                "Unknown virus scanner: '$virus_scanner'"
            );
        }
        if ($virus_scanner === self::VIRUS_SCANNER_ICAP) {
            $this->icap_host = $this->toLinuxConvention($icap_host);
            $this->icap_port = $this->toLinuxConvention($icap_port);
            $this->icap_service_name = $this->toLinuxConvention($icap_service_name);
            $this->icap_client_path = $this->toLinuxConvention($icap_client_path);
        } elseif ($virus_scanner !== self::VIRUS_SCANNER_NONE && (!$path_to_scan || !$path_to_clean)) {
            throw new InvalidArgumentException(
                "Missing path to scan and/or clean commands for virus scanner."
            );
        }
        $this->virus_scanner = $virus_scanner;
        $this->path_to_scan = $this->toLinuxConvention($path_to_scan);
        $this->path_to_clean = $this->toLinuxConvention($path_to_clean);
    }

References $path_to_clean, $path_to_scan, $virus_scanner, toLinuxConvention(), VIRUS_SCANNER_ANTIVIR, VIRUS_SCANNER_CLAMAV, VIRUS_SCANNER_ICAP, VIRUS_SCANNER_NONE, and VIRUS_SCANNER_SOPHOS.

Here is the call graph for this function:

Member Function Documentation

◆ getIcapClientPath()

ilVirusScannerSetupConfig::getIcapClientPath ( )

Definition at line 119 of file class.ilVirusScannerSetupConfig.php.

                                       : ?string
    {
        return $this->icap_client_path;
    }

References $icap_client_path.

◆ getIcapHost()

ilVirusScannerSetupConfig::getIcapHost ( )

Definition at line 104 of file class.ilVirusScannerSetupConfig.php.

                                 : ?string
    {
        return $this->icap_host;
    }

References $icap_host.

◆ getIcapPort()

ilVirusScannerSetupConfig::getIcapPort ( )

Definition at line 109 of file class.ilVirusScannerSetupConfig.php.

                                 : ?string
    {
        return $this->icap_port;
    }

References $icap_port.

◆ getIcapServiceName()

ilVirusScannerSetupConfig::getIcapServiceName ( )

Definition at line 114 of file class.ilVirusScannerSetupConfig.php.

                                        : ?string
    {
        return $this->icap_service_name;
    }

References $icap_service_name.

◆ getPathToClean()

ilVirusScannerSetupConfig::getPathToClean ( )

Definition at line 99 of file class.ilVirusScannerSetupConfig.php.

                                    : ?string
    {
        return $this->path_to_clean;
    }

References $path_to_clean.

◆ getPathToScan()

ilVirusScannerSetupConfig::getPathToScan ( )

Definition at line 94 of file class.ilVirusScannerSetupConfig.php.

                                   : ?string
    {
        return $this->path_to_scan;
    }

References $path_to_scan.

◆ getVirusScanner()

ilVirusScannerSetupConfig::getVirusScanner ( )

Definition at line 89 of file class.ilVirusScannerSetupConfig.php.

                                     : string
    {
        return $this->virus_scanner;
    }

References $virus_scanner.

◆ toLinuxConvention()

ilVirusScannerSetupConfig::toLinuxConvention ( ?string $p )

protected

Definition at line 81 of file class.ilVirusScannerSetupConfig.php.

                                                    : ?string
    {
        if (!$p) {
            return null;
        }
        return preg_replace("/\\\\/", "/", $p);
    }