eZ Components 2009.2

Getting Started

Components

Archive (1.4)
Authentication (1.3.1)
AuthenticationDatabaseTiein (1.1)
Base (1.8)
Cache (1.5)
Configuration (1.3.5)
ConsoleTools (1.6)
Database (1.4.6)
DatabaseSchema (1.4.3)
Debug (1.2.1)
Document (1.3)
EventLog (1.4)
EventLogDatabaseTiein (1.0.2)
Execution (1.1.1)
Feed (1.3)
File (1.2)
Graph (1.5)
GraphDatabaseTiein (1.0.1)
ImageAnalysis (1.1.3)
ImageConversion (1.3.7)
Mail (1.7)
MvcTools (1.1.2)
MvcAuthenticationTiein (1.0)
MvcFeedTiein (1.0)
MvcMailTiein (1.0.1)
MvcTemplateTiein (1.0)
PersistentObject (1.7)
PersistentObjectDatabaseSchemaTiein (1.3)
PhpGenerator (1.0.5)
Search (1.0.8)
SignalSlot (1.1.1)
SystemInformation (1.0.8)
Template (1.4.2)
TemplateTranslationTiein (1.1)
Translation (1.3.2)
TranslationCacheTiein (1.1.2)
Tree (1.1.3)
TreeDatabaseTiein (1.1.1)
TreePersistentObjectTiein (1.0)
Url (1.2.2)
UserInput (1.4)
Webdav (1.1.3)
Workflow (1.4)
WorkflowDatabaseTiein (1.4)
WorkflowEventLogTiein (1.1)
WorkflowSignalSlotTiein (1.0)

Document: ezcDocumentPdfHeaderPdfPart

[ Tutorial ] [ Conversion ] [ Styles ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Class: ezcDocumentPdfHeaderPdfPart

Just an alias for the footer class, but will be positioned on the top of a page by default. [source]

A header, or any other PDF part, can be registered for rendering in the main PDF class using the registerPdfPart() method, like:

 1.   $pdf = new ezcDocumentPdf();
 2.  
 3.   // Add a customized footer
 4.   $pdf->registerPdfPart( new ezcDocumentPdfHeaderPdfPart(
 5.       new ezcDocumentPdfFooterOptions( array(
 6.           'showPageNumber' => false,
 7.           'height'         => '10mm',
 8.       ) )
 9.   ) );
10.  
11.   $pdf->createFromDocbook( $docbook );
12.   file_put_contents( __FILE__ . '.pdf', $pdf );

Since it is just an alias class for the ezcDocumentPdfFooterPdfPart it is also confugured by using the ezcDocumentPdfFooterOptions class.

Parents

ezcDocumentPdfPart
   |
   --ezcDocumentPdfFooterPdfPart
      |
      --ezcDocumentPdfHeaderPdfPart

Inherited Member Variables

From ezcDocumentPdfFooterPdfPart:

protected	`ezcDocumentPdfFooterPdfPart::$document`
protected	`ezcDocumentPdfFooterPdfPart::$documentAuthor`
protected	`ezcDocumentPdfFooterPdfPart::$documentTitle`
protected	`ezcDocumentPdfFooterPdfPart::$options`

From ezcDocumentPdfPart:

protected	`ezcDocumentPdfPart::$driver`
protected	`ezcDocumentPdfPart::$renderer`
protected	`ezcDocumentPdfPart::$styles`

Method Summary

public ezcDocumentPdfHeaderPdfPart

__construct(
[$options = null] )

Create a new footer PDF part.

Inherited Methods

From ezcDocumentPdfFooterPdfPart :

public ezcDocumentPdfFooterPdfPart	`ezcDocumentPdfFooterPdfPart::__construct()` Create a new footer PDF part
public void	`ezcDocumentPdfFooterPdfPart::hookDocumentCreation()` Hook on document creation
public void	`ezcDocumentPdfFooterPdfPart::hookPageCreation()` Hook on page creation

From ezcDocumentPdfPart :

public void	`ezcDocumentPdfPart::hookDocumentCreation()` Hook on document creation
public void	`ezcDocumentPdfPart::hookDocumentRendering()` Hook on document rendering
public void	`ezcDocumentPdfPart::hookPageCreation()` Hook on page creation
public void	`ezcDocumentPdfPart::hookPageRendering()` Hook on page rendering
public void	`ezcDocumentPdfPart::registerContext()` Registration function called by the renderer.

Methods

__construct

ezcDocumentPdfHeaderPdfPart __construct( [ezcDocumentPdfFooterOptions $options = null] )