/**
* Output annotations objects for all pages.
* !!! THIS METHOD IS NOT YET COMPLETED !!!
* See section 12.5 of PDF 32000_2008 reference.
* @protected
* @author Nicola Asuni
* @since 4.0.018 (2008-08-06)
*/
protected function _putannotsobjs()
{
// reset object counter
for ($n = 1; $n <= $this->numpages; ++$n) {
if (isset($this->PageAnnots[$n])) {
// set page annotations
foreach ($this->PageAnnots[$n] as $key => $pl) {
$annot_obj_id = $this->PageAnnots[$n][$key]['n'];
// create annotation object for grouping radiobuttons
if (isset($this->radiobutton_groups[$n][$pl['txt']]) and is_array($this->radiobutton_groups[$n][$pl['txt']])) {
$radio_button_obj_id = $this->radiobutton_groups[$n][$pl['txt']]['n'];
$annots = '<<';
$annots .= ' /Type /Annot';
$annots .= ' /Subtype /Widget';
$annots .= ' /Rect [0 0 0 0]';
if ($this->radiobutton_groups[$n][$pl['txt']]['#readonly#']) {
// read only
$annots .= ' /F 68';
$annots .= ' /Ff 49153';
} else {
$annots .= ' /F 4';
// default print for PDF/A
$annots .= ' /Ff 49152';
}
$annots .= ' /T ' . $this->_datastring($pl['txt'], $radio_button_obj_id);
if (isset($pl['opt']['tu']) and is_string($pl['opt']['tu'])) {
$annots .= ' /TU ' . $this->_datastring($pl['opt']['tu'], $radio_button_obj_id);
}
$annots .= ' /FT /Btn';
$annots .= ' /Kids [';
$defval = '';
foreach ($this->radiobutton_groups[$n][$pl['txt']] as $key => $data) {
if (isset($data['kid'])) {
$annots .= ' ' . $data['kid'] . ' 0 R';
if ($data['def'] !== 'Off') {
$defval = $data['def'];
}
}
}
$annots .= ' ]';
if (!empty($defval)) {
$annots .= ' /V /' . $defval;
}
$annots .= ' >>';
$this->_out($this->_getobj($radio_button_obj_id) . "\n" . $annots . "\n" . 'endobj');
$this->form_obj_id[] = $radio_button_obj_id;
// store object id to be used on Parent entry of Kids
$this->radiobutton_groups[$n][$pl['txt']] = $radio_button_obj_id;
}
$formfield = false;
$pl['opt'] = array_change_key_case($pl['opt'], CASE_LOWER);
$a = $pl['x'] * $this->k;
$b = $this->pagedim[$n]['h'] - ($pl['y'] + $pl['h']) * $this->k;
$c = $pl['w'] * $this->k;
$d = $pl['h'] * $this->k;
$rect = sprintf('%F %F %F %F', $a, $b, $a + $c, $b + $d);
// create new annotation object
$annots = '<</Type /Annot';
$annots .= ' /Subtype /' . $pl['opt']['subtype'];
$annots .= ' /Rect [' . $rect . ']';
$ft = array('Btn', 'Tx', 'Ch', 'Sig');
if (isset($pl['opt']['ft']) and in_array($pl['opt']['ft'], $ft)) {
$annots .= ' /FT /' . $pl['opt']['ft'];
$formfield = true;
}
$annots .= ' /Contents ' . $this->_textstring($pl['txt'], $annot_obj_id);
$annots .= ' /P ' . $this->page_obj_id[$n] . ' 0 R';
$annots .= ' /NM ' . $this->_datastring(sprintf('%04u-%04u', $n, $key), $annot_obj_id);
$annots .= ' /M ' . $this->_datestring($annot_obj_id, $this->doc_modification_timestamp);
if (isset($pl['opt']['f'])) {
$fval = 0;
if (is_array($pl['opt']['f'])) {
foreach ($pl['opt']['f'] as $f) {
switch (strtolower($f)) {
case 'invisible':
$fval += 1 << 0;
break;
case 'hidden':
$fval += 1 << 1;
break;
case 'print':
$fval += 1 << 2;
break;
case 'nozoom':
$fval += 1 << 3;
break;
case 'norotate':
$fval += 1 << 4;
break;
case 'noview':
$fval += 1 << 5;
break;
case 'readonly':
$fval += 1 << 6;
break;
case 'locked':
$fval += 1 << 8;
break;
case 'togglenoview':
$fval += 1 << 9;
break;
case 'lockedcontents':
$fval += 1 << 10;
break;
default:
break;
}
}
} else {
$fval = intval($pl['opt']['f']);
}
} else {
$fval = 4;
}
if ($this->pdfa_mode) {
// force print flag for PDF/A mode
$fval |= 4;
}
$annots .= ' /F ' . intval($fval);
if (isset($pl['opt']['as']) and is_string($pl['opt']['as'])) {
$annots .= ' /AS /' . $pl['opt']['as'];
}
if (isset($pl['opt']['ap'])) {
// appearance stream
$annots .= ' /AP <<';
if (is_array($pl['opt']['ap'])) {
foreach ($pl['opt']['ap'] as $apmode => $apdef) {
// $apmode can be: n = normal; r = rollover; d = down;
$annots .= ' /' . strtoupper($apmode);
if (is_array($apdef)) {
$annots .= ' <<';
foreach ($apdef as $apstate => $stream) {
// reference to XObject that define the appearance for this mode-state
$apsobjid = $this->_putAPXObject($c, $d, $stream);
$annots .= ' /' . $apstate . ' ' . $apsobjid . ' 0 R';
}
$annots .= ' >>';
} else {
// reference to XObject that define the appearance for this mode
$apsobjid = $this->_putAPXObject($c, $d, $apdef);
$annots .= ' ' . $apsobjid . ' 0 R';
}
}
} else {
$annots .= $pl['opt']['ap'];
}
$annots .= ' >>';
}
if (isset($pl['opt']['bs']) and is_array($pl['opt']['bs'])) {
$annots .= ' /BS <<';
$annots .= ' /Type /Border';
if (isset($pl['opt']['bs']['w'])) {
$annots .= ' /W ' . intval($pl['opt']['bs']['w']);
}
$bstyles = array('S', 'D', 'B', 'I', 'U');
if (isset($pl['opt']['bs']['s']) and in_array($pl['opt']['bs']['s'], $bstyles)) {
$annots .= ' /S /' . $pl['opt']['bs']['s'];
}
if (isset($pl['opt']['bs']['d']) and is_array($pl['opt']['bs']['d'])) {
$annots .= ' /D [';
foreach ($pl['opt']['bs']['d'] as $cord) {
$annots .= ' ' . intval($cord);
}
$annots .= ']';
}
$annots .= ' >>';
} else {
$annots .= ' /Border [';
if (isset($pl['opt']['border']) and count($pl['opt']['border']) >= 3) {
$annots .= intval($pl['opt']['border'][0]) . ' ';
$annots .= intval($pl['opt']['border'][1]) . ' ';
$annots .= intval($pl['opt']['border'][2]);
if (isset($pl['opt']['border'][3]) and is_array($pl['opt']['border'][3])) {
$annots .= ' [';
foreach ($pl['opt']['border'][3] as $dash) {
$annots .= intval($dash) . ' ';
}
$annots .= ']';
}
} else {
$annots .= '0 0 0';
}
$annots .= ']';
}
if (isset($pl['opt']['be']) and is_array($pl['opt']['be'])) {
$annots .= ' /BE <<';
$bstyles = array('S', 'C');
if (isset($pl['opt']['be']['s']) and in_array($pl['opt']['be']['s'], $bstyles)) {
$annots .= ' /S /' . $pl['opt']['bs']['s'];
} else {
$annots .= ' /S /S';
}
if (isset($pl['opt']['be']['i']) and $pl['opt']['be']['i'] >= 0 and $pl['opt']['be']['i'] <= 2) {
$annots .= ' /I ' . sprintf(' %F', $pl['opt']['be']['i']);
}
$annots .= '>>';
}
if (isset($pl['opt']['c']) and is_array($pl['opt']['c']) and !empty($pl['opt']['c'])) {
$annots .= ' /C ' . TCPDF_COLORS::getColorStringFromArray($pl['opt']['c']);
}
//$annots .= ' /StructParent ';
//$annots .= ' /OC ';
$markups = array('text', 'freetext', 'line', 'square', 'circle', 'polygon', 'polyline', 'highlight', 'underline', 'squiggly', 'strikeout', 'stamp', 'caret', 'ink', 'fileattachment', 'sound');
if (in_array(strtolower($pl['opt']['subtype']), $markups)) {
// this is a markup type
if (isset($pl['opt']['t']) and is_string($pl['opt']['t'])) {
$annots .= ' /T ' . $this->_textstring($pl['opt']['t'], $annot_obj_id);
}
//$annots .= ' /Popup ';
if (isset($pl['opt']['ca'])) {
$annots .= ' /CA ' . sprintf('%F', floatval($pl['opt']['ca']));
}
if (isset($pl['opt']['rc'])) {
$annots .= ' /RC ' . $this->_textstring($pl['opt']['rc'], $annot_obj_id);
}
$annots .= ' /CreationDate ' . $this->_datestring($annot_obj_id, $this->doc_creation_timestamp);
//$annots .= ' /IRT ';
if (isset($pl['opt']['subj'])) {
$annots .= ' /Subj ' . $this->_textstring($pl['opt']['subj'], $annot_obj_id);
}
//$annots .= ' /RT ';
//$annots .= ' /IT ';
//$annots .= ' /ExData ';
}
$lineendings = array('Square', 'Circle', 'Diamond', 'OpenArrow', 'ClosedArrow', 'None', 'Butt', 'ROpenArrow', 'RClosedArrow', 'Slash');
// Annotation types
switch (strtolower($pl['opt']['subtype'])) {
case 'text':
if (isset($pl['opt']['open'])) {
$annots .= ' /Open ' . (strtolower($pl['opt']['open']) == 'true' ? 'true' : 'false');
}
$iconsapp = array('Comment', 'Help', 'Insert', 'Key', 'NewParagraph', 'Note', 'Paragraph');
if (isset($pl['opt']['name']) and in_array($pl['opt']['name'], $iconsapp)) {
$annots .= ' /Name /' . $pl['opt']['name'];
} else {
$annots .= ' /Name /Note';
}
$statemodels = array('Marked', 'Review');
if (isset($pl['opt']['statemodel']) and in_array($pl['opt']['statemodel'], $statemodels)) {
$annots .= ' /StateModel /' . $pl['opt']['statemodel'];
} else {
$pl['opt']['statemodel'] = 'Marked';
$annots .= ' /StateModel /' . $pl['opt']['statemodel'];
}
if ($pl['opt']['statemodel'] == 'Marked') {
$states = array('Accepted', 'Unmarked');
} else {
$states = array('Accepted', 'Rejected', 'Cancelled', 'Completed', 'None');
}
if (isset($pl['opt']['state']) and in_array($pl['opt']['state'], $states)) {
$annots .= ' /State /' . $pl['opt']['state'];
} else {
if ($pl['opt']['statemodel'] == 'Marked') {
$annots .= ' /State /Unmarked';
} else {
$annots .= ' /State /None';
}
}
break;
case 'link':
if (is_string($pl['txt'])) {
if ($pl['txt'][0] == '#') {
// internal destination
$annots .= ' /Dest /' . TCPDF_STATIC::encodeNameObject(substr($pl['txt'], 1));
} elseif ($pl['txt'][0] == '%') {
// embedded PDF file
$filename = basename(substr($pl['txt'], 1));
$annots .= ' /A << /S /GoToE /D [0 /Fit] /NewWindow true /T << /R /C /P ' . ($n - 1) . ' /A ' . $this->embeddedfiles[$filename]['a'] . ' >> >>';
} elseif ($pl['txt'][0] == '*') {
// embedded generic file
$filename = basename(substr($pl['txt'], 1));
$jsa = 'var D=event.target.doc;var MyData=D.dataObjects;for (var i in MyData) if (MyData[i].path=="' . $filename . '") D.exportDataObject( { cName : MyData[i].name, nLaunch : 2});';
$annots .= ' /A << /S /JavaScript /JS ' . $this->_textstring($jsa, $annot_obj_id) . '>>';
} else {
// external URI link
$annots .= ' /A <</S /URI /URI ' . $this->_datastring($this->unhtmlentities($pl['txt']), $annot_obj_id) . '>>';
}
} elseif (isset($this->links[$pl['txt']])) {
// internal link ID
$l = $this->links[$pl['txt']];
if (isset($this->page_obj_id[$l[0]])) {
$annots .= sprintf(' /Dest [%u 0 R /XYZ 0 %F null]', $this->page_obj_id[$l[0]], $this->pagedim[$l[0]]['h'] - $l[1] * $this->k);
}
}
$hmodes = array('N', 'I', 'O', 'P');
if (isset($pl['opt']['h']) and in_array($pl['opt']['h'], $hmodes)) {
$annots .= ' /H /' . $pl['opt']['h'];
} else {
$annots .= ' /H /I';
}
//$annots .= ' /PA ';
//$annots .= ' /Quadpoints ';
break;
case 'freetext':
if (isset($pl['opt']['da']) and !empty($pl['opt']['da'])) {
$annots .= ' /DA (' . $pl['opt']['da'] . ')';
}
if (isset($pl['opt']['q']) and $pl['opt']['q'] >= 0 and $pl['opt']['q'] <= 2) {
$annots .= ' /Q ' . intval($pl['opt']['q']);
}
if (isset($pl['opt']['rc'])) {
$annots .= ' /RC ' . $this->_textstring($pl['opt']['rc'], $annot_obj_id);
}
if (isset($pl['opt']['ds'])) {
$annots .= ' /DS ' . $this->_textstring($pl['opt']['ds'], $annot_obj_id);
}
if (isset($pl['opt']['cl']) and is_array($pl['opt']['cl'])) {
$annots .= ' /CL [';
foreach ($pl['opt']['cl'] as $cl) {
$annots .= sprintf('%F ', $cl * $this->k);
}
$annots .= ']';
}
$tfit = array('FreeText', 'FreeTextCallout', 'FreeTextTypeWriter');
if (isset($pl['opt']['it']) and in_array($pl['opt']['it'], $tfit)) {
$annots .= ' /IT /' . $pl['opt']['it'];
}
if (isset($pl['opt']['rd']) and is_array($pl['opt']['rd'])) {
$l = $pl['opt']['rd'][0] * $this->k;
$r = $pl['opt']['rd'][1] * $this->k;
$t = $pl['opt']['rd'][2] * $this->k;
$b = $pl['opt']['rd'][3] * $this->k;
$annots .= ' /RD [' . sprintf('%F %F %F %F', $l, $r, $t, $b) . ']';
}
if (isset($pl['opt']['le']) and in_array($pl['opt']['le'], $lineendings)) {
$annots .= ' /LE /' . $pl['opt']['le'];
}
break;
case 'line':
break;
case 'square':
break;
case 'circle':
break;
case 'polygon':
break;
case 'polyline':
break;
case 'highlight':
break;
case 'underline':
break;
case 'squiggly':
break;
case 'strikeout':
break;
case 'stamp':
break;
case 'caret':
break;
case 'ink':
break;
case 'popup':
break;
case 'fileattachment':
if ($this->pdfa_mode) {
// embedded files are not allowed in PDF/A mode
break;
}
if (!isset($pl['opt']['fs'])) {
break;
}
$filename = basename($pl['opt']['fs']);
if (isset($this->embeddedfiles[$filename]['f'])) {
$annots .= ' /FS ' . $this->embeddedfiles[$filename]['f'] . ' 0 R';
$iconsapp = array('Graph', 'Paperclip', 'PushPin', 'Tag');
if (isset($pl['opt']['name']) and in_array($pl['opt']['name'], $iconsapp)) {
$annots .= ' /Name /' . $pl['opt']['name'];
} else {
$annots .= ' /Name /PushPin';
}
// index (zero-based) of the annotation in the Annots array of this page
$this->embeddedfiles[$filename]['a'] = $key;
}
break;
case 'sound':
if (!isset($pl['opt']['fs'])) {
break;
}
$filename = basename($pl['opt']['fs']);
if (isset($this->embeddedfiles[$filename]['f'])) {
// ... TO BE COMPLETED ...
// /R /C /B /E /CO /CP
$annots .= ' /Sound ' . $this->embeddedfiles[$filename]['f'] . ' 0 R';
$iconsapp = array('Speaker', 'Mic');
if (isset($pl['opt']['name']) and in_array($pl['opt']['name'], $iconsapp)) {
$annots .= ' /Name /' . $pl['opt']['name'];
} else {
$annots .= ' /Name /Speaker';
}
}
break;
case 'movie':
break;
case 'widget':
$hmode = array('N', 'I', 'O', 'P', 'T');
if (isset($pl['opt']['h']) and in_array($pl['opt']['h'], $hmode)) {
$annots .= ' /H /' . $pl['opt']['h'];
}
if (isset($pl['opt']['mk']) and is_array($pl['opt']['mk']) and !empty($pl['opt']['mk'])) {
$annots .= ' /MK <<';
if (isset($pl['opt']['mk']['r'])) {
$annots .= ' /R ' . $pl['opt']['mk']['r'];
}
if (isset($pl['opt']['mk']['bc']) and is_array($pl['opt']['mk']['bc'])) {
$annots .= ' /BC ' . TCPDF_COLORS::getColorStringFromArray($pl['opt']['mk']['bc']);
}
if (isset($pl['opt']['mk']['bg']) and is_array($pl['opt']['mk']['bg'])) {
$annots .= ' /BG ' . TCPDF_COLORS::getColorStringFromArray($pl['opt']['mk']['bg']);
}
if (isset($pl['opt']['mk']['ca'])) {
$annots .= ' /CA ' . $pl['opt']['mk']['ca'];
}
if (isset($pl['opt']['mk']['rc'])) {
$annots .= ' /RC ' . $pl['opt']['mk']['rc'];
}
if (isset($pl['opt']['mk']['ac'])) {
$annots .= ' /AC ' . $pl['opt']['mk']['ac'];
}
if (isset($pl['opt']['mk']['i'])) {
$info = $this->getImageBuffer($pl['opt']['mk']['i']);
if ($info !== false) {
$annots .= ' /I ' . $info['n'] . ' 0 R';
}
}
if (isset($pl['opt']['mk']['ri'])) {
$info = $this->getImageBuffer($pl['opt']['mk']['ri']);
if ($info !== false) {
$annots .= ' /RI ' . $info['n'] . ' 0 R';
}
}
if (isset($pl['opt']['mk']['ix'])) {
$info = $this->getImageBuffer($pl['opt']['mk']['ix']);
if ($info !== false) {
$annots .= ' /IX ' . $info['n'] . ' 0 R';
}
}
if (isset($pl['opt']['mk']['if']) and is_array($pl['opt']['mk']['if']) and !empty($pl['opt']['mk']['if'])) {
$annots .= ' /IF <<';
$if_sw = array('A', 'B', 'S', 'N');
if (isset($pl['opt']['mk']['if']['sw']) and in_array($pl['opt']['mk']['if']['sw'], $if_sw)) {
$annots .= ' /SW /' . $pl['opt']['mk']['if']['sw'];
}
$if_s = array('A', 'P');
if (isset($pl['opt']['mk']['if']['s']) and in_array($pl['opt']['mk']['if']['s'], $if_s)) {
$annots .= ' /S /' . $pl['opt']['mk']['if']['s'];
}
if (isset($pl['opt']['mk']['if']['a']) and is_array($pl['opt']['mk']['if']['a']) and !empty($pl['opt']['mk']['if']['a'])) {
$annots .= sprintf(' /A [%F %F]', $pl['opt']['mk']['if']['a'][0], $pl['opt']['mk']['if']['a'][1]);
}
if (isset($pl['opt']['mk']['if']['fb']) and $pl['opt']['mk']['if']['fb']) {
$annots .= ' /FB true';
}
$annots .= '>>';
}
if (isset($pl['opt']['mk']['tp']) and $pl['opt']['mk']['tp'] >= 0 and $pl['opt']['mk']['tp'] <= 6) {
$annots .= ' /TP ' . intval($pl['opt']['mk']['tp']);
}
$annots .= '>>';
}
// end MK
// --- Entries for field dictionaries ---
if (isset($this->radiobutton_groups[$n][$pl['txt']])) {
// set parent
$annots .= ' /Parent ' . $this->radiobutton_groups[$n][$pl['txt']] . ' 0 R';
}
if (isset($pl['opt']['t']) and is_string($pl['opt']['t'])) {
$annots .= ' /T ' . $this->_datastring($pl['opt']['t'], $annot_obj_id);
}
if (isset($pl['opt']['tu']) and is_string($pl['opt']['tu'])) {
$annots .= ' /TU ' . $this->_datastring($pl['opt']['tu'], $annot_obj_id);
}
if (isset($pl['opt']['tm']) and is_string($pl['opt']['tm'])) {
$annots .= ' /TM ' . $this->_datastring($pl['opt']['tm'], $annot_obj_id);
}
if (isset($pl['opt']['ff'])) {
if (is_array($pl['opt']['ff'])) {
// array of bit settings
$flag = 0;
foreach ($pl['opt']['ff'] as $val) {
$flag += 1 << $val - 1;
}
} else {
$flag = intval($pl['opt']['ff']);
}
$annots .= ' /Ff ' . $flag;
}
if (isset($pl['opt']['maxlen'])) {
$annots .= ' /MaxLen ' . intval($pl['opt']['maxlen']);
}
if (isset($pl['opt']['v'])) {
$annots .= ' /V';
if (is_array($pl['opt']['v'])) {
foreach ($pl['opt']['v'] as $optval) {
if (is_float($optval)) {
$optval = sprintf('%F', $optval);
}
$annots .= ' ' . $optval;
}
} else {
$annots .= ' ' . $this->_textstring($pl['opt']['v'], $annot_obj_id);
}
}
if (isset($pl['opt']['dv'])) {
$annots .= ' /DV';
if (is_array($pl['opt']['dv'])) {
foreach ($pl['opt']['dv'] as $optval) {
if (is_float($optval)) {
$optval = sprintf('%F', $optval);
}
$annots .= ' ' . $optval;
}
} else {
$annots .= ' ' . $this->_textstring($pl['opt']['dv'], $annot_obj_id);
}
}
if (isset($pl['opt']['rv'])) {
$annots .= ' /RV';
if (is_array($pl['opt']['rv'])) {
foreach ($pl['opt']['rv'] as $optval) {
if (is_float($optval)) {
$optval = sprintf('%F', $optval);
}
$annots .= ' ' . $optval;
}
} else {
$annots .= ' ' . $this->_textstring($pl['opt']['rv'], $annot_obj_id);
}
}
if (isset($pl['opt']['a']) and !empty($pl['opt']['a'])) {
$annots .= ' /A << ' . $pl['opt']['a'] . ' >>';
}
if (isset($pl['opt']['aa']) and !empty($pl['opt']['aa'])) {
$annots .= ' /AA << ' . $pl['opt']['aa'] . ' >>';
}
if (isset($pl['opt']['da']) and !empty($pl['opt']['da'])) {
$annots .= ' /DA (' . $pl['opt']['da'] . ')';
}
if (isset($pl['opt']['q']) and $pl['opt']['q'] >= 0 and $pl['opt']['q'] <= 2) {
$annots .= ' /Q ' . intval($pl['opt']['q']);
}
if (isset($pl['opt']['opt']) and is_array($pl['opt']['opt']) and !empty($pl['opt']['opt'])) {
$annots .= ' /Opt [';
foreach ($pl['opt']['opt'] as $copt) {
if (is_array($copt)) {
$annots .= ' [' . $this->_textstring($copt[0], $annot_obj_id) . ' ' . $this->_textstring($copt[1], $annot_obj_id) . ']';
} else {
$annots .= ' ' . $this->_textstring($copt, $annot_obj_id);
}
}
$annots .= ']';
}
if (isset($pl['opt']['ti'])) {
$annots .= ' /TI ' . intval($pl['opt']['ti']);
}
if (isset($pl['opt']['i']) and is_array($pl['opt']['i']) and !empty($pl['opt']['i'])) {
$annots .= ' /I [';
foreach ($pl['opt']['i'] as $copt) {
$annots .= intval($copt) . ' ';
}
$annots .= ']';
}
break;
case 'screen':
break;
case 'printermark':
break;
case 'trapnet':
break;
case 'watermark':
break;
case '3d':
break;
default:
break;
}
$annots .= '>>';
// create new annotation object
$this->_out($this->_getobj($annot_obj_id) . "\n" . $annots . "\n" . 'endobj');
if ($formfield and !isset($this->radiobutton_groups[$n][$pl['txt']])) {
// store reference of form object
$this->form_obj_id[] = $annot_obj_id;
}
}
}
}
// end for each page
}
