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

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

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

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

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

Метод Описание
__construct ( array $options ) Constructor.
display ( ) Display the global options tab description.
doInitialUpgrade ( ) Remove deprecated keys from global options, clarify two-level TOC key name.
filterDefaults ( array $defaults ) : array Filter the array of default values for the Global options tab.
getBooleanOptions ( ) : array Get an array of options which return booleans.
getDefaults ( ) : array Get an array of default values for the global options tab.
getPredefinedOptions ( ) : array Get an array of options which return predefined values.
getSlug ( ) : string Get the slug for the global options tab.
getTitle ( ) : string Get the localized title of the global options tab.
init ( ) Configure the global options tab using the settings API.
render ( ) Render the PDF options tab form (NOT USED).
renderChapterNumbersField ( array $args ) Render the chapter_numbers checkbox.
renderCopyrightLicenseField ( array $args ) Render the copyright_license checkbox.
renderLanguagesField ( array $args ) Render the pressbooks_global_typography select.
renderTwoLevelTOCField ( array $args ) Render the parse_subsections checkbox.
sanitizeLanguages ( $input ) Sanitize the languages (just returns the array or an empty array, as these are predefined values).
upgrade ( integer $version ) Upgrade handler for global options.

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

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

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

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

Display the global options tab description.
public display ( )

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

Remove deprecated keys from global options, clarify two-level TOC key name.
public doInitialUpgrade ( )

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

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

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

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

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

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

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

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

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

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

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

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

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

Render the chapter_numbers checkbox.
public renderChapterNumbersField ( array $args )
$args array

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

Render the copyright_license checkbox.
public renderCopyrightLicenseField ( array $args )
$args array

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

Render the pressbooks_global_typography select.
public renderLanguagesField ( array $args )
$args array

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

Render the parse_subsections checkbox.
public renderTwoLevelTOCField ( array $args )
$args array

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

Sanitize the languages (just returns the array or an empty array, as these are predefined values).
public sanitizeLanguages ( $input )

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

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

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

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

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

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

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

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

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