PHP Class Pressbooks\Modules\ThemeOptions\EbookOptions

Inheritance: extends Pressbooks\Options
ファイルを表示 Open project: pressbooks/pressbooks

Public Properties

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

Public Methods

Method Description
__construct ( array $options ) Constructor.
display ( ) Display the Ebook options tab description.
doInitialUpgrade ( ) Update values to human-readable equivalents within Ebook options.
filterDefaults ( array $defaults ) : array Filter the array of default values for the Ebook options tab.
getBooleanOptions ( ) : array Get an array of options which return booleans.
getDefaults ( ) : array Get an array of default values for the Ebook options tab.
getPredefinedOptions ( ) : array Get an array of options which return predefined values.
getSlug ( ) : string Get the slug for the Ebook options tab.
getTitle ( ) : string Get the localized title of the Ebook options tab.
init ( ) Configure the ebook options tab using the settings API.
render ( ) Render the Ebook options tab form (NOT USED).
renderCompressImagesField ( array $args ) Render the ebook_compress_images checkbox.
renderParagraphSeparationField ( array $args ) Render the ebook_paragraph_separation radio buttons.
upgrade ( integer $version ) Upgrade handler for Ebook options.

Method Details

__construct() public method

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

display() public method

Display the Ebook options tab description.
public display ( )

doInitialUpgrade() public method

Update values to human-readable equivalents within Ebook options.
public doInitialUpgrade ( )

filterDefaults() static public method

Filter the array of default values for the Ebook 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 Ebook options tab.
static public getDefaults ( ) : array
return array $defaults

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 Ebook options tab.
static public getSlug ( ) : string
return string $slug

getTitle() static public method

Get the localized title of the Ebook options tab.
static public getTitle ( ) : string
return string $title

init() public method

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

render() public method

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

renderCompressImagesField() public method

Render the ebook_compress_images checkbox.
public renderCompressImagesField ( array $args )
$args array

renderParagraphSeparationField() public method

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

upgrade() public method

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

Property Details

$currentVersion static_oe public_oe property

The value for option: pressbooks_theme_options_ebook_version
See also: upgrade()
static public int $currentVersion
return integer

$defaults public_oe property

Web theme defaults.
public array $defaults
return array

$options public_oe property

Web theme options.
public array $options
return array