Class TCPDFFacade

A facade class for the TCPDF library which is used to convert some HTML content provided by the Markdown library to a PDF file using FPDF

Package: alpha::util
Copyright: Copyright (c) 2012, John Collins (founder of Alpha Framework). All rights reserved.

Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the
following conditions are met:

* Redistributions of source code must retain the above
  copyright notice, this list of conditions and the
  following disclaimer.
* Redistributions in binary form must reproduce the above
  copyright notice, this list of conditions and the
  following disclaimer in the documentation and/or other
  materials provided with the distribution.
* Neither the name of the Alpha Framework nor the names
  of its contributors may be used to endorse or promote
  products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

License: The BSD License
Author: John Collins <dev@alphaframework.org>
Version: $Id: TCPDFFacade.inc 1550 2012-07-29 21:15:40Z alphadevx $
Since: 1.0
Located at util/TCPDFFacade.inc

Methods summary
`public`	# `__construct( object $BO )` The constructor The constructor Parameters `$BO` `object` $BO the business object that stores the content will be rendered to Markdown Since 1.0
`private`	# `markdown( mixed $text, mixed $attachURL = '' )` Facade method which will invoke our custom markdown class rather than the standard one Facade method which will invoke our custom markdown class rather than the standard one Since 1.0
`public string`	# `getContent( )` Fetter for the content Fetter for the content Returns `string` HTML rendered the content Since 1.0
`private`	# `HTMLCache( )` Saves the HTML generated by Markdown to the cache directory Saves the HTML generated by Markdown to the cache directory Since 1.0
`private boolean`	# `checkHTMLCache( )` Used to check the HTML cache for the BO cache file Used to check the HTML cache for the BO cache file Returns `boolean` true if the file exists, false otherwise Since 1.0
`private`	# `loadHTMLCache( )` Method to load the content of the cache file to the $content attribute of this object Method to load the content of the cache file to the $content attribute of this object Since 1.0
`private boolean`	# `checkPDFCache( )` Used to check the PDF cache for the BO cache file Used to check the PDF cache for the BO cache file Returns `boolean` true if the file exists, false otherwise Since 1.0
`private`	# `serveCachedPDF( mixed $name )` Used to serve the cached PDF file as a download Used to serve the cached PDF file as a download Since 1.0

Properties summary
`private string`	`$content`		# The HTML-format content that we will render as a PDF The HTML-format content that we will render as a PDF Since 1.0
`private AlphaTCPDF`	`$pdf`		# The PDF object that will be generated from the Markdown HTML content The PDF object that will be generated from the Markdown HTML content Since 1.0
`private AlphaDAO`	`$BO`	`null`	# The business object that stores the content will be rendered to Markdown The business object that stores the content will be rendered to Markdown Since 1.0
`private string`	`$PDFFilename`		# The auto-generated name of the PDF cache file for the BO The auto-generated name of the PDF cache file for the BO Since 1.0
`private string`	`$HTMLFilename`		# The auto-generated name of the HTML cache file for the BO generated by Markdown The auto-generated name of the HTML cache file for the BO generated by Markdown Since 1.0

Packages

Classes

Interfaces

Class TCPDFFacade

Parameters

Since

Since

Returns

Since

Since

Returns

Since

Since

Returns

Since

Since

Since

Since

Since

Since

Since