phpbu\App\Backup\Target\Compression

Complexity

Total Complexity

9

Size/Duplication

Total Lines	139
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	3
Bugs	0	Features	1

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	getCommand()	0	4	1
A	getPath()	0	4	1
A	getSuffix()	0	4	1
A	isPipeable()	0	4	1
A	getMimeType()	0	4	1
A	create()	0	14	3

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

use phpbu\App\Exception;

/**
 * Compression
 *
 * @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 1.0.0
 */
class Compression
{
    /**
     * Path to command binary
     *
     * @var string
     */
    protected $path;

    /**
     * Command name
     *
     * @var string
     */
    protected $cmd;

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

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

    /**
     * List of available compressors
     *
     * @var array
     */
    protected static $availableCompressors = [
        'gzip' => [
            'pipeable' => true,
            'suffix'   => 'gz',
            'mime'     => 'application/x-gzip'
        ],
        'bzip2' => [
            'pipeable' => true,
            'suffix'   => 'bz2',
            'mime'     => 'application/x-bzip2'
        ],
        'zip' => [
            'pipeable' => false,
            'suffix'   => 'zip',
            'mime'     => 'application/zip'
        ]
    ];

    /**
     * Constructor.
     *
     * @param string $cmd
     * @param string $pathToCmd without trailing slash
     */
    public function __construct($cmd, $pathToCmd = null)
    {
        $this->path     = $pathToCmd;
        $this->cmd      = $cmd;
        $this->suffix   = self::$availableCompressors[$cmd]['suffix'];
        $this->mimeType = self::$availableCompressors[$cmd]['mime'];
    }

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

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

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

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

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

    /**
     * Factory method.
     *
     * @param  string $name
     * @return \phpbu\App\Backup\Target\Compression
     * @throws \phpbu\App\Exception
     */
    public static function create($name)
    {
        $path = null;
        // check if a path is given for the compressor
        if (basename($name) !== $name) {
            $path = dirname($name);
            $name = basename($name);
        }

        if (!isset(self::$availableCompressors[$name])) {
            throw new Exception('invalid compressor:' . $name);
        }
        return new static($name, $path);
    }
}