Download the PHP package friendsofcake/cakepdf without Composer

On this page you can find all versions of the php package friendsofcake/cakepdf. 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 friendsofcake/cakepdf

Informations about the package cakepdf

CakePdf plugin

Build Status Total Downloads License

Plugin containing CakePdf lib which will use a PDF engine to convert HTML to PDF.

Engines included in the plugin:

Community maintained engines:

Requirements

Installation

Using Composer:

CakePdf does not include any of the supported PDF engines, you need to install the ones you intend to use yourself.

Packages for the recommend wkhtmltopdf engine can be downloaded from https://wkhtmltopdf.org/downloads.html. DomPdf, Mpdf and Tcpdf can be installed via composer using one of the following commands:

Setup

Loading the plugin using CakePHP's console:

If you plan to use the PDF view functionality that automatically renders and returns the PDF for sending it to the browser, you should also register the pdf extension in your config/routes.php file:

Further setup information can be found in the usage section.

Configuration

Use Configure::write('CakePdf', $config); or in controller use view builder to set view option named pdfConfig (only when used with PdfView). You need to define at least $config['engine']. When using CakePdf directly you can also pass the config array to constructor. The value for engine should have the Plugin.ClassName format without the Engine suffix.

Configuration options:

Example:

The engine and crypto config options can also be arrays with configuration options for the relevant class. For example:

Usage

You can use CakePdf in two ways, read carefully which one you actually need. Many people mix both ways and don't get the expected results.

1: Render as PDF (including forced download) in the browser with PdfView

You can create PDF template and layout files for your controller actions and have them automatically rendered. Place the templates in a pdf subdir, for instance templates/Invoices/pdf/view.php, layouts will be in templates/layout/pdf/default.php.

Then for e.g. accessing the URL http://localhost/invoices/view/1.pdf would give you the generated PDF.

Additionally you can map resources by adding Router::mapResources(['Invoices']); to your routes file and you can access the same document at http://localhost/invoices/1.pdf.

In case you don't want to use the pdf extension in your URLs, you can omit registering it in your routes configuration. You can then set the Accept request header to application/pdf to make CakePHP automatically switch to PdfView (required the viewClasses() method to be set as shown above), or explicity switch the view class in your controller action:

Instead of having the pdf rendered in the browser itself, you can force it to be downloaded by using download option. Additionally you can specify custom filename using filename options.

2: Create PDF for email attachment, file storage etc.

You can use CakePdf to create raw PDF data with a view template. The view file path would look like templates/pdf/newsletter.php. Layout file path would be like templates/layout/pdf/default.php Note that layouts for both usage types are within same directory, but the view templates use different file paths Optionally you can also write the raw data to file.

Example:

Encryption

You can optionally encrypt the PDF with permissions

To use encryption you first need to select a crypto engine. Currently we support the following crypto engines:

Usage

Add the following in your bootstrap.

Options in pdfConfig:

Permissions:

By default, we deny all permissions.

To allow all permissions:

Set 'permission' to true

To allow specific permissions:

Set 'permissions' to an array with a combination of the following available permissions:

How to

Ensure css, images etc. are loaded in PDF

Use absolute URLs for static assets in your view templates for PDFs. If you use HtmlHelper::image(), or HtmlHelper::css() make sure you have set fullBase option to true.

For example

If you are enable to get URLs for assets working properly, you can try using file system paths instead for the assets.

Note: Since v0.12.16 wkhtmltopdf requires the option enable-local-file-access to be able to use local filesytem paths for assets. You can enable it by setting 'enable-local-file-access' => true in the engine config array.

Get header and footer on all pages

Here are a couple of CSS based solutions you can refer to for easily getting header footer on all PDF pages.

All versions of cakepdf with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
cakephp/cakephp Version ^5.0.1
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 friendsofcake/cakepdf contains the following files

Loading the files please wait ....