yfix.net
  1. API
  2. common
  3. yf_pdf_page

yf_pdf_page class

PDF page view handler.

Fileplugins/common/classes/common/yf_pdf_page.class.php
Use_class('pdf_page', 'classes/common/')

Public properties

A site sets them in its config with $PROJECT_CONF['pdf_page']['NAME'] = ...;

PropertyDefaultDescription
$PATH_TO_PDF 'uploads/pdf/'
$pdf_obj null

Public methods 2

go

public function go($html = '', $file = 'page', $type = 'I')

Show given text as PDF I: send the file inline to the browser. The plug-in is used if available. The name given by filename is used when one selects the "Save as" option on the link generating the PDF. D: send to the browser and force a file download with the name given by filename. F: save to a local file with the name given by filename (may include a path). S: return the document as a string. filename is ignored. You can use the 'S' option to e-mail a PDF file (as a content of email).

    public function go($html = '', $file = 'page', $type = 'I')
    {
        if (is_array($html)) {
            $_ = $html;
            $html = ($_['html'] ?? null) ?: '';
            $css = ($_['css'] ?? null) ?: null;
            $file = ($_['file'] ?? null) ?: $file;
            $type = ($_['type'] ?? null) ?: $type;
        }
        if ($type == 'F') {
            _class('dir')->mkdir($this->PATH_TO_PDF);
            $file = $this->PATH_TO_PDF . $file;
        } else {
            main()->NO_GRAPHICS = true;
        }
        setlocale(LC_NUMERIC, $this->_LC_NUMERIC_MPDF);
        $this->pdf_obj->charset_in = 'utf-8';
        if ( ! empty($css)) {
            $this->pdf_obj->WriteHTML($css, 1);
        }
        $this->pdf_obj->WriteHTML($html, 2);
        $this->pdf_obj->Output($file . '.pdf', $type);
        setlocale(LC_NUMERIC, $this->_LC_NUMERIC);
    }

Methods starting with _ hooks and helpers; not routable as page actions

__construct

public function __construct()
    public function __construct()
    {
        // TODO: check and enable
        return false;
        require_php_lib('mpdf');

        $this->_LC_NUMERIC = localeconv();
        // params:
        // coding, format, font size, font name
        // margin left margin right, margin top, margin bottom, margin head, margin footer
        $this->pdf_obj = new mPDF('utf-8', 'A4', '10');
        $this->_LC_NUMERIC_MPDF = localeconv();
        setlocale(LC_NUMERIC, $this->_LC_NUMERIC);
        $this->PATH_TO_PDF = PROJECT_PATH . $this->PATH_TO_PDF;
    }