Class sevenpdf

Description

7-PDF PHP Library CLASS

7-PDF PHP Library CLASS

Located in /class.sevenpdf.inc.php (line 79)


	
			
Variable Summary
mixed $http
mixed $options
mixed $password
mixed $service_url
mixed $username
mixed $wsdl
Method Summary
sevenpdf __construct ([host $host = NULL], [port $username = NULL], ssl $password, [username $ssl = False], [password $port = NULL])
void __destruct ()
string create_random_value (length $length, [type $type = 'mixed'])
string getFileType (file $file)
string getIsSupportedFileType (file $file)
mt_rand rand ([min $min = null], [max $max = null])
True runConvertToPDF (source_file $source_file, PDFFile $pdf_file)
void setEnableCopyingOfContentPDFOption (value $value)
void setEncryptFilePDFOption (value $value)
void setExportBookmarksPDFOption (value $value)
void setExportNotesPagesPDFOption (value $value)
void setExportNotesPDFOption (value $value)
void setImageQualityPDFOption (value $value)
void setMaxImageResolutionPDFOption (value $value)
void setOpenPasswordPDFOption (open_password $open_password)
void setPageRangePDFOption (value $value)
void setPermissionChangesPDFOption (value $value)
void setPermissionPasswordPDFOption (permission_password $permission_password)
void setPermissionPrintingPDFOption (value $value)
void setReduceImageResolutionPDFOption (value $value)
void setRestrictPermissionsPDFOption (value $value)
void setSelectedPDFVersionPDFOption (value $value)
void setUseLosslessCompressionPDFOption (value $value)
void setUseTaggedPDFOption (value $value)
Variables
mixed $http (line 84)
mixed $options (line 93)
mixed $password (line 99)
mixed $service_url (line 90)
mixed $supported_file_types_array = array(

'doc','dot','xls','xlt','ppt','pps','pot',
'odt','ott','ods','ots','odp','otp','sxw',
'stw','sxc','stc','swi','sti','sdw','vor',
'sdc','sdd','rtf','txt','csv','html','htm',
'xml','dif','dxf','eps','tif','odg','otg',
'sxd','std','jpg','jpeg','png','gif','bmp',
'odf','sxm','mml','smf','docx','docm','dotx',
'dotm','xlsx','xlsb','xlsm','xltm','xltx','pptx',
'pptm','potm','odm','sxg','sgl','slk','wpd',
'oth','wb2','sda','emf','met','pct','sgf',
'sgv','svm','wmf','pbm','pcx','pgm','ppm',
'psd','ras','tga','tiff','xbm','xpm','pcd'

)
(line 104)

Supported filetype array of the sourcefile

Supported filetype array of the sourcefile

mixed $username (line 96)
mixed $wsdl (line 87)
Methods
Constructor __construct (line 131)

sevenpdf

sevenpdf CONSTRUCTOR

sevenpdf __construct ([host $host = NULL], [port $username = NULL], ssl $password, [username $ssl = False], [password $port = NULL])
  • host $host: The Host of the 7-PDF Api Service.
    For example localhost, www.your-domain.de, 192.168.1.100)
  • port $username: The port, where the service is running on the host.
  • ssl $password: Enables SSL-Support if necessary.
  • username $ssl: The Service-User that is necessary to connect the 7-PDF Remote Api Service.
  • password $port: The Service-Password that is necessary to connect the 7-PDF Remote Api Service.
Destructor __destruct (line 210)

sevenpdf

sevenpdf DESTRUCTOR

void __destruct ()
create_random_value (line 251)

create_random_value

create_random_value Returns a randomized string

  • return: randomized
string create_random_value (length $length, [type $type = 'mixed'])
  • length $length: Defines the randomized string-length
  • type $type: Defines possible digit values
getFileType (line 292)

getFileType

getFileType Returns the filetype extension of a file

  • return: filetype extension (txt, doc, etc.)
string getFileType (file $file)
  • file $file: string path of file
getIsSupportedFileType (line 303)

getIsSupportedFileType

getIsSupportedFileType Returns true if sourcefile type is supported

  • return: timestamp as folder name
string getIsSupportedFileType (file $file)
  • file $file: string path of the source file
getRemoteFolderName (line 280)

getRemoteFolderName

getRemoteFolderName Returns a remote folder name for the pdf creation process

  • return: timestamp as folder name
string getRemoteFolderName ()
rand (line 224)

rand

rand Returns mt_rand for min/max

  • return: value
mt_rand rand ([min $min = null], [max $max = null])
  • min $min: Miniumum Value for randomization
  • max $max: Maximum Value for randomazation
runConvertToPDF (line 630)

runConvertToPDF Starts a conversion run.

runConvertToPDF Starts a conversion run.

  • return: if conversion run was successfull, false if not.
True runConvertToPDF (source_file $source_file, PDFFile $pdf_file)
  • source_file $source_file: The file that you would like to convert to PDF. You can use relative and absolute filepaths like files/letter.doc or /usr/local/files/letter.doc
  • PDFFile $pdf_file: The result pdf.
setEnableCopyingOfContentPDFOption (line 597)

setEnableCopyingOfContentPDFOption

setEnableCopyingOfContentPDFOption If set a pdf reader of the PDF File can extract and copy included pdf content

void setEnableCopyingOfContentPDFOption (value $value)
  • value $value: This permission value can be true (default) or false;
setEnableTextAccessForAccessibilityToolsPDFOption (line 612)

setEnableTextAccessForAccessibilityToolsPDFOption Accessibility Tools have access to the pdf text.

setEnableTextAccessForAccessibilityToolsPDFOption Accessibility Tools have access to the pdf text.

void setEnableTextAccessForAccessibilityToolsPDFOption (value $value)
  • value $value: This permission value can be true (default) or false;
setEncryptFilePDFOption (line 487)

setEncryptFilePDFOption

setEncryptFilePDFOption Enables the PDF File Encryption for generated PDF Files

void setEncryptFilePDFOption (value $value)
  • value $value: The encryption state can be true (encrypt files) or false (no encryption, default).
setExportBookmarksPDFOption (line 376)

setExportBookmarksPDFOption

setExportBookmarksPDFOption Exports bookmarks to generate PDF Files

void setExportBookmarksPDFOption (value $value)
  • value $value: The value can be true (default) or false.
setExportNotesPagesPDFOption (line 360)

setExportNotesPagesPDFOption

setExportNotesPagesPDFOption Exports notes pages to generate PDF Files

void setExportNotesPagesPDFOption (value $value)
  • value $value: The value can be true (default) or false.
setExportNotesPDFOption (line 344)

setExportNotesPDFOption

setExportNotesPDFOption Exports notes to the generated PDF Files

void setExportNotesPDFOption (value $value)
  • value $value: The value can be true or false (default).
setImageQualityPDFOption (line 430)

setImageQualityPDFOption Sets the quality value in percent (0 - 100) for image compressions inside the generated PDF.

setImageQualityPDFOption Sets the quality value in percent (0 - 100) for image compressions inside the generated PDF.

void setImageQualityPDFOption (value $value)
  • value $value: Possible value range from 0 - 100 (percent). Default = 50
setMaxImageResolutionPDFOption (line 460)

setMaxImageResolutionPDFOption

setMaxImageResolutionPDFOption The value of the maximum allowed image resolution Possible values (DPI) are 75 (default), 150, 300, 600, 1200 Notice: The PDF Option ReduceImageResolution must be set to true to enable this option!

void setMaxImageResolutionPDFOption (value $value)
  • value $value: Should be a possible value that stands for a DPI resolution of images inside the PDF.
setOpenPasswordPDFOption (line 505)

setOpenPasswordPDFOption Password that must be known when the generated PDF will be opened.

setOpenPasswordPDFOption Password that must be known when the generated PDF will be opened. So the generated PDF File is password protected Notice: setEncryptFilePDFOption() method must be set to true.

  • see: setEncryptFilePDFOption( $value )
void setOpenPasswordPDFOption (open_password $open_password)
  • open_password $open_password: The value can be any password string that you would like to use for your pdf encryption.
setPageRangePDFOption (line 404)

setPageRangePDFOption

setPageRangePDFOption Sets the page range for pdf generation

void setPageRangePDFOption (value $value)
  • value $value: The value can be a valid PageRange string like 1; 1-2;
    e.g. or you leave it empty for all pages.
setPermissionChangesPDFOption (line 571)

setPermissionChangesPDFOption Set permissions for changes for the generated PDF File.

setPermissionChangesPDFOption Set permissions for changes for the generated PDF File. Possible is -> 0: Not permitted, 1: Inserting, deleting and rotating pages, 2: Filling in form fields, 3: Commenting, filling in form fields, 4: Any except extracting pages (default) Notice: setRestrictPermissionsPDFOption method must be set to true and setPermissionPasswordPDFOption must be set with a permission password

  • see: setRestrictPermissionsPDFOption( $value ), setPermissionPasswordPDFOption( $permission_password )
void setPermissionChangesPDFOption (value $value)
  • value $value: The permission value of printing (0,1,2,3,4)
setPermissionPasswordPDFOption (line 532)

setPermissionPasswordPDFOption Password that protects the pdf permission level for generated PDF Files.

setPermissionPasswordPDFOption Password that protects the pdf permission level for generated PDF Files. Notice: setRestrictPermissionsPDFOption method must be set to true.

  • see: setEncryptFilePDFOption( $value )
void setPermissionPasswordPDFOption (permission_password $permission_password)
  • permission_password $permission_password: The value can be any password string that you would like to use for your pdf encryption.
setPermissionPrintingPDFOption (line 546)

setPermissionPrintingPDFOption Set permissions for printing level of the generated PDF File.

setPermissionPrintingPDFOption Set permissions for printing level of the generated PDF File. Possible is -> 0: Not permitted, 1: Low resolution (150 DPI), 2: High resolution (default) Notice: setRestrictPermissionsPDFOption method must be set to true and setPermissionPasswordPDFOption must be set with a permission password

  • see: setRestrictPermissionsPDFOption( $value ), setPermissionPasswordPDFOption( $permission_password )
void setPermissionPrintingPDFOption (value $value)
  • value $value: The permission value of printing (0,1,2)
setReduceImageResolutionPDFOption (line 442)

setReduceImageResolutionPDFOption

setReduceImageResolutionPDFOption Reduces the image resolution level of images

void setReduceImageResolutionPDFOption (value $value)
  • value $value: The ReduceImageResolution state can be true or false (default).
setRestrictPermissionsPDFOption (line 515)

setRestrictPermissionsPDFOption

setRestrictPermissionsPDFOption Enables the encryption level to restrict pdf permissions

void setRestrictPermissionsPDFOption (value $value)
  • value $value: The restrict permission state can be true (pdf with permission settings) or false (pdf without permission settings, default).
setSelectedPDFVersionPDFOption (line 392)

setSelectPDFVersionPDFOption

setSelectPDFVersionPDFOption Sets the pdf version that should be generated

void setSelectedPDFVersionPDFOption (value $value)
  • value $value: The value can be 0 (PDF 1.4, default) or 1 (PDF/A-1).
setUseLosslessCompressionPDFOption (line 414)

setUseLosslessCompressionPDFOption

setUseLosslessCompressionPDFOption Sets a lossless compression level for images inside the generated PDF

void setUseLosslessCompressionPDFOption (value $value)
  • value $value: This compression state can be true (default) or false.
setUseTaggedPDFOption (line 328)

setUseTaggedPDFOption

setUseTaggedPDFOption Sets the PDFOption UseTaggedPDF to generate tagged PDF Files

void setUseTaggedPDFOption (value $value)
  • value $value: The value can be true or false (default).

Documentation generated on Fri, 08 Jan 2010 14:35:24 +0100 by phpDocumentor 1.4.0a2