[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/mod/assign/feedback/editpdf/fpdi/ -> fpdf_tpl.php (summary)

(no description)

File Size: 460 lines (16 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

FPDF_TPL:: (14 methods):
  beginTemplate()
  endTemplate()
  useTemplate()
  getTemplateSize()
  SetFont()
  Image()
  AddPage()
  Link()
  AddLink()
  SetLink()
  _putformxobjects()
  _putimages()
  _putxobjectdict()
  _out()


Class: FPDF_TPL  - X-Ref

beginTemplate($x = null, $y = null, $w = null, $h = null)   X-Ref
Start a Template

This method starts a template. You can give own coordinates to build an own sized
Template. Pay attention, that the margins are adapted to the new templatesize.
If you want to write outside the template, for example to build a clipped Template,
you have to set the Margins and "Cursor"-Position manual after beginTemplate-Call.

If no parameter is given, the template uses the current page-size.
The Method returns an ID of the current Template. This ID is used later for using this template.
Warning: A created Template is used in PDF at all events. Still if you don't use it after creation!

param: int $x The x-coordinate given in user-unit
param: int $y The y-coordinate given in user-unit
param: int $w The width given in user-unit
param: int $h The height given in user-unit
return: int The ID of new created Template

endTemplate()   X-Ref
End Template

This method ends a template and reset initiated variables on beginTemplate.

return: mixed If a template is opened, the ID is returned. If not a false is returned.

useTemplate($tplidx, $_x = null, $_y = null, $_w = 0, $_h = 0)   X-Ref
Use a Template in current Page or other Template

You can use a template in a page or in another template.
You can give the used template a new size like you use the Image()-method.
All parameters are optional. The width or height is calculated automaticaly
if one is given. If no parameter is given the origin size as defined in
beginTemplate() is used.
The calculated or used width and height are returned as an array.

param: int $tplidx A valid template-Id
param: int $_x The x-position
param: int $_y The y-position
param: int $_w The new width of the template
param: int $_h The new height of the template
return: array The height and width of the template

getTemplateSize($tplidx, $_w = 0, $_h = 0)   X-Ref
Get The calculated Size of a Template

If one size is given, this method calculates the other one.

param: int $tplidx A valid template-Id
param: int $_w The width of the template
param: int $_h The height of the template
return: array The height and width of the template

SetFont($family, $style='', $size=null, $fontfile='', $subset='default', $out=true)   X-Ref
See FPDF/TCPDF-Documentation ;-)


Image( $file, $x = '', $y = '', $w = 0, $h = 0, $type = '', $link = '', $align = '', $resize = false, $dpi = 300, $palign = '', $ismask = false, $imgmask = false, $border = 0, $fitbox = false, $hidden = false, $fitonpage = false, $alt = false, $altimgs = array()   X-Ref
See FPDF/TCPDF-Documentation ;-)


AddPage($orientation = '', $format = '', $keepmargins = false, $tocpage = false)   X-Ref
See FPDF-Documentation ;-)

AddPage is not available when you're "in" a template.

Link($x, $y, $w, $h, $link, $spaces = 0)   X-Ref
Preserve adding Links in Templates ...won't work


AddLink()   X-Ref
No description

SetLink($link, $y = 0, $page = -1)   X-Ref
No description

_putformxobjects()   X-Ref
Private Method that writes the form xobjects


_putimages()   X-Ref
Overwritten to add _putformxobjects() after _putimages()


_putxobjectdict()   X-Ref
No description

_out($s)   X-Ref
Private Method




Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1