'generate', // If 'generate', Titan will try and generate a cacheable CSS file (or inline if it can't).
// If 'inline', CSS will be printed out in the head tag,
// If false, CSS will not be generated nor printed
'tracking' => false, // TODO: Turn to true, when code is finalized for 1.6
);
public static function getInstance( $optionNamespace ) {
// Clean namespace
$optionNamespace = str_replace( ' ', '-', trim( strtolower( $optionNamespace ) ) );
foreach ( self::$instances as $instance ) {
if ( $instance->optionNamespace == $optionNamespace ) {
return $instance;
}
}
$newInstance = new TitanFramework( $optionNamespace );
self::$instances[] = $newInstance;
return $newInstance;
}
function __construct( $optionNamespace ) {
// Clean namespace
$optionNamespace = str_replace( ' ', '-', trim( strtolower( $optionNamespace ) ) );
$this->optionNamespace = $optionNamespace;
$this->settings = $this->defaultSettings;
do_action( 'tf_init', $this );
do_action( 'tf_init_' . $this->optionNamespace, $this );
$this->cssInstance = new TitanFrameworkCSS( $this );
$this->trackerInstance = new TitanFrameworkTracker( $this );
add_action( 'after_setup_theme', array( $this, 'getAllOptions' ), 7 );
add_action( 'init', array( $this, 'updateOptionDBListing' ), 12 );
if ( is_admin() ) {
add_action( 'init', array( $this, 'updateThemeModListing' ), 12 );
add_action( 'init', array( $this, 'updateMetaDbListing' ), 12 );
add_action( 'tf_create_option_' . $this->optionNamespace, array( $this, "verifyUniqueIDs" ) );
}
add_action( 'admin_enqueue_scripts', array( $this, "loadAdminScripts" ) );
add_action( 'wp_enqueue_scripts', array( $this, "loadFrontEndScripts" ) );
add_action( 'tf_create_option_' . $this->optionNamespace, array( $this, "rememberGoogleFonts" ) );
add_action( 'tf_create_option_' . $this->optionNamespace, array( $this, "rememberAllOptions" ) );
add_filter( 'tf_create_option_continue_' . $this->optionNamespace, array( $this, "removeChildThemeOptions" ), 10, 2 );
}
/**
* Checks all the ids and shows a warning when multiple occurances of an id is found.
* This is to ensure that there won't be any option conflicts
*
* @param TitanFrameworkOption $option The object just created
* @return void
* @since 1.1.1
*/
public function verifyUniqueIDs( $option ) {
if ( empty( $option->settings['id'] ) ) {
return;
}
// During initialization don't display ID errors
if ( self::$initializing ) {
return;
}
if ( in_array( $option->settings['id'], $this->allOptionIDs ) ) {
self::displayFrameworkError(
sprintf( __( 'All option IDs must be unique. The id %s has been used multiple times.', TF_I18NDOMAIN ),
'' . $option->settings['id'] . ''
)
);
} else {
$this->allOptionIDs[] = $option->settings['id'];
}
}
public function rememberGoogleFonts( $option ) {
if ( is_a( $option, 'TitanFrameworkOptionSelectGooglefont' ) ) {
if ( $option->settings['enqueue'] ) {
$this->googleFontsOptions[] = $option;
}
}
}
/**
* Action hook on tf_create_option to remember all the options, used to
* ensure that our serialized option does not get cluttered with unused
* options
*
* @access public
* @param TitanFrameworkOption $option The option that was just created
* @return void
* @since 1.2.1
*/
public function rememberAllOptions( $option ) {
if ( ! empty( $option->settings['id'] ) ) {
$this->optionsUsed[ $option->settings['id'] ] = $option;
}
}
public function loadFrontEndScripts() {
foreach ( $this->googleFontsOptions as $googleFontOption ) {
$font = $this->getOption( $googleFontOption->settings['id'] );
if ( empty( $font ) ) {
continue;
}
wp_enqueue_style(
'tf-google-webfont-' . strtolower( str_replace( ' ', '-', $font['name'] ) ),
TitanFrameworkOptionSelectGooglefont::formScript( $font )
);
}
}
public function loadAdminScripts( $hook ) {
// Get all options panel IDs
$panel_ids = array();
foreach ( $this->adminPanels as $admin_panel ) {
$panel_ids[] = $admin_panel->panelID;
}
// Only enqueue scripts if we're on a Titan options page
if ( in_array( $hook, $panel_ids ) || count($this->metaBoxes) ) {
wp_enqueue_media();
wp_enqueue_script( 'tf-serialize', TitanFramework::getURL( 'js/serialize.js', __FILE__ ) );
wp_enqueue_script( 'tf-styling', TitanFramework::getURL( 'js/admin-styling.js', __FILE__ ) );
wp_enqueue_style( 'tf-admin-styles', TitanFramework::getURL( 'css/admin-styles.css', __FILE__ ) );
}
}
public function getAllOptions() {
if ( empty( $this->allOptions ) ) {
$this->allOptions = array();
}
if ( empty( $this->allOptions[$this->optionNamespace] ) ) {
$this->allOptions[$this->optionNamespace] = array();
} else {
return $this->allOptions[$this->optionNamespace];
}
// Check if we have options saved already
$currentOptions = get_option( $this->optionNamespace . '_options' );
// First time run, this action hook can be used to trigger something
if ( $currentOptions === false ) {
do_action( 'tf_init_no_options_' . $this->optionNamespace );
}
// Put all the available options in our global variable for future checking
if ( ! empty( $currentOptions ) && ! count( $this->allOptions[$this->optionNamespace] ) ) {
$this->allOptions[$this->optionNamespace] = unserialize( $currentOptions );
}
return $this->allOptions[$this->optionNamespace];
}
public function saveOptions() {
update_option( $this->optionNamespace . '_options', serialize( $this->allOptions[$this->optionNamespace] ) );
do_action( 'tf_save_options_' . $this->optionNamespace );
return $this->allOptions[$this->optionNamespace];
}
/*
* Cleans up the meta options in the database for our namespace.
* Remove unused stuff and add in the default values for new stuff
*/
public function updateMetaDbListing() {
// TODO
}
/*
* Cleans up the theme mods in the database for our namespace.
* Remove unused stuff and add in the default values for new stuff
*/
public function updateThemeModListing() {
$allThemeMods = get_theme_mods();
// For fresh installs there won't be any theme mods yet
if ( $allThemeMods === false ) {
$allThemeMods = array();
}
$allThemeModKeys = array_fill_keys( array_keys( $allThemeMods ), null );
// Check existing theme mods
foreach ( $this->themeCustomizerSections as $section ) {
foreach ( $section->options as $option ) {
if ( ! isset( $allThemeMods[$option->getID()] ) ) {
set_theme_mod( $option->getID(), $option->settings['default'] );
}
unset( $allThemeModKeys[$option->getID()] );
}
}
// Remove all unused theme mods
if ( count( $allThemeModKeys ) ) {
foreach ( $allThemeModKeys as $optionName => $dummy ) {
// Only remove theme mods that the framework created
if ( stripos( $optionName, $this->optionNamespace . '_' ) === 0 ) {
remove_theme_mod( $optionName );
}
}
}
}
/*
* Cleans up the options present in the database for our namespace.
* Remove unused stuff and add in the default values for new stuff
*/
public function updateOptionDBListing() {
// Get also a list of all option keys
$allOptionKeys = array();
if ( ! empty( $this->allOptions[$this->optionNamespace] ) ) {
$allOptionKeys = array_fill_keys( array_keys( $this->allOptions[ $this->optionNamespace ] ), null );
}
// Check whether options have changed / added
$changed = false;
foreach ( $this->adminPanels as $panel ) {
// Check existing options
foreach ( $panel->options as $option ) {
if ( empty( $option->settings['id'] ) ) {
continue;
}
if ( ! isset( $this->allOptions[$this->optionNamespace][$option->settings['id']] ) ) {
$this->allOptions[$this->optionNamespace][$option->settings['id']] = $option->settings['default'];
$changed = true;
}
unset( $allOptionKeys[$option->settings['id']] );
// Clean the value for retrieval
$this->allOptions[$this->optionNamespace][$option->settings['id']] =
$option->cleanValueForGetting( $this->allOptions[$this->optionNamespace][$option->settings['id']] );
}
// Check existing options
foreach ( $panel->tabs as $tab ) {
foreach ( $tab->options as $option ) {
if ( empty( $option->settings['id'] ) ) {
continue;
}
if ( ! isset( $this->allOptions[$this->optionNamespace][$option->settings['id']] ) ) {
$this->allOptions[$this->optionNamespace][$option->settings['id']] = $option->settings['default'];
$changed = true;
}
unset( $allOptionKeys[$option->settings['id']] );
// Clean the value for retrieval
$this->allOptions[$this->optionNamespace][$option->settings['id']] =
$option->cleanValueForGetting( $this->allOptions[$this->optionNamespace][$option->settings['id']] );
}
}
}
// Remove all unused keys
if ( count( $allOptionKeys ) ) {
foreach ( $allOptionKeys as $optionName => $dummy ) {
unset( $this->allOptions[$this->optionNamespace][$optionName] );
}
$changed = true;
}
// New options have been added, save the default values
if ( $changed ) {
update_option( $this->optionNamespace . '_options', serialize( $this->allOptions[$this->optionNamespace] ) );
}
}
public function createAdminPanel( $settings ) {
$obj = new TitanFrameworkAdminPanel( $settings, $this );
$this->adminPanels[] = $obj;
do_action( 'tf_admin_panel_created_' . $this->optionNamespace, $obj );
return $obj;
}
public function createMetaBox( $settings ) {
$obj = new TitanFrameworkMetaBox( $settings, $this );
$this->metaBoxes[] = $obj;
do_action( 'tf_meta_box_created_' . $this->optionNamespace, $obj );
return $obj;
}
public function createThemeCustomizerSection( $settings ) {
$obj = new TitanFrameworkThemeCustomizerSection( $settings, $this );
$this->themeCustomizerSections[] = $obj;
do_action( 'tf_theme_customizer_created_' . $this->optionNamespace, $obj );
return $obj;
}
/**
* A function available ONLY to CHILD themes to stop the creation of options
* created by the PARENT theme.
*
* @access public
* @param string $optionName The id of the option to remove / stop from being created
* @return void
* @since 1.2.1
*/
public function removeOption( $optionName ) {
$this->optionsToRemove[] = $optionName;
}
/**
* Hook to the tf_create_option_continue filter, to check whether or not to continue
* adding an option (if the option id was used in $titan->removeOption).
*
* @access public
* @param boolean $continueCreating If true, the option will be created
* @param array $optionSettings The settings for the option to be created
* @return boolean If true, continue with creating the option. False to stop it.
* @since 1.2.1
*/
public function removeChildThemeOptions( $continueCreating, $optionSettings ) {
if ( ! count( $this->optionsToRemove ) ) {
return $continueCreating;
}
if ( empty( $optionSettings['id'] ) ) {
return $continueCreating;
}
if ( in_array( $optionSettings['id'], $this->optionsToRemove ) ) {
return false;
}
return $continueCreating;
}
public function getOption( $optionName, $postID = null ) {
$value = null;
// Get the option value
if ( array_key_exists( $optionName, $this->optionsUsed ) ) {
$option = $this->optionsUsed[ $optionName ];
// Admin page options
if ( $option->type == TitanFrameworkOption::TYPE_ADMIN ) {
// this is blank if called too early. getOption should be called inside a hook or template
if ( ! is_array( $this->allOptions ) ) {
self::displayFrameworkError( sprintf( __( 'Wrong usage of %s, this should be called inside a hook or from within a theme file.', TF_I18NDOMAIN ), 'getOption' ) );
return null;
}
$value = $this->allOptions[ $this->optionNamespace ][ $optionName ];
// Meta box options
} else if ( $option->type == TitanFrameworkOption::TYPE_META ) {
// If no $postID is given, try and get it if we are in a loop
if ( empty( $postID ) && ! is_admin() ) {
if ( get_post() != null ) {
$postID = get_the_ID();
}
}
$value = get_post_meta( $postID, $this->optionNamespace . '_' . $optionName, true );
// Theme customizer options
} else if ( $option->type == TitanFrameworkOption::TYPE_CUSTOMIZER ) {
$value = get_theme_mod( $this->optionNamespace . '_' . $optionName );
}
}
// Apply cleaning method for the value (for serialized data, slashes, etc)
if ( $value !== null ) {
if ( ! empty( $this->optionsUsed[$optionName] ) ) {
$value = $this->optionsUsed[$optionName]->cleanValueForGetting( $value );
}
}
return $value;
}
public function setOption( $optionName, $value, $postID = null ) {
// Apply cleaning method for the value (for serialized data, slashes, etc)
if ( ! empty( $this->optionsUsed[$optionName] ) ) {
$value = $this->optionsUsed[$optionName]->cleanValueForSaving( $value );
}
if ( empty( $postID ) ) {
// option
if ( ! is_array( $this->allOptions ) ) {
// this is blank if called too early. getOption should be called inside a hook or template
self::displayFrameworkError( sprintf( __( 'Wrong usage of %s, this should be called inside a hook or from within a theme file.', TF_I18NDOMAIN ), 'setOption' ) );
return '';
}
if ( array_key_exists( $optionName, $this->allOptions[$this->optionNamespace] ) ) {
$this->allOptions[$this->optionNamespace][$optionName] = $value;
} else {
// customizer
set_theme_mod( $this->optionNamespace . '_' . $optionName, $value );
}
} else {
// meta
return update_post_meta( $postID, $this->optionNamespace . '_' . $optionName, $value );
}
return $value;
}
public function createWidgetArea( $settings ) {
$obj = new TitanFrameworkWidgetArea( $settings, $this );
$this->widgetAreas[] = $obj;
return $obj;
}
public function createCSS( $CSSString ) {
$this->cssInstance->addCSS( $CSSString );
}
public function createShortcode( $settings ) {
do_action( 'tf_create_shortcode', $settings );
do_action( 'tf_create_shortcode_' . $this->optionNamespace, $settings );
}
public static function displayFrameworkError( $message, $errorObject = null ) {
// Clean up the debug object for display. e.g. If this is a setting, we can have lots of blank values
if ( is_array( $errorObject ) ) {
foreach ( $errorObject as $key => $val ) {
if ( $val === '' ) {
unset( $errorObject[$key] );
}
}
}
// Display an error message
?>
settings[ $setting ];
$this->settings[ $setting ] = $value;
do_action( 'tf_setting_' . $setting . '_changed_' . $this->optionNamespace, $value, $oldValue );
}
/**
* Gets the CSS generated
*
* @return string The generated CSS
* @since 1.6
*/
public function generateCSS() {
return $this->cssInstance->generateCSS();
}
}