README

LaTeX是一个非凡的排版系统，使用它可以制作非常专业和干净的文档。文档可以是一篇简单的文章，也可以是一本庞大的技术/科学书籍。

选择LaTeX的原因在于，它内置了丰富的功能，如标题、页脚、书籍索引、页码、水印等。一旦你探索了LaTeX文档的可能性，你会感到非常惊讶。

这个包使用整个框架，你可以用它来生成、保存或下载PDF文档。

先决条件

您需要在服务器上安装 texlive-full 程序。这个程序包含tex包和语言库，可以帮助您生成文档。

注意：您也可以选择安装 textlive，它是包的较轻、较原始的版本，而 texlive-full 包含所有包集。

区别在于：- 当您安装 textlive 并想要使用任何额外的tex包时，您需要手动安装它。- texlive-full 包含这些额外包。因此，它可能会占用服务器上一些额外的空间（用于存储包库文件）。

安装

composer require techsemicolon/laravel-php-latex

干运行

在直接使用之前，确保在您的服务器上正确安装了所需的程序非常重要。该包包含dryrun方法，您可以在任何控制器或路由中调用它。如果一切设置正确，它将自动生成 dryrun.pdf。如果不正确，它将抛出带有详细服务器错误的 LatexException。

<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use Techsemicolon\Latex;

class TestController extends Controller
{
    /**
     * Download PDF generated from latex
     * 
     * @return Illuminate\Http\Response
     */
    public function download(){

        return (new Latex)->dryRun();
    }
}

干运行将下载一个如下的美丽干净的测试PDF

用法

• 创建一个包含tex数据的视图文件

在 resources/views/latex/tex.blade.php 中创建视图文件

\documentclass[a4paper,9pt,landscape]{article}

\usepackage{adjustbox}
\usepackage[english]{babel}
\usepackage[scaled=.92]{helvet}
\usepackage{fancyhdr}
\usepackage[svgnames,table]{xcolor}
\usepackage[a4paper,inner=1.5cm,outer=1.5cm,top=1cm,bottom=1cm,bindingoffset=0cm]{geometry}
\usepackage{blindtext}
\geometry{textwidth=\paperwidth, textheight=\paperheight, noheadfoot, nomarginpar}

\renewcommand{\familydefault}{\sfdefault}

\pagestyle{fancy}
\fancyhead{}
\renewcommand{\headrulewidth}{0pt}
\fancyfoot{}
\fancyfoot[LE,RO]{\thepage}

\fancyfoot[C]{\fontsize{8pt}{8pt}\selectfont Above document is auto-generated.}
\renewcommand{\footrulewidth}{0.2pt}


\begin{document}

\section*{\centering{Test Document}}

\begin{center}
    \item[Name :] {{ $name }}
    \item[Date of Birth :] {{ $dob }}
\end{center}

\blindtext

\begin{table}[ht]
\centering
\begin{adjustbox}{center}
\renewcommand{\arraystretch}{2}
\begin{tabular}{|l|l|}

\hline

\rowcolor[HTML]{E3E3E3}
\textbf{Sr. No} 
& \textbf{Addresses}\\
\hline

@foreach($addresses as $key => $address)

    \renewcommand{\arraystretch}{1.5}
    {{ $key }} & {{ $address }} \\
    \hline

@endforeach

\end{tabular}
\end{adjustbox}
\caption{Address Summmary}
\end{table}

\blindtext

\vfill
\centering

\end{document}

您可以看到我们如何轻松地使用blade指令为 {{ $name }} 或 @foreach 显示表格中的地址来动态生成内容。

• 生成文件

您可以选择以下几种方法来生成文件。

1. 您可以下载文件作为响应

<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use Techsemicolon\Latex;

class TestController extends Controller
{
    /**
     * Download PDF generated from LaTex
     * 
     * @return Illuminate\Http\Response
     */
    public function download(){

        return (new Latex('latex.tex'))->with([
            'name' => 'John Doe',
            'dob' => '01/01/1994',
            'addresses' => [
                '20 Pumpkin Hill Drive Satellite Beach, FL 32937',
                '7408 South San Juan Ave. Beaver Falls, PA 15010'
            ]
        ])->download('test.pdf');
    }
}

1. 您可以保存PDF到您想要的任何位置以供以后使用

(new Latex('latex.tex'))->with([
    'name' => 'John Doe',
    'dob' => '01/01/1994',
    'addresses' => [
        '20 Pumpkin Hill Drive Satellite Beach, FL 32937',
        '7408 South San Juan Ave. Beaver Falls, PA 15010'
    ]
])->savePdf(storage_path('exports/pdf/test.pdf'));

1. 您可以仅渲染tex而不生成PDF

$tex = new Latex('latex.tex'))->with([
    'name' => 'John Doe',
    'dob' => '01/01/1994',
    'addresses' => [
        '20 Pumpkin Hill Drive Satellite Beach, FL 32937',
        '7408 South San Juan Ave. Beaver Falls, PA 15010'
    ]
])->render();

设置自定义bin路径

如果您的服务器上没有在环境 $PATH 中包含 pdflatex，您可能需要给出完整的路径来执行命令。要找到路径，您可以这样做

which pdflatex

然后您可以使用 binPath 函数传递这个路径，如下所示

return (new Latex('latex.tex'))->with([
    'name' => 'John Doe',
    'dob' => '01/01/1994',
    'addresses' => [
        '20 Pumpkin Hill Drive Satellite Beach, FL 32937',
        '7408 South San Juan Ave. Beaver Falls, PA 15010'
    ]
])->binPath('/usr/bin/pdflatex')->download('test.pdf');

使用原始TeX

如果您不想使用视图作为TeX文件，但已经有了TeX内容，或者正在使用其他库生成TeX内容，如 Markdown-to-LaTeX，则可以使用 RawTex 类而不是传递视图路径

$tex = new RawTex('your_raw_tex_content_string.....');

return (new Latex($tex))->with([
    'name' => 'John Doe',
    'dob' => '01/01/1994',
    'addresses' => [
        '20 Pumpkin Hill Drive Satellite Beach, FL 32937',
        '7408 South San Juan Ave. Beaver Falls, PA 15010'
    ]
])->download('test.pdf');

批量下载为ZIP存档

想要将多个PDF导出为ZIP吗？该包已经为您准备好了这个功能。这为您提供了很大的灵活性。但是，请确保不要一次性传递太多的PDF，因为这将消耗大量的服务器内存来一起导出。

$latexCollection = (new LatexCollection());
$users = User::limit(10)->get();
foreach ($users as $user) {
            
    $pdfName = $user->first_name.'-'.$user->last_name.'-'.$user->id.'.pdf';

    // Create latex instance
    $latex = (new Latex('latex.patientsummary'))->with([
        'user' => $user
    ])->setName($pdfName);

    // Add it to latex collection
    $latexCollection->add($latex);
}

// Download the zip
return $latexCollection->downloadZip('bulk.zip');

// OR you can also save it 
$latexCollection->saveZip(storage_path('exports/zips/users.zip'));

监听事件

每当成功生成PDF时，它会触发一个名为 LatexPdfWasGenerated 的事件。同样，如果PDF生成失败，它会触发名为 LatexPdfFailed 的事件。

这些事件在需要根据生成状态执行某些操作时很重要，例如更新数据库。但大多数PDF文件都有一些元数据，比如PDF属于哪个用户或属于哪个订单。您可以在实例化latex时作为第二个参数传递这些元数据。

这些元数据随后从触发的事件中返回给您，这使得监听更加有意义。元数据可以是任何东西，可以是字符串、数字、数组、对象、集合等。您可以根据您需要的逻辑传递元数据。

// $user will be our metadata in this example
$user = Auth::user();

(new Latex('latex.tex', $user))->with([
    'name' => 'John Doe',
    'dob' => '01/01/1994',
    'addresses' => [
        '20 Pumpkin Hill Drive Satellite Beach, FL 32937',
        '7408 South San Juan Ave. Beaver Falls, PA 15010'
    ]
])->savePdf(storage_path('exports/pdf/test.pdf'));

然后您可以定义一个监听器，例如

<?php

namespace App\Listeners;

use Techsemicolon\LatexPdfWasGenerated;

class LatexPdfWasGeneratedConfirmation
{
    /**
     * Create the event listener.
     *
     * @return void
     */
    public function __construct()
    {
        //
    }

    /**
     * Handle the event.
     *
     * @param  LatexPdfWasGenerated  $event
     * @return void
     */
    public function handle(LatexPdfWasGenerated $event)
    {
        // Path  of pdf in case in was saved 
        // OR 
        // Downloaded name of pdf file in case it was downloaded in response directly
        $pdf = $event->pdf;

        // download OR savepdf
        $action = $event->action;

        // metadata $user in this example
        $user = $event->metadata;

        // Perform desired actions
    }
}

垃圾回收

当您导出PDF时，pdflatext会生成一些额外的文件，例如.aux、.log等。该包会处理垃圾回收过程，确保在生成PDF或发生任何错误时没有残留文件。

这确保服务器不会浪费空间来保留残留文件。

错误处理

我们使用来自texlive的pdflatex程序来生成PDF。如果您的TeX文件中发生语法错误，它会在日志文件中记录。或者如果关闭了，它会在控制台中显示输出。

该包也会内部处理这些问题，并抛出大量的ViewNotFoundException。异常将包含有关错误的所有信息，便于您进行调试。

如果您想为这个包添加新的功能，请随时贡献。

许可协议

此包是开源软件，受MIT许可协议许可