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

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

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

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

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

Метод Описание
__construct ( array $options ) Constructor.
display ( ) Display the mPDF options tab description.
filterDefaults ( array $defaults ) : array Filter the array of default values for the mPDF options tab.
getBooleanOptions ( ) : array Get an array of options which return booleans.
getDefaults ( ) : array Get an array of default values for the mPDF options tab.
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 mPDF options tab.
getTitle ( ) : string Get the localized title of the mPDF options tab.
init ( ) Configure the mPDF options tab using the settings API.
render ( ) Render the mPDF options tab form (NOT USED).
renderCoverImageField ( array $args ) Render the mpdf_include_cover checkbox.
renderFontSizeField ( array $args ) Render the mpdf_fontsize checkbox.
renderHyphensField ( array $args ) Render the mpdf_hyphens checkbox.
renderIndentParagraphsField ( array $args ) Render the mpdf_indent_paragraphs checkbox.
renderLeftMarginField ( array $args ) Render the mpdf_margin_left input.
renderMirrorMarginsField ( array $args ) Render the mpdf_mirror_margins checkbox.
renderPageSizeField ( array $args ) Render the mpdf_page_size input.
renderRightMarginField ( array $args ) Render the mpdf_margin_right input.
renderTOCField ( array $args ) Render the mpdf_include_toc checkbox.
upgrade ( integer $version ) Upgrade handler for mPDF options (none at present).

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

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

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

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

Display the mPDF options tab description.
public display ( )

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

Filter the array of default values for the mPDF 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 mPDF options tab.
static public getDefaults ( ) : array
Результат array $defaults

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 mPDF options tab.
static public getSlug ( ) : string
Результат string $slug

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

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

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

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

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

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

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

Render the mpdf_include_cover checkbox.
public renderCoverImageField ( array $args )
$args array

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

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

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

Render the mpdf_hyphens checkbox.
public renderHyphensField ( array $args )
$args array

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

Render the mpdf_indent_paragraphs checkbox.
public renderIndentParagraphsField ( array $args )
$args array

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

Render the mpdf_margin_left input.
public renderLeftMarginField ( array $args )
$args array

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

Render the mpdf_mirror_margins checkbox.
public renderMirrorMarginsField ( array $args )
$args array

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

Render the mpdf_page_size input.
public renderPageSizeField ( array $args )
$args array

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

Render the mpdf_margin_right input.
public renderRightMarginField ( array $args )
$args array

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

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

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

Upgrade handler for mPDF options (none at present).
public upgrade ( integer $version )
$version integer

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

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

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

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

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

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

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