wapmorgan\UnifiedArchive\Drivers\BasicDriver

Complexity

Total Complexity

13

Size/Duplication

Total Lines	237
Duplicated Lines	0 %

Test Coverage

Coverage

15.15%

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	canCreateArchive()	0	3	1
A	canEncrypt()	0	3	1
A	getComment()	0	3	1
A	canDeleteFiles()	0	3	1
A	deleteFiles()	0	3	1
A	addFiles()	0	3	1
A	setComment()	0	3	1
A	canAddFiles()	0	3	1
A	getInstallationInstruction()	0	3	1
A	canStream()	0	3	1
A	createArchive()	0	9	1
A	getDescription()	0	3	1
A	wrapStringInStream()	0	6	1

<?php
namespace wapmorgan\UnifiedArchive\Drivers;

use wapmorgan\UnifiedArchive\ArchiveEntry;
use wapmorgan\UnifiedArchive\ArchiveInformation;
use wapmorgan\UnifiedArchive\Exceptions\ArchiveExtractionException;
use wapmorgan\UnifiedArchive\Exceptions\ArchiveModificationException;
use wapmorgan\UnifiedArchive\Exceptions\NonExistentArchiveFileException;
use wapmorgan\UnifiedArchive\Exceptions\UnsupportedOperationException;

abstract class BasicDriver
{
    const COMPRESSION_NONE = 0;
    const COMPRESSION_WEAK = 1;
    const COMPRESSION_AVERAGE = 2;
    const COMPRESSION_STRONG = 3;
    const COMPRESSION_MAXIMUM = 4;

    const OPEN = 1;
    const OPEN_ENCRYPTED = 2;
    const OPEN_VOLUMED = 4;

    const GET_COMMENT = 64;
    const EXTRACT_CONTENT = 128;
    const STREAM_CONTENT = 256;

    const APPEND = 4096;
    const DELETE = 8192;
    const SET_COMMENT = 16384;

    const CREATE = 1048576;
    const CREATE_ENCRYPTED = 2097152;

    /**
     * @return array
     */
    abstract public static function getSupportedFormats();

    /**
     * @param $format
     * @return array
     */
    abstract public static function checkFormatSupport($format);

    /**
     * @return string
     */
    public static function getDescription()
    {
        return null;
    }

    /**
     * @return string
     */
    public static function getInstallationInstruction()
    {
        return null;
    }

    /**
     * @param $format
     * @return bool
     */
    public static function canCreateArchive($format)

The parameter $format is not used and could be removed.

    {
        return false;
    }

    /**
     * @param $format
     * @return bool
     */
    public static function canAddFiles($format)

The parameter $format is not used and could be removed.

    {
        return false;
    }

    /**
     * @param $format
     * @return bool
     */
    public static function canDeleteFiles($format)

The parameter $format is not used and could be removed.

    {
        return false;
    }

    /**
     * @param $format
     * @return false
     */
    public static function canEncrypt($format)

The parameter $format is not used and could be removed.

    {
        return false;
    }

    /**
     * @param $format
     * @return false
     */
    public static function canStream($format)

The parameter $format is not used and could be removed.

    {
        return false;
    }

    /**
     * @param array $files
     * @param string $archiveFileName
     * @param string $archiveFormat
     * @param int $compressionLevel
     * @param null $password

Are you sure the doc-type for parameter $password is correct as it would always require null to be passed?

     * @param $fileProgressCallable
     * @return int Number of archived files
     * @throws UnsupportedOperationException
     */
    public static function createArchive(
        array $files,

The parameter $files is not used and could be removed.

        $archiveFileName,

The parameter $archiveFileName is not used and could be removed.

        $archiveFormat,

The parameter $archiveFormat is not used and could be removed.

        $compressionLevel = self::COMPRESSION_AVERAGE,

The parameter $compressionLevel is not used and could be removed.

        $password = null,

The parameter $password is not used and could be removed.

        $fileProgressCallable = null

The parameter $fileProgressCallable is not used and could be removed.

    ) {
        throw new UnsupportedOperationException();
    }

    /**
     * BasicDriver constructor.
     * @param string $archiveFileName
     * @param string $format
     * @param string|null $password Archive password for opening
     */
    abstract public function __construct($archiveFileName, $format, $password = null);

    /**
     * Returns summary about an archive.
     * Called after
     * - constructing
     * - addFiles()
     * - deleteFiles()
     * @return ArchiveInformation
     */
    abstract public function getArchiveInformation();

    /**
     * @return array
     */
    abstract public function getFileNames();

    /**
     * @param string $fileName
     * @return bool
     */
    abstract public function isFileExists($fileName);

    /**
     * @param string $fileName
     * @return ArchiveEntry|false
     */
    abstract public function getFileData($fileName);

    /**
     * @param string $fileName
     * @return string|false
     * @throws NonExistentArchiveFileException
     */
    abstract public function getFileContent($fileName);

    /**
     * @param string $fileName
     * @return resource
     */
    abstract public function getFileStream($fileName);

    /**
     * @param $string
     * @return resource
     */
    public static function wrapStringInStream($string)
    {
        $resource = fopen('php://temp', 'r+');
        fwrite($resource, $string);
        rewind($resource);
        return $resource;
    }

    /**
     * @param string $outputFolder
     * @param array  $files
     * @return int Number of extracted files
     * @throws ArchiveExtractionException
     */
    abstract public function extractFiles($outputFolder, array $files);

    /**
     * @param string $outputFolder
     * @return int Number of extracted files
     * @throws ArchiveExtractionException
     */
    abstract public function extractArchive($outputFolder);

    /**
     * @param array $files
     * @return false|int Number of deleted files
     * @throws UnsupportedOperationException
     * @throws ArchiveModificationException
     */
    public function deleteFiles(array $files)

The parameter $files is not used and could be removed.

    {
        throw new UnsupportedOperationException();
    }

    /**
     * @param array $files
     * @return int Number of added files
     * @throws UnsupportedOperationException
     * @throws ArchiveModificationException
     */
    public function addFiles(array $files)

The parameter $files is not used and could be removed.

    {
        throw new UnsupportedOperationException();
    }

    /**
     * @param string $inArchiveName
     * @param string $content
     * @return bool
     * @throws UnsupportedOperationException
     * @throws ArchiveModificationException
     */
    abstract public function addFileFromString($inArchiveName, $content);

    /**
     * @return string|null
     */
    public function getComment()
    {
        return null;
    }

    /**
     * @param string|null $comment
     * @return null
     */
    public function setComment($comment)

The parameter $comment is not used and could be removed.

    {
        return null;
    }
}