PHP Class TitanFrameworkOption

Exibir arquivo Open project: gambitph/titan-framework Class Usage Examples

Public Properties

Property Type Description
$defaultSecondarySettings array Default settings specific for this option. This is overridden by each option class
$echo_wrapper
$owner One of the TYPE_* constants above
$settings
$type

Public Methods

Method Description
__call ( $name, $args )
__construct ( $settings, $owner )
cleanValueForGetting ( $value ) * overridden
cleanValueForSaving ( $value ) * overridden
display ( ) * overridden
factory ( $settings, $owner )
getID ( )
getOptionNamespace ( ) : string Gets the option namespace used in the framework instance currently used
getValue ( $postID = null )
registerCustomizerControl ( $wp_customize, $section, $priority = 1 ) * overridden
setValue ( $value, $postID = null )

Protected Methods

Method Description
echoOptionFooter ( $showDesc = true )
echoOptionFooterBare ( $showDesc = true )
echoOptionHeader ( $showDesc = false )
echoOptionHeaderBare ( )
getFramework ( ) : TitanFramework Gets the framework instance currently used

Method Details

__call() public method

public __call ( $name, $args )

__construct() public method

public __construct ( $settings, $owner )

cleanValueForGetting() public method

* overridden
public cleanValueForGetting ( $value )

cleanValueForSaving() public method

* overridden
public cleanValueForSaving ( $value )

display() public method

* overridden
public display ( )

echoOptionFooter() protected method

protected echoOptionFooter ( $showDesc = true )

echoOptionFooterBare() protected method

protected echoOptionFooterBare ( $showDesc = true )

echoOptionHeader() protected method

protected echoOptionHeader ( $showDesc = false )

echoOptionHeaderBare() protected method

protected echoOptionHeaderBare ( )

factory() public static method

public static factory ( $settings, $owner )

getFramework() protected method

Gets the framework instance currently used
Since: 1.3
protected getFramework ( ) : TitanFramework
return TitanFramework

getID() public method

public getID ( )

getOptionNamespace() public method

Gets the option namespace used in the framework instance currently used
Since: 1.0
public getOptionNamespace ( ) : string
return string The option namespace

getValue() public method

public getValue ( $postID = null )

registerCustomizerControl() public method

* overridden
public registerCustomizerControl ( $wp_customize, $section, $priority = 1 )

setValue() public method

public setValue ( $value, $postID = null )

Property Details

$defaultSecondarySettings public_oe property

Default settings specific for this option. This is overridden by each option class
public array $defaultSecondarySettings
return array

$echo_wrapper public_oe property

public $echo_wrapper

$owner public_oe property

One of the TYPE_* constants above
public $owner

$settings public_oe property

public $settings

$type public_oe property

public $type