ilVirusScannerConfigStoredObjective Class Reference

Inheritance diagram for ilVirusScannerConfigStoredObjective:

Collaboration diagram for ilVirusScannerConfigStoredObjective:

Public Member Functions
	__construct (ilVirusScannerSetupConfig $config)
	getHash ()
	getLabel ()
	isNotable ()
	getPreconditions (Setup\Environment $environment)
	achieve (Setup\Environment $environment)
	isApplicable (Setup\Environment $environment)

Protected Attributes
ilVirusScannerSetupConfig	$config

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilVirusScannerConfigStoredObjective::__construct

(

ilVirusScannerSetupConfig

$config

)

Definition at line 27 of file class.ilVirusScannerConfigStoredObjective.php.

      {
        $this->config = $config;
    }

References $config.

Member Function Documentation

achieve()

ilVirusScannerConfigStoredObjective::achieve

(

Setup\Environment

$environment

)

Definition at line 58 of file class.ilVirusScannerConfigStoredObjective.php.

                                                           : Setup\Environment
    {
        $ini = $environment->getResource(Setup\Environment::RESOURCE_ILIAS_INI);
 
        $ini->setVariable('tools', 'vscantype', $this->config->getVirusScanner());
        $ini->setVariable('tools', 'scancommand', (string) $this->config->getPathToScan());
        $ini->setVariable('tools', 'cleancommand', (string) $this->config->getPathToClean());
        $ini->setVariable('tools', 'icap_host', (string) $this->config->getIcapHost());
        $ini->setVariable('tools', 'icap_port', (string) $this->config->getIcapPort());
        $ini->setVariable('tools', 'icap_service_name', (string) $this->config->getIcapServiceName());
        $ini->setVariable('tools', 'icap_client_path', (string) $this->config->getIcapClientPath());
 
        if (!$ini->write()) {
            throw new Setup\UnachievableException('Could not write ilias.ini.php');
        }
 
        return $environment;
    }

References $ini.

getHash()

ilVirusScannerConfigStoredObjective::getHash

(

)

Definition at line 33 of file class.ilVirusScannerConfigStoredObjective.php.

                             : string
    {
        return hash('sha256', self::class);
    }

getLabel()

ilVirusScannerConfigStoredObjective::getLabel

(

)

Definition at line 38 of file class.ilVirusScannerConfigStoredObjective.php.

                              : string
    {
        return 'Fill ini with settings for components/ILIAS/VirusScanner_';
    }

getPreconditions()

ilVirusScannerConfigStoredObjective::getPreconditions

(

Setup\Environment

$environment

)

Returns

ilIniFilesLoadedObjective[]

Definition at line 51 of file class.ilVirusScannerConfigStoredObjective.php.

                                                                    : array
    {
        return [
            new ilIniFilesLoadedObjective()
        ];
    }

isApplicable()

ilVirusScannerConfigStoredObjective::isApplicable

(

Setup\Environment

$environment

)

Definition at line 77 of file class.ilVirusScannerConfigStoredObjective.php.

                                                                : bool
    {
        $ini = $environment->getResource(Setup\Environment::RESOURCE_ILIAS_INI);
 
        return
            $ini->readVariable('tools', 'vscantype') !== $this->config->getVirusScanner() ||
            $ini->readVariable('tools', 'scancommand') !== $this->config->getPathToScan() ||
            $ini->readVariable('tools', 'cleancommand') !== $this->config->getPathToClean() ||
            $ini->readVariable('tools', 'icap_host') !== $this->config->getIcapHost() ||
            $ini->readVariable('tools', 'icap_port') !== $this->config->getIcapPort() ||
            $ini->readVariable('tools', 'icap_service_name') !== $this->config->getIcapServiceName() ||
            $ini->readVariable('tools', 'icap_client_path') !== $this->config->getIcapClientPath();
    }

References $ini.

isNotable()

ilVirusScannerConfigStoredObjective::isNotable

(

)

Definition at line 43 of file class.ilVirusScannerConfigStoredObjective.php.

                               : bool
    {
        return false;
    }

Field Documentation

$config

ilVirusScannerSetupConfig ilVirusScannerConfigStoredObjective::$config

protected

Definition at line 25 of file class.ilVirusScannerConfigStoredObjective.php.

Referenced by __construct().

---

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

• components/ILIAS/VirusScanner/classes/Setup/class.ilVirusScannerConfigStoredObjective.php