• Home
• Horde_Pdf_Writer

PHP Class Horde_Pdf_Writer, horde

Datei anzeigen Open project: horde/horde Class Usage Examples

Public Properties

Property	Type	Description
$fh	float	Current height of page format in user units.
$fhPt	float	Current height of page format in points.
$fw	float	Current width of page format in user units.
$fwPt	float	Current width of page format in points.
$h	float	Current height of page in user units
$hPt	float	Current height of page in points.
$w	float	Current width of page in user units
$wPt	float	Current width of page in points.
$x	float	Value is set in user units and is calculated from the top left corner as origin.
$y	float	Value is set in user units and is calculated from the top left corner as origin.

Protected Properties

Property	Type	Description
$_alias_nb_pages	string	Alias for total number of pages.
$_auto_page_break	boolean	Automatic page breaking.
$_break_margin	float	Break page margin size, the bottom margin which triggers a page break.
$_buffer	string	Buffer holding in-memory Pdf.
$_buflen	integer	Buffer length, including already flushed content.
$_cell_margin	float	Cell margin size.
$_color_flag	boolean	Whether text color is different from fill color.
$_compress	boolean	Flag indicating if PDF file is to be compressed or not.
$_core_fonts	array	An array of standard font names.
$_current_font	array	An array containing current font info.
$_current_orientation	string	The current page orientation.
$_default_orientation	string	The default page orientation.
$_diffs	array	An array of encoding differences.
$_draw_color	string	Commands for drawing color.
$_fill_color	string	Commands for filling color.
$_flushed	boolean	Whether the buffer has been flushed already.
$_font_family	string	Current font family.
$_font_files	array	An array of font files.
$_font_size	float	Current font size in user units.
$_font_size_pt	float	Current font size in points.
$_font_style	string	Current font style.
$_font_widths	array	Widths of specific font files
$_fonts	array	An array of used fonts.
$_images	array	An array of used images.
$_in_footer	boolean	Flag set when processing footer.
$_info	array	An array containing the document info, consisting of: - title - subject - author - keywords - creator
$_last_height	float	The height of the last cell printed.
$_layout_mode	string	Layout display mode.
$_left_margin	float	Left page margin size.
$_line_width	float	Line width in user units.
$_links	array	An array of internal links.
$_n	integer	Current object number.
$_offsets	array	Array of object offsets.
$_orientation_changes	array	Array indicating orientation changes.
$_page	integer	Current page number.
$_page_break_trigger	float	Threshold used to trigger page breaks.
$_page_links	array	An array of links in pages.
$_pages	array	Array containing the pages.
$_right_margin	float	Right page margin size.
$_scale	float	Scale factor (number of points in user units).
$_state	integer	Current document state. 0 - initial state 1 - document opened 2 - page opened 3 - document closed
$_text_color	string	Commands for text color.
$_top_margin	float	Top page margin size.
$_underline	boolean	Underlining flag.
$_word_spacing	integer	Word spacing.
$_zoom_mode	string	Zoom display mode.

Public Methods

Method	Description
__construct ( array $params = [] )	Constructor
acceptPageBreak ( ) : boolean	Whenever a page break condition is met, the method is called, and the break is issued or not depending on the returned value. The default implementation returns a value according to the mode selected by {@link setAutoPageBreak()}.
addFont ( string $family, string $style = '', string $file = '' )	Imports a TrueType or Type1 font and makes it available. It is necessary to generate a font definition file first with the makefont.php utility.
addLink ( )	Creates a new internal link and returns its identifier.
addPage ( string $orientation = '' )	Adds a new page to the document.
aliasNbPages ( string $alias = '{nb}' )	Defines an alias for the total number of pages.
cell ( float $width, float $height, string $text = '', mixed $border, integer $ln, string $align = '', integer $fill, string $link = '' )	Prints a cell (rectangular area) with optional borders, background color and character string.
circle ( float $x, float $y, float $r, string $style = '' )	Outputs a circle. It can be drawn (border only), filled (with no border) or both.
close ( )	Terminates the PDF document.
flush ( )	Returns the current buffer content and resets the buffer.
footer ( )	This method is used to render the page footer.
getDefaultOrientation ( ) : string	P (portrait) or L (landscape)
getDrawColor ( ) : string	Get the draw color
getFillColor ( ) : string	Get the fill color
getFormatHeight ( ) : float
getFormatWidth ( ) : float
getOutput ( )	Returns the raw Pdf file.
getPage ( ) : integer	Get the current page
getPageHeight ( ) : float	Returns the actual page height.
getPageNo ( ) : integer	Returns the current page number.
getPageWidth ( ) : float	Returns the actual page width.
getScale ( ) : integer
getStringWidth ( string $text, boolean $pt = false ) : float	Returns the length of a text string. A font must be selected.
getTextColor ( ) : string	Get the text color
getX ( ) : float	Returns the abscissa of the current position in user units.
getY ( ) : float	Returns the ordinate of the current position in user units.
header ( )	This method is used to render the page header.
image ( string $file, float $x, float $y, float $width, float $height, string $type = '', mixed $link = '' )	Prints an image in the page.
line ( float $x1, float $y1, float $x2, float $y2 )	Draws a line between two points.
link ( float $x, float $y, float $width, float $height, mixed $link )	Puts a link on a rectangular area of the page.
multiCell ( float $width, float $height, string $text, mixed $border, string $align = 'J', integer $fill )	This method allows printing text with line breaks.
newLine ( float $height = '' )	Performs a line break.
open ( )	This method begins the generation of the PDF document; it must be called before any output commands.
rect ( float $x, float $y, float $width, float $height, float $style = '' )	Outputs a rectangle.
save ( string $filename = 'unknown.pdf' )	Saves the PDF file on the filesystem.
setAutoPageBreak ( boolean $auto, float $margin )	Enables or disables the automatic page breaking mode.
setCompression ( boolean $compress )	Activates or deactivates page compression.
setDisplayMode ( mixed $zoom, $layout = 'continuous' )	Defines the way the document is to be displayed by the viewer.
setDrawColor ( string $cs = 'rgb', float $c1, float $c2, float $c3, float $c4 )	Sets the draw color, used when drawing lines.
setFillColor ( string $cs = 'rgb', float $c1, float $c2, float $c3, float $c4 )	Sets the fill color.
setFont ( string $family, string $style = '', integer $size = null, boolean $force = false )	Sets the font used to print character strings.
setFontSize ( float $size )	Defines the size of the current font.
setFontStyle ( string $style )	Defines the style of the current font.
setInfo ( array | string $info, string $value = '' )	Set the info to a document.
setLeftMargin ( float $margin )	Defines the left margin.
setLineWidth ( float $width )	Defines the line width.
setLink ( integer $link, float $y, integer $page )	Defines the page and position a link points to.
setMargins ( float $left, float $top, float $right = null )	Defines the left, top and right margins.
setPage ( integer $page )	Set the current page
setRightMargin ( float $margin )	Defines the right margin.
setTextColor ( string $cs = 'rgb', float $c1, float $c2, float $c3, float $c4 )	Sets the text color.
setTopMargin ( float $margin )	Defines the top margin.
setX ( float $x )	Defines the abscissa of the current position.
setXY ( float $x, float $y )	Defines the abscissa and ordinate of the current position.
setY ( float $y )	Defines the ordinate of the current position.
text ( float $x, float $y, string $text )	Prints a character string.
write ( float $height, string $text, mixed $link = '' )	This method prints text from the current position.
writeRotated ( integer $x, integer $y, string $text, float $text_angle, float $font_angle )	Writes text at an angle.

Protected Methods

Method	Description
_beginDoc ( ) : void	Begin the PDF document.
_beginPage ( string $orientation ) : void	Begin a new page.
_doUnderline ( integer $x, integer $y, string $text ) : string	Underline a block of text.
_endDoc ( ) : void	End the PDF document
_endPage ( ) : void	Set the end of page contents.
_escape ( string $s ) : string	Escape parentheses and forward slash.
_freadInt ( resource $f ) : integer	Read a 4-byte integer from stream.
_getFontFile ( string $fontkey ) : array	Load information about a font from its key name.
_hexToRgb ( $hex )	Convert hex-based color to RGB
_link ( integer $x, integer $y, integer $width, integer $height, string $link ) : void	Save link to page links array.
_newobj ( ) : void	Begin a new object.
_out ( string $s ) : void	Add a line to the document.
_parseJPG ( string $file ) : array	Extract info from a JPEG file.
_parsePNG ( string $file ) : array	Extract info from a PNG file.
_putCatalog ( ) : void	Write the PDF catalog.
_putFonts ( ) : void	Write the PDF fonts.
_putImages ( ) : void	Write the PDF images.
_putInfo ( ) : void	Write the PDF information.
_putPages ( ) : void	Write the PDF pages.
_putResources ( ) : void	Write the PDF resources.
_putStream ( string $s ) : void	Add a line to the document wrapped in 'stream' and 'endstream'.
_putTrailer ( ) : void	Write the PDF trailer.
_textString ( string $s ) : string	Format a text string by escaping and wrapping in parentheses.
_toPt ( integer $val ) : integer	Scale a value.

Method Details

Property Details