CPDF Class Reference

PDF creator object extending FDPF library. More...

Inheritance diagram for CPDF:

Public Member Functions
	__construct ($orientation='P', $unit='mm', $format='A4')
	CPDF ($orientation=null, $unit=null, $format=null)
	MultiCell ($w, $h, $txt, $border=0, $align='J', $fill=false, $maxLines=0)
	setFont ($font='', $style=null, $size=null, $isTemporary=false)
	revert_font ()
	set_htmlParams ($params=array())
	get_realWidth ($w=0)
	write_html ($html)
	get_fontList ()
	decode_text ($text)
	decode_HTMLText ($text='')
	set_textColor ($color='')
	move_page ($page, $location)

Private Member Functions
	_write_htmlOpenTag ($tag, $attr)
	_write_htmlCloseTag ($tag)
	_write_htmlSetStyle ($tag, $enable)
	_write_htmlAddLink ($URL, $txt)
	_encode_entities ($text)

Detailed Description

PDF creator object extending FDPF library.

Engine / Object Library

Author

CaMykS Team camyk.nosp@m.s.co.nosp@m.ntact.nosp@m.@gma.nosp@m.il.co.nosp@m.m

Version

1.0.5.1

Date

Creation: May 2010

Modification: Jul 2025

Copyright

2010 - 2025 CaMykS Team

Note

This program is distributed as is - WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Warning

This library is not loaded with CaMykS initialisation. CPDF class.

Constructor & Destructor Documentation

__construct()

CPDF::__construct	(		$orientation = 'P',
			$unit = 'mm',
			$format = 'A4'
	)

Class constructor.

Parameters

string	$orientation
string	$unit
mixed	$format

Member Function Documentation

CPDF()

CPDF::CPDF	(		$orientation = null,
			$unit = null,
			$format = null
	)

Old style constructor definition.

Parameters

string	$orientation
string	$unit
mixed	$format

Returns

void

MultiCell()

CPDF::MultiCell	(		$w,
			$h,
			$txt,
			$border = 0,
			$align = 'J',
			$fill = false,
			$maxLines = 0
	)

Write multiple lines at once

Parameters

int	$w
int	$h
string	$txt
mixed	$border
string	$align
boolean	$fill
integer	$maxLines

Returns

string

setFont()

CPDF::setFont	(		$font = '',
			$style = null,
			$size = null,
			$isTemporary = false
	)

Define font.

Parameters

string	$font
string	$style
integer	$size
boolean	$isTemporary

Returns

void

revert_font()

CPDF::revert_font

(

)

Revert font (after temporary use).

Returns

void

set_htmlParams()

CPDF::set_htmlParams

(

$params = array()

)

Update html params.

Parameters

array

$params

Returns

void

get_realWidth()

CPDF::get_realWidth

(

$w = 0

)

Return real width.

Parameters

float

$w

Returns

float

write_html()

CPDF::write_html

(

$html

)

Write html into PDF.

Parameters

HTML

$html

Returns

void

get_fontList()

CPDF::get_fontList

(

)

Return available fond list.

Returns

array

decode_text()

CPDF::decode_text

(

$text

)

Decode text.

Parameters

string

$text

Returns

string

decode_HTMLText()

CPDF::decode_HTMLText

(

$text = ''

)

Return entity decoded text.

Parameters

string

$text

Returns

string

set_textColor()

CPDF::set_textColor

(

$color = ''

)

Set text color from any value.

Parameters

mixed

$color

Returns

string

move_page()

CPDF::move_page	(		$page,
			$location
	)

Move current page to a new location.

Parameters

integer	$page
integer	$location

Returns

void

_write_htmlOpenTag()

CPDF::_write_htmlOpenTag (   $tag,   $attr  )

private

Open tag for html writing.

Parameters

string	$tag
array	$attr

Returns

void

_write_htmlCloseTag()

CPDF::_write_htmlCloseTag (   $tag )

private

Close tag for html writing.

Parameters

string

$tag

Returns

void

_write_htmlSetStyle()

CPDF::_write_htmlSetStyle (   $tag,   $enable  )

private

Define current style for html writing.

Parameters

string	$tag
integer	$enable

Returns

void

_write_htmlAddLink()

CPDF::_write_htmlAddLink (   $URL,   $txt  )

private

Add link to text.

Parameters

string	$URL
string	$txt

Returns

void

_encode_entities()

CPDF::_encode_entities (   $text )

private

Encode entities.

Parameters

string

$text

Returns

string

---

The documentation for this class was generated from the following file:

• CaMykS/engine/lib/object/CPDF.php.inc