Index

  1. \SetaPDF
    1. Core
    2. Core
      1. Document
      2. Document
        1. Action
        2. Action
        3. Catalog
        4. Catalog
        5. OptionalContent
        6. Page
        7. Page
        8. CrossReferenceTable
        9. Destination
        10. Info
        11. ObjectNotDefinedException
        12. ObjectNotFoundException
        13. OutlinesItem
        14. PageLayout
        15. PageMode

SetaPDF_Core_Document_Destination Class for handling Destinations in a PDF document

File: /SetaPDF v2/Core/Document/Destination.php

Class hierarchy

Summary

Static Methods

Methods

Properties

Constants

Constants

FIT_MODE_FIT

public const SetaPDF_Core_Document_Destination::FIT_MODE_FIT = 'Fit'

Fit mode constant.

Display the page designated by page, with its contents magnified just enough to fit the entire page within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the page within the window in the other dimension.
See
  • PDF 32000-1:2008 - Table 151

FIT_MODE_FIT_B

public const SetaPDF_Core_Document_Destination::FIT_MODE_FIT_B = 'FitB'

Fit mode constant.

Display the page designated by page, with its contents magnified just enough to fit its bounding box entirely within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the bounding box within the window in the other dimension.
See
  • PDF 32000-1:2008 - Table 151

FIT_MODE_FIT_BH

public const SetaPDF_Core_Document_Destination::FIT_MODE_FIT_BH = 'FitBH'

Fit mode constant.

Display the page designated by page, with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of its bounding box within the window. A null value for top specifies that the current value of that parameter shall be retained unchanged.
See
  • PDF 32000-1:2008 - Table 151

FIT_MODE_FIT_BV

public const SetaPDF_Core_Document_Destination::FIT_MODE_FIT_BV = 'FitBV'

Fit mode constant.

Display the page designated by page, with the horizontal coordinate left positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of its bounding box within the window. A null value for left specifies that the current value of that parameter shall be retained unchanged.
See
  • PDF 32000-1:2008 - Table 151

FIT_MODE_FIT_H

public const SetaPDF_Core_Document_Destination::FIT_MODE_FIT_H = 'FitH'

Fit mode constant.

Display the page designated by page, with the vertical coordinate toppositioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of the page within the window. A null value for top specifies that the current value of that parameter shall be retained unchanged.
See
  • PDF 32000-1:2008 - Table 151

FIT_MODE_FIT_R

public const SetaPDF_Core_Document_Destination::FIT_MODE_FIT_R = 'FitR'

Fit mode constant.

Display the page designated by page, with its contents magnified just enough to fit the rectangle specified by the coordinates left, bottom, right, and top entirely within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the rectangle within the window in the other dimension.
See
  • PDF 32000-1:2008 - Table 151

FIT_MODE_FIT_V

public const SetaPDF_Core_Document_Destination::FIT_MODE_FIT_V = 'FitV'

Fit mode constant.

Display the page designated by page, with the horizontal coordinate left positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of the page within the window. A null value for left specifies that the current value of that parameter shall be retained unchanged.
See
  • PDF 32000-1:2008 - Table 151

FIT_MODE_XYZ

public const SetaPDF_Core_Document_Destination::FIT_MODE_XYZ = 'XYZ'

Fit mode constant.

Display the page designated by page, with the coordinates (left, top) positioned at the upper-left corner of the window and the contents of the page magnified by the factor zoom. A null value for any of the parameters left, top, or zoom specifies that the current value of that parameter shall be retained unchanged. A zoom value of 0 has the same meaning as a null value.
See
  • PDF 32000-1:2008 - Table 151

Properties

$_destination

protected SetaPDF_Core_Type_Array SetaPDF_Core_Document_Destination::$_destination

The destination array

$_indirectReference

protected null|SetaPDF_Core_Type_IndirectObjectInterface SetaPDF_Core_Document_Destination::$_indirectReference

Static Methods

_handleFitModeParameter()

protected static SetaPDF_Core_Document_Destination::_handleFitModeParameter (
SetaPDF_Core_Type_Array $array, string $fitMode
): SetaPDF_Core_Type_Array

Handle the fitMode parameter and set the correct values in the resulting array.

Parameters
$array : SetaPDF_Core_Type_Array
 
$fitMode : string
 

createByPage()

public static SetaPDF_Core_Document_Destination::createByPage (): SetaPDF_Core_Document_Destination

Creates a destination by a page object.

All additional arguments are passed to the createDestinationArray() method.

Parameters
$page : SetaPDF_Core_Document_Page
 
See

createByPageNo()

public static SetaPDF_Core_Document_Destination::createByPageNo (
SetaPDF_Core_Document $document, int $pageNumber
): SetaPDF_Core_Document_Destination

Creates a destination by page number.

All additional arguments are passed to the createDestinationArray() method.

Example:

$destinationArray = SetaPDF_Core_Document_Destination::createByPageNo(
    $document, 123, SetaPDF_Core_Document_Destination::FIT_MODE_XYZ, 30, 50, 200
);
Parameters
$document : SetaPDF_Core_Document
 
$pageNumber : int
 
Exceptions

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Type_Exception

See

createDestinationArray()

public static SetaPDF_Core_Document_Destination::createDestinationArray (): SetaPDF_Core_Type_Array

Creates an explicit Destination array.

This method allows you to pass a flexible argument count after the $fitMode parameter, depending on its value. Following fit modes expect following arguments:

SetaPDF_Core_Document_Destination::FIT_MODE_XYZ

float|null $left, float|null $top, float|null $zoom

SetaPDF_Core_Document_Destination::FIT_MODE_FIT

- no parameter -

SetaPDF_Core_Document_Destination::FIT_MODE_FIT_H

float|null $top

SetaPDF_Core_Document_Destination::FIT_MODE_FIT_V

float|null $left

SetaPDF_Core_Document_Destination::FIT_MODE_FIT_R

float $left, float $bottom, float $right, float $top

SetaPDF_Core_Document_Destination::FIT_MODE_FIT_B

- no parameter -

SetaPDF_Core_Document_Destination::FIT_MODE_FIT_BH

float|null $top

SetaPDF_Core_Document_Destination::FIT_MODE_FIT_BV

float|null $left

Example:

$destinationArray = SetaPDF_Core_Document_Destination::createDestinationArray(
    $indirectObject, SetaPDF_Core_Document_Destination::FIT_MODE_XYZ, 30, 50, 200
);

It is also possible to pass a single array to the $fitMode parameter with all data:

$destinationArray = SetaPDF_Core_Document_Destination::createDestinationArray(
    $indirectObject, [SetaPDF_Core_Document_Destination::FIT_MODE_XYZ, 30, 50, 200]
);
Parameters
$pageObject : SetaPDF_Core_Type_IndirectObject|SetaPDF_Core_Type_Numeric

The indirect object of a page of or the page number for the usage in remote go-to actions.

$fitMode : string|array

The fit mode or an array with the fit mode and all additional arguments

Exceptions

Throws InvalidArgumentException

findByName()

public static SetaPDF_Core_Document_Destination::findByName (
SetaPDF_Core_Document $document, string $name
): bool|SetaPDF_Core_Document_Destination

Find a destination by a name.

Parameters
$document : SetaPDF_Core_Document
 
$name : string
 
Return Values

The destination object or false if it was not found.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception


Methods

__construct()

public SetaPDF_Core_Document_Destination::__construct ()

The constructor.

Parameters
$destination : SetaPDF_Core_Type_AbstractType
 
Exceptions

Throws InvalidArgumentException

getDestinationArray()

public SetaPDF_Core_Document_Destination::getDestinationArray (
void
): SetaPDF_Core_Type_Array

Get the destination array.

getFitMode()

public SetaPDF_Core_Document_Destination::getFitMode (
void
): array

Get the fit mode and its parameters.

Return Values

Index 0 is the fit mode, all other values are the individual parameters of the fit mode.

Exceptions

Throws SetaPDF_Core_Type_Exception

getIndirectObject()

public SetaPDF_Core_Document_Destination::getIndirectObject (
[ SetaPDF_Core_Document $document = null ]
): SetaPDF_Core_Type_IndirectObjectInterface

Get the indirect object of this destination or creates it in the specific document context.

Parameters
$document : SetaPDF_Core_Document

The document instance

getPage()

public SetaPDF_Core_Document_Destination::getPage (): SetaPDF_Core_Document_Page|false

Get the target page object.

Parameters
$document : SetaPDF_Core_Document
 
Exceptions

Throws SetaPDF_Core_Document_ObjectNotDefinedException

Throws SetaPDF_Core_Document_ObjectNotFoundException

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Type_Exception

getPageNo()

public SetaPDF_Core_Document_Destination::getPageNo (): integer|false

Get the target page number.

Parameters
$document : SetaPDF_Core_Document
 
Exceptions

Throws SetaPDF_Core_Document_ObjectNotDefinedException

Throws SetaPDF_Core_Document_ObjectNotFoundException

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Type_Exception

getPdfValue()

public SetaPDF_Core_Document_Destination::getPdfValue (
void
): SetaPDF_Core_Type_Array

Get the PDF value of this destination.

setFitMode()

public SetaPDF_Core_Document_Destination::setFitMode (
string|array $fitMode
): void

Set the fit mode.

Parameters
$fitMode : string|array
 
See

© 2024 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)