<?php
/**
* WP-Simple-Settings-Framework
*
* Copyright (c) 2012 Matt Gates.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* * Neither the names of the copyright holders nor the names of the
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* @subpackage WP-Simple-Settings-Framework
* @copyright 2012 Matt Gates.
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @link http://mgates.me
* @version 1.1
* @author Matt Gates <info@mgates.me>
* @package WordPress
*/
if ( !class_exists( 'SF_Settings_API' ) ) {
class WooCommerce_Quick_Donation_Settings_API
{
private $data = array();
/**
* Init
*
* @param string $id
* @param string $title
* @param string $menu (optional)
* @param string $file
*/
public function __construct( $id, $title, $page_title, $menu = '', $file )
{
$this->assets_url = trailingslashit( plugins_url( 'assets/', dirname( __FILE__ ) ) );
$this->id = $id;
$this->title = $title;
$this->page_title = $page_title;
$this->menu = empty( $menu ) ? 'plugins.php' : $menu;
$this->file = $file;
$this->includes();
$this->actions();
}
// ==================================================================
//
// Getter and setter.
//
// ------------------------------------------------------------------
/**
* Setter
*
* @param unknown $name
* @param unknown $value
*/
public function __set( $name, $value )
{
if ( isset ( $this->data[ $name ] ) && is_array( $this->data[ $name ] ) ) {
$this->data[ $name ] = array_merge( $this->data[ $name ], $value );
} else {
$this->data[ $name ] = $value;
}
}
/**
* Getter
*
* @param unknown $name
*
* @return unknown
*/
public function __get( $name )
{
if ( array_key_exists( $name, $this->data ) ) {
return $this->data[ $name ];
}
return null;
}
/**
* Isset
*
* @param unknown $name
*
* @return unknown
*/
public function __isset( $name )
{
return isset( $this->data[ $name ] );
}
/**
* Unset
*
* @param unknown $name
*/
public function __unset( $name )
{
unset( $this->data[ $name ] );
}
/**
* Add a "Settings" link to the plugins.php page
*
* @param array $links
* @param array $file
*
* @return array
*/
public function add_settings_link( $links, $file )
{
$this_plugin = plugin_basename( $this->file );
$page = strpos( $this->menu, '.php' ) ? $this->menu : 'admin.php';
if ( $file == $this_plugin ) {
$settings_link = '<a href="' . $page . '?page=' . $this->id . '">' . __( 'Settings', 'geczy' ) . '</a>';
array_unshift( $links, $settings_link );
}
return $links;
}
// ==================================================================
//
// Begin initialization.
//
// ------------------------------------------------------------------
/**
* Core files
*/
private function includes()
{
require_once dirname( __FILE__ ) . '/class-sanitize.php';
require_once dirname( __FILE__ ) . '/class-format-options.php';
new WooCommerce_Quick_Donation_Sanitize;
}
/**
* Hooks
*/
private function actions()
{
add_action( 'admin_enqueue_scripts', array( &$this, 'admin_enqueue_scripts' ) );
add_action( 'admin_init', array( &$this, 'register_options' ) );
add_action( 'admin_menu', array( &$this, 'create_menu' ) );
add_filter( 'plugin_action_links', array( &$this, 'add_settings_link' ), 10, 2 );
}
/**
* Admin scripts and styles
*/
public function admin_enqueue_scripts()
{
wp_register_script( 'bootstrap-tooltip', WC_QD_JS. 'bootstrap-tooltip.js', array( 'jquery' ), '1.0' );
wp_register_script( 'select2', WC_QD_JS. 'select2/select2.min.js', array( 'jquery' ), '3.5.2' );
wp_register_script( 'sf-scripts', WC_QD_JS. 'sf-jquery.js', array( 'jquery' ), '1.0' );
wp_register_style( 'select2', WC_QD_JS. 'select2/select2.css' );
wp_register_style( 'sf-styles', WC_QD_CSS. 'sf-styles.css' );
}
/**
* Admin scripts and styles
*/
public function admin_print_scripts()
{
global $wp_version;
//Check wp version and load appropriate scripts for colorpicker.
if ( 3.5 <= $wp_version ) {
wp_enqueue_style( 'wp-color-picker' );
wp_enqueue_script( 'wp-color-picker' );
} else {
wp_enqueue_style( 'farbtastic' );
wp_enqueue_script( 'farbtastic' );
}
wp_enqueue_script( 'bootstrap-tooltip' );
wp_enqueue_script( 'select2' );
wp_enqueue_script( 'sf-scripts' );
wp_enqueue_style( 'wp-color-picker' );
wp_enqueue_style( 'select2' );
wp_enqueue_style( 'sf-styles' );
}
/**
* Register setting
*/
public function register_options()
{
register_setting( $this->id . '_options_nonce', $this->id . '_options', array( &$this, 'validate_options' ) );
}
/**
* Create menu
*/
public function create_menu()
{
$page = add_submenu_page( $this->menu, $this->title, $this->title, apply_filters( $this->id . '_manage_options', 'manage_options' ), $this->id, array( &$this, 'init_settings_page' ) );
add_action( 'admin_print_scripts-' . $page, array( &$this, 'admin_print_scripts' ) );
}
/**
* Parse options into tabbed organization
*
* @return array
*/
private function parse_options()
{
$options = $this->options;
foreach ( $options as $option ) {
if ( $option[ 'type' ] == 'heading' ) {
$tab_name = sanitize_title( $option[ 'name' ] );
$this->tab_headers = array( $tab_name => $option[ 'name' ] );
continue;
}
$option[ 'tab' ] = $tab_name;
$tabs[ $tab_name ][ ] = $option;
}
$this->tabs = $tabs;
return $tabs;
}
/**
* Load the options array from a file
*
* @param string $option_file
*/
public function load_options( $option_file )
{
if ( !empty( $this->options ) ) return;
if ( file_exists( $option_file ) ) {
require $option_file;
$this->options = apply_filters( $this->id . '_options', $options );
$this->parse_options();
$this->current_options = $this->get_current_options();
/* If the option has no saved data, load the defaults. */
/* @TODO: Can prob add this to the activation hook. */
$this->set_defaults( $this->current_options );
} else {
wp_die( __( 'Could not load settings at: ', 'geczy' ) . '<br/><code>' . $option_file . '</code>', __( 'Error - WP Settings Framework', 'geczy' ) );
}
}
/**
*
*
* @return unknown
*/
public function get_current_options()
{
if ( !empty( $this->current_options ) )
return $this->current_options;
$options = get_option( $this->id . '_options' );
if ( $options ) {
$options = array_map( 'maybe_unserialize', $options );
}
return $options;
}
/**
* Sanitize and validate post fields
*
* @param unknown $input
*
* @return unknown
*/
public function validate_options( $input )
{
if ( !isset( $_POST[ 'update' ] ) )
return $this->get_defaults();
$clean = $this->current_options;
$tabname = $_POST[ 'currentTab' ];
foreach ( $this->tabs[ $tabname ] as $option ) :
if ( !isset( $option[ 'id' ] ) )
continue;
if ( !isset( $option[ 'type' ] ) )
continue;
if ( $option[ 'type' ] == 'select' ) {
$option[ 'options' ] = apply_filters( $this->id . '_select_options', $option[ 'options' ], $option );
}
$id = sanitize_text_field( strtolower( $option[ 'id' ] ) );
// Set checkbox to false if it wasn't sent in the $_POST
if ( 'checkbox' == $option[ 'type' ] && !isset( $input[ $id ] ) )
$input[ $id ] = 0;
// For a value to be submitted to database it must pass through a sanitization filter
if ( has_filter( 'geczy_sanitize_' . $option[ 'type' ] ) ) {
$clean[ $id ] = apply_filters( 'geczy_sanitize_' . $option[ 'type' ], $input[ $id ], $option );
}
endforeach;
do_action( $this->id . '_options_updated', $clean, $tabname );
add_settings_error( $this->id, 'save_options', __( 'Settings saved.', 'geczy' ), 'updated' );
return apply_filters( $this->id . '_options_on_update', $clean, $tabname );
}
/**
* Create default options
*
* @param unknown $current_options (optional)
*/
private function set_defaults( $current_options = array() )
{
$options = $this->get_defaults( $current_options );
if ( $options ) {
update_option( $this->id . '_options', $options );
}
}
/**
* Retrieve default options
*
* @param unknown $currents (optional)
*
* @return array
*/
private function get_defaults( $currents = array() )
{
$output = array();
$config = $this->options;
$flag = false;
if ( $currents ) {
foreach ( $config as $value ) {
if ( !isset( $value[ 'id' ] ) || !isset( $value[ 'std' ] ) || !isset( $value[ 'type' ] ) )
continue;
if ( !isset( $currents[ $value[ 'id' ] ] ) ) {
$flag = true;
}
}
}
foreach ( $config as $option ) {
if ( !isset( $option[ 'id' ] ) || !isset( $option[ 'std' ] ) || !isset( $option[ 'type' ] ) )
continue;
if ( $currents && isset( $currents[ $option[ 'id' ] ] ) ) {
$output[ $option[ 'id' ] ] = $currents[ $option[ 'id' ] ];
} else if ( has_filter( 'geczy_sanitize_' . $option[ 'type' ] ) ) {
$output[ $option[ 'id' ] ] = apply_filters( 'geczy_sanitize_' . $option[ 'type' ], $option[ 'std' ], $option );
}
}
if ( $currents ) {
$output = array_merge( $currents, $output );
}
return !$flag && $currents ? array() : $output;
}
/**
* HTML header
*/
private function template_header()
{
?>
<div class="wrap">
<?php if(! empty($this->page_title)){ ?>
<?php screen_icon(); ?><h2><?php echo $this->page_title; ?></h2>
<?php } ?>
<h2 class="nav-tab-wrapper">
<?php echo $this->display_tabs(); ?>
</h2><?php
if ( !empty ( $_REQUEST[ 'settings-updated' ] ) )
settings_errors();
}
/**
* HTML body
*
* @return unknown
*/
private function template_body()
{
if ( empty( $this->options ) ) return false;
$options = $this->options;
$tabs = $this->get_tabs();
$tabname = !empty ( $_GET[ 'tab' ] ) ? $_GET[ 'tab' ] : $tabs[ 0 ][ 'slug' ];
$options = apply_filters( $this->id . '_options_tab-' . $tabname, $this->tabs[ $tabname ] ); ?>
<form method="post" action="options.php">
<?php settings_fields( $this->id . '_options_nonce' ); ?>
<table class="form-table">
<?php
foreach ( $options as $value ) :
$this->settings_options_format( $value );
endforeach;
do_action( $this->id . '_options_tab-' . $tabname );
?>
</table>
<p class="submit">
<input type="hidden" name="currentTab" value="<?php echo $tabname; ?>">
<input type="submit" name="update" class="button-primary"
value="<?php echo sprintf( __( 'Save %s changes', 'geczy' ), $this->tab_headers[ $tabname ] ); ?>"/>
</p>
</form> <?php
}
/**
* HTML footer
*/
private function template_footer()
{
echo '</div>';
}
/**
* Create the settings page
*/
public function init_settings_page()
{
$this->template_header();
$this->template_body();
$this->template_footer();
}
/**
* Retrieve tabs
*
* @return array
*/
private function get_tabs()
{
$tabs = array();
foreach ( $this->options as $option ) {
if ( $option[ 'type' ] != 'heading' )
continue;
$option[ 'slug' ] = sanitize_title( $option[ 'name' ] );
unset( $option[ 'type' ] );
$tabs[ ] = $option;
}
return $tabs;
}
/**
* Heading for navigation
*
* @return string
*/
private function display_tabs()
{
$tabs = $this->get_tabs();
$tabname = !empty ( $_GET[ 'tab' ] ) ? $_GET[ 'tab' ] : $tabs[ 0 ][ 'slug' ];
$menu = '';
foreach ( $tabs as $tab ) {
$class = $tabname == $tab[ 'slug' ] ? 'nav-tab-active' : '';
$fields = array(
'page' => $this->id,
'tab' => $tab[ 'slug' ],
);
$query = http_build_query( array_merge( $_GET, $fields ) );
$menu .= sprintf( '<a id="%s-tab" class="nav-tab %s" title="%s" href="?%s">%s</a>', $tab[ 'slug' ], $class, $tab[ 'name' ], $query, esc_html( $tab[ 'name' ] ) );
}
return $menu;
}
/**
* Update an option
*
* @param string $name
* @param string $value
*
* @return bool
*/
public function update_option( $name, $value )
{
// Overwrite the key/value pair
$this->current_options = array( $name => $value ) + (array) $this->current_options;
return update_option( $this->id . '_options', $this->current_options );
}
/**
* Get an option
*
* @param string $name
* @param string $default (optional)
*
* @return bool
*/
public function get_option( $name, $default = false )
{
return isset( $this->current_options[ $name ] ) ? maybe_unserialize( $this->current_options[ $name ] ) : $default;
}
public function settings_options_format( $setting )
{
if ( empty( $setting ) ) return false;
$defaults = apply_filters( $this->id . '_options_defaults', array(
'name' => '',
'desc' => '',
'placeholder' => '',
'class' => '',
'tip' => '',
'id' => '',
'css' => '',
'type' => 'text',
'std' => '',
'select2' => false,
'multiple' => false,
'options' => array(),
'restrict' => array(),
'settings' => array()
) );
// Each to it's own variable for slim-ness' sakes.
$setting = shortcode_atts( $defaults, $setting );
$restrict_defaults = array(
'min' => 0,
'max' => '',
'step' => 'any',
);
$setting[ 'restrict' ] = shortcode_atts( $restrict_defaults, $setting[ 'restrict' ] );
$setting[ 'value' ] = $this->get_option( $setting[ 'id' ] );
$setting[ 'value' ] = $setting[ 'value' ] !== false ? maybe_unserialize( $setting[ 'value' ] ) : false;
$setting[ 'value' ] = $this->sanitize_value( $setting[ 'value' ], $setting );
$setting[ 'title' ] = $setting[ 'name' ];
$setting[ 'name' ] = $this->id . "_options[{$setting['id']}]";
$setting[ 'grouped' ] = !$setting[ 'title' ] ? ' style="padding-top:0px;"' : '';
$setting[ 'tip' ] = $this->get_formatted_tip( $setting[ 'tip' ] );
$header_types = apply_filters( $this->id . '_options_header_types', array( 'heading', 'title' ) );
extract( $setting );
$description = $desc && !$grouped && $type != 'checkbox'
? '<br /><small>' . $desc . '</small>'
: '<label for="' . $id . '"> ' . $desc . '</label>';
$description = ( ( in_array( $type, $header_types ) || $type == 'radio' ) && !empty( $desc ) )
? '<p>' . $desc . '</p>'
: $description;
?>
<?php if ( !in_array( $type, $header_types ) ) : ?>
<!-- Header of the option. -->
<tr valign="top">
<th scope="row"<?php echo $grouped; ?>>
<?php echo $tip; ?>
<?php if ( !$grouped ) : ?>
<label for="<?php echo $name; ?>" class="description"><?php echo $title; ?></label>
<?php endif; ?>
</th>
<td <?php echo $grouped; ?> >
<?php endif; ?>
<?php foreach ( $header_types as $header ) :
if ( $type != $header ) continue; ?>
<tr>
<th scope="col" colspan="2">
<h3 class="title"><?php echo $title; ?></h3>
<?php echo $description; ?>
</th>
</tr>
<?php endforeach; ?>
<?php switch ( $type ) :
case 'text' :
case 'color' :
case 'number' :
if ( $type == 'color' ) {
$type = 'text';
$class .= ' colorpick';
$description .= '<div id="colorPickerDiv_' . $id . '" class="colorpickdiv" style="z-index: 100;background:#eee;border:1px solid #ccc;position:absolute;display:none;"></div>';
}
?>
<input name="<?php echo $name; ?>"
id="<?php echo $id; ?>"
type="<?php echo $type; ?>"
<?php if ( $type == 'number' ): ?>
min="<?php echo $restrict[ 'min' ]; ?>"
max="<?php echo $restrict[ 'max' ]; ?>"
step="<?php echo $restrict[ 'step' ]; ?>"
<?php endif; ?>
class="regular-text <?php echo $class; ?>"
style="<?php echo $css; ?>"
placeholder="<?php echo $placeholder; ?>"
value="<?php echo $value !== false ? $value : $std; ?>"
/>
<?php echo $description;
break;
case 'checkbox':
$selected = ( $value !== false ) ? $value : $std;
if ( $multiple ) :
foreach ( $options as $key => $desc ) : ?>
<input name="<?php echo $name; ?><?php echo $multiple ? '[]' : ''; ?>"
id="<?php echo $id . '_' . $key; ?>"
type="checkbox"
class="<?php echo $class; ?>"
style="<?php echo $css; ?>"
value="<?php echo $key; ?>"
<?php @checked( $selected[$key], 1 ); ?>
/>
<label for="<?php echo $id . '_' . $key; ?>">
<?php echo $desc; ?>
</label>
<br/>
<?php
endforeach;
else : ?>
<input name="<?php echo $name; ?>"
id="<?php echo $id ?>"
type="checkbox"
class="<?php echo $class; ?>"
style="<?php echo $css; ?>"
<?php checked( $selected, 1 ); ?>
/>
<?php echo $description;
endif;
break;
case 'radio':
$selected = ( $value !== false ) ? $value : $std;
foreach ( $options as $key => $val ) : ?>
<label class="radio">
<input type="radio"
name="<?php echo $name; ?>"
id="<?php echo $key; ?>"
value="<?php echo $key; ?>"
class="<?php echo $class; ?>"
<?php checked( $selected, $key ); ?>
/>
<?php echo $val; ?>
</label><br/>
<?php endforeach;
echo $description;
break;
case 'single_select_page':
$selected = ( $value !== false ) ? $value : $std;
$args = array(
'name' => $name,
'id' => $id,
'sort_order' => 'ASC',
'echo' => 0,
'selected' => $selected
);
echo str_replace( "'>", "'><option></option>", wp_dropdown_pages( $args ) );
echo $description;
if ( $select2 ) : ?>
<script type="text/javascript">jQuery(function () {
jQuery("#<?php echo $id; ?>").select2({ allowClear: true, placeholder: "<?php _e( 'Select a page...', 'geczy' ); ?>", width: '350px' });
});</script>
<?php endif;
break;
case 'select':
$selected = ( $value !== false ) ? $value : $std;
$options = apply_filters( $this->id . '_select_options', $options, $setting ); ?>
<select id="<?php echo $id; ?>"
class="<?php echo $class; ?>"
style="<?php echo $css; ?>"
name="<?php echo $name; ?><?php echo $multiple ? '[]' : ''; ?>"
<?php echo $multiple ? 'multiple="multiple"' : ''; ?>>
<?php foreach ( $options as $key => $val ) : ?>
<option
value="<?php echo $key; ?>" <?php self::selected( $selected, $key ); ?>><?php echo $val; ?></option>
<?php endforeach; ?>
</select>
<?php echo $description;
if ( $select2 ) : ?>
<script type="text/javascript">jQuery(function () {
jQuery("#<?php echo $id; ?>").select2({ width: '350px' });
});</script>
<?php endif;
break;
case 'textarea':
?>
<textarea name="<?php echo $name; ?>"
id="<?php echo $id; ?>"
class="large-text <?php echo $class; ?>"
style="<?php if ( $css ) echo $css; else echo 'width:300px;'; ?>"
placeholder="<?php echo $placeholder; ?>"
rows="3"
><?php echo ( $value !== false ) ? $value : $std; ?></textarea>
<?php echo $description;
break;
case 'wysiwyg':
wp_editor( $value, $id, array( 'textarea_name' => $name ) );
echo $description;
break;
default :
do_action( $this->id . '_options_type_' . $type, $setting );
break;
endswitch;
/* Footer of the option. */
if ( !in_array( $type, $header_types ) ) echo '</td></tr>';
}
/**
*
*
* @param unknown $haystack
* @param unknown $current
*/
private function selected( $haystack, $current )
{
if ( is_array( $haystack ) && in_array( $current, $haystack ) ) {
$current = $haystack = 1;
}
if(is_array($haystack)){
foreach($haystack as $option) {
selected( $option, $current );
}
} else {
selected( $haystack, $current );
}
}
/**
*
*
* @param unknown $haystack
* @param unknown $current
*/
private function checked( $haystack, $current )
{
if ( is_array( $haystack ) && !empty( $haystack[ $current ] ) ) {
$current = $haystack = 1;
}
checked( $haystack, $current );
}
/**
* Format a tooltip given a string
*
* @param string $tip
*
* @return string
*/
private function get_formatted_tip( $tip )
{
return $tip ? sprintf( '<a href="#" title="%s" class="sf-tips" tabindex="99"></a>', $tip ) : '';
}
/**
*
*
* @param unknown $value
* @param unknown $setting
*
* @return unknown
*/
private function sanitize_value( $value, $setting )
{
if ( $value !== false && $setting[ 'type' ] != 'wysiwyg' ) {
if ( is_array( $value ) ) {
foreach ( $value as $key => $output ) {
$value[ $key ] = esc_attr( $output );
}
} else {
$value = esc_attr( $value );
}
}
return apply_filters( $this->id . '_options_sanitize_value', $value, $setting );
}
}
}