0.9

used "skyzyx/mimetypes": "^1.1"

Author: KarelWintersky

.gitattributes

@@ -0,0 +1,8 @@
+* text=auto
+* eol=lf
+
+.git				export-ignore
+.gitattributes      export-ignore
+.gitignore          export-ignore
+
+

.gitignore

@@ -0,0 +1,2 @@
+/vendor/
+composer.lock

README.md

@@ -0,0 +1,61 @@
+# PHP File Download
+
+A class to help with creating downloads for files in PHP.
+
+
+## Tip
+If you can use direct downloads, you should just use them.
+This class is for providing downloads of files out of PHP, for example if you want to provide a download to a temporarily created file.
+
+# Usage
+
+The examples assume, that you have included the namespace:
+```php
+use Arris\Toolkit\FileDownload;
+```
+
+
+## Create a download for a file on your file system
+```php
+$fileDownload = FileDownload::createFromFilePath("/path/to/file.pdf");
+$fileDownload->sendDownload("download.pdf");
+```
+
+
+## Create a download for a file via file pointer
+```php
+$file = /* your file, somewhere opened with fopen() or tmpfile(), etc.. */;
+$fileDownload = new FileDownload($file);
+$fileDownload->sendDownload("download.pdf");
+```
+
+
+## Create a download for a file via content
+```php
+$content = "This is the content of the file:";
+$fileDownload = FileDownload::createFromString($content);
+$fileDownload->sendDownload("download.txt");
+```
+
+For example, you can create downloads for PDF files, generated by Zend (or any other library):
+
+```php
+$pdf = new Zend_Pdf();
+$page = $pdf->newPage(Zend_Pdf_Page::SIZE_A4);
+$pdf->pages[] = $page;
+
+/* draw content in the pdf ... */
+
+$fileDownload = FileDownload::createFromString($pdf->render());
+$fileDownload->sendDownload("download.pdf");
+```
+
+## NB
+
+Если в методе `sendDownload()` опустить имя файла - оно будет равно имени файла, которое передали конструктору.
+
+Есть нюанс: если файл создается из строки: `createFromString()` - отсутствие аргумента в `sendDownload()` предписывает
+скачать файл с пустым именем. Последствия неизвестны. 
+
+
+

composer.json

@@ -0,0 +1,21 @@
+{
+    "name": "karelwintersky/arris.php-file-download",
+    "description": "A library to help with creating downloads for files in PHP",
+    "type": "library",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Karel Wintersky",
+            "email": "[email protected]"
+        }
+    ],
+    "require": {
+        "php": ">7.2",
+        "skyzyx/mimetypes": "^1.1"
+    },
+    "autoload": {
+        "psr-4": {
+            "Arris\\Toolkit\\": "src/"
+        }
+    }
+}

src/FileDownload.php

@@ -0,0 +1,140 @@
+<?php
+/**
+ * Provides the possibility to easily create file downloads in PHP
+ *
+ * @author Jannik Zschiesche <[email protected]>
+ * @author Karel Wintersky <[email protected]>
+ * @version 1.0
+ * @license MIT
+ */
+
+namespace Arris\Toolkit;
+
+use InvalidArgumentException;
+use RuntimeException;
+use Skyzyx\Components\Mimetypes\Mimetypes;
+
+class FileDownload implements FileDownloadInterface
+{
+    /**
+     * The pointer to the file to download
+     *
+     * @var resource
+     */
+    private $filePointer;
+
+    /**
+     * @var string
+     */
+    private $fileName;
+
+    /**
+     * Constructs a new file download
+     *
+     * @param resource $filePointer
+     *
+     * @throws InvalidArgumentException
+     */
+    public function __construct($filePointer, string $filePath)
+    {
+        if (!is_resource($filePointer)) {
+            throw new InvalidArgumentException("You must pass a file pointer to the constructor");
+        }
+
+        $this->filePointer = $filePointer;
+        $this->fileName = pathinfo($filePath, PATHINFO_BASENAME);
+    }
+
+    public function sendDownload(string $filename = '', bool $forceDownload = true)
+    {
+        if (headers_sent()) {
+            throw new RuntimeException("Cannot send file to the browser, since the headers were already sent.");
+        }
+
+        if (empty($filename)) {
+            $filename = $this->fileName;
+        }
+
+        header("Pragma: public");
+        header("Expires: 0");
+        header("Cache-Control: must-revalidate, post-check=0, pre-check=0");
+        header("Cache-Control: private", false);
+        header("Content-Type: {$this->getMimeType($filename)}");
+
+        if ($forceDownload) {
+            header("Content-Disposition: attachment; filename=\"{$filename}\";");
+        } else {
+            header("Content-Disposition: filename=\"{$filename}\";");
+        }
+
+        header("Content-Transfer-Encoding: binary");
+        header("Content-Length: {$this->getFileSize()}");
+
+        @ob_clean();
+
+        rewind($this->filePointer);
+        fpassthru($this->filePointer);
+    }
+
+    /**
+     * Returns the mime type of a file name
+     *
+     * @param string $fileName
+     *
+     * @return string
+     */
+    private function getMimeType(string $fileName): string
+    {
+        $fileExtension = pathinfo($fileName, PATHINFO_EXTENSION);
+        $mimeTypeHelper = Mimetypes::getInstance();
+        $mimeType = $mimeTypeHelper->fromExtension($fileExtension);
+
+        return !is_null($mimeType) ? $mimeType : "application/force-download";
+    }
+
+    /**
+     * Returns the file size of the file
+     *
+     * @return int
+     */
+    public function getFileSize(): int
+    {
+        $stat = fstat($this->filePointer);
+        if ($stat === false) {
+            throw new RuntimeException("Get File size error");
+        }
+
+        return $stat['size'];
+    }
+
+    public static function createFromFilePath(string $filePath): FileDownloadInterface
+    {
+        if (!is_file($filePath)) {
+            throw new InvalidArgumentException("File does not exist");
+        } else if (!is_readable($filePath)) {
+            throw new InvalidArgumentException("File to download is not readable");
+        }
+
+        return new static(fopen($filePath, "rb"), $filePath);
+    }
+
+    public static function createFromString(string $content): FileDownloadInterface
+    {
+        $file = tmpfile();
+        fwrite($file, $content);
+
+        return new static($file, '');
+    }
+
+    public static function createFromResource($fileResource): FileDownloadInterface
+    {
+        $meta_data = stream_get_meta_data($fileResource);
+        $filename = $meta_data["uri"];
+
+        return new static($fileResource, $filename);
+    }
+
+
+}
+
+# -eof-

src/FileDownloadInterface.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace Arris\Toolkit;
+
+use InvalidArgumentException;
+use RuntimeException;
+
+interface FileDownloadInterface
+{
+    /**
+     * Constructs a new file download
+     *
+     * @param resource $filePointer
+     *
+     * @throws InvalidArgumentException
+     */
+    public function __construct($filePointer, string $filePath);
+
+    /**
+     * Sends the download to the browser
+     *
+     * @param string $filename
+     * @param bool $forceDownload
+     *
+     * @throws RuntimeException would thrown if the headers are already sent
+     */
+    public function sendDownload(string $filename = '', bool $forceDownload = true);
+
+    /**
+     * Returns the file size of the file
+     *
+     * @return int
+     */
+    public function getFileSize(): int;
+
+    /**
+     * Creates a new file download from a file path
+     *
+     * @param string $filePath
+     *
+     * @return FileDownloadInterface
+     * @throws InvalidArgumentException is thrown, if the given file does not exist or is not readable
+     *
+     */
+    public static function createFromFilePath(string $filePath): FileDownloadInterface;
+
+    /**
+     * Creates a new file download helper with a given content
+     *
+     * @static
+     *
+     * @param string $content the file content
+     *
+     * @return FileDownloadInterface
+     */
+    public static function createFromString(string $content): FileDownloadInterface;
+}