TxTextControl\ReportingCloud\Stdlib\FileUtils

Complexity

Total Complexity

5

Size/Duplication

Total Lines	43
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	read()	0	10	2
A	write()	0	10	3

<?php
declare(strict_types=1);

/**
 * ReportingCloud PHP SDK
 *
 * PHP SDK for ReportingCloud Web API. Authored and supported by Text Control GmbH.
 *
 * @link      https://www.reporting.cloud to learn more about ReportingCloud
 * @link      https://git.io/Jejj2 for the canonical source repository
 * @license   https://git.io/Jejjr
 * @copyright © 2022 Text Control GmbH
 */

namespace TxTextControl\ReportingCloud\Stdlib;

/**
 * Class FileUtils
 *
 * @package TxTextControl\ReportingCloud
 */
class FileUtils extends AbstractStdlib
{
    /**
     * Read a filename from filesystem and return its binary data.
     * Optionally, base64 encode the returned binary data.
     *
     * @param string $filename
     * @param bool   $base64Encode
     *
     * @return string
     */
    public static function read(string $filename, bool $base64Encode = false): string
    {
        $binaryData = file_get_contents($filename);
        assert(is_string($binaryData));

        if ($base64Encode) {
            $binaryData = base64_encode($binaryData);
        }

        return $binaryData;
    }

    /**
     * Write binary data to a filename on filesystem.
     * Optionally, based decode the binary data before writing.
     *
     * @param string $filename
     * @param string $binaryData
     * @param bool   $base64Encoded
     *
     * @return bool
     */
    public static function write(string $filename, string $binaryData, bool $base64Encoded = false): bool
    {
        if ($base64Encoded) {
            $binaryData = base64_decode($binaryData, true);
            assert(is_string($binaryData));
        }

        $result = file_put_contents($filename, $binaryData);

        return is_int($result) && $result > 0;
    }
}