Manuals

 

SetaPDF_MetaManager::getPageData()

Description

class SetaPDF_MetaManager extends SetaPDF {
mixed getPageData ( integer $pageNo[, string $key=null[, boolean $limit=false]] ) }

Returns information of a specific page.

Parameters

$pageNo

The page number you want to get the information from.

$key

The key or an array of keys which values you want to get.

Possible keys:

  • MediaBox
  • CropBox
  • BleedBox
  • TrimBox
  • ArtBox
  • LastModified
  • Rotate

If no key is given all available values will be taken.

$limit

With this parameter you can define that the API will load/extract only the pages you defined in parameter $pageNo.

This is usable if you just want to get information of only a single page in a script call. If you use this method several times, you should leave that parameter to be false.

Return Value

If $key is an array or null this method will return an array with the desired key and value pairs or the single value if only a single key is given in the $key-parameter.

If no value is available the value will be null.

The box type values (MediaBox, CropBox,...) will be in the following structure:

array(
  
'llx' => ..., // Lower Left X
   'lly' => ..., // Lower Left Y
   'urx' => ..., // Upper Right X
   'ury' => ..., // Upper Right Y
   '_w' => ..., // Width
   '_h' => ... // Height
);

The Rotate value will be an integer (multiple of 90).

The LastModified value will be returned as a datetime string (see PDF Reference 3.8.3).

Version

Available since version 1.1.