PageInterface
in
Pdf page interface
Tags
Table of Contents
Methods
- addAnnotation() : PageInterface
- Add an annotation to the PDF page
- addImage() : PageInterface
- Add an image to the PDF page
- addLink() : PageInterface
- Add a link annotation to the PDF page
- addPath() : PageInterface
- Add a path to the Pdf page
- addText() : PageInterface
- Add text to the PDF page
- addUrl() : PageInterface
- Add a URL annotation to the PDF page
- getAnnotations() : array<string|int, mixed>
- Get annotation objects
- getHeight() : int
- Get the page height
- getImages() : array<string|int, mixed>
- Get image objects
- getIndex() : int|null
- Get the page index
- getPaths() : array<string|int, mixed>
- Get path objects
- getText() : array<string|int, mixed>
- Get text objects
- getWidth() : int
- Get the page width
- hasAnnotations() : bool
- Determine if the page has annotation objects
- hasImages() : bool
- Determine if the page has image objects
- hasPaths() : bool
- Determine if the page has path objects
- hasText() : bool
- Determine if the page has text objects
- setHeight() : PageInterface
- Set the page height
- setIndex() : PageInterface
- Set the page index
- setWidth() : PageInterface
- Set the page width
Methods
addAnnotation()
Add an annotation to the PDF page
public
addAnnotation(AbstractAnnotation $annotation[, int $x = 0 ][, int $y = 0 ]) : PageInterface
Parameters
- $annotation : AbstractAnnotation
- $x : int = 0
- $y : int = 0
Return values
PageInterfaceaddImage()
Add an image to the PDF page
public
addImage(Image $image[, int $x = 0 ][, int $y = 0 ]) : PageInterface
Parameters
- $image : Image
- $x : int = 0
- $y : int = 0
Return values
PageInterfaceaddLink()
Add a link annotation to the PDF page
public
addLink(Link $link[, int $x = 0 ][, int $y = 0 ]) : PageInterface
Parameters
- $link : Link
- $x : int = 0
- $y : int = 0
Return values
PageInterfaceaddPath()
Add a path to the Pdf page
public
addPath(Path $path) : PageInterface
Parameters
- $path : Path
Return values
PageInterfaceaddText()
Add text to the PDF page
public
addText(Text $text, string $fontStyle[, int $x = 0 ][, int $y = 0 ]) : PageInterface
Parameters
- $text : Text
- $fontStyle : string
-
(can be either a reference to a font or a style)
- $x : int = 0
- $y : int = 0
Return values
PageInterfaceaddUrl()
Add a URL annotation to the PDF page
public
addUrl(Url $url[, int $x = 0 ][, int $y = 0 ]) : PageInterface
Parameters
- $url : Url
- $x : int = 0
- $y : int = 0
Return values
PageInterfacegetAnnotations()
Get annotation objects
public
getAnnotations() : array<string|int, mixed>
Return values
array<string|int, mixed>getHeight()
Get the page height
public
getHeight() : int
Return values
intgetImages()
Get image objects
public
getImages() : array<string|int, mixed>
Return values
array<string|int, mixed>getIndex()
Get the page index
public
getIndex() : int|null
Return values
int|nullgetPaths()
Get path objects
public
getPaths() : array<string|int, mixed>
Return values
array<string|int, mixed>getText()
Get text objects
public
getText() : array<string|int, mixed>
Return values
array<string|int, mixed>getWidth()
Get the page width
public
getWidth() : int
Return values
inthasAnnotations()
Determine if the page has annotation objects
public
hasAnnotations() : bool
Return values
boolhasImages()
Determine if the page has image objects
public
hasImages() : bool
Return values
boolhasPaths()
Determine if the page has path objects
public
hasPaths() : bool
Return values
boolhasText()
Determine if the page has text objects
public
hasText() : bool
Return values
boolsetHeight()
Set the page height
public
setHeight(mixed $height) : PageInterface
Parameters
- $height : mixed
Return values
PageInterfacesetIndex()
Set the page index
public
setIndex(int $i) : PageInterface
Parameters
- $i : int
Return values
PageInterfacesetWidth()
Set the page width
public
setWidth(mixed $width) : PageInterface
Parameters
- $width : mixed