class views_pdf_handler_page_number in Views PDF 6

Plugin class that holds the functionality for the page number in a PDF display.

Hierarchy

• class \views_pdf_handler_page_number extends \views_handler_field

1 string reference to 'views_pdf_handler_page_number'

views_pdf_views_data in ./views_pdf.views.inc

Implementation of hook_views_data()

File

field_plugins/views_pdf_handler_page_number.inc, line 17

The page number plugin for PDF page display.

class views_pdf_handler_page_number extends views_handler_field {

  /**
   * This method  is used to query data. In our case
   * we want that no data is queried.
   *
   */
  function query() {

    // Override parent::query() and don't alter query.
    $this->field_alias = 'pdf_page_number_' . $this->position;
  }

  /**
   * This method adds a page number to the display, if it is a PDF display.
   * Therefore the PDF class is used.
   */
  function render($values) {
    if (isset($this->view->pdf) && is_object($this->view->pdf)) {
      return $this->view->pdf
        ->getPage();
    }
    else {
      return '';
    }
  }

  /**
   * We dont want to use advanced rendering.
   */
  function allow_advanced_render() {
    return FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
views_pdf_handler_page_number::allow_advanced_render		function	We dont want to use advanced rendering.
views_pdf_handler_page_number::query		function	This method is used to query data. In our case we want that no data is queried.
views_pdf_handler_page_number::render		function	This method adds a page number to the display, if it is a PDF display. Therefore the PDF class is used.