Overview

Namespaces

  • None
  • PHP

Classes

  • Sidecar
  • Sidecar_Admin_Page
  • Sidecar_Admin_Tab
  • Sidecar_Field
  • Sidecar_Form
  • Sidecar_Form_Settings
  • Sidecar_Plugin_Base
  • Sidecar_Plugin_Settings
  • Sidecar_Settings_Base
  • Sidecar_Shortcode
  • Sidecar_Singleton_Base

Functions

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

Class Sidecar_Settings_Base

Class Sidecar_Settings_Base

ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, Serializable, Countable
Extended by Sidecar_Settings_Base

Direct known subclasses

Sidecar_Form_Settings, Sidecar_Plugin_Settings
Located at classes/class-settings-base.php
Methods summary
public
# __construct( Sidecar_Plugin_Base|Sidecar_Settings_Base $parent )

Parameters

$parent
Sidecar_Plugin_Base|Sidecar_Settings_Base
$parent

Overrides

ArrayObject::__construct()
public
# register_setting( string $setting_name )

Register a setting

Register a setting

Parameters

$setting_name
string
$setting_name
public boolean
# has_setting( string $setting_name )

Parameters

$setting_name
string
$setting_name

Returns

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

Parameters

$setting_name
string
$setting_name

Returns

boolean|mixed|Sidecar_Settings_Base
public
# set_setting( string $setting_name, mixed $setting_value )

Parameters

$setting_name
string
$setting_name
$setting_value
mixed
$setting_value
public array
# get_values( )

Returns

array
public array
# get_value( string $setting_name )

Parameters

$setting_name
string
$setting_name

Returns

array
public array
# get_values_deep( )

Returns

array
public
# set_dirty( mixed $is_dirty )

Parameters

$is_dirty
mixed
$is_dirty
public
# set_values( array $settings_values )

Parameters

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

Parameters

$setting_name
string
$setting_name
$setting_value
mixed
$setting_value
$set_dirty
boolean
$set_dirty

Returns

array
public
# update_settings( )
public boolean
# is_dirty( )

Returns

boolean
public boolean
# is_encrypted( )

Returns

boolean

Todo

verify this is needed in base class Get a representation of the encryption status
public
# set_encrypted( boolean $is_encrypted )

Parameters

$is_encrypted
boolean
$is_encrypted

Todo

verify this is needed in base class
public Sidecar_Settings_Base|string|null
# offsetGet( integer|string $offset )

Parameters

$offset
integer|string
$offset

Returns

Sidecar_Settings_Base|string|null

Overrides

ArrayObject::offsetGet()
Methods inherited from ArrayObject
append(), asort(), count(), exchangeArray(), getArrayCopy(), getFlags(), getIterator(), getIteratorClass(), ksort(), natcasesort(), natsort(), offsetExists(), offsetSet(), offsetUnset(), serialize(), setFlags(), setIteratorClass(), uasort(), uksort(), unserialize()
Constants inherited from ArrayObject
ARRAY_AS_PROPS, STD_PROP_LIST
Properties summary
protected Sidecar_Plugin_Base|Sidecar_Settings_Base $_parent
#
protected boolean $_is_dirty false
#
API documentation generated by ApiGen 2.8.0