mirror of
https://github.com/InvoiceShelf/InvoiceShelf.git
synced 2026-04-07 05:31:24 +00:00
* Add utility class for managing templates * Register custom pdf template views location * Update the make:template command to make use of PdfTemplateUtils * Update PDF invoice/estimate template controllers * Register pdf_templates filesystem disk * Remove unused leftovers * Reformat with pint
141 lines
4.1 KiB
PHP
141 lines
4.1 KiB
PHP
<?php
|
|
|
|
namespace App\Space;
|
|
|
|
use Illuminate\Support\Facades\File;
|
|
use Illuminate\Support\Facades\Storage;
|
|
use Illuminate\Support\Str;
|
|
|
|
class PdfTemplateUtils
|
|
{
|
|
/**
|
|
* Find the formatted template
|
|
*
|
|
* @param string $imageFormat
|
|
* @return array|null
|
|
*/
|
|
public static function findFormattedTemplate($templateType, $templateName, $imageFormat = 'base64')
|
|
{
|
|
foreach (array_reverse(self::getFormattedTemplates($templateType, $imageFormat)) as $formattedTemplate) {
|
|
if ($formattedTemplate['name'] === $templateName) {
|
|
return $formattedTemplate;
|
|
}
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Return the available formatted template paths
|
|
*
|
|
* @param string $imageFormat
|
|
* @return array|array[]
|
|
*/
|
|
public static function getFormattedTemplates($templateType, $imageFormat = 'base64')
|
|
{
|
|
|
|
$files_native = array_map(function ($file) {
|
|
return [
|
|
'path' => $file,
|
|
'custom' => false,
|
|
];
|
|
}, Storage::disk('views')->files(sprintf('/app/pdf/%s', $templateType)));
|
|
|
|
$files_custom = array_map(function ($file) {
|
|
return [
|
|
'path' => $file,
|
|
'custom' => true,
|
|
];
|
|
}, Storage::disk('pdf_templates')->files(sprintf('/%s', $templateType)));
|
|
|
|
$files = array_merge($files_native, $files_custom);
|
|
$files = array_filter($files, function ($file) {
|
|
return Str::endsWith($file['path'], '.blade.php');
|
|
});
|
|
|
|
return array_map(function ($file) use ($templateType, $imageFormat) {
|
|
$templateName = Str::before(basename($file['path']), '.blade.php');
|
|
|
|
if ($file['custom']) {
|
|
$imagePath = self::getCustomTemplateFilePath($templateType, sprintf('%s.png', $templateName));
|
|
$isCustomTemplate = true;
|
|
} else {
|
|
$imagePath = resource_path('static/img/PDF/'.$templateName.'.png');
|
|
$isCustomTemplate = false;
|
|
}
|
|
|
|
if (empty($imageFormat)) {
|
|
$imageValue = '';
|
|
} elseif ($imageFormat == 'path') {
|
|
$imageValue = $imagePath;
|
|
} else {
|
|
$imageValue = File::exists($imagePath) ? ImageUtils::toBase64Src($imagePath) : '';
|
|
}
|
|
|
|
return [
|
|
'name' => $templateName,
|
|
'path' => $imageValue,
|
|
'custom' => $isCustomTemplate,
|
|
];
|
|
}, $files);
|
|
}
|
|
|
|
/**
|
|
* Returns custom template path
|
|
*
|
|
* @param string $fileName
|
|
*/
|
|
public static function getCustomTemplateFilePath($templateType, $fileName = ''): string
|
|
{
|
|
$path = ! empty($fileName) ? sprintf('/%s/%s', $templateType, $fileName) : sprintf('/%s/', $templateType);
|
|
|
|
return Storage::disk('pdf_templates')->path($path);
|
|
}
|
|
|
|
/**
|
|
* Check if custom template exists.
|
|
*
|
|
* @param $templateName
|
|
* @return string
|
|
*/
|
|
public static function customTemplateFileExists($templateType, $fileName)
|
|
{
|
|
return Storage::disk('pdf_templates')->exists(sprintf('/%s/%s', $templateType, $fileName));
|
|
}
|
|
|
|
/**
|
|
* Save template markup file
|
|
*
|
|
* @return bool|string
|
|
*/
|
|
public static function toCustomTemplateMarkupFile($contents, $templateType, $templateName)
|
|
{
|
|
return self::toCustomTemplateFile($contents, $templateType, $templateName.'.blade.php');
|
|
}
|
|
|
|
/**
|
|
* Save template image file
|
|
*
|
|
*
|
|
* @return bool|string
|
|
*/
|
|
public static function toCustomTemplateImageFile($contents, $templateType, $templateName, $imageType = 'png')
|
|
{
|
|
return self::toCustomTemplateFile($contents, $templateType, $templateName.'.'.$imageType);
|
|
}
|
|
|
|
/**
|
|
* Save file contents into a template file of specific template type.
|
|
*
|
|
*
|
|
* @return bool|string
|
|
*/
|
|
public static function toCustomTemplateFile($contents, $templateType, $fileName)
|
|
{
|
|
return Storage::disk('pdf_templates')->put(
|
|
sprintf('/%s/%s', $templateType, $fileName),
|
|
$contents
|
|
);
|
|
}
|
|
}
|