Overview

Namespaces

  • None
  • PHP
  • WkHtmlToPdf
    • Options

Traits

  • GlobalOptionsTrait
  • HeaderFooterOptionsTrait
  • OutlineOptionsTrait
  • PageOptionsTrait
  • TocOptionsTrait
  • Overview
  • Namespace
  • Class
  • Tree

Trait HeaderFooterOptionsTrait

Direct Known Users

WkHtmlToPdf\WkHtmlToPdf
Namespace: WkHtmlToPdf\Options
Author: ivanpepelko
Located at WkHtmlToPdf/Options/HeaderFooterOptionsTrait.php
Methods summary
public WkHtmlToPdf\WkHtmlToPdf
# setFooterCenterText( string $text )

Centered footer text.

Centered footer text.

Parameters

$text

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# setFooterFontName( string $name = 'Arial' )

Set footer font name (default Arial).

Set footer font name (default Arial).

Parameters

$name

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# setFooterFontSize( integer $size = 12 )

Set footer font size (default 12).

Set footer font size (default 12).

Parameters

$size

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# setFooterHtml( string $html )

Adds a html footer.

Adds a html footer.

Parameters

$html

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# setFooterHtmlPath( string $path )

Adds a html footer.

Adds a html footer.

Parameters

$path

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# setFooterLeftText( string $text )

Left aligned footer text.

Left aligned footer text.

Parameters

$text

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# enableFooterLine( )

Display line above the footer.

Display line above the footer.

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# disableFooterLine( )

Do not display line above the footer.

Do not display line above the footer.

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# setFooterRightText( string $text )

Right aligned footer text.

Right aligned footer text.

Parameters

$text

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# setFooterSpacing( float $spacing = 0 )

Spacing between footer and content in mm (default 0).

Spacing between footer and content in mm (default 0).

Parameters

$spacing

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# setHeaderCenterText( string $text )

Centered header text.

Centered header text.

Parameters

$text

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# setHeaderFontName( string $name = 'Arial' )

Set header font name (default Arial).

Set header font name (default Arial).

Parameters

$name

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# setHeaderFontSize( integer $size = 12 )

Set header font size (default 12).

Set header font size (default 12).

Parameters

$size

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# setHeaderHtml( string $html )

Adds a html header.

Adds a html header.

Parameters

$html

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# setHeaderHtmlPath( string $path )

Adds a html header.

Adds a html header.

Parameters

$path

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# setHeaderLeftText( string $text )

Left aligned header text.

Left aligned header text.

Parameters

$text

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# enableHeaderLine( )

Display line above the header.

Display line above the header.

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# disableHeaderLine( )

Do not display line above the header.

Do not display line above the header.

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# setHeaderRightText( string $text )

Right aligned header text.

Right aligned header text.

Parameters

$text

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# setHeaderSpacing( float $spacing = 0 )

Spacing between header and content in mm (default 0).

Spacing between header and content in mm (default 0).

Parameters

$spacing

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# addHeaderFooterVar( string $name, string $value )

Add custom value to be replaced in header/footer (--replace argument).

Add custom value to be replaced in header/footer (--replace argument).

Parameters

$name
$value

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# addHeaderFooterVars( array $vars )

Add custom values to be replaced in header/footer (--replace argument).

Add custom values to be replaced in header/footer (--replace argument).

Parameters

$vars

Returns

WkHtmlToPdf\WkHtmlToPdf
wkp2p API documentation generated by ApiGen