blueshoes php application framework and cms            core_file
[ class tree: core_file ] [ index: core_file ] [ all elements ]

Class: Bs_FileConverterPdf

Source Location: /core/file/converter/Bs_FileConverterPdf.class.php

Class Overview

Bs_Object
   |
   --Bs_FileConverter
      |
      --Bs_FileConverterPdf

Pseudostatic utility class to convert files from one format to another.


Author(s):

Version:

  • 4.3.$Revision: 1.3 $ $Date: 2003/09/03 11:06:15 $

Copyright:

  • blueshoes.org

Variables

Methods


Inherited Variables

Inherited Methods

Class: Bs_FileConverter

Bs_FileConverter::Bs_FileConverter()
Bs_FileConverter::capable()
Tells whether we can do a conversion or not.
Bs_FileConverter::htmlToPdf()
Bs_FileConverter::htmlToText()
Convert Html => Text at first it stripps all tags, then converts html entities back to orig values.
Bs_FileConverter::htmlToWord()
Bs_FileConverter::loadBsHtmlUtil()
Bs_FileConverter::wordStreamToHtmlStream()
converts a word document to html and saves it to $destination.
Bs_FileConverter::wordStreamToHtmlString()
converts a word document to html and returns it as string.
Bs_FileConverter::wordSummary()
returns information about the given word document.
Bs_FileConverter::wordToAbi()
converts a word document to abiword.
Bs_FileConverter::wordToHtml()
deprecated, use wordStreamToHtmlStream() or wordStreamToHtmlString() instead.
Bs_FileConverter::wordToLatex()
converts a word document to latex.
Bs_FileConverter::wordToText()
converts a word document to plain text.
Bs_FileConverter::wordToWml()
converts a word document to wml.
Bs_FileConverter::wordVersion()
returns information about the word version.

Class: Bs_Object

Bs_Object::Bs_Object()
Bs_Object::getErrors()
Basic error handling: Get *all* errors as string array from the global Bs_Error-error stack.
Bs_Object::getLastError()
Basic error handling: Get last error string from the global Bs_Error-error stack.
Bs_Object::getLastErrors()
Basic error handling: Get last errors string array from the global Bs_Error-error stack sinc last call of getLastErrors().
Bs_Object::persist()
Persists this object by serializing it and saving it to a file with unique name.
Bs_Object::setError()
Basic error handling: Push an error string on the global Bs_Error-error stack.
Bs_Object::toHtml()
Dumps the content of this object to a string using PHP's var_dump().
Bs_Object::toString()
Dumps the content of this object to a string using PHP's var_dump().
Bs_Object::unpersist()
Fetches an object that was persisted with persist()

Class Details

[line 34]
Pseudostatic utility class to convert files from one format to another.

 WISHLIST
 --------
 FROM     TO    | CONVERTER LINUX         | CONVERTER WIN32         | COMMENTS                   |
 ---------------+-------------------------+-------------------------+----------------------------|
 pdf   -> html  | pdftohtml               | pdftohtml               |                            |
 pdf   -> xml   | pdftohtml               | pdftohtml               |                            |
 pdf   -> text  | pdftohtml               | pdftohtml               | with stripping tags        |
 pdf   -> word  | not supported           | not supported           |                            |
 

dependencies: Bs_FileConverter




Tags:

pattern:  singleton (pseudostatic)
since:  bs4.3
pattern:  singleton: (pseudostatic)
access:  public
copyright:  blueshoes.org
version:  4.3.$Revision: 1.3 $ $Date: 2003/09/03 11:06:15 $
author:  andrej arn <at blueshoes dot org>


[ Top ]


Class Variables

$pathToPdfToHtmlExe =

[line 50]

path to the pdftohtml.exe file.

this file is used for the conversions of: pdf to html pdf to xml pdf to text

by default we will use $APP['path']['pdftohtml'] if it is set.




Tags:

access:  public

Type:   string


[ Top ]



Class Methods


constructor Bs_FileConverterPdf [line 56]

Bs_FileConverterPdf Bs_FileConverterPdf( )

constructor.



[ Top ]

method capable [line 69]

bool capable( string $functionName)

Tells whether we can do a conversion or not.



Tags:

throws:  NULL on an unknown $functionName


Overrides Bs_FileConverter::capable() (Tells whether we can do a conversion or not.)

Parameters:

string   $functionName   not case sensitive.

[ Top ]

method pdfToHtmlString [line 128]

void pdfToHtmlString( mixed $fullPath, [mixed $zoom = 1.5], [mixed $firstPage = NULL], [mixed $lastPage = NULL], [mixed $complex = FALSE])

deprecated, use streamToHtmlString(), new method name.



Tags:

deprecated:  


[ Top ]

method streamToHtmlString [line 91]

string streamToHtmlString( string $fullPath, [float $zoom = 1.5], [int $firstPage = NULL], [int $lastPage = NULL], [bool $complex = FALSE])

reads a pdf document and returns it as html string.



Tags:

throws:  bool FALSE


Parameters:

string   $fullPath   (path & filename of .pdf file)
float   $zoom   (default zoom factor is 1.5)
int   $firstPage   (page number to start, default is NULL which means at the beginning.)
int   $lastPage   (page number to end, default is NULL which means at the end.)
bool   $complex   (default is FALSE, if a complex html output should be generated. rtfm.)

[ Top ]

method toHtmlFile [line 136]

void toHtmlFile( )



Tags:

todo:  all


[ Top ]


Documentation generated on Mon, 29 Dec 2003 21:09:07 +0100 by phpDocumentor 1.2.3