BasicDriver::wrapStringInStream() - Code Metrics - Inspection of "Update PclZip interface" - wapmorgan/UnifiedArchive - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 3f67b7...07fe76 )

by f
created 2021-02-24 01:27 UTC
BasicDriver::wrapStringInStream() A

↳ Parent: BasicDriver
Complexity

Conditions	1
Paths	1
Size

Total Lines	6
Code Lines	4
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	5
CRAP Score	1
Importance

Changes
Metric	Value
eloc	4
c	0
b	0
f	0
dl	0
loc	6
ccs	5
cts	5
cp	1
rs	10
cc	1
nc	1
nop	1
crap	1
<?php
namespace wapmorgan\UnifiedArchive\Drivers;

use wapmorgan\UnifiedArchive\ArchiveEntry;
use wapmorgan\UnifiedArchive\ArchiveInformation;
use wapmorgan\UnifiedArchive\Exceptions\ArchiveCreationException;
use wapmorgan\UnifiedArchive\Exceptions\ArchiveExtractionException;
use wapmorgan\UnifiedArchive\Exceptions\ArchiveModificationException;
use wapmorgan\UnifiedArchive\Exceptions\UnsupportedArchiveException;
use wapmorgan\UnifiedArchive\Exceptions\UnsupportedOperationException;
use wapmorgan\UnifiedArchive\PclzipZipInterface;

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

    /**
     * @return mixed
     * @throws UnsupportedOperationException
     */
    public static function getSupportedFormats()
    {
        throw new UnsupportedOperationException();
    }

    /**
     * @param $format
     * @throws UnsupportedOperationException
     */
    public static function checkFormatSupport($format)
    public static function checkFormatSupport(/** @scrutinizer ignore-unused */ $format)
    {
        throw new UnsupportedOperationException();
    }

    /**
     * @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)
    public static function canCreateArchive(/** @scrutinizer ignore-unused */ $format)
    {
        return false;
    }

    /**
     * @param $format
     * @return bool
     */
    public static function canAddFiles($format)
    public static function canAddFiles(/** @scrutinizer ignore-unused */ $format)
    {
        return false;
    }

    /**
     * @param $format
     * @return bool
     */
    public static function canDeleteFiles($format)
    public static function canDeleteFiles(/** @scrutinizer ignore-unused */ $format)
    {
        return false;
    }

    /**
     * @param $format
     * @return false
     */
    public static function canEncrypt($format)
    public static function canEncrypt(/** @scrutinizer ignore-unused */ $format)
    {
        return false;
    }

    /**
     * @param $format
     * @return false
     */
    public static function canStream($format)
    public static function canStream(/** @scrutinizer ignore-unused */ $format)
    {
        return false;
    }

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

     * @return int Number of archived files
     * @throws UnsupportedOperationException
     */
    public static function createArchive(array $files, $archiveFileName, $compressionLevel = self::COMPRESSION_AVERAGE, $password = null)
    public static function createArchive(array $files, $archiveFileName, /** @scrutinizer ignore-unused */ $compressionLevel = self::COMPRESSION_AVERAGE, $password = null)
    {
        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
     */
    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)
    public function deleteFiles(/** @scrutinizer ignore-unused */ array $files)
    {
        throw new UnsupportedOperationException();
    }

    /**
     * @param array $files
     * @return int Number of added files
     * @throws UnsupportedOperationException
     * @throws ArchiveModificationException
     */
    public function addFiles(array $files)
    public function addFiles(/** @scrutinizer ignore-unused */ array $files)
    {
        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)
    public function setComment(/** @scrutinizer ignore-unused */ $comment)
    {
        return null;
    }
}
wapmorgan / UnifiedArchive

Push — master ( 3f67b7...07fe76 )

BasicDriver::wrapStringInStream() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
