229. Class

229.1. Zend\Filter\Compress\Rar

Compression adapter for Rar

229.1.1. Methods

229.1.1.1. __construct

__construct()

Class constructor

Parameters:array – (Optional) Options to set Throws ExceptionExtensionNotLoadedException:  if rar extension not loaded

229.1.1.2. getCallback

getCallback()

Returns the set callback for compression

Return type:string

229.1.1.3. setCallback

setCallback()

Sets the callback to use

Parameters:string – Return type:Rar Throws :ExceptionInvalidArgumentException if invalid callback provided

229.1.1.4. getArchive

getArchive()

Returns the set archive

Return type:string

229.1.1.5. setArchive

setArchive()

Sets the archive to use for de-/compression

Parameters:string – Archive to use Return type:Rar

229.1.1.6. getPassword

getPassword()

Returns the set password

Return type:string

229.1.1.7. setPassword

setPassword()

Sets the password to use

Parameters:string – Return type:Rar

229.1.1.8. getTarget

getTarget()

Returns the set targetpath

Return type:string

229.1.1.9. setTarget

setTarget()

Sets the targetpath to use

Parameters:string – Return type:Rar Throws :ExceptionInvalidArgumentException if specified target directory does not exist

229.1.1.10. compress

compress()

Compresses the given content

Parameters:string|array – Return type:string Throws :ExceptionRuntimeException if no callback available, or error during compression

229.1.1.11. decompress

decompress()

Decompresses the given content

Parameters:string – Return type:bool Throws :ExceptionRuntimeException if archive not found, cannot be opened, or error during decompression

229.1.1.12. toString

toString()

Returns the adapter name

Return type:string