PHP Класс Pressbooks\Modules\ThemeOptions\PDFOptions

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

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

Свойство Тип Описание
$currentVersion integer The value for option: pressbooks_theme_options_pdf_version
$defaults array PDF theme defaults.
$options array PDF theme options.

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

Метод Описание
__construct ( array $options ) Constructor.
display ( ) Display the PDF options tab description.
doInitialUpgrade ( ) Substitute human-readable values, add new defaults, replace pdf_page_size with pdf_page_width and pdf_page_height.
filterDefaults ( array $defaults ) : array Filter the array of default values for the PDF options tab.
getBooleanOptions ( ) : array Get an array of options which return booleans.
getDefaults ( ) : array Get an array of default values for the PDF options tab.
getFloatOptions ( ) : array Get an array of options which return floats.
getIntegerOptions ( ) : array Get an array of options which return integers.
getPredefinedOptions ( ) : array Get an array of options which return predefined values.
getSlug ( ) : string Get the slug for the PDF options tab.
getStringOptions ( ) : array Get an array of options which return strings.
getTitle ( ) : string Get the localized title of the PDF options tab.
init ( ) Configure the PDF options tab using the settings API.
render ( ) Render the PDF options tab form (NOT USED).
renderBlankPagesField ( array $args ) Render the pdf_blankpages radio buttons.
renderBodyFontSizeField ( array $args ) Render the pdf_body_font_size input.
renderBodyLineHightField ( array $args ) Render the pdf_body_line_height input.
renderBottomMarginField ( array $args ) Render the pdf_page_margin_bottom input.
renderCropMarksField ( array $args ) Render the pdf_crop_marks checkbox.
renderFontSizeField ( array $args ) Render the pdf_fontsize checkbox.
renderFootnoteStyleField ( array $args ) Render the pdf_footnotes_style radio buttons.
renderHyphenationField ( array $args ) Render the pdf_hyphens checkbox.
renderImageResolutionField ( array $args ) Render the pdf_image_resolution radio buttons.
renderInsideMarginField ( array $args ) Render the pdf_page_margin_inside input.
renderMarginsField ( array $args ) Render the margins diagram.
renderOrphansField ( array $args ) Render the orphans input.
renderOutsideMarginField ( array $args ) Render the pdf_page_margin_outside input.
renderPageHeightField ( array $args ) Render the pdf_page_height input.
renderPageSizeField ( array $args ) Render the pdf_page_size select.
renderPageWidthField ( array $args ) Render the pdf_page_width input.
renderParagraphSeparationField ( array $args ) Render the pdf_paragraph_separation radio buttons.
renderRomanizePartsField ( array $args ) Render the pdf_romanize_parts checkbox.
renderRunningContentBackMatterLeftField ( array $args ) Render the running_content_back_matter_left input.
renderRunningContentBackMatterRightField ( array $args ) Render the running_content_back_matter_right input.
renderRunningContentChapterLeftField ( array $args ) Render the running_content_chapter_left input.
renderRunningContentChapterRightField ( array $args ) Render the running_content_chapter_right input.
renderRunningContentField ( array $args ) Render the running content instructional diagram.
renderRunningContentFrontMatterLeftField ( array $args ) Render the running_content_front_matter_left input.
renderRunningContentFrontMatterRightField ( array $args ) Render the running_content_front_matter_right input.
renderRunningContentIntroductionLeftField ( array $args ) Render the running_content_introduction_left input.
renderRunningContentIntroductionRightField ( array $args ) Render the running_content_introduction_right input.
renderRunningContentPartLeftField ( array $args ) Render the running_content_part_left input.
renderRunningContentPartRightField ( array $args ) Render the running_content_part_right input.
renderTOCField ( array $args ) Render the pdf_toc checkbox.
renderTopMarginField ( array $args ) Render the pdf_page_margin_top input.
renderWidowsField ( array $args ) Render the widows input.
upgrade ( integer $version ) Upgrade handler for PDF options.

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

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

Constructor.
public __construct ( array $options )
$options array

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

Display the PDF options tab description.
public display ( )

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

Substitute human-readable values, add new defaults, replace pdf_page_size with pdf_page_width and pdf_page_height.
public doInitialUpgrade ( )

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

Filter the array of default values for the PDF options tab.
static public filterDefaults ( array $defaults ) : array
$defaults array
Результат array $defaults

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

Get an array of options which return booleans.
static public getBooleanOptions ( ) : array
Результат array $options

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

Get an array of default values for the PDF options tab.
static public getDefaults ( ) : array
Результат array $defaults

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

Get an array of options which return floats.
static public getFloatOptions ( ) : array
Результат array $options

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

Get an array of options which return integers.
static public getIntegerOptions ( ) : array
Результат array $options

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

Get an array of options which return predefined values.
static public getPredefinedOptions ( ) : array
Результат array $options

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

Get the slug for the PDF options tab.
static public getSlug ( ) : string
Результат string $slug

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

Get an array of options which return strings.
static public getStringOptions ( ) : array
Результат array $options

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

Get the localized title of the PDF options tab.
static public getTitle ( ) : string
Результат string $title

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

Configure the PDF options tab using the settings API.
public init ( )

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

Render the PDF options tab form (NOT USED).
public render ( )

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

Render the pdf_blankpages radio buttons.
public renderBlankPagesField ( array $args )
$args array

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

Render the pdf_body_font_size input.
public renderBodyFontSizeField ( array $args )
$args array

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

Render the pdf_body_line_height input.
public renderBodyLineHightField ( array $args )
$args array

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

Render the pdf_page_margin_bottom input.
public renderBottomMarginField ( array $args )
$args array

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

Render the pdf_crop_marks checkbox.
public renderCropMarksField ( array $args )
$args array

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

Render the pdf_fontsize checkbox.
public renderFontSizeField ( array $args )
$args array

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

Render the pdf_footnotes_style radio buttons.
public renderFootnoteStyleField ( array $args )
$args array

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

Render the pdf_hyphens checkbox.
public renderHyphenationField ( array $args )
$args array

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

Render the pdf_image_resolution radio buttons.
public renderImageResolutionField ( array $args )
$args array

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

Render the pdf_page_margin_inside input.
public renderInsideMarginField ( array $args )
$args array

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

Render the margins diagram.
public renderMarginsField ( array $args )
$args array

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

Render the orphans input.
public renderOrphansField ( array $args )
$args array

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

Render the pdf_page_margin_outside input.
public renderOutsideMarginField ( array $args )
$args array

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

Render the pdf_page_height input.
public renderPageHeightField ( array $args )
$args array

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

Render the pdf_page_size select.
public renderPageSizeField ( array $args )
$args array

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

Render the pdf_page_width input.
public renderPageWidthField ( array $args )
$args array

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

Render the pdf_paragraph_separation radio buttons.
public renderParagraphSeparationField ( array $args )
$args array

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

Render the pdf_romanize_parts checkbox.
public renderRomanizePartsField ( array $args )
$args array

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

Render the running_content_back_matter_left input.
public renderRunningContentBackMatterLeftField ( array $args )
$args array

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

Render the running_content_back_matter_right input.
public renderRunningContentBackMatterRightField ( array $args )
$args array

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

Render the running_content_chapter_left input.
public renderRunningContentChapterLeftField ( array $args )
$args array

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

Render the running_content_chapter_right input.
public renderRunningContentChapterRightField ( array $args )
$args array

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

Render the running content instructional diagram.
public renderRunningContentField ( array $args )
$args array

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

Render the running_content_front_matter_left input.
public renderRunningContentFrontMatterLeftField ( array $args )
$args array

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

Render the running_content_front_matter_right input.
public renderRunningContentFrontMatterRightField ( array $args )
$args array

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

Render the running_content_introduction_left input.
public renderRunningContentIntroductionLeftField ( array $args )
$args array

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

Render the running_content_introduction_right input.
public renderRunningContentIntroductionRightField ( array $args )
$args array

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

Render the running_content_part_left input.
public renderRunningContentPartLeftField ( array $args )
$args array

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

Render the running_content_part_right input.
public renderRunningContentPartRightField ( array $args )
$args array

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

Render the pdf_toc checkbox.
public renderTOCField ( array $args )
$args array

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

Render the pdf_page_margin_top input.
public renderTopMarginField ( array $args )
$args array

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

Render the widows input.
public renderWidowsField ( array $args )
$args array

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

Upgrade handler for PDF options.
public upgrade ( integer $version )
$version integer

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

$currentVersion статическое публичное свойство

The value for option: pressbooks_theme_options_pdf_version
См. также: upgrade()
static public int $currentVersion
Результат integer

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

PDF theme defaults.
public array $defaults
Результат array

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

PDF theme options.
public array $options
Результат array