Overview

Namespaces

  • None
  • PHP

Classes

  • Sidecar
  • Sidecar_Admin_Page
  • Sidecar_Admin_Tab
  • Sidecar_Field
  • Sidecar_Form
  • Sidecar_Plugin_Base
  • Sidecar_Settings
  • Sidecar_Shortcode
  • Sidecar_Singleton_Base

Functions

  • body
  • format_gmt_string
  • headers
  • output_css
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo
  • Download

Class Sidecar_Settings

Class Sidecar_Settings

Located at classes/class-settings.php
Methods summary
public
# __construct( string $option_name, Sidecar_Plugin_Base|Sidecar_Settings $parent )

Parameters

$option_name
string
$option_name
$parent
Sidecar_Plugin_Base|Sidecar_Settings
$parent
public
# shutdown( )

Autosave dirty settings on shutdown

Autosave dirty settings on shutdown

public string
# is_decrypted( boolean|string $setting_name = false )

Get a string representing the encryption status

Get a string representing the encryption status

Parameters

$setting_name
boolean|string
$setting_name

Returns

string
public
# set_decrypted( boolean $decrypted )

Parameters

$decrypted
boolean
$decrypted
public mixed
# decrypt_settings( Sidecar_Settings $settings, Sidecar_Form $caller )

Parameters

$settings
Sidecar_Settings
$settings
$caller
Sidecar_Form
$caller

Returns

mixed

Todo

Implement decryption
public boolean
# has_setting( string $setting_name )

Parameters

$setting_name
string
$setting_name

Returns

boolean
public boolean|mixed|Sidecar_Settings
# get_setting( string $setting_name )

Parameters

$setting_name
string
$setting_name

Returns

boolean|mixed|Sidecar_Settings
public array
# get_settings_values( )

Returns

array
public
# initialize_settings( array $settings )

Accepts an array of name/value pairs and assigns the settings.

Accepts an array of name/value pairs and assigns the settings.

Parameters

$settings
array
$settings
public
# update_settings_values( array $settings_values, boolean $set_dirty = true )

Parameters

$settings_values
array
$settings_values
$set_dirty
boolean
$set_dirty
public array
# update_settings_value( string $setting_name, mixed $value, boolean $set_dirty = true )

Parameters

$setting_name
string
$setting_name
$value
mixed
$value
$set_dirty
boolean
$set_dirty

Returns

array
public
# update_settings_array( mixed $settings_array )

Update the settings based on an array of option values

Update the settings based on an array of option values

The keys in top level/global array are probably form names and the keys in the subject arrays are field names. This is different from "Settings Values" in that the top level array contains form objects vs. arrays of values.

Parameters

$settings_array
mixed
$settings_array
public
# update_settings( )
public array
# update_settings_option( object $settings_option, boolean $set_dirty = true )

Parameters

$settings_option
object
$settings_option
$set_dirty
boolean
$set_dirty

Returns

array
public
# set_required_setting_names( array $required_settings )

Parameters

$required_settings
array
$required_settings
public boolean
# has_required_settings( boolean|array $required_setting_names = false )

Parameters

$required_setting_names
boolean|array
$required_setting_names

Returns

boolean
public array
# get_empty_settings_values( )

Returns

array
public boolean
# is_dirty( )

Returns

boolean
public array
# get_settings_array( )

Returns

array
public
# save_settings( )

Save settings if parent is Sidecar_Plugin_Base

Save settings if parent is Sidecar_Plugin_Base

public
# load_settings( )

Load settings if parent is Sidecar_Plugin_Base

Load settings if parent is Sidecar_Plugin_Base

public
# delete_settings( )
Properties summary
public string $option_name
#
protected boolean $_is_dirty false
#
public string $installed_version
#
public boolean $configured false
#
API documentation generated by ApiGen 2.8.0