ClearOS API

Description

ClamAV class.

author: Point Clark Networks
copyright: Copyright 2005-2006, Point Clark Networks
license: GNU Public License

Located in /api/ClamAv.class.php (line 58)

Engine
   |
   --Software
      |
      --Daemon
         |
         --ClamAv

Class Constant Summary

DEFAULT_ARCHIVE_MAX_FILES = 1000

DEFAULT_ARCHIVE_MAX_FILE_SIZE = 10

DEFAULT_ARCHIVE_MAX_RECURSION = 8

FILE_CONFIG = '/etc/clamd.conf'

Variable Summary

mixed $config

mixed $is_loaded

Method Summary

ClamAv __construct ()

void __destruct ()

boolean GetArchiveBlockEncrypted ()

int GetMaxFiles ()

int GetMaxFileSize ()

int GetMaxRecursion ()

void SetArchiveBlockEncrypted (boolean $policy)

void SetMaxFiles (int $max)

void SetMaxFileSize (int $max)

void SetMaxRecursion (int $max)

void _LoadConfig ()

void _SetBooleanParameter (string $key, boolean $policy)

void _SetParameter (string $key, string $value)

Variables

mixed $config = array() (line 65)

access: protected

mixed $is_loaded = false (line 64)

access: protected

Inherited Variables

Inherited from Daemon

Daemon::$initscript
Daemon::$package
Daemon::$processname
Daemon::$reloadable
Daemon::$title

Inherited from Software

Software::$copyright
Software::$description
Software::$installsize
Software::$installtime
Software::$packager
Software::$pkgname
Software::$release
Software::$summary
Software::$version

Inherited from Engine

Engine::$errors

Methods

Constructor __construct (line 80)

ClamAV constructor.

ClamAv __construct ()

Redefinition of:

Daemon::__construct(): Daemon constructor.

Destructor __destruct (line 383)

access: public

void __destruct ()

Redefinition of:

Daemon::__destruct()

GetArchiveBlockEncrypted (line 97)

Returns archive encryption policy.

return: true if archives should be marked as a virus if encrypted
throws: EngineException

boolean GetArchiveBlockEncrypted ()

GetMaxFiles (line 122)

Returns maximum number of files to be scanned in an archive.

return: maximum number of files
throws: EngineException

int GetMaxFiles ()

GetMaxFileSize (line 143)

Returns maximum file size inside archive to be scanned (in megabytes).

return: maximum file size
throws: EngineException

int GetMaxFileSize ()

GetMaxRecursion (line 168)

Returns maximum recursion in archive.

For example, if a zip file contains another zip file, files within the second zip will also be scanned. This result from this method specifies the number of iterations.

return: maximum recursion
throws: EngineException

int GetMaxRecursion ()

SetArchiveBlockEncrypted (line 192)

Returns archive encryption policy.

If this parameter is set, encrypted archives will be marked as viruses.

throws: EngineException, ValidationException

void SetArchiveBlockEncrypted (boolean $policy)

boolean $policy: archive encryption policy

SetMaxFiles (line 215)

Sets maximum number of files to be scanned in an archive.

throws: EngineException, ValidationException

void SetMaxFiles (int $max)

int $max: maximum number of files to be scanned in an archive

SetMaxFileSize (line 238)

Sets maximum file size inside archive to be scanned.

throws: EngineException, ValidationException

void SetMaxFileSize (int $max)

int $max: maximum file size inside archive to be scanned

SetMaxRecursion (line 263)

Sets maximum recursion in archive.

throws: EngineException, ValidationException

void SetMaxRecursion (int $max)

int $max: maximum recursion in archive

_LoadConfig (line 289)

Loads configuration files.

throws: EngineException
access: protected

void _LoadConfig ()

_SetBooleanParameter (line 325)

Sets a boolean parameter in the config file.

throws: EngineException
access: protected

void _SetBooleanParameter (string $key, boolean $policy)

string $key: name of the key in the config file
boolean $policy: value for the key

_SetParameter (line 357)

Sets a parameter in the config file.

throws: EngineException
access: protected

void _SetParameter (string $key, string $value)

string $key: name of the key in the config file
string $value: value for the key

Inherited Methods

Inherited From Daemon

Daemon::__construct()
Daemon::GetBootState()
Daemon::GetProcessName()
Daemon::GetRunningState()
Daemon::GetTitle()
Daemon::Reset()
Daemon::Restart()
Daemon::SetBootState()
Daemon::SetRunningState()
Daemon::__destruct()

Inherited From Software

Software::__construct()
Software::GetCopyright()
Software::GetDescription()
Software::GetInstallSize()
Software::GetInstallTime()
Software::GetPackageName()
Software::GetPackager()
Software::GetRelease()
Software::GetRpmInfo()
Software::GetSummary()
Software::GetVersion()
Software::IsInstalled()
Software::__destruct()

Inherited From Engine

Engine::__construct()
Engine::AddValidationError()
Engine::CheckValidationErrors()
Engine::CopyValidationErrors()
Engine::GetValidationErrors()
Engine::Log()
Engine::__destruct()

Class Constants

DEFAULT_ARCHIVE_MAX_FILES = 1000 (line 68)

DEFAULT_ARCHIVE_MAX_FILE_SIZE = 10 (line 69)

DEFAULT_ARCHIVE_MAX_RECURSION = 8 (line 70)

FILE_CONFIG = '/etc/clamd.conf' (line 67)

Inherited Constants

Inherited from Daemon

Daemon::CMD_CHKCONFIG
Daemon::CMD_LS
Daemon::CMD_PIDOF
Daemon::CMD_SERVICE
Daemon::PATH_INITD

Inherited from Software

Software::COMMAND_RPM

Inherited from Engine

Engine::COMMAND_API

ClearFoundation

Class ClamAv

Inherited Variables

Inherited Methods

Inherited Constants

Foundation

Software

Community

Contribute