PHP 클래스 Pressbooks\Modules\ThemeOptions\EbookOptions

상속: extends Pressbooks\Options
파일 보기 프로젝트 열기: pressbooks/pressbooks

공개 프로퍼티들

프로퍼티 타입 설명
$currentVersion integer The value for option: pressbooks_theme_options_ebook_version
$defaults array Web theme defaults.
$options array Web theme options.

공개 메소드들

메소드 설명
__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.

메소드 상세

__construct() 공개 메소드

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

display() 공개 메소드

Display the Ebook options tab description.
public display ( )

doInitialUpgrade() 공개 메소드

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

filterDefaults() 정적인 공개 메소드

Filter the array of default values for the Ebook 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 Ebook 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 Ebook options tab.
static public getSlug ( ) : string
리턴 string $slug

getTitle() 정적인 공개 메소드

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

init() 공개 메소드

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

render() 공개 메소드

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

renderCompressImagesField() 공개 메소드

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

renderParagraphSeparationField() 공개 메소드

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

upgrade() 공개 메소드

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

프로퍼티 상세

$currentVersion 정적으로 공개적으로 프로퍼티

The value for option: pressbooks_theme_options_ebook_version
또한 보기: upgrade()
static public int $currentVersion
리턴 integer

$defaults 공개적으로 프로퍼티

Web theme defaults.
public array $defaults
리턴 array

$options 공개적으로 프로퍼티

Web theme options.
public array $options
리턴 array