xenolope/quahog

Breaking Changes

• Made the minimum supported version PHP 7.3
• Introduced a value object for scan result (#38)

The previous array-based structure returned by scan results has been changed to a strictly-typed object. See the README.md for more details, or check out this snippet:

// Result is an instance of \Xenolope\Quahog\Result.
$result = $quahog->scanFile('/tmp/virusfile');
// A result id of a session that was used.
$result->getId();
// The file name of the scanned file.
$result->getFilename();
// The reason why a scan resulted in a failure. Returns null if the scan was successful.
$result->getReason();
// A boolean value that is true, in case the scan was successful.
$result->isOk();
// A boolean value that is true, in case the scan failed. This is the opposite of isOk().
$result->hasFailed();
// A boolean value that is true, if a virus was found.
$result->isFound();
// A boolean value that is true, if an error happened.
$result->isError();

Improvements

• Added missing documentation for using startSession and endSession (#29)
• Added missing documentation for using a TCP socket (#36)
• Fixed PHPDoc return types (#31)
• Fixed incompatibility with Composer 2.0
• Added PHP 7.3 to the tested versions matrix (#37)
• Added PHP 7.4 to the tested versions matrix (#41)
• Added PHP 8.0 to the tested versions matrix (#43)
• Replaced Travis CI with GitHub Actions (#42)

Thanks

Big thanks to all who contributed towards this long-awaited release!

• @SenseException
• @derikb
• @jkrehm
• @bkuhl

Bug Fixes

• Fixed incompatibility with Composer v2

Bug Fixes

• Fixed session mode breaking over TCP connections (massive thanks to @davidvanlaatum!)

General

• Sped up Travis CI builds significantly

Miscellaneous

• Changed package vendor and name to xenolope/quahog

New Features

• Added Client::scanLocalFile() for scanning a file
• Added Client::scanResourceStream() for scanning a resource stream

Improvements

• Changed visibility of methods and properties to protected
• Dropped support for PHP 5.3, 5.4 and 5.5 and gained support for PHP 5.6 and 7.0
• Changed autoloading to be PSR-4 compatible
• Now requiring phpunit/phpunit as a require-dev dependency
• Removed old blur Group associations
• Now adhering to Composer namespace recommendations (Xenolope\Quahog)
• Updated tests to use virtual file system

Thanks to @MassiveHiggsField, @jchamberlain, @gimler, @TheOnlyMerlin and @lbialy for their contributions!