• Accueil
• PHPePub
• Core
• EPub

PHP Class PHPePub\Core\EPub

Please note, once finalized a book can no longer have chapters of data added or changed. License: GNU LGPL 2.1. Thanks to: Adam Schmalhofer and Kirstyn Fox for invaluable input and for "nudging" me in the right direction :) Afficher le fichier Open project: grandt/phpepub Class Usage Examples

Méthodes publiques

Свойство	Type	Description
$encodeHTML
$isGifImagesEnabled		getImage will convert these if it can, unless this is set to TRUE.
$isLogging
$isReferencesAddedToToc
$maxImageHeight
$maxImageWidth
$pluginDir
$referencesOrder		If this list is overwritten it MUST contain at least "text" as an element.
$splitDefaultSize
$viewportMap

Méthodes publiques

Méthode	Description
DANGER_getNcx ( ) : null | PHPePub\Core\Structure\Ncx	The Ncx data isn't generated before the ePub is finalized.
DANGER_getOpf ( ) : null | Opf	The Opf data isn't generated before the ePub is finalized.
DANGER_getZip ( ) : null | Zip	The Zip file isn't completed before the ePub is finalized, however files added ARE packed and written to it immediately, and their contents can't be altered.
__construct ( string $bookVersion = EPub::BOOK_VERSION_EPUB2, string $languageCode = 'en', string $writingDirection = EPub::DIRECTION_LEFT_TO_RIGHT )	Class constructor.
__destruct ( ) : void	Class destructor
addCSSFile ( string $fileName, string $fileId, string $fileData, integer $externalReferences = EPub::EXTERNAL_REF_IGNORE, string $baseDir = "" ) : boolean	Add a CSS file to the book.
addChapter ( string $chapterName, string $fileName, string $chapterData = null, boolean $autoSplit = false, integer $externalReferences = EPub::EXTERNAL_REF_IGNORE, string $baseDir = "" ) : mixed	Add a chapter to the book, as a chapter should not exceed 250kB, you can parse an array with multiple parts as $chapterData.
addCustomMetaProperty ( string $name, string $content )	Add a Meta property value to the metadata
addCustomMetaValue ( PHPePub\Core\Structure\OPF\MetaValue $value )	Add a custom meta data value to the OPF metadata.
addCustomMetadata ( string $name, string $content )	Add custom metadata to the book.
addCustomNamespace ( string $nsName, string $nsURI )
addCustomPrefix ( string $name, string $URI )	Add a prefix declaration to the OPF file.
addDublinCoreMetadata ( string $dublinCoreConstant, string $value )	Add DublinCore metadata to the book
addEPub3TOC ( string $fileName, string $tocData ) : boolean
addFile ( string $fileName, string $fileId, string $fileData, string $mimetype ) : boolean	Add dynamically generated data as a file to the book.
addFileToMETAINF ( string $fileName, string $fileData ) : boolean	Add a file to the META-INF directory.
addLargeFile ( string $fileName, string $fileId, string $filePath, string $mimetype ) : boolean	Add a large file directly from the filestystem to the book.
addReferencePage ( string $pageName, string $fileName, string $pageData, string $reference, integer $externalReferences = EPub::EXTERNAL_REF_IGNORE, string $baseDir = "" ) : boolean	Reference pages is usually one or two pages for items such as Table of Contents, reference lists, Author notes or Acknowledgements.
backLevel ( )	Step back one chapter level.
buildEPub3TOC ( string $cssFileName = null, string $title = "Table of Contents" ) : string
buildTOC ( string $cssFileName = null, string $tocCSSClass = "toc", string $title = "Table of Contents", boolean $addReferences = true, boolean $addToIndex = false, string $tocFileName = "TOC.xhtml" ) : boolean	Build the Table of Contents. This is not strictly necessary, as most eReaders will build it from the navigation structure in the .ncx file.
extractIdAttributes ( string $partName, string $chapterData )
finalize ( ) : boolean	Check for mandatory parameters and finalize the e-book.
findIdAttributes ( string $chapterData ) : array	find all id attributes in the html document.
getAuthor ( ) : string	Get Book author.
getBook ( ) : string	Return the finalized book.
getBookSize ( ) : string	Return the finalized book size.
getChapterCount ( ) : number	Get Book Chapter count.
getCoverage ( ) : string	Get Book coverage.
getCurrentLevel ( ) : integer	Get current level count.
getDate ( ) : string	Get Book date.
getDescription ( ) : string	Get Book description.
getFileList ( ) : array	Retrieve an array of file names currently added to the book.
getGenerator ( ) : string	Get the book relation.
getIdentifier ( ) : string	Get Book identifier.
getIdentifierType ( ) : string	Get Book identifierType.
getLanguage ( ) : string	Get Book language.
getLog ( ) : string
getPublisherName ( ) : string	Get Book publisherName.
getPublisherURL ( ) : string	Get Book publisherURL.
getRelation ( ) : string	Get the book relation.
getRights ( ) : string	Get Book rights.
getSourceURL ( ) : string	Get Book sourceURL.
getSplitSize ( ) : integer	Get the chapter target size.
getTitle ( ) : string	Get Book title.
getViewportMetaLine ( ) : string	Generate the viewport meta line if the viewport is set.
isEPubVersion2 ( ) : boolean
isFinalized ( ) : boolean	Get Book status.
rootLevel ( )	Step back to the root level.
saveBook ( string $fileName, string $baseDir = '.' ) : string	Save the ePub file to local disk.
sendBook ( string $fileName ) : string | boolean	Send the book as a zip download
setAuthor ( string $author, string $authorSortKey ) : boolean	Book author or creator, optional.
setBookRoot ( string $bookRoot )	The bookRoot is the root directory inside the ePub book, defaults to "OEBPS/"
setCoverImage ( string $fileName, string $imageData = null, string $mimetype = null ) : boolean	Add a cover image to the book.
setCoverage ( string $coverage ) : boolean	Coverage, optional.
setCurrentLevel ( integer $newLevel )	Step back to the given level.
setDangermode ( boolean $dangermode )	Set or clear "Dangermode"
setDate ( integer $timestamp ) : boolean	Release date, optional. If left blank, the time of the finalization will be used.
setDescription ( string $description ) : boolean	Book description, optional.
setGenerator ( string $generator )	Set book Generator.
setIdentifier ( string $identifier, string $identifierType ) : boolean	Unique book identifier, mandatory.
setLanguage ( string $language ) : boolean	Book language, mandatory
setPublisher ( string $publisherName, string $publisherURL ) : boolean	Publisher Information, optional.
setReferencesTitle ( string $referencesTitle = "Guide", string $referencesId = "", string $referencesClass = "references" ) : boolean	Set the references title for the ePub 3 landmarks section
setRelation ( string $relation )	Set book Relation.
setRights ( string $rightsText ) : boolean	Book (copy)rights, optional.
setShortDateFormat ( ) : boolean	Set ePub date formate to the short yyyy-mm-dd form, for compliance with a bug in EpubCheck, prior to its version 1.1.
setSourceURL ( string $sourceURL ) : boolean	Book source URL, optional.
setSplitSize ( integer $size ) : void	Set default chapter target size.
setSubject ( string $subject )	Add book Subject.
setTitle ( string $title ) : boolean	Book title, mandatory.
setViewport ( integer | string $width = null, integer $height = null )	Viewport is used for fixed-layout books, specifically ePub 3 books using the Rendition metadata.
setisReferencesAddedToToc ( boolean $isReferencesAddedToToc = true ) : boolean	Set the references title for the ePub 3 landmarks section
subLevel ( string $navTitle = null, string $navId = null, string $navClass = null, boolean $isNavHidden = false, string $writingDirection = null ) : boolean | NavPoint	Add one chapter level.

Méthodes protégées

Méthode	Description
processCSSExternalReferences ( &$cssFile, integer $externalReferences = EPub::EXTERNAL_REF_ADD, string $baseDir = "", string $cssDir = "" ) : boolean	Process images referenced from an CSS file to the book.
processChapterExternalReferences ( &$doc, integer $externalReferences = EPub::EXTERNAL_REF_ADD, string $baseDir = "", string $htmlDir = "" ) : boolean	Process external references from a HTML to the book. The chapter itself is not stored.
processChapterImages ( &$xmlDoc, integer $externalReferences = EPub::EXTERNAL_REF_ADD, string $baseDir = "", string $htmlDir = "", string $backPath = "" ) : boolean	Process img tags in a DOMDocument.
processChapterLinks ( &$xmlDoc, integer $externalReferences = EPub::EXTERNAL_REF_ADD, string $baseDir = "", string $htmlDir = "", string $backPath = "" ) : boolean	Process link tags in a DOMDocument. Linked files will be loaded into the archive, and the link src will be rewritten to point to that location.
processChapterSources ( &$xmlDoc, integer $externalReferences = EPub::EXTERNAL_REF_ADD, string $baseDir = "", string $htmlDir = "", string $backPath = "" ) : boolean	Process source tags in a DOMDocument.
processChapterStyles ( &$xmlDoc, integer $externalReferences = EPub::EXTERNAL_REF_ADD, string $baseDir = "", string $htmlDir = "" ) : boolean	Process style tags in a DOMDocument. Styles will be passed as CSS files and reinserted into the document.
resolveImage ( string $source, &$internalPath, &$internalSrc, &$isSourceExternal, string $baseDir = "", string $htmlDir = "" ) : boolean	Resolve an image src and determine it's target location and add it to the book.
resolveMedia ( string $source, string &$internalPath, string &$internalSrc, string &$isSourceExternal, string $baseDir = "", string $htmlDir = "" ) : boolean	Resolve a media src and determine it's target location and add it to the book.

Private Methods

Méthode	Description
finalizeTOC ( ) : boolean	Finalize and build final ePub structures.
initialize ( )	initialize defaults.
setUp ( )
wrapChapter ( $content ) : string	Wrap ChapterContent with Head and Footer

Method Details

Property Details