StartProgressBarOutput()
(mPDF ≥ 4.2 & < 7.0)
Note: This feature was removed in mPDF 7.0
StartProgressBarOutput – Enable progress bars to be shown during file generation
Description
void StartProgressBarOutput ( [ string $mode ] )
Enable progress bars to be shown during file generation. Not recommended for general use, but may be helpful for
development purposes, or for slow document generation. To set this value globally you can edit the value for
$progressBar in the configuration file config.php
Note: You may need to define the constant _MPDF_URI
if you use progress bars. The constant _MPDF_URI is needed to redirect the user to the PDF file (and prior to
mPDF 5.0 to locate a javascript file within the progress bar script). It must be either a relative path
(e.g. '../') or a full URI (e.g. 'http://www.mydomain.com/mpdf/').
If you do not define it before calling mPDF() mPDF will assign it the same value as _MPDF_PATH. This is
fine if you have used a relative path. _MPDF_PATH requires either a relative path or a filesystem real path
(e.g. '/homepages/27/d84233457/htdocs/')
Parameters
- $mode
-
Values (case-insensitive)
-
1or BLANK or omitted: Shows 1 progress bar (simple form) -
2: Shows multiple progress bars for detailed examination of progress
Default:
1 -
Examples
<?php
define('_MPDF_URI','../'); // must be a relative or absolute URI - not a file system path
$mpdf = new \Mpdf\Mpdf();
$mpdf->StartProgressBarOutput(2);
$mpdf->WriteHTML('You will hardly have time to see the progress bars!');
$mpdf->Output();
Changelog
| Version | Description |
|---|---|
| 4.2 | Variable was added. |
| 7.0 | Variable was removed along with progressbar capabilities. |
See Also
- $progressBar – Specify whether to show progress bars during file generation
- $progbar_heading - define customised heading for progress bars
- $progbar_altHTML - define customised HTML for progress bars
