| Current File : /home/bwalansa/www/wp-content/plugins/the-events-calendar/src/Tribe/Settings.php |
<?php
// Don't load directly
if ( ! defined( 'ABSPATH' ) ) {
die( '-1' );
}
if ( ! class_exists( 'Tribe__Events__Settings' ) ) {
/**
* helper class that allows registration of settings
* this is a static class & uses the singleton design method
* instantiation takes place in Tribe__Events__Main
*
*/
class Tribe__Events__Settings {
/**
* singleton instance var
* @var stdClass
*/
public static $instance;
/**
* @var Tribe__Events__Admin__Live_Date_Preview
*/
public $live_date_preview;
/**
* the tabs that will appear in the settings page
* filtered on class construct
* @var array
*/
public $tabs;
/**
* All the tabs registered, not just the ones that will appear
* @var array
*/
public $allTabs;
/**
* multidimentional array of the fields that will be generated
* for the entire settings panel, tabs are represented in the array keys
* @var array
*/
public $fields;
/**
* the default tab for the settings panel
* this should be a tab ID
* @var string
*/
public $defaultTab;
/**
* the current tab being displayed
* @var string
*/
public $currentTab;
/**
* tabs that shouldn't show the save button
* @var array
*/
public $noSaveTabs;
/**
* the slug used in the admin to generate the settings page
* @var string
*/
public $adminSlug;
/**
* the menu name used for the settings page
* @var string
*/
public $menuName;
/**
* the required capability for the settings page
* @var string
*/
public $requiredCap;
/**
* errors that occur after a save operation
* @var mixed
*/
public $errors;
/**
* POST data before/after save
* @var mixed
*/
public $sent_data;
/**
* the $current_screen name corresponding to the admin page
* @var string
*/
public $admin_page;
/**
* true if a major error that prevents saving occurred
* @var bool
*/
public $major_error;
/**
* holds validated fields
* @var array
*/
public $validated;
/**
* Static Singleton Factory Method
*
* @return Tribe__Events__Settings
*/
public static function instance() {
if ( ! isset( self::$instance ) ) {
$className = __CLASS__;
self::$instance = new $className;
}
return self::$instance;
}
/**
* Class constructor
*
* @return void
*/
public function __construct() {
// set instance variables
$this->menuName = apply_filters( 'tribe_settings_menu_name', __( 'The Events Calendar', 'the-events-calendar' ) );
$this->requiredCap = apply_filters( 'tribe_settings_req_cap', 'manage_options' );
$this->adminSlug = apply_filters( 'tribe_settings_admin_slug', 'tribe-events-calendar' );
$this->errors = get_option( 'tribe_settings_errors', array() );
$this->major_error = get_option( 'tribe_settings_major_error', false );
$this->sent_data = get_option( 'tribe_settings_sent_data', array() );
$this->validated = array();
$this->defaultTab = null;
$this->currentTab = null;
// run actions & filters
add_action( 'admin_menu', array( $this, 'addPage' ) );
add_action( 'network_admin_menu', array( $this, 'addNetworkPage' ) );
add_action( 'admin_init', array( $this, 'initTabs' ) );
add_action( 'tribe_settings_below_tabs', array( $this, 'displayErrors' ) );
add_action( 'tribe_settings_below_tabs', array( $this, 'displaySuccess' ) );
add_action( 'shutdown', array( $this, 'deleteOptions' ) );
}
/**
* create the main option page
*
* @return void
*/
public function addPage() {
if ( ! is_multisite() || ( is_multisite() && '0' == Tribe__Events__Main::instance()->getNetworkOption( 'allSettingsTabsHidden', '0' ) ) ) {
$this->admin_page = add_submenu_page(
'edit.php?post_type=' . Tribe__Events__Main::POSTTYPE,
__( 'The Events Calendar Settings', 'the-events-calendar' ),
__( 'Settings', 'the-events-calendar' ),
$this->requiredCap,
$this->adminSlug,
array( $this, 'generatePage' )
);
}
}
/**
* create the network options page
*
* @return void
*/
public function addNetworkPage() {
$this->admin_page = add_submenu_page(
'settings.php', __( 'The Events Calendar Settings', 'the-events-calendar' ), __( 'Events Settings', 'the-events-calendar' ), $this->requiredCap, $this->adminSlug, array(
$this,
'generatePage',
)
);
}
/**
* init all the tabs
*
* @return void
*/
public function initTabs() {
if ( isset( $_GET['page'] ) && $_GET['page'] == $this->adminSlug ) {
// Load settings tab-specific helpers and enhancements
$this->live_date_preview = new Tribe__Events__Admin__Live_Date_Preview;
do_action( 'tribe_settings_do_tabs' ); // this is the hook to use to add new tabs
$this->tabs = (array) apply_filters( 'tribe_settings_tabs', array() );
$this->allTabs = (array) apply_filters( 'tribe_settings_all_tabs', array() );
$this->noSaveTabs = (array) apply_filters( 'tribe_settings_no_save_tabs', array() );
if ( is_network_admin() ) {
$this->defaultTab = apply_filters( 'tribe_settings_default_tab_network', 'network' );
$this->currentTab = apply_filters( 'tribe_settings_current_tab', ( isset( $_GET['tab'] ) && $_GET['tab'] ) ? esc_attr( $_GET['tab'] ) : $this->defaultTab );
$this->url = apply_filters(
'tribe_settings_url', add_query_arg(
array(
'page' => $this->adminSlug,
'tab' => $this->currentTab,
), network_admin_url( 'settings.php' )
)
);
}
if ( ! is_network_admin() ) {
$tabs_keys = array_keys( $this->tabs );
$this->defaultTab = in_array( apply_filters( 'tribe_settings_default_tab', 'general' ), $tabs_keys ) ? apply_filters( 'tribe_settings_default_tab', 'general' ) : $tabs_keys[0];
$this->currentTab = apply_filters( 'tribe_settings_current_tab', ( isset( $_GET['tab'] ) && $_GET['tab'] ) ? esc_attr( $_GET['tab'] ) : $this->defaultTab );
$this->url = apply_filters(
'tribe_settings_url', add_query_arg(
array(
'page' => $this->adminSlug,
'tab' => $this->currentTab,
), add_query_arg( array( 'post_type' => Tribe__Events__Main::POSTTYPE ), admin_url( 'edit.php' ) )
)
);
}
$this->fields_for_save = (array) apply_filters( 'tribe_settings_fields', array() );
do_action( 'tribe_settings_after_do_tabs' );
$this->fields = (array) apply_filters( 'tribe_settings_fields', array() );
$this->validate();
}
}
/**
* generate the main option page
* includes the view file
*
* @return void
*/
public function generatePage() {
$tec = Tribe__Events__Main::instance();
do_action( 'tribe_settings_top' );
echo '<div class="tribe_settings wrap">';
screen_icon();
echo '<h1>';
printf( __( '%s Settings', 'the-events-calendar' ), $this->menuName );
echo '</h1>';
do_action( 'tribe_settings_above_tabs' );
$this->generateTabs( $this->currentTab );
do_action( 'tribe_settings_below_tabs' );
do_action( 'tribe_settings_below_tabs_tab_' . $this->currentTab );
echo '<div class="tribe-settings-form form">';
do_action( 'tribe_settings_above_form_element' );
do_action( 'tribe_settings_above_form_element_tab_' . $this->currentTab );
echo apply_filters( 'tribe_settings_form_element_tab_' . $this->currentTab, '<form method="post">' );
do_action( 'tribe_settings_before_content' );
do_action( 'tribe_settings_before_content_tab_' . $this->currentTab );
do_action( 'tribe_settings_content_tab_' . $this->currentTab );
if ( ! has_action( 'tribe_settings_content_tab_' . $this->currentTab ) ) {
echo '<p>' . esc_html__( "You've requested a non-existent tab.", 'the-events-calendar' ) . '</p>';
}
do_action( 'tribe_settings_after_content_tab_' . $this->currentTab );
do_action( 'tribe_settings_after_content' );
if ( has_action( 'tribe_settings_content_tab_' . $this->currentTab ) && ! in_array( $this->currentTab, $this->noSaveTabs ) ) {
wp_nonce_field( 'saving', 'tribe-save-settings' );
echo '<div class="clear"></div>';
echo '<input type="hidden" name="current-settings-tab" id="current-settings-tab" value="' . esc_attr( $this->currentTab ) . '" />';
echo '<input id="tribeSaveSettings" class="button-primary" type="submit" name="tribeSaveSettings" value="' . esc_attr__( 'Save Changes', 'the-events-calendar' ) . '" />';
}
echo apply_filters( 'tribe_settings_closing_form_element', '</form>' );
do_action( 'tribe_settings_after_form_element' );
do_action( 'tribe_settings_after_form_element_tab_' . $this->currentTab );
echo '</div>';
do_action( 'tribe_settings_after_form_div' );
echo '</div>';
do_action( 'tribe_settings_bottom' );
}
/**
* generate the tabs in the settings screen
*
* @return void
*/
public function generateTabs() {
if ( is_array( $this->tabs ) && ! empty( $this->tabs ) ) {
echo '<h2 id="tribe-settings-tabs" class="nav-tab-wrapper">';
foreach ( $this->tabs as $tab => $name ) {
if ( ! is_network_admin() ) {
$url = '?post_type=' . Tribe__Events__Main::POSTTYPE . '&page=' . $this->adminSlug . '&tab=' . urlencode( $tab );
}
if ( is_network_admin() ) {
$url = '?page=' . $this->adminSlug . '&tab=' . urlencode( $tab );
}
$class = ( $tab == $this->currentTab ) ? ' nav-tab-active' : '';
echo '<a id="' . esc_attr( $tab ) . '" class="nav-tab' . esc_attr( $class ) . '" href="' . esc_url( $url ) . '">' . esc_html( $name ) . '</a>';
}
do_action( 'tribe_settings_after_tabs' );
echo '</h2>';
}
}
/**
* validate the settings
*
* @return void
*/
public function validate() {
do_action( 'tribe_settings_validate_before_checks' );
// check that the right POST && variables are set
if ( isset( $_POST['tribeSaveSettings'] ) && isset( $_POST['current-settings-tab'] ) ) {
// check permissions
if ( ! current_user_can( 'manage_options' ) ) {
$this->errors[] = __( "You don't have permission to do that.", 'the-events-calendar' );
$this->major_error = true;
}
// check the nonce
if ( ! wp_verify_nonce( $_POST['tribe-save-settings'], 'saving' ) ) {
$this->errors[] = __( 'The request was sent insecurely.', 'the-events-calendar' );
$this->major_error = true;
}
// check that the request originated from the current tab
if ( $_POST['current-settings-tab'] != $this->currentTab ) {
$this->errors[] = __( "The request wasn't sent from this tab.", 'the-events-calendar' );
$this->major_error = true;
}
// bail if we have errors
if ( count( $this->errors ) ) {
remove_action( 'shutdown', array( $this, 'deleteOptions' ) );
add_option( 'tribe_settings_errors', $this->errors );
add_option( 'tribe_settings_major_error', $this->major_error );
wp_redirect( $this->url );
exit;
}
// some hooks
do_action( 'tribe_settings_validate' );
do_action( 'tribe_settings_validate_tab_' . $this->currentTab );
// set the current tab and current fields
$tab = $this->currentTab;
$fields = $this->fields_for_save[ $tab ];
if ( is_array( $fields ) ) {
// loop through the fields and validate them
foreach ( $fields as $field_id => $field ) {
// get the value
$value = ( isset( $_POST[ $field_id ] ) ) ? $_POST[ $field_id ] : null;
$value = apply_filters( 'tribe_settings_validate_field_value', $value, $field_id, $field );
// make sure it has validation set up for it, else do nothing
if ( ( ! isset( $field['conditional'] ) || $field['conditional'] ) && ( ! empty( $field['validation_type'] ) || ! empty( $field['validation_callback'] ) ) ) {
// some hooks
do_action( 'tribe_settings_validate_field', $field_id, $value, $field );
do_action( 'tribe_settings_validate_field_' . $field_id, $value, $field );
// validate this sucka
$validate = new Tribe__Events__Validate( $field_id, $field, $value );
if ( isset( $validate->result->error ) ) {
// uh oh; validation failed
$this->errors[ $field_id ] = $validate->result->error;
} elseif ( $validate->result->valid ) {
// validation passed
$this->validated[ $field_id ] = new stdClass;
$this->validated[ $field_id ]->field = $validate->field;
$this->validated[ $field_id ]->value = $validate->value;
}
}
}
// run the saving method
$this->save();
}
}
}
/**
* save the settings
*
* @return void
*/
public function save() {
// some hooks
do_action( 'tribe_settings_save' );
do_action( 'tribe_settings_save_tab_' . $this->currentTab );
// we'll need this later
$parent_options = array();
/**
* loop through each validated option and either
* save it as is or figure out its parent option ID
* (in that case, it's a serialized option array and
* will be saved in the next loop)
*/
if ( ! empty( $this->validated ) ) {
foreach ( $this->validated as $field_id => $validated_field ) {
// get the value and filter it
$value = $validated_field->value;
$value = apply_filters( 'tribe_settings_save_field_value', $value, $field_id, $validated_field );
// figure out the parent option [could be set to false] and filter it
if ( is_network_admin() ) {
$parent_option = ( isset( $validated_field->field['parent_option'] ) ) ? $validated_field->field['parent_option'] : Tribe__Events__Main::OPTIONNAMENETWORK;
}
if ( ! is_network_admin() ) {
$parent_option = ( isset( $validated_field->field['parent_option'] ) ) ? $validated_field->field['parent_option'] : Tribe__Events__Main::OPTIONNAME;
}
$parent_option = apply_filters( 'tribe_settings_save_field_parent_option', $parent_option, $field_id );
$network_option = isset( $validated_field->field['network_option'] ) ? (bool) $validated_field->field['network_option'] : false;
// some hooks
do_action( 'tribe_settings_save_field', $field_id, $value, $validated_field );
do_action( 'tribe_settings_save_field_' . $field_id, $value, $validated_field );
if ( ! $parent_option ) {
if ( $network_option || is_network_admin() ) {
update_site_option( $field_id, $value );
} else {
update_option( $field_id, $value );
}
} else {
// set the parent option
$parent_options[ $parent_option ][ $field_id ] = $value;
}
}
}
/**
* loop through parent option arrays
* and save them
* NOTE: in the case of the main option Tribe Options,
* this will save using the Tribe__Events__Main:setOptions method.
*/
foreach ( $parent_options as $option_id => $new_options ) {
// get the old options
if ( $option_id == Tribe__Events__Main::OPTIONNAME ) {
$old_options = (array) get_option( $option_id );
} else {
$old_options = (array) get_site_option( $option_id );
}
// set the options by parsing old + new and filter that
$options = apply_filters( 'tribe_settings_save_option_array', wp_parse_args( $new_options, $old_options ), $option_id );
if ( $option_id == Tribe__Events__Main::OPTIONNAME ) {
// save using the Tribe__Events__Main method
Tribe__Events__Main::instance()->setOptions( $options );
} elseif ( $option_id == Tribe__Events__Main::OPTIONNAMENETWORK ) {
Tribe__Events__Main::instance()->setNetworkOptions( $options );
} else {
// save using regular WP method
if ( is_network_admin() ) {
update_site_option( $option_id, $options );
} else {
update_option( $option_id, $options );
}
}
}
do_action( 'tribe_settings_after_save' );
do_action( 'tribe_settings_after_save_' . $this->currentTab );
remove_action( 'shutdown', array( $this, 'deleteOptions' ) );
add_option( 'tribe_settings_sent_data', $_POST );
add_option( 'tribe_settings_errors', $this->errors );
add_option( 'tribe_settings_major_error', $this->major_error );
wp_redirect( esc_url_raw( add_query_arg( array( 'saved' => true ), $this->url ) ) );
exit;
}
/**
* display errors, if any, after saving
*
* @return void
*/
public function displayErrors() {
// fetch the errors and filter them
$errors = (array) apply_filters( 'tribe_settings_display_errors', $this->errors );
$count = apply_filters( 'tribe_settings_count_errors', count( $errors ) );
if ( apply_filters( 'tribe_settings_display_errors_or_not', ( $count > 0 ) ) ) {
// output a message if we have errors
$output = '<div id="message" class="error"><p><strong>';
$output .= __( 'Your form had the following errors:', 'the-events-calendar' );
$output .= '</strong></p><ul class="tribe-errors-list">';
// loop through each error
foreach ( $errors as $error ) {
$output .= '<li>' . (string) $error . '</li>';
}
if ( count( $errors ) ) {
$message = ( isset( $this->major_error ) && $this->major_error ) ? __( 'None of your settings were saved. Please try again.' ) : _n( 'The above setting was not saved. Other settings were successfully saved.', 'The above settings were not saved. Other settings were successfully saved.', $count, 'the-events-calendar' );
}
$output .= '</ul><p>' . $message . '</p></div>';
// final output, filtered of course
echo apply_filters( 'tribe_settings_error_message', $output );
}
}
/**
* display success message after saving
*
* @return void
*/
public function displaySuccess() {
$errors = (array) apply_filters( 'tribe_settings_display_errors', $this->errors );
$count = apply_filters( 'tribe_settings_count_errors', count( $errors ) );
// are we coming from the saving place?
if ( isset( $_GET['saved'] ) && ! apply_filters( 'tribe_settings_display_errors_or_not', ( $count > 0 ) ) ) {
// output the filtered message
$message = __( 'Settings saved.', 'the-events-calendar' );
$output = '<div id="message" class="updated"><p><strong>' . $message . '</strong></p></div>';
echo apply_filters( 'tribe_settings_success_message', $output, $this->currentTab );
}
}
/**
* delete temporary options
*
* @return void
*/
public function deleteOptions() {
delete_option( 'tribe_settings_errors' );
delete_option( 'tribe_settings_major_error' );
delete_option( 'tribe_settings_sent_data' );
}
/**
* Returns the main admin settings URL.
*
* @return string
*/
public function get_url() {
return apply_filters( 'tribe_settings_url', add_query_arg( array(
'post_type' => Tribe__Events__Main::POSTTYPE,
'page' => $this->adminSlug,
), admin_url( 'edit.php' )
) );
}
} // end class
} // endif class_exists