PHP Class Pressbooks\Admin\ExportOptions

Inheritance: extends Pressbooks\Options

Show file Open project: pressbooks/pressbooks

Public Properties

Property	Type	Description
$currentVersion	integer	The value for option: pressbooks_export_options_version
$defaults	array	Export defaults.
$options	array	Export options.

Public Methods

Method	Description
__construct ( array $options )	Constructor.
display ( )	Display the export options page description.
doInitialUpgrade ( )
filterDefaults ( array $defaults ) : array	Filter the array of default values for this set of options
getBooleanOptions ( ) : array	Get an array of options which return booleans.
getDefaults ( ) : array	Get an array of default values for the export options page.
getSlug ( ) : string	Get the slug for the export options page.
getTitle ( ) : string	Get the localized title of the export options page.
init ( )	Configure the export options page using the settings API.
render ( )
renderEmailValidationLogsField ( array $args )	Render the email_validation_logs radio buttons.
upgrade ( $version )

Method Details

__construct() public method

Constructor.

public __construct ( array $options )
$options	array

display() public method

Display the export options page description.

public display ( )

doInitialUpgrade() public method

public doInitialUpgrade ( )

filterDefaults() static public method

Filter the array of default values for this set of options

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 export options page.

static public getDefaults ( ) : array
return	array	$defaults

getSlug() static public method

Get the slug for the export options page.

static public getSlug ( ) : string
return	string	$slug

getTitle() static public method

Get the localized title of the export options page.

static public getTitle ( ) : string
return	string	$title

init() public method

Configure the export options page using the settings API.

public init ( )

render() public method

public render ( )

renderEmailValidationLogsField() public method

Render the email_validation_logs radio buttons.

public renderEmailValidationLogsField ( array $args )
$args	array

upgrade() public method

public upgrade ( $version )

Property Details

$currentVersion static public property

The value for option: pressbooks_export_options_version

$defaults public property

Export defaults.

public array $defaults
return	array

$options public property

Export options.

public array $options
return	array