PHP Класс PressBooks\Modules\Export\Xhtml\Xhtml11

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

Открытые свойства

Свойство Тип Описание
$timeout integer Used with wp_remote_get()
$url string Service URL

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

Свойство Тип Описание
$endnotes array Use when overriding the footnote shortcode.
$frontMatterPos integer Keep track of where we are using this variable.
$hasIntroduction boolean Sometimes the user will omit an introduction so we must inject the style in either the first part or the first chapter ourselves.
$lang string Main language of document, two letter code

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

Метод Описание
__construct ( array $args )
convert ( ) : boolean Create $this->outputPath
doEndnotes ( $id ) : string Style endnotes.
endnoteShortcode ( array $atts, null $content = null ) : string Convert footnotes to endnotes by moving them to the end of the_content()
footnoteShortcode ( $atts, null $content = null ) : string Wrap footnotes for Prince compatibility
hasDependencies ( ) : boolean Dependency check.
logError ( $message, array $more_info = [] ) Add $this->url as additional log info, fallback to parent.
transform ( ) Procedure for "format/xhtml" rewrite rule.
validate ( ) : boolean Check the sanity of $this->outputPath

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

Метод Описание
atLeastOneExport ( array $chapters ) : boolean Does array of chapters have at least one export? Recursive.
createPromo ( array $book_contents, array $metadata )
echoBackMatter ( array $book_contents, array $metadata )
echoBeforeTitle ( array $book_contents, array $metadata )
echoCopyright ( array $book_contents, array $metadata )
echoCover ( array $book_contents, array $metadata )
echoDedicationAndEpigraph ( array $book_contents, array $metadata )
echoDocType ( array $book_contents, array $metadata )
echoFrontMatter ( array $book_contents, array $metadata )
echoHalfTitle ( array $book_contents, array $metadata )
echoMetaData ( array $book_contents, array $metadata )
echoPartsAndChapters ( array $book_contents, array $metadata )
echoTitle ( array $book_contents, array $metadata )
echoToc ( array $book_contents, array $metadata )
fixInternalLinks ( string $content ) : string
preProcessBookContents ( $book_contents ) : mixed
preProcessPostContent ( string $content ) : string
queryXhtml ( ) : boolean | string Query the access protected "format/xhtml" URL, return the results.
switchLaTexFormat ( string $content ) Replace links to QuickLaTex PNG files with links to the corresponding SVG files.
tidy ( string $html ) : string Tidy HTML

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

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

public __construct ( array $args )
$args array

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

Does array of chapters have at least one export? Recursive.
protected atLeastOneExport ( array $chapters ) : boolean
$chapters array
Результат boolean

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

Create $this->outputPath
public convert ( ) : boolean
Результат boolean

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

protected createPromo ( array $book_contents, array $metadata )
$book_contents array
$metadata array

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

Style endnotes.
См. также: endnoteShortcode
public doEndnotes ( $id ) : string
$id
Результат string

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

protected echoBackMatter ( array $book_contents, array $metadata )
$book_contents array
$metadata array

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

protected echoBeforeTitle ( array $book_contents, array $metadata )
$book_contents array
$metadata array

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

protected echoCopyright ( array $book_contents, array $metadata )
$book_contents array
$metadata array

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

protected echoCover ( array $book_contents, array $metadata )
$book_contents array
$metadata array

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

protected echoDedicationAndEpigraph ( array $book_contents, array $metadata )
$book_contents array
$metadata array

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

protected echoDocType ( array $book_contents, array $metadata )
$book_contents array
$metadata array

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

protected echoFrontMatter ( array $book_contents, array $metadata )
$book_contents array
$metadata array

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

protected echoHalfTitle ( array $book_contents, array $metadata )
$book_contents array
$metadata array

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

protected echoMetaData ( array $book_contents, array $metadata )
$book_contents array
$metadata array

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

protected echoPartsAndChapters ( array $book_contents, array $metadata )
$book_contents array
$metadata array

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

protected echoTitle ( array $book_contents, array $metadata )
$book_contents array
$metadata array

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

protected echoToc ( array $book_contents, array $metadata )
$book_contents array
$metadata array

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

Convert footnotes to endnotes by moving them to the end of the_content()
См. также: doEndnotes
public endnoteShortcode ( array $atts, null $content = null ) : string
$atts array
$content null
Результат string

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

Wrap footnotes for Prince compatibility
См. также: http://www.princexml.com/doc/8.1/footnotes/
public footnoteShortcode ( $atts, null $content = null ) : string
$atts
$content null
Результат string

hasDependencies() статический публичный Метод

Dependency check.
static public hasDependencies ( ) : boolean
Результат boolean

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

Add $this->url as additional log info, fallback to parent.
public logError ( $message, array $more_info = [] )
$message
$more_info array (unused, overridden)

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

protected preProcessBookContents ( $book_contents ) : mixed
$book_contents
Результат mixed

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

protected preProcessPostContent ( string $content ) : string
$content string
Результат string

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

Query the access protected "format/xhtml" URL, return the results.
protected queryXhtml ( ) : boolean | string
Результат boolean | string

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

Replace links to QuickLaTex PNG files with links to the corresponding SVG files.
protected switchLaTexFormat ( string $content )
$content string The section content.

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

Tidy HTML
protected tidy ( string $html ) : string
$html string
Результат string

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

Procedure for "format/xhtml" rewrite rule.
public transform ( )

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

Check the sanity of $this->outputPath
public validate ( ) : boolean
Результат boolean

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

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

Use when overriding the footnote shortcode.
protected array $endnotes
Результат array

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

Keep track of where we are using this variable.
protected int $frontMatterPos
Результат integer

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

Sometimes the user will omit an introduction so we must inject the style in either the first part or the first chapter ourselves.
protected bool $hasIntroduction
Результат boolean

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

Main language of document, two letter code
protected string $lang
Результат string

$timeout публичное свойство

Used with wp_remote_get()
public int $timeout
Результат integer

$url публичное свойство

Service URL
public string $url
Результат string