PHP Class Pressbooks\Modules\ThemeOptions\PDFOptions

Inheritance: extends Pressbooks\Options

Mostra file Open project: pressbooks/pressbooks

Public Properties

Property	Type	Description
$currentVersion	integer	The value for option: pressbooks_theme_options_pdf_version
$defaults	array	PDF theme defaults.
$options	array	PDF theme options.

Public Methods

Method	Description
__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.

Method Details

__construct() public method

Constructor.

public __construct ( array $options )
$options	array

display() public method

Display the PDF options tab description.

public display ( )

doInitialUpgrade() public method

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

public doInitialUpgrade ( )

filterDefaults() static public method

Filter the array of default values for the PDF options tab.

static public filterDefaults ( array $defaults ) : array
$defaults	array
return	array	$defaults

getBooleanOptions() static public method

Get an array of options which return booleans.

static public getBooleanOptions ( ) : array
return	array	$options

getDefaults() static public method

Get an array of default values for the PDF options tab.

static public getDefaults ( ) : array
return	array	$defaults

getFloatOptions() static public method

Get an array of options which return floats.

static public getFloatOptions ( ) : array
return	array	$options

getIntegerOptions() static public method

Get an array of options which return integers.

static public getIntegerOptions ( ) : array
return	array	$options

getPredefinedOptions() static public method

Get an array of options which return predefined values.

static public getPredefinedOptions ( ) : array
return	array	$options

getSlug() static public method

Get the slug for the PDF options tab.

static public getSlug ( ) : string
return	string	$slug

getStringOptions() static public method

Get an array of options which return strings.

static public getStringOptions ( ) : array
return	array	$options

getTitle() static public method

Get the localized title of the PDF options tab.

static public getTitle ( ) : string
return	string	$title

init() public method

Configure the PDF options tab using the settings API.

public init ( )

render() public method

Render the PDF options tab form (NOT USED).

public render ( )

renderBlankPagesField() public method

Render the pdf_blankpages radio buttons.

public renderBlankPagesField ( array $args )
$args	array

renderBodyFontSizeField() public method

Render the pdf_body_font_size input.

public renderBodyFontSizeField ( array $args )
$args	array

renderBodyLineHightField() public method

Render the pdf_body_line_height input.

public renderBodyLineHightField ( array $args )
$args	array

renderBottomMarginField() public method

Render the pdf_page_margin_bottom input.

public renderBottomMarginField ( array $args )
$args	array

renderCropMarksField() public method

Render the pdf_crop_marks checkbox.

public renderCropMarksField ( array $args )
$args	array

renderFontSizeField() public method

Render the pdf_fontsize checkbox.

public renderFontSizeField ( array $args )
$args	array

renderFootnoteStyleField() public method

Render the pdf_footnotes_style radio buttons.

public renderFootnoteStyleField ( array $args )
$args	array

renderHyphenationField() public method

Render the pdf_hyphens checkbox.

public renderHyphenationField ( array $args )
$args	array

renderImageResolutionField() public method

Render the pdf_image_resolution radio buttons.

public renderImageResolutionField ( array $args )
$args	array

renderInsideMarginField() public method

Render the pdf_page_margin_inside input.

public renderInsideMarginField ( array $args )
$args	array

renderMarginsField() public method

Render the margins diagram.

public renderMarginsField ( array $args )
$args	array

renderOrphansField() public method

Render the orphans input.

public renderOrphansField ( array $args )
$args	array

renderOutsideMarginField() public method

Render the pdf_page_margin_outside input.

public renderOutsideMarginField ( array $args )
$args	array

renderPageHeightField() public method

Render the pdf_page_height input.

public renderPageHeightField ( array $args )
$args	array

renderPageSizeField() public method

Render the pdf_page_size select.

public renderPageSizeField ( array $args )
$args	array

renderPageWidthField() public method

Render the pdf_page_width input.

public renderPageWidthField ( array $args )
$args	array

renderParagraphSeparationField() public method

Render the pdf_paragraph_separation radio buttons.

public renderParagraphSeparationField ( array $args )
$args	array

renderRomanizePartsField() public method

Render the pdf_romanize_parts checkbox.

public renderRomanizePartsField ( array $args )
$args	array

renderRunningContentBackMatterLeftField() public method

Render the running_content_back_matter_left input.

public renderRunningContentBackMatterLeftField ( array $args )
$args	array

renderRunningContentBackMatterRightField() public method

Render the running_content_back_matter_right input.

public renderRunningContentBackMatterRightField ( array $args )
$args	array

renderRunningContentChapterLeftField() public method

Render the running_content_chapter_left input.

public renderRunningContentChapterLeftField ( array $args )
$args	array

renderRunningContentChapterRightField() public method

Render the running_content_chapter_right input.

public renderRunningContentChapterRightField ( array $args )
$args	array

renderRunningContentField() public method

Render the running content instructional diagram.

public renderRunningContentField ( array $args )
$args	array

renderRunningContentFrontMatterLeftField() public method

Render the running_content_front_matter_left input.

public renderRunningContentFrontMatterLeftField ( array $args )
$args	array

renderRunningContentFrontMatterRightField() public method

Render the running_content_front_matter_right input.

public renderRunningContentFrontMatterRightField ( array $args )
$args	array

renderRunningContentIntroductionLeftField() public method

Render the running_content_introduction_left input.

public renderRunningContentIntroductionLeftField ( array $args )
$args	array

renderRunningContentIntroductionRightField() public method

Render the running_content_introduction_right input.

public renderRunningContentIntroductionRightField ( array $args )
$args	array

renderRunningContentPartLeftField() public method

Render the running_content_part_left input.

public renderRunningContentPartLeftField ( array $args )
$args	array

renderRunningContentPartRightField() public method

Render the running_content_part_right input.

public renderRunningContentPartRightField ( array $args )
$args	array

renderTOCField() public method

Render the pdf_toc checkbox.

public renderTOCField ( array $args )
$args	array

renderTopMarginField() public method

Render the pdf_page_margin_top input.

public renderTopMarginField ( array $args )
$args	array

renderWidowsField() public method

Render the widows input.

public renderWidowsField ( array $args )
$args	array

upgrade() public method

Upgrade handler for PDF options.

public upgrade ( integer $version )
$version	integer

Property Details

$currentVersion static_oe public_oe property

The value for option: pressbooks_theme_options_pdf_version

$defaults public_oe property

PDF theme defaults.

public array $defaults
return	array

$options public_oe property

PDF theme options.

public array $options
return	array