documentation/manual/en/module_specs/Zend_Pdf-Save.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect1 id="zend.pdf.save">
   4     <title>Save Changes to PDF Documents</title>
   5
   6     <para>
   7         There are two methods that save changes to <acronym>PDF</acronym> documents: the
   8         <methodname>Zend_Pdf::save()</methodname> and <methodname>Zend_Pdf::render()</methodname>
   9         methods.
  10     </para>
  11
  12     <para>
  13         <methodname>Zend_Pdf::save($filename, $updateOnly = false)</methodname> saves the
  14         <acronym>PDF</acronym> document to a file. If $updateOnly is <constant>TRUE</constant>,
  15         then only the new <acronym>PDF</acronym> file segment is appended to a file. Otherwise, the
  16         file is overwritten.
  17     </para>
  18
  19     <para>
  20         <methodname>Zend_Pdf::render($newSegmentOnly = false)</methodname> returns the
  21         <acronym>PDF</acronym> document as a string. If $newSegmentOnly is
  22         <constant>TRUE</constant>, then only the new <acronym>PDF</acronym> file segment is
  23         returned.
  24     </para>
  25
  26     <example id="zend.pdf.save.example-1">
  27         <title>Saving PDF Documents</title>
  28
  29         <programlisting language="php"><![CDATA[
  30 ...
  31 // Load the PDF document
  32 $pdf = Zend_Pdf::load($fileName);
  33 ...
  34 // Update the PDF document
  35 $pdf->save($fileName, true);
  36 // Save document as a new file
  37 $pdf->save($newFileName);
  38
  39 // Return the PDF document as a string
  40 $pdfString = $pdf->render();
  41
  42 ...
  43 ]]></programlisting>
  44     </example>
  45 </sect1>
  46 <!--
  47 vim:se ts=4 sw=4 et:
  48 -->