Skip to content

Reference

phil/upload-scan
TypeKindRole
Phil\UploadScan\Contract\ScannerinterfaceAn antivirus: scanStream(), scanPath()
Phil\UploadScan\Contract\ScannerProbeinterfaceWhether the engine answers: ping(), version()
Phil\UploadScan\Contract\ClamdConnectorinterfaceA connection to clamd: connect()
Phil\UploadScan\ScanResultfinal readonly classClean, infected or an error: clean(), infected(), error(), isClean(), isInfected(), isError(), MAX_TEXT_BYTES
Phil\UploadScan\ScanStatusenumclean, infected, error
Phil\UploadScan\ScanPolicyfinal readonly classA result to a decision: decide()
Phil\UploadScan\OnScanErrorenumreject, accept_and_flag
Phil\UploadScan\Decisionenumaccept, flag, reject; keeps()
Phil\UploadScan\Clamd\ClamdScannerfinal readonly classclamd over its protocol: at(), scanStream(), scanPath(), ping(), version(), DEFAULT_MAX_BYTES, DEFAULT_CHUNK_BYTES
Phil\UploadScan\Clamd\SocketConnectorfinal readonly classA Unix or TCP socket to clamd
Phil\UploadScan\Clamd\ClamdResponsefinal classThe reader of clamd's answers: scan(), isPong(), version(), MAX_BYTES
Phil\UploadScan\NullScannerfinal readonly classEvery file clean
Phil\UploadScan\FakeScannerfinal readonly classThe EICAR string and given needles infected: eicar(), EICAR_SIGNATURE
Phil\UploadScan\Exception\UploadScanExceptioninterfaceEvery exception of the library
Phil\UploadScan\Exception\InvalidArgumentfinal classA value the library refuses
Phil\UploadScan\Exception\ScannerUnavailablefinal classclamd cannot be reached, thrown by a connector