Soluble\MediaTools\Common\IO\PlatformNullFile

Complexity

Total Complexity

9

Size/Duplication

Total Lines	59
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	1

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getCurrentPlatform()	0	4	2
A	getNullFile()	0	11	3
A	getFile()	0	3	1
A	__construct()	0	13	3

<?php

declare(strict_types=1);

/**
 * @see       https://github.com/soluble-io/soluble-mediatools for the canonical repository
 *
 * @copyright Copyright (c) 2018-2020 Sébastien Vanvelthem. (https://github.com/belgattitude)
 * @license   https://github.com/soluble-io/soluble-mediatools/blob/master/LICENSE.md MIT
 */

namespace Soluble\MediaTools\Common\IO;

use Soluble\MediaTools\Common\Exception\InvalidArgumentException;

final class PlatformNullFile implements UnescapedFileInterface
{
    public const PLATFORM_LINUX = 'LINUX';
    public const PLATFORM_WIN   = 'WINDOWS';

    public const SUPPORTED_PLATFORMS = [
        self::PLATFORM_LINUX,
        self::PLATFORM_WIN,
    ];

    /** @var string $platform if null platform wil be auto detected */
    private $platform;

    /**
     * @param null|string $platform if null platform will be autodetected
     *
     * @throws InvalidArgumentException
     */
    public function __construct(?string $platform = null)
    {
        if ($platform === null) {
            $platform = self::getCurrentPlatform();
        } else {
            if (!in_array(mb_strtoupper($platform), self::SUPPORTED_PLATFORMS, true)) {
                throw new InvalidArgumentException(sprintf(
                    'Platform \'%s\' is not supported',
                    $platform
                ));
            }
        }
        $this->platform = mb_strtoupper($platform);
    }

    public static function getCurrentPlatform(): string
    {
        return defined('PHP_WINDOWS_VERSION_MAJOR')
                    ? self::PLATFORM_WIN : self::PLATFORM_LINUX;
    }

    /**
     * Return /dev/null on linux/unix/mac or NUL on windows.
     */
    public function getNullFile(?string $platform = null): string
    {
        $platform = $platform ?? $this->platform;

        switch ($platform) {
            case self::PLATFORM_WIN:
                return 'NUL';
            // All others for now
            case self::PLATFORM_LINUX:
            default:
                return '/dev/null';
        }
    }

    public function getFile(): string
    {
        return $this->getNullFile();
    }
}