Download the PHP package springworks/pdf-maker without Composer

On this page you can find all versions of the php package springworks/pdf-maker. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of springworks/pdf-maker

Informations about the package pdf-maker

Pdf Maker plugin for Craft CMS 3.x

PDF creation using the v2 API headless chrome services from api2pdf.com. You can also use Api2Pdf for rendering PDFs in Formie or Craft Commerce.

Requirements

This plugin requires Craft CMS 3.0.0-beta.23 or later.

Formie integration requires Formie 1.5 or later.

Commerce integration requires Commerce 2.0 or later.

Installation

To install the plugin, follow these instructions.

  1. Open your terminal and go to your Craft project:

    cd /path/to/project

  2. Then tell Composer to load the plugin:

    composer require springworks/pdf-maker
  3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Pdf Maker.

Settings

The only required setting is a valid Api2Pdf API key. It is recommended to set this using an environment variable.

The plugin will automatically detect if either Formie or Craft Commerce is installed and enabled and will offer additional settings to override the PDF generation for these plugins if detected.

Default PDF creation options are set in the config file. Rename config.php to pdf-maker.php and place in your config folder. Change the default options as required.

For details of what options are available, please see the following:

Examples

For any of the methods below, you can pass in an options array as hidden inputs in the forms to override the default config options, for example:

Generate PDF from URL

Generate PDF from HTML

Generate PDF from Template

To generate a PDF from a template, set the hidden template input to the hashed value of the path to the template to render. The path is hashed to prevent it being tempered with in the browser. For example, if you wanted to use a template called page, which lived in a folder called _pdfs in your templates folder, you would set the value of the hidden template to {{ '_pdfs/page'|hash }}.

You can pass variables into the template by setting them as hidden variables[variableName] inputs. Each of these values must also be hashed. So, for example, if your template required an entryId to tell it what entry to render, you could pass that in like this:

<input type="hidden" name="variables[entryId]" value="{{ entry.id|hash }}" />

Full example:

Merge PDFs

Generate Image from URL

Generate Image from HTML

Generate Image from Template

To generate an image from a template, set the hidden template input to the hashed value of the path to the template to render. The path is hashed to prevent it being tempered with in the browser. For example, if you wanted to use a template called page, which lived in a folder called _pdfs in your templates folder, you would set the value of the hidden template to {{ '_pdfs/page'|hash }}.

You can pass variables into the template by setting them as hidden variables[variableName] inputs. Each of these values must also be hashed. So, for example, if your template required an entryId to tell it what entry to render, you could pass that in like this:

<input type="hidden" name="variables[entryId]" value="{{ entry.id|hash }}" />

Full example:

Brought to you by Steve Rowling

All versions of pdf-maker with dependencies

PHP Build Version
Package Version
Requires craftcms/cms Version ^5.0.0
api2pdf/api2pdf.php Version 2.0.2
php Version ^8.2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package springworks/pdf-maker contains the following files

Loading the files please wait ....