classes-Com-Tecnick-Pdf-MetaInfo

It appears that you are using AdBlocking software. The cost of running this website is covered by advertisements. If you like it please feel free to a small amount of money to secure the future of this website.

MetaInfo extends Text

in package

AbstractYes

Com\Tecnick\Pdf\MetaInfo

Meta Informaton PDF class

Tags
since
2002-08-03
category

Library

author

Nicola Asuni info@tecnick.com

copyright

2002-2023 Nicola Asuni - Tecnick.com LTD

license

http://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)

link
https://github.com/tecnickcom/tc-lib-pdf
phpstan-import-type

TViewerPref from Base

Table of Contents

Properties

$barcode  : Barcode
Barcode object
$cache  : Cache
Cache object
$color  : Pdf
Color object
$encrypt  : Encrypt
Encrypt object
$file  : File
File object
$font  : Stack
Font object
$graph  : Draw
Graph object
$image  : Import
Image Import object
$page  : Page
Page object
$pon  : int
Current PDF object number.
$uniconv  : Convert
Unicode Convert object

Methods

getLastTextBBox()  : TextBBox
Returns the last text bounding box [llx, lly, urx, ury].
getTextLine()  : string
Returns the PDF code to render a line of text.
getVersion()  : string
Return the program version.
loadTexHyphenPatterns()  : array<string, string>
Returns an array of hyphenation patterns.
setAuthor()  : static
Defines the author of the document.
setCreator()  : static
Defines the creator of the document.
setDefaultCellMargin()  : void
Set the default cell margin in user units.
setDefaultCellPadding()  : void
Set the default cell padding in user units.
setExtraXMP()  : static
Set additional XMP data to be appended just before the end of "x:xmpmeta" tag.
setExtraXMPRDF()  : static
Set additional XMP data to be appended just before the end of "rdf:RDF" tag.
setKeywords()  : static
Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.
setPDFVersion()  : static
Set the PDF version (check PDF reference for valid values).
setRTL()  : static
Set the default document language direction.
setSRGB()  : static
Set the sRGB mode
setSubject()  : static
Defines the subject of the document.
setTitle()  : static
Defines the title of the document.
setViewerPreferences()  : static
Set the viewer preferences dictionary controlling the way the document is to be presented on the screen or in print.
toPoints()  : float
Convert user units to internal points unit.
toUnit()  : float
Convert internal points to user unit.
toYPoints()  : float
Convert vertical user value to internal points unit.
toYUnit()  : float
Convert vertical internal points value to user unit.

Properties

$barcode

Barcode object

public Barcode $barcode

$cache

Cache object

public Cache $cache

$color

Color object

public Pdf $color

$encrypt

Encrypt object

public Encrypt $encrypt

$file

File object

public File $file

$font

Font object

public Stack $font

$graph

Graph object

public Draw $graph

$image

Image Import object

public Import $image

$page

Page object

public Page $page

$pon

Current PDF object number.

public int $pon = 0

$uniconv

Unicode Convert object

public Convert $uniconv

Methods

getLastTextBBox()

Returns the last text bounding box [llx, lly, urx, ury].

public getLastTextBBox() : TextBBox
Return values
TextBBox

Array of bounding box values.

getTextLine()

Returns the PDF code to render a line of text.

public getTextLine(string $txt[, float $posx = 0 ][, float $posy = 0 ][, float $width = 0 ][, float $strokewidth = 0 ][, float $wordspacing = 0 ][, float $leading = 0 ][, float $rise = 0 ][, bool $fill = true ][, bool $stroke = false ][, bool $clip = false ][, string $forcedir = '' ]) : string
Parameters
$txt : string

Text string to be processed.

$posx : float = 0

X position relative to the start of the current line.

$posy : float = 0

Y position relative to the start of the current line (font baseline).

$width : float = 0

Desired string width to force justification via word spacing (0 = automatic).

$strokewidth : float = 0

Stroke width.

$wordspacing : float = 0

Word spacing (use it only when width == 0).

$leading : float = 0

Leading.

$rise : float = 0

Text rise.

$fill : bool = true

If true fills the text.

$stroke : bool = false

If true stroke the text.

$clip : bool = false

If true activate clipping mode.

$forcedir : string = ''

If 'R' forces RTL, if 'L' forces LTR

Return values
string

getVersion()

Return the program version.

public getVersion() : string
Return values
string

loadTexHyphenPatterns()

Returns an array of hyphenation patterns.

public loadTexHyphenPatterns(string $file) : array<string, string>
Parameters
$file : string

TEX file containing hypenation patterns. TEX patterns can be downloaded from https://www.ctan.org/tex-archive/language/hyph-utf8/tex/generic/hyph-utf8/patterns/tex See https://www.ctan.org/tex-archive/language/hyph-utf8/ for more information.

Return values
array<string, string>

Array of hyphenation patterns.

setAuthor()

Defines the author of the document.

public setAuthor(string $author) : static
Parameters
$author : string

The name of the author.

Return values
static

setCreator()

Defines the creator of the document.

public setCreator(string $creator) : static

This is typically the name of the application that generates the PDF.

Parameters
$creator : string

The name of the creator.

Return values
static

setDefaultCellMargin()

Set the default cell margin in user units.

public setDefaultCellMargin(float $top, float $right, float $bottom, float $left) : void
Parameters
$top : float

Top.

$right : float

Right.

$bottom : float

Bottom.

$left : float

Left.

setDefaultCellPadding()

Set the default cell padding in user units.

public setDefaultCellPadding(float $top, float $right, float $bottom, float $left) : void
Parameters
$top : float

Top.

$right : float

Right.

$bottom : float

Bottom.

$left : float

Left.

setExtraXMP()

Set additional XMP data to be appended just before the end of "x:xmpmeta" tag.

public setExtraXMP(string $xmp) : static

IMPORTANT: This data is added as-is without controls, so you have to validate your data before using this method.

Parameters
$xmp : string

Custom XMP data.

Return values
static

setExtraXMPRDF()

Set additional XMP data to be appended just before the end of "rdf:RDF" tag.

public setExtraXMPRDF(string $xmp) : static

IMPORTANT: This data is added as-is without controls, so you have to validate your data before using this method.

Parameters
$xmp : string

Custom XMP data.

Return values
static

setKeywords()

Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.

public setKeywords(string $keywords) : static
Parameters
$keywords : string

Space-separated list of keywords.

Return values
static

setPDFVersion()

Set the PDF version (check PDF reference for valid values).

public setPDFVersion([string $version = '1.7' ]) : static
Parameters
$version : string = '1.7'

PDF document version.

Tags
throws
Exception

in case of error.

Return values
static

setRTL()

Set the default document language direction.

public setRTL(bool $enabled) : static
Parameters
$enabled : bool

False = LTR = Left-To-Right; True = RTL = Right-To-Left.

Return values
static

setSRGB()

Set the sRGB mode

public setSRGB(bool $enabled) : static
Parameters
$enabled : bool

Set to true to add the default sRGB ICC color profile

Return values
static

setSubject()

Defines the subject of the document.

public setSubject(string $subject) : static
Parameters
$subject : string

The subject.

Return values
static

setTitle()

Defines the title of the document.

public setTitle(string $title) : static
Parameters
$title : string

The title.

Return values
static

setViewerPreferences()

Set the viewer preferences dictionary controlling the way the document is to be presented on the screen or in print.

public setViewerPreferences(TViewerPref $pref) : static
Parameters
$pref : TViewerPref

Array of options (see PDF reference "Viewer Preferences").

Return values
static

toPoints()

Convert user units to internal points unit.

public toPoints(float $usr) : float
Parameters
$usr : float

Value to convert.

Return values
float

toUnit()

Convert internal points to user unit.

public toUnit(float $pnt) : float
Parameters
$pnt : float

Value to convert in user units.

Return values
float

toYPoints()

Convert vertical user value to internal points unit.

public toYPoints(float $usr[, float $pageh = -1 ]) : float

Note: the internal Y points coordinate starts at the bottom left of the page.

Parameters
$usr : float

Value to convert.

$pageh : float = -1

Optional page height in internal points ($pageh:$this->page->getPage()['pheight']).

Return values
float

toYUnit()

Convert vertical internal points value to user unit.

public toYUnit(float $pnt[, float $pageh = -1 ]) : float

Note: the internal Y points coordinate starts at the bottom left of the page.

Parameters
$pnt : float

Value to convert.

$pageh : float = -1

Optional page height in internal points ($pageh:$this->page->getPage()['pheight']).

Return values
float
On this page
 

© 2004-2024 – Nicola Asuni - Tecnick.com - All rights reserved.
about - disclaimer - privacy