PHPackages alex-oliveira/ao-pdf - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. alex-oliveira/ao-pdf ActivePackage alex-oliveira/ao-pdf ==================== Resources for filling PDF Templates with Laravel. 16Rich Text FormatCI failing Since May 31Pushed 5y ago1 watchersCompare [ Source](https://github.com/alex-oliveira/ao-pdf)[ Packagist](https://packagist.org/packages/alex-oliveira/ao-pdf)[ RSS](/packages/alex-oliveira-ao-pdf/feed)WikiDiscussions master Synced 1mo ago READMEChangelogDependenciesVersions (1)Used By (0) AO-PDF ====== [](#ao-pdf) This package is for those who want to create their own customized pdf service. If you just want to use the standard container service, you can find the official image at PREREQUISITES ------------- [](#prerequisites) ### Install "pdftk" [](#install-pdftk) UBUNTU ``` $ sudo snap install pdftk $ sudo ln -s /snap/bin/pdftk /bin/pdftk ``` [https://linuxhint.com/install\_pdftk\_ubuntu/](https://linuxhint.com/install_pdftk_ubuntu/) INSTALLATION ------------ [](#installation) ### 1) Install [](#1-install) ``` $ composer require alex-oliveira/ao-pdf ``` ### 2) Configure "config/app.php" file [](#2-configure-configappphp-file) ``` 'providers' => [ /* * Package Service Providers... */ AOPDF\AOPDFServiceProvider::class, ], ``` ROUTES ------ [](#routes) O ServiceProvider do pacote disponibiliza quatro rotas para utilização dos recursos: ##### GET: /pdf/fill [](#get-pdffill) - Rota para **criação e download** de documentos curtos. ##### POST: /pdf/fill [](#post-pdffill) - Rota para **criação** de documentos longos. ##### GET: /pdf/download [](#get-pdfdownload) - Rota para **download** de documentos longos. ##### GET: /pdf/test [](#get-pdftest) - Rota para **teste** de funcionalidade do pacote. UTILIZATION ----------- [](#utilization) ### Basic [](#basic) ``` use AOPDF\AOPDF; ... $document_part_1 = [ 'template' => 'https://github.com/alex-oliveira/ao-pdf/raw/master/example.pdf', 'params' => [ 'client_name' => 'Alex Oliveira', 'client_cpf' => '12345678900', ] ]; ... $data = AOPDF::encode([ $document_part_1, $document_part_2, $document_part_3, $document_part_n... ]); ``` - Determinando a composição do documento. - Para compor um **documento** é necessário configurar uma ou mais partes para o mesmo. - Cada **parte** possui suas próprias configurações individuais. - O serviço processa cada **parte** separadamente e concatena todas no final para retornar **um único** arquivo PDF. - Não existem regras para a divisão do documento, você deve fazer isso apenas de for conveniente e/ou necessário para flexibilizar a utilização. - Determinando o **template** a ser utilizado para a criação de uma parte. - Cada **parte** deve ter um atributo chamado **template**, contendo uma URL para download de um arquivo PDF. - Na primeira utilização de uma URL, o pacote baixará o arquivo e guardará para as próximas utilizações. - Para alterar o **template** a ser utilizado, basta alterar a URL fornecida na requisição. - O arquivo PDF indicado pela URL deve conter os campos que serão preenchidos. - Determinando os parâmetros que serão utilizados para preencher os campos. - Cada **parte** deve ter um atributos chamado *params*, contendo uma lista de dados organizados como **chave** e **valor**. - A **chave** de cada atributo deve corresponder exatamente com o nome do campo no arquivo PDF que será utilizado como **template**. - **Chaves** não encontradas no **template** não geram erro, apenas são ignoradas. - É possível aninhar atributos e aplicar filtros, para se ter uma utilização mais rebuscada. - Preparando dados para processamento. - Após criar a lista com todas as configurações das partes do documento, é preciso codifica-lo para envio. - Utilize a função **AOPDF::encode($data)** para codificar corretamente os dados. - Uma vez com os dados codificados, você pode enviá-los para a rota **http://{{MY\_HOST}}/pdf/fill**, por requisição **GET** ou **POST**. - Utilize **GET** para documentos que utilizam poucos dados e **POST** para documentos com muitos dados. - Se deseja simplificar a gestão do tipo de requisição, utilize apenas **POST**. ### GET Requests ( para requisições com **poucos dados** ) [](#get-requests--para-requisições-com-poucos-dados-) ``` redirect()->to('http://{{__MY_HOST__}}/pdf/fill?data=' . $data); ``` - Essa é a forma mais fácil de utilizar o serviço. - O dados são enviados via URL, por uma parâmetro chamado **data** na **queryString** e o download do arquivo PDF é iniciado como resposta a requisição. - O inconveniente deste método é que existe um limite para o envio de dados via URL. Se muitos dados são necessários, você será obrigado a usar **POST**. ### POST Requests ( para requisições com **muitos dados** ) [](#post-requests--para-requisições-com-muitos-dados-) ``` $client = new GuzzleHttp\Client(); $response = $client->request('POST', 'http://{{__MY_HOST__}}/pdf/fill', [ 'form_params' => [ 'data' => $data ] ]); $content = json_decode($response->getBody()->getContents()); redirect()->to('http://{{__MY_HOST__}}/pdf/download?file=' . $content->file_name); ``` - Essa forma adicionar mais passos ao fluxo de trabalho, mas permite o envio de muitos dados para a construção do documento. - Será preciso enviar os dados em um campo **data** no corpo da requisição, mas a resposta não será um arquivo PDF e sim um **nome de um arquivo temporário no servidor**. - Para obter o arquivo PDF será necessário fazer uma nova requisição, do tipo **GET**, para a rota **http://{{MY\_HOST}}/pdf/download**, informando o **nome do arquivo temporário**em um campo chamado **file**, na queryString. - Fazendo isso o arquivo será processado e o download será iniciado. ### About Cache System [](#about-cache-system) - O pacote tem um sistema de cache de arquivos. O arquivo PDF final de cada requisição é preservado por 6 horas, se a requisição se repetir durante esse período o arquivo do cache será retornado. - Os arquivos armazenados são identificados pelo hash md5 da requisição, sendo assim qualquer alteração em uma requisição muda o hash e assim é tratada como uma nova requisição. ### Using formatteres [](#using-formatteres) ``` ``` ### Available formatteres [](#available-formatteres) ``` ``` ### Health Score 18 — LowBetter than 8% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity6 Limited adoption so far Community7 Small or concentrated contributor base Maturity33 Early-stage or recently created project Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/e826fd88857da403181f2a4e7f1834909414a5ded31cc5e9362c5677dae92877?d=identicon)[alex-oliveira](/maintainers/alex-oliveira) --- Top Contributors [![alex-oliveira](https://avatars.githubusercontent.com/u/5826507?v=4)](https://github.com/alex-oliveira "alex-oliveira (19 commits)") ### Embed Badge ![Health badge](/badges/alex-oliveira-ao-pdf/health.svg) ``` [![Health](https://phpackages.com/badges/alex-oliveira-ao-pdf/health.svg)](https://phpackages.com/packages/alex-oliveira-ao-pdf) ``` PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)