phpbu\App\Backup\Target\Compression\Abstraction

Complexity

Total Complexity

7

Size/Duplication

Total Lines	107
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

86.67%

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getCommand()	0	4	1
A	getAcceptableExitCodes()	0	4	1
A	getPath()	0	4	1
A	getSuffix()	0	4	1
A	isPipeable()	0	4	1
A	getMimeType()	0	4	1

<?php
namespace phpbu\App\Backup\Target\Compression;

use phpbu\App\Backup\Target\Compression;

/**
 * Abstraction
 *
 * @package    phpbu
 * @subpackage Backup
 * @author     Sebastian Feldmann <sebastian@phpbu.de>
 * @copyright  Sebastian Feldmann <sebastian@phpbu.de>
 * @license    https://opensource.org/licenses/MIT The MIT License (MIT)
 * @link       http://phpbu.de/
 * @since      Class available since Release 3.2.1
 */
abstract class Abstraction implements Compression
{
    /**
     * Command name
     *
     * @var string
     */
    protected $cmd;

    /**
     * Path to command binary
     *
     * @var string
     */
    protected $path;

    /**
     * Suffix for compressed files
     *
     * @var string
     */
    protected $suffix;

    /**
     * MIME type for compressed files
     *
     * @var string
     */
    protected $mimeType;

    /**
     * Can this compression compress piped output
     *
     * @var bool
     */
    protected $pipeable;

    /**
     * Constructor.
     *
     * @param string $path
     */
    public function __construct(string $path = '')
    {
        $this->path = $path;
    }

    /**
     * Return the cli command.
     *
     * @return string
     */
    public function getCommand() : string
    {
        return $this->cmd;
    }

    /**
     * Return a list of acceptable exit codes.
     *
     * @return int[]
     */
    public function getAcceptableExitCodes(): array
    {
        return [0];
    }

    /**
     * Path getter.
     *
     * @return string
     */
    public function getPath() : string
    {
        return $this->path;
    }

    /**
     * Returns the compressor suffix e.g. 'bz2'.
     *
     * @return string
     */
    public function getSuffix() : string
    {
        return $this->suffix;
    }

    /**
     * Is the compression app pipeable.
     *
     * @return bool
     */
    public function isPipeable() : bool
    {
        return $this->pipeable;
    }

    /**
     * Returns the compressor mime type.
     *
     * @return string
     */
    public function getMimeType() : string
    {
        return $this->mimeType;
    }
}