You are here

interface ScannerInterface in ClamAV 8

Same name and namespace in other branches
  1. 2.x src/ScannerInterface.php \Drupal\clamav\ScannerInterface

Provides an interface defining a menu entity.

Hierarchy

Expanded class hierarchy of ScannerInterface

All classes that implement ScannerInterface

3 files declare their use of ScannerInterface
DaemonTCPIP.php in src/Scanner/DaemonTCPIP.php
DaemonUnixSocket.php in src/Scanner/DaemonUnixSocket.php
Executable.php in src/Scanner/Executable.php

File

src/ScannerInterface.php, line 11

Namespace

Drupal\clamav
View source
interface ScannerInterface {

  /**
   * Constructor.
   *
   * @param Drupal\clamav\Config $config
   *   Configuration to use.
   */
  public function __construct(Config $config);

  /**
   * Scan a file.
   *
   * @param Drupal\file\FileInterface $file
   *   The file to scan for viruses.
   *
   * @return int
   *   - Scanner::FILE_IS_CLEAN
   *   - Scanner::FILE_IS_INFECTED
   *   - Scanner::FILE_IS_UNCHECKED
   */
  public function scan(FileInterface $file);

  /**
   * The version of the ClamAV service.
   *
   * @return string
   *   The version number provided by ClamAV.
   */
  public function version();

}

Members

Namesort descending Modifiers Type Description Overrides
ScannerInterface::scan public function Scan a file. 3
ScannerInterface::version public function The version of the ClamAV service. 3
ScannerInterface::__construct public function Constructor. 3