• Accueil
• Pressbooks
• Modules
• Export
• Mpdf
• Pdf

PHP Class Pressbooks\Modules\Export\Mpdf\Pdf

Afficher le fichier Open project: pressbooks/pressbooks Class Usage Examples

Protected Properties

Свойство	Type	Description
$bookMeta	array	Book Metadata
$bookTitle	string	Holds the title of the book being published
$exportStylePath	string	Fullpath to book CSS file.
$globalOptions	array	Global theme options, set by the user
$memoryNeeded	integer	mPDF uses a lot of memory, this the recommended minimum
$mpdf	object	MPDF Class
$numbered	boolean	Number the chapters
$options	array	mPDF theme options, set by the user

Méthodes publiques

Méthode	Description
__construct ( )
addBookInfo ( )	Add book information page, otherwise known as title page
addCopyright ( )	Copyright information on a separate page
addCover ( )	Add the cover for the book.
addFrontMatter ( array $contents )	Adds front matter, resets the page numbering on the first loop, romanizes the numeric style
addFrontMatterByType ( string $type, array $contents )	Add front matter of a specific/special type
addPage ( array $page, array $page_options = [], boolean $display_footer = true, boolean $display_header = true ) : boolean	Add a page to the pdf
addPartsAndChapters ( $contents )
addPreContent ( array $contents )	Add all specially handled content.
addToc ( )	Add the mpdf Table of Contents.
convert ( ) : boolean	Book Assembly. Create $this->outputPath
fixAnnoyingCharacters ( string $html ) : string	This function prevents mPDF from completely aborting the export routine, or replacing each non-breaking space with a '?' if ignore_invalid_utf8 is true. Important to leave this in.
getBookmarkEntry ( array $page ) : string	Return the PDF bookmark entry for this page should be unique, using static variable for cheap cache
getFilteredContent ( string $content ) : string	Cleans up html
getFooter ( boolean $display = true, string $content = '' ) : string	Return formatted footers.
getHeader ( boolean $display = true, string $content = '' ) : string	Return formatted headers.
getOrderedBookContents ( ) : array	Restructures \Pressbooks\Book::getBookContents() into a format more useful for direct iteration, and tracks a nesting level for Bookmark and ToC entries.
getThemeCss ( object $theme ) : string	Get current child and parent theme css files. Child themes only have one parent theme, and 99% of the time this is 'Luther' or /pressbooks-book/ whose stylesheet is named 'style.css'
getTocEntry ( string $page ) : string	Return the Table of Contents entry for this page.
hasDependencies ( ) : boolean	Dependency check.
setCss ( )	Add all css files
validate ( ) : boolean	Check the sanity of $this->outputPath

Méthodes protégées

Méthode	Description
atLeastOneExport ( array $chapters ) : boolean	Does array of chapters have at least one export? Recursive.
isPdf ( string $file ) : boolean	Verify if file has 'application/pdf' mimeType.

Private Methods

Méthode	Description
stripUnwantedStyles ( array $styles ) : array	Helper function to omit unwanted stylesheets in the output

Method Details

Property Details