vitormicillo /
pdf-fusion-laravel
@@ -6,226 +6,226 @@ |
||
| 6 | 6 | use Illuminate\Support\Str; |
| 7 | 7 | |
| 8 | 8 | class PdfFusionLaravel { |
| 9 | - /** |
|
| 10 | - * Access the filesystem on an oop base |
|
| 11 | - * |
|
| 12 | - * @var Filesystem |
|
| 13 | - */ |
|
| 14 | - protected $filesystem = Filesystem::class; |
|
| 15 | - /** |
|
| 16 | - * Hold all the files which will be merged |
|
| 17 | - * |
|
| 18 | - * @var Collection |
|
| 19 | - */ |
|
| 20 | - protected $files = Collection::class; |
|
| 21 | - /** |
|
| 22 | - * Holds every tmp file so they can be removed during the deconstruction |
|
| 23 | - * |
|
| 24 | - * @var Collection |
|
| 25 | - */ |
|
| 26 | - protected $tmpFiles = Collection::class; |
|
| 27 | - /** |
|
| 28 | - * The actual PDF Service |
|
| 29 | - * |
|
| 30 | - * @var FPDI |
|
| 31 | - */ |
|
| 32 | - protected $fpdi = Fpdi::class; |
|
| 33 | - /** |
|
| 34 | - * The final file name |
|
| 35 | - * |
|
| 36 | - * @var string |
|
| 37 | - */ |
|
| 38 | - protected $fileName = 'undefined.pdf'; |
|
| 39 | - /** |
|
| 40 | - * Construct and initialize a new instance |
|
| 41 | - * @param Filesystem $Filesystem |
|
| 42 | - */ |
|
| 43 | - public function __construct(Filesystem $filesystem){ |
|
| 44 | - $this->filesystem = $filesystem; |
|
| 45 | - $this->createDirectoryForTemporaryFiles(); |
|
| 46 | - $this->fpdi = new Fpdi(); |
|
| 47 | - $this->tmpFiles = collect([]); |
|
| 48 | - $this->files = collect([]); |
|
| 49 | - } |
|
| 50 | - /** |
|
| 51 | - * The class deconstructor method |
|
| 52 | - */ |
|
| 53 | - public function __destruct() { |
|
| 54 | - $filesystem = $this->filesystem; |
|
| 55 | - $this->tmpFiles->each(function($filePath) use($filesystem){ |
|
| 56 | - $filesystem->delete($filePath); |
|
| 57 | - }); |
|
| 58 | - } |
|
| 59 | - /** |
|
| 60 | - * Initialize a new internal instance of FPDI in order to prevent any problems with shared resources |
|
| 61 | - * Please visit https://www.setasign.com/products/fpdi/manual/#p-159 for more information on this issue |
|
| 62 | - * |
|
| 63 | - * @return self |
|
| 64 | - */ |
|
| 65 | - public function init(){ |
|
| 66 | - return $this; |
|
| 67 | - } |
|
| 68 | - /** |
|
| 69 | - * Stream the merged PDF content |
|
| 70 | - * |
|
| 71 | - * @return string |
|
| 72 | - */ |
|
| 73 | - public function inline(){ |
|
| 74 | - return $this->fpdi->Output($this->fileName, 'I'); |
|
| 75 | - } |
|
| 76 | - /** |
|
| 77 | - * Download the merged PDF content |
|
| 78 | - * |
|
| 79 | - * @return string |
|
| 80 | - */ |
|
| 81 | - public function download(){ |
|
| 82 | - return $this->fpdi->Output($this->fileName, 'D'); |
|
| 83 | - } |
|
| 84 | - /** |
|
| 85 | - * Save the merged PDF content to the filesystem |
|
| 86 | - * |
|
| 87 | - * @return string |
|
| 88 | - */ |
|
| 89 | - public function save($filePath = null){ |
|
| 90 | - return $this->filesystem->put($filePath ? $filePath : $this->fileName, $this->string()); |
|
| 91 | - } |
|
| 92 | - /** |
|
| 93 | - * Get the merged PDF content as binary string |
|
| 94 | - * |
|
| 95 | - * @return string |
|
| 96 | - */ |
|
| 97 | - public function string(){ |
|
| 98 | - return $this->fpdi->Output($this->fileName, 'S'); |
|
| 99 | - } |
|
| 100 | - /** |
|
| 101 | - * Set the generated PDF fileName |
|
| 102 | - * @param string $fileName |
|
| 103 | - * |
|
| 104 | - * @return string |
|
| 105 | - */ |
|
| 106 | - public function setFileName($fileName){ |
|
| 107 | - $this->fileName = $fileName; |
|
| 108 | - return $this; |
|
| 109 | - } |
|
| 110 | - /** |
|
| 111 | - * Add a PDF for inclusion in the merge with a binary string. Pages should be formatted: 1,3,6, 12-16. |
|
| 112 | - * @param string $string |
|
| 113 | - * @param mixed $pages |
|
| 114 | - * @param mixed $orientation |
|
| 115 | - * |
|
| 116 | - * @return void |
|
| 117 | - */ |
|
| 118 | - public function addPDFString($string, $pages = 'all', $orientation = null){ |
|
| 119 | - $filePath = storage_path('tmp/'.Str::random(16).'.pdf'); |
|
| 120 | - $this->filesystem->put($filePath, $string); |
|
| 121 | - $this->tmpFiles->push($filePath); |
|
| 122 | - return $this->addPathToPDF($filePath, $pages, $orientation); |
|
| 123 | - } |
|
| 124 | - /** |
|
| 125 | - * Add a PDF for inclusion in the merge with a valid file path. Pages should be formatted: 1,3,6, 12-16. |
|
| 126 | - * @param string $filePath |
|
| 127 | - * @param string $pages |
|
| 128 | - * @param string $orientation |
|
| 129 | - * |
|
| 130 | - * @return self |
|
| 131 | - * |
|
| 132 | - * @throws \Exception if the given pages aren't correct |
|
| 133 | - */ |
|
| 134 | - public function addPathToPDF($filePath, $pages = 'all', $orientation = null) { |
|
| 135 | - if (file_exists($filePath)) { |
|
| 136 | - $filePath = $this->convertPDFVersion($filePath); |
|
| 137 | - if (!is_array($pages) && strtolower($pages) != 'all') { |
|
| 138 | - throw new \Exception($filePath."'s pages could not be validated"); |
|
| 139 | - } |
|
| 140 | - $this->files->push([ |
|
| 141 | - 'name' => $filePath, |
|
| 142 | - 'pages' => $pages, |
|
| 143 | - 'orientation' => $orientation |
|
| 144 | - ]); |
|
| 145 | - } else { |
|
| 146 | - throw new \Exception("Could not locate PDF on '$filePath'"); |
|
| 147 | - } |
|
| 148 | - return $this; |
|
| 149 | - } |
|
| 150 | - /** |
|
| 151 | - * Merges your provided PDFs and outputs to specified location. |
|
| 152 | - * @param string $orientation |
|
| 153 | - * |
|
| 154 | - * @return void |
|
| 155 | - * |
|
| 156 | - * @throws \Exception if there are now PDFs to merge |
|
| 157 | - */ |
|
| 158 | - public function duplexMerge($orientation = 'P'){ |
|
| 159 | - $this->merge($orientation, true); |
|
| 160 | - } |
|
| 9 | + /** |
|
| 10 | + * Access the filesystem on an oop base |
|
| 11 | + * |
|
| 12 | + * @var Filesystem |
|
| 13 | + */ |
|
| 14 | + protected $filesystem = Filesystem::class; |
|
| 15 | + /** |
|
| 16 | + * Hold all the files which will be merged |
|
| 17 | + * |
|
| 18 | + * @var Collection |
|
| 19 | + */ |
|
| 20 | + protected $files = Collection::class; |
|
| 21 | + /** |
|
| 22 | + * Holds every tmp file so they can be removed during the deconstruction |
|
| 23 | + * |
|
| 24 | + * @var Collection |
|
| 25 | + */ |
|
| 26 | + protected $tmpFiles = Collection::class; |
|
| 27 | + /** |
|
| 28 | + * The actual PDF Service |
|
| 29 | + * |
|
| 30 | + * @var FPDI |
|
| 31 | + */ |
|
| 32 | + protected $fpdi = Fpdi::class; |
|
| 33 | + /** |
|
| 34 | + * The final file name |
|
| 35 | + * |
|
| 36 | + * @var string |
|
| 37 | + */ |
|
| 38 | + protected $fileName = 'undefined.pdf'; |
|
| 39 | + /** |
|
| 40 | + * Construct and initialize a new instance |
|
| 41 | + * @param Filesystem $Filesystem |
|
| 42 | + */ |
|
| 43 | + public function __construct(Filesystem $filesystem){ |
|
| 44 | + $this->filesystem = $filesystem; |
|
| 45 | + $this->createDirectoryForTemporaryFiles(); |
|
| 46 | + $this->fpdi = new Fpdi(); |
|
| 47 | + $this->tmpFiles = collect([]); |
|
| 48 | + $this->files = collect([]); |
|
| 49 | + } |
|
| 50 | + /** |
|
| 51 | + * The class deconstructor method |
|
| 52 | + */ |
|
| 53 | + public function __destruct() { |
|
| 54 | + $filesystem = $this->filesystem; |
|
| 55 | + $this->tmpFiles->each(function($filePath) use($filesystem){ |
|
| 56 | + $filesystem->delete($filePath); |
|
| 57 | + }); |
|
| 58 | + } |
|
| 59 | + /** |
|
| 60 | + * Initialize a new internal instance of FPDI in order to prevent any problems with shared resources |
|
| 61 | + * Please visit https://www.setasign.com/products/fpdi/manual/#p-159 for more information on this issue |
|
| 62 | + * |
|
| 63 | + * @return self |
|
| 64 | + */ |
|
| 65 | + public function init(){ |
|
| 66 | + return $this; |
|
| 67 | + } |
|
| 68 | + /** |
|
| 69 | + * Stream the merged PDF content |
|
| 70 | + * |
|
| 71 | + * @return string |
|
| 72 | + */ |
|
| 73 | + public function inline(){ |
|
| 74 | + return $this->fpdi->Output($this->fileName, 'I'); |
|
| 75 | + } |
|
| 76 | + /** |
|
| 77 | + * Download the merged PDF content |
|
| 78 | + * |
|
| 79 | + * @return string |
|
| 80 | + */ |
|
| 81 | + public function download(){ |
|
| 82 | + return $this->fpdi->Output($this->fileName, 'D'); |
|
| 83 | + } |
|
| 84 | + /** |
|
| 85 | + * Save the merged PDF content to the filesystem |
|
| 86 | + * |
|
| 87 | + * @return string |
|
| 88 | + */ |
|
| 89 | + public function save($filePath = null){ |
|
| 90 | + return $this->filesystem->put($filePath ? $filePath : $this->fileName, $this->string()); |
|
| 91 | + } |
|
| 92 | + /** |
|
| 93 | + * Get the merged PDF content as binary string |
|
| 94 | + * |
|
| 95 | + * @return string |
|
| 96 | + */ |
|
| 97 | + public function string(){ |
|
| 98 | + return $this->fpdi->Output($this->fileName, 'S'); |
|
| 99 | + } |
|
| 100 | + /** |
|
| 101 | + * Set the generated PDF fileName |
|
| 102 | + * @param string $fileName |
|
| 103 | + * |
|
| 104 | + * @return string |
|
| 105 | + */ |
|
| 106 | + public function setFileName($fileName){ |
|
| 107 | + $this->fileName = $fileName; |
|
| 108 | + return $this; |
|
| 109 | + } |
|
| 110 | + /** |
|
| 111 | + * Add a PDF for inclusion in the merge with a binary string. Pages should be formatted: 1,3,6, 12-16. |
|
| 112 | + * @param string $string |
|
| 113 | + * @param mixed $pages |
|
| 114 | + * @param mixed $orientation |
|
| 115 | + * |
|
| 116 | + * @return void |
|
| 117 | + */ |
|
| 118 | + public function addPDFString($string, $pages = 'all', $orientation = null){ |
|
| 119 | + $filePath = storage_path('tmp/'.Str::random(16).'.pdf'); |
|
| 120 | + $this->filesystem->put($filePath, $string); |
|
| 121 | + $this->tmpFiles->push($filePath); |
|
| 122 | + return $this->addPathToPDF($filePath, $pages, $orientation); |
|
| 123 | + } |
|
| 124 | + /** |
|
| 125 | + * Add a PDF for inclusion in the merge with a valid file path. Pages should be formatted: 1,3,6, 12-16. |
|
| 126 | + * @param string $filePath |
|
| 127 | + * @param string $pages |
|
| 128 | + * @param string $orientation |
|
| 129 | + * |
|
| 130 | + * @return self |
|
| 131 | + * |
|
| 132 | + * @throws \Exception if the given pages aren't correct |
|
| 133 | + */ |
|
| 134 | + public function addPathToPDF($filePath, $pages = 'all', $orientation = null) { |
|
| 135 | + if (file_exists($filePath)) { |
|
| 136 | + $filePath = $this->convertPDFVersion($filePath); |
|
| 137 | + if (!is_array($pages) && strtolower($pages) != 'all') { |
|
| 138 | + throw new \Exception($filePath."'s pages could not be validated"); |
|
| 139 | + } |
|
| 140 | + $this->files->push([ |
|
| 141 | + 'name' => $filePath, |
|
| 142 | + 'pages' => $pages, |
|
| 143 | + 'orientation' => $orientation |
|
| 144 | + ]); |
|
| 145 | + } else { |
|
| 146 | + throw new \Exception("Could not locate PDF on '$filePath'"); |
|
| 147 | + } |
|
| 148 | + return $this; |
|
| 149 | + } |
|
| 150 | + /** |
|
| 151 | + * Merges your provided PDFs and outputs to specified location. |
|
| 152 | + * @param string $orientation |
|
| 153 | + * |
|
| 154 | + * @return void |
|
| 155 | + * |
|
| 156 | + * @throws \Exception if there are now PDFs to merge |
|
| 157 | + */ |
|
| 158 | + public function duplexMerge($orientation = 'P'){ |
|
| 159 | + $this->merge($orientation, true); |
|
| 160 | + } |
|
| 161 | 161 | |
| 162 | - public function merge($orientation = 'P', $duplex = false) { |
|
| 163 | - if ($this->files->count() == 0) { |
|
| 164 | - throw new \Exception("No PDFs to merge."); |
|
| 165 | - } |
|
| 166 | - $fpdi = $this->fpdi; |
|
| 167 | - $files = $this->files; |
|
| 168 | - foreach($files as $index => $file){ |
|
| 169 | - $file['orientation'] = is_null($file['orientation']) ? $orientation : $file['orientation']; |
|
| 170 | - $count = $fpdi->setSourceFile($file['name']); |
|
| 171 | - if($file['pages'] == 'all') { |
|
| 172 | - $pages = $count; |
|
| 173 | - for ($i = 1; $i <= $count; $i++) { |
|
| 174 | - $template = $fpdi->importPage($i); |
|
| 175 | - $size = $fpdi->getTemplateSize($template); |
|
| 176 | - $fpdi->AddPage($file['orientation'], [$size['width'], $size['height']]); |
|
| 177 | - $fpdi->useTemplate($template); |
|
| 178 | - } |
|
| 179 | - }else { |
|
| 180 | - $pages = count($file['pages']); |
|
| 181 | - foreach ($file['pages'] as $page) { |
|
| 182 | - if (!$template = $fpdi->importPage($page)) { |
|
| 183 | - throw new \Exception("Could not load page '$page' in PDF '".$file['name']."'. Check that the page exists."); |
|
| 184 | - } |
|
| 185 | - $size = $fpdi->getTemplateSize($template); |
|
| 186 | - $fpdi->AddPage($file['orientation'], [$size['width'], $size['height']]); |
|
| 187 | - $fpdi->useTemplate($template); |
|
| 188 | - } |
|
| 189 | - } |
|
| 190 | - if ($duplex && $pages % 2 && $index < (count($files) - 1)) { |
|
| 191 | - $fpdi->AddPage($file['orientation'], [$size['width'], $size['height']]); |
|
| 192 | - } |
|
| 193 | - } |
|
| 194 | - } |
|
| 162 | + public function merge($orientation = 'P', $duplex = false) { |
|
| 163 | + if ($this->files->count() == 0) { |
|
| 164 | + throw new \Exception("No PDFs to merge."); |
|
| 165 | + } |
|
| 166 | + $fpdi = $this->fpdi; |
|
| 167 | + $files = $this->files; |
|
| 168 | + foreach($files as $index => $file){ |
|
| 169 | + $file['orientation'] = is_null($file['orientation']) ? $orientation : $file['orientation']; |
|
| 170 | + $count = $fpdi->setSourceFile($file['name']); |
|
| 171 | + if($file['pages'] == 'all') { |
|
| 172 | + $pages = $count; |
|
| 173 | + for ($i = 1; $i <= $count; $i++) { |
|
| 174 | + $template = $fpdi->importPage($i); |
|
| 175 | + $size = $fpdi->getTemplateSize($template); |
|
| 176 | + $fpdi->AddPage($file['orientation'], [$size['width'], $size['height']]); |
|
| 177 | + $fpdi->useTemplate($template); |
|
| 178 | + } |
|
| 179 | + }else { |
|
| 180 | + $pages = count($file['pages']); |
|
| 181 | + foreach ($file['pages'] as $page) { |
|
| 182 | + if (!$template = $fpdi->importPage($page)) { |
|
| 183 | + throw new \Exception("Could not load page '$page' in PDF '".$file['name']."'. Check that the page exists."); |
|
| 184 | + } |
|
| 185 | + $size = $fpdi->getTemplateSize($template); |
|
| 186 | + $fpdi->AddPage($file['orientation'], [$size['width'], $size['height']]); |
|
| 187 | + $fpdi->useTemplate($template); |
|
| 188 | + } |
|
| 189 | + } |
|
| 190 | + if ($duplex && $pages % 2 && $index < (count($files) - 1)) { |
|
| 191 | + $fpdi->AddPage($file['orientation'], [$size['width'], $size['height']]); |
|
| 192 | + } |
|
| 193 | + } |
|
| 194 | + } |
|
| 195 | 195 | |
| 196 | - /** |
|
| 197 | - * Converts PDF if version is above 1.4 |
|
| 198 | - * @param string $filePath |
|
| 199 | - * |
|
| 200 | - * @return string |
|
| 201 | - */ |
|
| 202 | - protected function convertPDFVersion($filePath){ |
|
| 203 | - $pdf = fopen($filePath, "r"); |
|
| 204 | - $first_line = fgets($pdf); |
|
| 205 | - fclose($pdf); |
|
| 206 | - //extract version number |
|
| 207 | - preg_match_all('!\d+!', $first_line, $matches); |
|
| 208 | - $pdfversion = implode('.', $matches[0]); |
|
| 209 | - if($pdfversion > "1.4"){ |
|
| 210 | - $newFilePath = storage_path('tmp/' . Str::random(16) . '.pdf'); |
|
| 211 | - //execute shell script that converts PDF to correct version and saves it to tmp folder |
|
| 212 | - shell_exec('gs -dBATCH -dNOPAUSE -q -sDEVICE=pdfwrite -sOutputFile="'. $newFilePath . '" "' . $filePath . '"'); |
|
| 213 | - $this->tmpFiles->push($newFilePath); |
|
| 214 | - $filePath = $newFilePath; |
|
| 215 | - } |
|
| 216 | - //return correct file path |
|
| 217 | - return $filePath; |
|
| 218 | - } |
|
| 196 | + /** |
|
| 197 | + * Converts PDF if version is above 1.4 |
|
| 198 | + * @param string $filePath |
|
| 199 | + * |
|
| 200 | + * @return string |
|
| 201 | + */ |
|
| 202 | + protected function convertPDFVersion($filePath){ |
|
| 203 | + $pdf = fopen($filePath, "r"); |
|
| 204 | + $first_line = fgets($pdf); |
|
| 205 | + fclose($pdf); |
|
| 206 | + //extract version number |
|
| 207 | + preg_match_all('!\d+!', $first_line, $matches); |
|
| 208 | + $pdfversion = implode('.', $matches[0]); |
|
| 209 | + if($pdfversion > "1.4"){ |
|
| 210 | + $newFilePath = storage_path('tmp/' . Str::random(16) . '.pdf'); |
|
| 211 | + //execute shell script that converts PDF to correct version and saves it to tmp folder |
|
| 212 | + shell_exec('gs -dBATCH -dNOPAUSE -q -sDEVICE=pdfwrite -sOutputFile="'. $newFilePath . '" "' . $filePath . '"'); |
|
| 213 | + $this->tmpFiles->push($newFilePath); |
|
| 214 | + $filePath = $newFilePath; |
|
| 215 | + } |
|
| 216 | + //return correct file path |
|
| 217 | + return $filePath; |
|
| 218 | + } |
|
| 219 | 219 | |
| 220 | - /** |
|
| 221 | - * Create a the temporary file directory if it doesn't exist. |
|
| 222 | - * |
|
| 223 | - * @return void |
|
| 224 | - */ |
|
| 225 | - protected function createDirectoryForTemporaryFiles(): void |
|
| 226 | - { |
|
| 227 | - if (! $this->filesystem->isDirectory(storage_path('tmp'))) { |
|
| 228 | - $this->filesystem->makeDirectory(storage_path('tmp')); |
|
| 229 | - } |
|
| 230 | - } |
|
| 220 | + /** |
|
| 221 | + * Create a the temporary file directory if it doesn't exist. |
|
| 222 | + * |
|
| 223 | + * @return void |
|
| 224 | + */ |
|
| 225 | + protected function createDirectoryForTemporaryFiles(): void |
|
| 226 | + { |
|
| 227 | + if (! $this->filesystem->isDirectory(storage_path('tmp'))) { |
|
| 228 | + $this->filesystem->makeDirectory(storage_path('tmp')); |
|
| 229 | + } |
|
| 230 | + } |
|
| 231 | 231 | } |
