ClearFoundation

ClearOS API

Class FileScan

Description
Description | Vars | Methods (details) Constants (details)

FileScan base class.

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

Engine
   |
   --FileScan
Class Constant Summary
Description | Constants (details) Vars | | Methods (details)
CMD_KILLALL = '/usr/bin/killall'
FILE_AVSCAN = 'avscan.php'
Method Summary
Description | Constants (details) Vars | Methods (details)
FileScan __construct ()
void __destruct ()
void AddDirectory (string $dir)
void DeleteQuarantinedVirus (string $hash)
void DeleteVirus (string $hash)
void EnableUpdates ()
array GetDirectories ()
array GetDirectoryPresets ()
array GetQuarantinedViruses ()
array GetScanSchedule ()
void QuarantineVirus (string $hash)
void RemoveDirectory (string $dir)
void RemoveScanSchedule ()
void RestoreQuarantinedVirus (string $hash)
boolean ScanScheduleExists ()
void SetScanSchedule (string $minute, string $hour, string $dayofmonth, string $month, string $dayofweek)
void StartScan ()
void StopScan ()
Variables
Description | Vars (details) Constants (details) | Methods (details)

Inherited Variables

Inherited from Engine

Engine::$errors
Methods
Description | Vars Constants (details) Methods (details)
Constructor __construct (line 71)
  • access: public
FileScan __construct ()
Redefinition of:
Engine::__construct()
Engine constructor.
Destructor __destruct (line 569)
  • access: public
void __destruct ()
Redefinition of:
Engine::__destruct()
AddDirectory (line 88)

Adds directory to scan list.

  • throws: EngineException
  • access: public
void AddDirectory (string $dir)
  • string $dir: Directory to scan
DeleteQuarantinedVirus (line 378)

Deletes a quarantined virus.

  • throws: EngineException
  • access: public
void DeleteQuarantinedVirus (string $hash)
  • string $hash: MD5 hash of virus filename to delete
DeleteVirus (line 217)

Deletes a virus.

  • throws: EngineException
  • access: public
void DeleteVirus (string $hash)
  • string $hash: MD5 hash of virus filename to delete
EnableUpdates (line 551)

Enables antivirus definition updates.

  • throws: EngineException
  • access: public
void EnableUpdates ()
GetDirectories (line 163)

Retturns array of directories configured to scan for viruses.

  • return: of directory names
  • throws: EngineException
  • access: public
array GetDirectories ()
GetDirectoryPresets (line 191)

Returns array of preset directories.

  • return: of human directory names keyed by filessytem directory name
  • access: public
array GetDirectoryPresets ()
GetQuarantinedViruses (line 314)

Returns array of quarantined viruses.

  • return: Array of viruses in quarantine
  • throws: EngineException
  • access: public
array GetQuarantinedViruses ()
GetScanSchedule (line 506)

Returns configured antivirus schedule.

  • return: of the scanner's configured schedule.
  • throws: EngineException
  • access: public
array GetScanSchedule ()
QuarantineVirus (line 264)

Quarantines a virus.

  • throws: EngineException
  • access: public
void QuarantineVirus (string $hash)
  • string $hash: MD5 hash of virus filename to quarantine
RemoveDirectory (line 130)

Removes directory from scan list.

  • throws: EngineException
  • access: public
void RemoveDirectory (string $dir)
  • string $dir: Directory to remove from scan
RemoveScanSchedule (line 484)

Removes an antivirus schedule.

  • throws: EngineException
  • access: public
void RemoveScanSchedule ()
RestoreQuarantinedVirus (line 354)

Restores a quarantined virus to its orignal location/filename.

  • throws: EngineException
  • access: public
void RestoreQuarantinedVirus (string $hash)
  • string $hash: MD5 hash of virus filename to restore
ScanScheduleExists (line 535)

Checks for existence of scan schedule.

  • return: true if a cron configlet exists.
  • throws: EngineException
  • access: public
boolean ScanScheduleExists ()
SetScanSchedule (line 461)

Sets an antivirus schedule.

  • throws: EngineException
  • access: public
void SetScanSchedule (string $minute, string $hour, string $dayofmonth, string $month, string $dayofweek)
  • string $minute: cron minute value
  • string $hour: cron hour value
  • string $dayofmonth: cron day-of-month value
  • string $month: cron month value
  • string $dayofweek: cron day-of-week value
StartScan (line 400)

Starts virus scanner.

  • throws: EngineException
  • access: public
void StartScan ()
StopScan (line 429)

Stops virus scanner.

  • throws: EngineException
  • access: public
void StopScan ()

Inherited Methods

Inherited From Engine

Engine::__construct()
Engine::AddValidationError()
Engine::CheckValidationErrors()
Engine::CopyValidationErrors()
Engine::GetValidationErrors()
Engine::Log()
Engine::__destruct()
Class Constants
Description | Constants (details) Vars | Methods (details)
CMD_KILLALL = '/usr/bin/killall' (line 65)
FILE_AVSCAN = 'avscan.php' (line 64)

Inherited Constants

Inherited from Engine

Engine::COMMAND_API

Documentation generated on Fri, 28 Aug 2009 20:32:05 -0400 by phpDocumentor 1.3.2