You are here

Home » API reference » Forena Reports 8 » PrincePDF.php

class PrincePDF in Forena Reports 8

Provides PDF file exports using Prince XML

Plugin annotation


@FrxDocument(
  id= "pdf-prince",
  name="PDF Generation using Prince XML",
  ext="pdf"
)

Hierarchy

Expanded class hierarchy of PrincePDF

File

forena_pdf/src/FrxPlugin/Document/PrincePDF.php, line 20
PrincePDF

Namespace

Drupal\forena_pdf\FrxPlugin\Document
View source 
class PrincePDF extends DocumentBase {
  use FrxAPI;
  private $p;
  public function __construct() {
    include_once 'libraries/prince/prince.php';
    $this->content_type = 'application/pdf';
    $prince_path = \Drupal::config('forena_pdf.settings')
      ->get('prince_path');
    if (class_exists('\\Prince') && forena_library_file('prince')) {
      $this->p = new \Prince($prince_path);
    }
  }

  /**
   * [@inheritdoc}
   */
  public function flush() {

    //@TODO: figure out how to deal with options
    $options = [];

    //@TODO: Figure out how to pass style portions of css doucments to the PDF.
    $css = '';
    $style_css = '';
    $disable_links = \Drupal::config('forena_pdf.settings')
      ->get('disable_links');
    $html = $this->write_buffer;
    if ($disable_links) {
      $html = preg_replace('/<a href=\\"(.*?)\\">(.*?)<\\/a>/', "\\2", $html);
    }
    $link_class = $disable_links ? 'prince-disable-links' : '';
    $output = '<html><head>';
    $output .= '<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>';
    if (!empty($options['css']) || isset($r->rpt_xml->head->style)) {
      $output .= '<style type="text/css">';
      $output .= $css;
      if ($style_css) {
        $sheet = (string) $r->rpt_xml->head->style;
        $output .= $sheet;
      }
      $output .= '</style>';
    }
    $output .= '<title>' . $this->title . "</title></head><body class='forena-report {$link_class}'><h1>" . $this->title . '</h1>' . $html . '</body></html>';
    $prince_css = drupal_get_path('module', 'forena_pdf') . '/forena_pdf_prince.css';

    // Generate the document
    if ($this->p) {
      $p = $this->p;
      foreach ($this
        ->documentManager()->stylesheets as $type => $sheets) {
        foreach ($sheets as $sheet) {
          switch ($type) {
            case 'all':
            case 'print':
            case 'screen':
            case 'pdf':
              $p
                ->addStyleSheet($sheet);
              break;
          }
        }
      }
      $msg = array();
      $pdf_file = tempnam(file_directory_temp(), 'prince_pdf');
      if ($p
        ->convert_string_to_file($output, $pdf_file, $msg)) {
        $output = file_get_contents($pdf_file);
      }
      else {
        $this
          ->app()
          ->error('Could not generate PDF File', print_r($msg, 1));
        $output = '';
      }

      // We don't care if this fails because it's temproary.
      @unlink($pdf_file);
      return $output;
    }
    else {
      $this
        ->error(t('Prince XML Not Properly Installed'));
      return '';
    }
  }

  /**
   * {@inheritdoc}
   */
  public function header() {
    $this->headers['Content-Type'] = $this->content_type;
    $this->headers['Cache-Control'] = '';
    $this->headers['Pragma'] = '';
    $this->headers['Cache-Control'] = 'must-revalidate';
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DocumentBase::$buffer public property
DocumentBase::$charset public property
DocumentBase::$commands protected property
DocumentBase::$content_type public property
DocumentBase::$filename protected property
DocumentBase::$file_name public property
DocumentBase::$format public property
DocumentBase::$headers public property
DocumentBase::$libraries public property
DocumentBase::$parameters_form public property
DocumentBase::$skin protected property
DocumentBase::$skin_name protected property
DocumentBase::$title public property
DocumentBase::$write_buffer protected property
DocumentBase::addAjaxCommand public function
DocumentBase::check_markup public function Wrapper function for check output to default the right type.
DocumentBase::clear public function Clear the buffer Overrides DocumentInterface::clear
DocumentBase::convertCharset public function Perform character set conversion
DocumentBase::footer public function No default footer. Overrides DocumentInterface::footer 1
DocumentBase::getAjaxCommands public function
DocumentBase::setFilename public function Overrides DocumentInterface::setFilename
DocumentBase::setSkin public function Overrides DocumentInterface::setSkin
DocumentBase::write public function Write Overrides DocumentInterface::write
FrxAPI::app public function Returns containing application service
FrxAPI::currentDataContext public function Get the current data context.
FrxAPI::currentDataContextArray public function
FrxAPI::dataManager public function Returns the data manager service
FrxAPI::dataService public function Return Data Service
FrxAPI::documentManager public function Returns the fornea document manager
FrxAPI::error public function Report an error
FrxAPI::getDataContext public function Get the context of a specific id.
FrxAPI::getDocument public function Get the current document
FrxAPI::getReportFileContents public function Load the contents of a file in the report file system.
FrxAPI::innerXML function Enter description here... 1
FrxAPI::popData public function Pop data off of the stack.
FrxAPI::pushData public function Push data onto the Stack
FrxAPI::report public function Run a report with a particular format. 1
FrxAPI::reportFileSystem public function Get the current report file system.
FrxAPI::setDataContext public function Set Data context by id.
FrxAPI::setDocument public function Change to a specific document type.
FrxAPI::skins public function Get list of skins.
PrincePDF::$p private property
PrincePDF::flush public function [@inheritdoc} Overrides DocumentBase::flush
PrincePDF::header public function Default implementation to put in content type based headers. Overrides DocumentBase::header
PrincePDF::__construct public function