PHP Класс Pressbooks\Modules\Import\Ooxml\Docx

Наследование: extends PressBooks\Modules\Import\Import
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$authors string
$en array
$fn array
$ln array
$tag string
$zip ZipArchive

Открытые методы

Метод Описание
__construct ( )
import ( array $current_import ) : boolean
setCurrentImportOption ( array $upload ) : boolean

Защищенные методы

Метод Описание
addFootnotes ( DOMDocument $chapter ) : DOMDocument adds footnotes, if they are present in the chapter
addHyperlinks ( DOMDocument $chapter ) : DOMDocument adds external hyperlinks, if they are present in a chapter
fetchAndSaveUniqueImage ( string $img_id ) : string Extract url from zip and load into WP using media_handle_sideload() Will return an empty string if something went wrong.
findTheNode ( DOMNode $node, string $chapter_name ) : DOMNode Recursive iterator to locate and return a specific node, targeting child nodes
getChapter ( DOMNodeList $dom_list, integer $index, string $chapter_title ) : string Find where to start, iterate through a list, add elements to a new DomDocument, return resulting xhtml
getFuzzyChapterTitles ( ) : array Returns an array of available chapters, or 'unknown' if none
getIDs ( DOMDocument $dom_doc, string $tag = 'footnoteReference', $attr = 'w:id' ) : array Given a documentElement, it will return an array of ids
getRelationshipPart ( array $ids, string $tag = 'footnotes' ) : array | boolean Give this some ids and it returns an associative array of footnotes
getTargetPath ( string $schema, string $id = '' ) : string Give it a schema, get back a path(s) that points to a resource
getZipContent ( string $file, boolean $as_xml = true ) : boolean | DOMDocument Give it a path to a file and it will return the contents of that file, either as xml or html
isValidZip ( string $fullpath ) Checks for standard DOCX file structure
kneadAndInsert ( string $html, string $title, string $post_type, integer $chapter_parent ) Pummel then insert HTML into our database
kneadHTML ( string $body ) : string Pummel the HTML into WordPress compatible dough.
parseContent ( DomDocument $xml, string $chapter_title ) : string
parseMetaData ( DomDocument $meta )
scrapeAndKneadImages ( DOMDocument $doc ) : DOMDocument Parse HTML snippet, save all found tags using media_handle_sideload(), return the HTML with changed paths.
tidy ( string $html ) : string Compliance with XTHML standards, rid cruft generated by word processors

Описание методов

__construct() публичный Метод

public __construct ( )

addFootnotes() защищенный Метод

adds footnotes, if they are present in the chapter
protected addFootnotes ( DOMDocument $chapter ) : DOMDocument
$chapter DOMDocument
Результат DOMDocument

fetchAndSaveUniqueImage() защищенный Метод

Extract url from zip and load into WP using media_handle_sideload() Will return an empty string if something went wrong.
protected fetchAndSaveUniqueImage ( string $img_id ) : string
$img_id string
Результат string

findTheNode() защищенный Метод

Recursive iterator to locate and return a specific node, targeting child nodes
protected findTheNode ( DOMNode $node, string $chapter_name ) : DOMNode
$node DOMNode
$chapter_name string
Результат DOMNode

getChapter() защищенный Метод

Find where to start, iterate through a list, add elements to a new DomDocument, return resulting xhtml
protected getChapter ( DOMNodeList $dom_list, integer $index, string $chapter_title ) : string
$dom_list DOMNodeList
$index integer
$chapter_title string
Результат string XHTML

getFuzzyChapterTitles() защищенный Метод

Returns an array of available chapters, or 'unknown' if none
protected getFuzzyChapterTitles ( ) : array
Результат array Chapter titles

getIDs() защищенный Метод

Given a documentElement, it will return an array of ids
protected getIDs ( DOMDocument $dom_doc, string $tag = 'footnoteReference', $attr = 'w:id' ) : array
$dom_doc DOMDocument
$tag string
Результат array

getRelationshipPart() защищенный Метод

Give this some ids and it returns an associative array of footnotes
protected getRelationshipPart ( array $ids, string $tag = 'footnotes' ) : array | boolean
$ids array
$tag string
Результат array | boolean

getTargetPath() защищенный Метод

Give it a schema, get back a path(s) that points to a resource
protected getTargetPath ( string $schema, string $id = '' ) : string
$schema string
$id string
Результат string

getZipContent() защищенный Метод

Give it a path to a file and it will return the contents of that file, either as xml or html
protected getZipContent ( string $file, boolean $as_xml = true ) : boolean | DOMDocument
$file string
$as_xml boolean (optional)
Результат boolean | DOMDocument

import() публичный Метод

public import ( array $current_import ) : boolean
$current_import array
Результат boolean

isValidZip() защищенный Метод

Checks for standard DOCX file structure
protected isValidZip ( string $fullpath )
$fullpath string

kneadAndInsert() защищенный Метод

Pummel then insert HTML into our database
protected kneadAndInsert ( string $html, string $title, string $post_type, integer $chapter_parent )
$html string
$title string
$post_type string (front-matter', 'chapter', 'back-matter')
$chapter_parent integer

kneadHTML() защищенный Метод

Pummel the HTML into WordPress compatible dough.
protected kneadHTML ( string $body ) : string
$body string
Результат string - modified with correct image paths

parseContent() защищенный Метод

protected parseContent ( DomDocument $xml, string $chapter_title ) : string
$xml DomDocument
$chapter_title string
Результат string

parseMetaData() защищенный Метод

protected parseMetaData ( DomDocument $meta )
$meta DomDocument

scrapeAndKneadImages() защищенный Метод

Parse HTML snippet, save all found tags using media_handle_sideload(), return the HTML with changed paths.
protected scrapeAndKneadImages ( DOMDocument $doc ) : DOMDocument
$doc DOMDocument
Результат DOMDocument

setCurrentImportOption() публичный Метод

public setCurrentImportOption ( array $upload ) : boolean
$upload array
Результат boolean

tidy() защищенный Метод

Compliance with XTHML standards, rid cruft generated by word processors
protected tidy ( string $html ) : string
$html string
Результат string

Описание свойств

$authors защищенное свойство

protected string $authors
Результат string

$en защищенное свойство

protected array $en
Результат array

$fn защищенное свойство

protected array $fn
Результат array

$ln защищенное свойство

protected array $ln
Результат array

$tag защищенное свойство

protected string $tag
Результат string

$zip защищенное свойство

protected ZipArchive $zip
Результат ZipArchive