class.bcn_admin.php000064400000110554147206607170010313 0ustar00

' . __('Your PHP version is too old, please upgrade to a newer version. Your version is %1$s, Breadcrumb NavXT requires %2$s', 'breadcrumb-navxt') . '

', phpversion(), '5.6.0'); } //If we are in the admin, let's print a warning then return if(is_admin()) { add_action('admin_notices', 'bcn_phpold'); } return; } //Include admin base class if(!class_exists('\mtekk\adminKit\adminKit')) { require_once(dirname(__FILE__) . '/includes/adminKit/class-mtekk_adminkit.php'); } use mtekk\adminKit\{adminKit, form, message, setting}; /** * The administrative interface class * */ class bcn_admin extends adminKit { const version = '7.3.1'; protected $full_name = 'Breadcrumb NavXT Settings'; protected $short_name = 'Breadcrumb NavXT'; protected $access_level = 'bcn_manage_options'; protected $identifier = 'breadcrumb-navxt'; protected $unique_prefix = 'bcn'; protected $plugin_basename = null; protected $support_url = 'https://wordpress.org/support/plugin/breadcrumb-navxt/'; /** * Administrative interface class default constructor * * @param array $opts The breadcrumb trail object's settings array * @param string $basename The basename of the plugin * @param array $settings The array of settings objects */ function __construct(array &$opts, $basename, array &$settings) { $this->plugin_basename = $basename; $this->full_name = esc_html__('Breadcrumb NavXT Settings', 'breadcrumb-navxt'); $this->settings =& $settings; $this->opt =& $opts; //We're going to make sure we load the parent's constructor parent::__construct(); } function is_network_admin() { return false; } /** * Loads opts array values into the local settings array * * @param array $opts The opts array */ function setting_merge($opts) { $unknown = array(); foreach($opts as $key => $value) { if(isset($this->settings[$key]) && $this->settings[$key] instanceof setting\setting) { $this->settings[$key]->set_value($this->settings[$key]->validate($value)); } else if(isset($this->settings[$key]) && is_array($this->settings[$key]) && is_array($value)) { foreach($value as $subkey => $subvalue) { if(isset($this->settings[$key][$subkey]) && $this->settings[$key][$subkey]instanceof setting\setting) { $this->settings[$key][$subkey]->set_value($this->settings[$key][$subkey]->validate($subvalue)); } } } else { $unknown[] = $key; } } //Add a message if we found some unknown settings while merging if(count($unknown) > 0) { $this->messages[] = new message( sprintf(__('Found %u unknown legacy settings: %s','breadcrumb-navxt'), count($unknown), implode(', ', $unknown)), 'warning', true, 'bcn_unkonwn_legacy_settings'); } } /** * admin initialization callback function * * is bound to wordpress action 'admin_init' on instantiation * * @since 3.2.0 * @return void */ function init() { //We're going to make sure we run the parent's version of this function as well parent::init(); $this->setting_merge($this->opt); } /** * Upgrades input options array, sets to $this->opt * * @param array $opts * @param string $version the version of the passed in options */ function opts_upgrade($opts, $version) { //If our version is not the same as in the db, time to update if(version_compare($version, $this::version, '<')) { require_once(dirname(__FILE__) . '/options_upgrade.php'); bcn_options_upgrade_handler($opts, $version, $this->opt); } //Merge in the defaults $this->opt = adminKit::parse_args($opts, adminKit::settings_to_opts($this->settings)); } /** * Fills in the help tab contents * * @param WP_Screen $screen The screen to add the help tab items to */ function help_contents(\WP_Screen &$screen) { $general_tab = '

' . esc_html__('Tips for the settings are located below select options.', 'breadcrumb-navxt') . '

' . esc_html__('Resources', 'breadcrumb-navxt') . '
' . '
' . esc_html__('Giving Back', 'breadcrumb-navxt') . '
'; $screen->add_help_tab( array( 'id' => $this->identifier . '-base', 'title' => __('General', 'breadcrumb-navxt'), 'content' => $general_tab )); $quickstart_tab = '

' . esc_html__('For the settings on this page to take effect, you must either use the included Breadcrumb NavXT widget, or place either of the code sections below into your theme.', 'breadcrumb-navxt') . '

' . esc_html__('Breadcrumb trail with separators', 'breadcrumb-navxt') . '
<div class="breadcrumbs" typeof="BreadcrumbList" vocab="https://schema.org/">' . "
	<?php if(function_exists('bcn_display'))
	{
		bcn_display();
	}?>
</div>
" . '
' . esc_html__('Breadcrumb trail in list form', 'breadcrumb-navxt').'
<ol class="breadcrumbs" typeof="BreadcrumbList" vocab="https://schema.org/">'."
	<?php if(function_exists('bcn_display_list'))
	{
		bcn_display_list();
	}?>
</ol>
"; $screen->add_help_tab( array( 'id' => $this->identifier . '-quick-start', 'title' => __('Quick Start', 'breadcrumb-navxt'), 'content' => $quickstart_tab )); $styling_tab = '

' . esc_html__('Using the code from the Quick Start section above, the following CSS can be used as base for styling your breadcrumb trail.', 'breadcrumb-navxt') . '

' . '
.breadcrumbs
{
	font-size: 1.1em;
	color: #fff;
	margin: 30px 0 0 10px;
	position: relative;
	float: left;
}
'; $screen->add_help_tab( array( 'id' => $this->identifier . '-styling', 'title' => __('Styling', 'breadcrumb-navxt'), 'content' => $styling_tab )); $screen->add_help_tab( array( 'id' => $this->identifier . '-import-export-reset', 'title' => __('Import/Export/Reset', 'breadcrumb-navxt'), 'content' => $this->import_form() )); } /** * enqueue's the tab style sheet on the settings page */ function admin_styles() { wp_enqueue_style('mtekk_adminkit_tabs'); } /** * enqueue's the tab js and translation js on the settings page */ function admin_scripts() { //Enqueue ui-tabs wp_enqueue_script('jquery-ui-tabs'); //Enqueue the admin tabs javascript wp_enqueue_script('mtekk_adminkit_tabs'); //Load the translations for the tabs wp_localize_script('mtekk_adminkit_tabs', 'objectL10n', array( 'mtad_uid' => 'bcn_admin', 'mtad_import' => __('Import', 'breadcrumb-navxt'), 'mtad_export' => __('Export', 'breadcrumb-navxt'), 'mtad_reset' => __('Reset', 'breadcrumb-navxt'), )); //Enqueue the admin enable/disable groups javascript wp_enqueue_script('mtekk_adminkit_engroups'); } /** * A message function that checks for the BCN_SETTINGS_* define statement */ function multisite_settings_warn() { if(is_multisite()) { if(defined('BCN_SETTINGS_USE_LOCAL') && BCN_SETTINGS_USE_LOCAL) { } else if(defined('BCN_SETTINGS_USE_NETWORK') && BCN_SETTINGS_USE_NETWORK) { $this->messages[] = new message(esc_html__('Warning: Your network settings will override any settings set in this page.', 'breadcrumb-navxt'), 'warning', true, $this->unique_prefix . '_msg_is_nsiteoveride'); } else if(defined('BCN_SETTINGS_FAVOR_LOCAL') && BCN_SETTINGS_FAVOR_LOCAL) { $this->messages[] = new message(esc_html__('Warning: Your network settings may override any settings set in this page.', 'breadcrumb-navxt'), 'warning', true, $this->unique_prefix . '_msg_is_isitemayoveride'); } else if(defined('BCN_SETTINGS_FAVOR_NETWORK') && BCN_SETTINGS_FAVOR_NETWORK) { $this->messages[] = new message(esc_html__('Warning: Your network settings may override any settings set in this page.', 'breadcrumb-navxt'), 'warning', true, $this->unique_prefix . '_msg_is_nsitemayoveride'); } //Fall through if no settings mode was set else { $this->messages[] = new message(esc_html__('Warning: No BCN_SETTINGS_* define statement found, defaulting to BCN_SETTINGS_USE_LOCAL.', 'breadcrumb-navxt'), 'warning', true, $this->unique_prefix . '_msg_is_nosetting'); } } } /** * A message function that checks for deprecated settings that are set and warns the user */ function deprecated_settings_warn() { //We're deprecating the limit title length setting, let the user know the new method of accomplishing this if(isset($this->settings['blimit_title']) && $this->settings['blimit_title']->get_value()) { $this->messages[] = new message( sprintf( esc_html__('Error: The deprecated setting "Title Length" (see Miscellaneous > Deprecated) has no effect in this version Breadcrumb NavXT. Please %1$suse CSS instead%2$s.', 'breadcrumb-navxt'), '', ''), 'error'); } foreach($this->settings as $key => $setting) { if($key[0] == "H" && substr_count($key, '_template') >= 1) { $deprecated_tags = array(); $replacement_tags = array(); //Deprecated ftitle check if(substr_count($setting->get_value(), '%ftitle%') >= 1) { $deprecated_tags[] = '%ftitle%'; $replacement_tags[] = '%title%'; } //Deprecated fhtitle check if(substr_count($setting->get_value(), '%fhtitle%') >= 1) { $deprecated_tags[] = '%fhtitle%'; $replacement_tags[] = '%htitle%'; } if(count($deprecated_tags) > 0) { $setting_link = sprintf('%2$s', $key, $setting->get_title()); $this->messages[] = new message( sprintf( esc_html__('Error: The deprecated template tag %1$s found in setting %3$s. Please use %2$s instead.', 'breadcrumb-navxt'), implode(' and ', $deprecated_tags), implode(' and ', $replacement_tags), $setting_link), 'error'); } } } } /** * A message function that checks for post types added after the settings defaults were established */ function unknown_custom_types_warn() { foreach($GLOBALS['wp_post_types'] as $post_type) { if(!($post_type instanceof WP_Post_Type)) { $this->messages[] = new message( sprintf( esc_html__('Error: WP_Post_Types global contains non WP_Post_Type object. Debug information: %1$s', 'breadcrumb-navxt'), var_export($post_type, true)), 'error', true, 'badtypeWP_Post_Types'); continue; } //If we haven't seen this post type before, warn the user if(!isset($this->settings['Hpost_' . $post_type->name . '_template'])) { $this->messages[] = new message( sprintf( esc_html__('Warning: The post type %1$s (%2$s) was registered after the Breadcrumb NavXT default settings. It will not show up in the settings.', 'breadcrumb-navxt'), $post_type->labels->singular_name, $post_type->name), 'warning', true, $post_type->name); } } foreach($GLOBALS['wp_taxonomies'] as $taxonomy) { if(!($taxonomy instanceof WP_Taxonomy)) { //If we haven't seen this taxonomy before, warn the user $this->messages[] = new message( sprintf( esc_html__('Error: WP_Taxonomies global contains non WP_Taxonomy object. Debug information: %1$s', 'breadcrumb-navxt'), var_export($taxonomy, true)), 'error', true, 'badtypeWP_Taxonomies'); continue; } if(!isset($this->settings['Htax_' . $taxonomy->name . '_template'])) { //If we haven't seen this taxonomy before, warn the user $this->messages[] = new message( sprintf( esc_html__('Warning: The taxonomy %1$s (%2$s) was registered after the Breadcrumb NavXT default settings. It will not show up in the settings.', 'breadcrumb-navxt'), $taxonomy->label, $taxonomy->name), 'warning', true, $taxonomy->name); } } } /** * Function checks the current site to see if the blog options should be disabled * * @return boool Whether or not the blog options should be disabled */ function maybe_disable_blog_options() { return (get_option('show_on_front') !== 'page' || get_option('page_for_posts') < 1); } /** * Function checks the current site to see if the mainsite options should be disabled * * @return bool Whether or not the mainsite options should be disabled */ function maybe_disable_mainsite_options() { return !is_multisite(); } /** * The administrative page for Breadcrumb NavXT */ function admin_page() { global $wp_taxonomies, $wp_post_types; $this->security(); //Do a check on deprecated settings $this->deprecated_settings_warn(); //Do a check for unknown CPTs and Taxnomies $this->unknown_custom_types_warn(); //Do a check for multisite settings mode $this->multisite_settings_warn(); do_action($this->unique_prefix . '_settings_pre_messages', $this->settings); //Display our messages $this->messages(); //Grab the network options, if multisite $network_opts = array(); $local_opts = array(); $overriden = array(); $overriden_style = array(); if(is_multisite() && !$this->is_network_admin()) { $network_opts = get_site_option('bcn_options'); $local_opts = get_option('bcn_options'); } foreach($this->settings as $key => $setting) { if(isset($network_opts[$key]) && ((defined('BCN_SETTINGS_USE_NETWORK') && BCN_SETTINGS_USE_NETWORK) || (defined('BCN_SETTINGS_FAVOR_NETWORK') && BCN_SETTINGS_FAVOR_NETWORK))) { $overriden[$key] = ' ' . __('Value has been set via network wide setting.', 'breadcrumb-navxt'); $overriden_style[$key] = ' disabled'; } else { $overriden[$key] = ''; $overriden_style[$key] = ''; } } ?>

full_name; ?>

version_check($this->get_option($this->unique_prefix . '_version'))) { return; } ?>

form->textbox($this->settings['hseparator'], '2', false, __('Placed in between each breadcrumb.', 'breadcrumb-navxt') . $overriden['hseparator'], $overriden_style['hseparator']); do_action($this->unique_prefix . '_settings_general', $this->settings); ?>

form->input_check( $this->settings['bcurrent_item_linked'], __('Yes', 'breadcrumb-navxt'), false, $overriden['bcurrent_item_linked'], $overriden_style['bcurrent_item_linked']); $this->form->input_check( $this->settings['bpaged_display'], __('Place the page number breadcrumb in the trail.', 'breadcrumb-navxt'), false, __('Indicates that the user is on a page other than the first of a paginated archive or post.', 'breadcrumb-navxt') . $overriden['bpaged_display'], 'adminkit-enset-ctrl adminkit-enset' . $overriden_style['bpaged_display']); $this->form->textbox( $this->settings['Hpaged_template'], '4', false, __('The template for paged breadcrumbs.', 'breadcrumb-navxt') . $overriden['Hpaged_template'], 'adminkit-enset' . $overriden_style['Hpaged_template']); do_action($this->unique_prefix . '_settings_current_item', $this->settings); ?>

form->input_check( $this->settings['bhome_display'], __('Place the home breadcrumb in the trail.', 'breadcrumb-navxt'), false, $overriden['bhome_display'], 'adminkit-enset-ctrl adminkit-enset' . $overriden_style['bhome_display']); $this->form->textbox( $this->settings['Hhome_template'], '6', false, __('The template for the home breadcrumb.', 'breadcrumb-navxt') . $overriden['Hhome_template'], 'adminkit-enset' . $overriden_style['Hhome_template']); $this->form->textbox( $this->settings['Hhome_template_no_anchor'], '4', false, __('The template for the home breadcrumb, used when the breadcrumb is not linked.', 'breadcrumb-navxt') . $overriden['Hhome_template_no_anchor'], 'adminkit-enset' . $overriden_style['Hhome_template_no_anchor']); do_action($this->unique_prefix . '_settings_home', $this->settings); ?>

form->input_check( $this->settings['bblog_display'], __('Place the blog breadcrumb in the trail.', 'breadcrumb-navxt'), $this->maybe_disable_blog_options(), $overriden['bblog_display'], 'adminkit-enset-ctrl adminkit-enset' . $overriden_style['bblog_display']); do_action($this->unique_prefix . '_settings_blog', $this->settings); ?>

form->input_check( $this->settings['bmainsite_display'], __('Place the main site home breadcrumb in the trail in an multisite setup.', 'breadcrumb-navxt'), $this->maybe_disable_mainsite_options(), $overriden['bmainsite_display'], 'adminkit-enset-ctrl adminkit-enset' . $overriden_style['bmainsite_display']); $this->form->textbox( $this->settings['Hmainsite_template'], '6', $this->maybe_disable_mainsite_options(), __('The template for the main site home breadcrumb, used only in multisite environments.', 'breadcrumb-navxt') . $overriden['Hmainsite_template'], 'adminkit-enset' . $overriden_style['Hmainsite_template']); $this->form->textbox( $this->settings['Hmainsite_template_no_anchor'], '4', $this->maybe_disable_mainsite_options(), __('The template for the main site home breadcrumb, used only in multisite environments and when the breadcrumb is not linked.', 'breadcrumb-navxt') . $overriden['Hmainsite_template_no_anchor'], 'adminkit-enset' . $overriden_style['Hmainsite_template_no_anchor']); do_action($this->unique_prefix . '_settings_mainsite', $this->settings); ?>
unique_prefix . '_after_settings_tab_general', $this->settings); ?>
public, $post_type->name) || !isset($this->settings['Hpost_' . $post_type->name . '_template'])) { continue; } $singular_name_lc = mb_strtolower($post_type->labels->singular_name, 'UTF-8'); ?>

labels->singular_name; ?>

form->textbox( $this->settings['Hpost_' . $post_type->name . '_template'], '6', false, sprintf(__('The template for %s breadcrumbs.', 'breadcrumb-navxt'), $singular_name_lc) . $overriden['Hpost_' . $post_type->name . '_template'], $overriden_style['Hpost_' . $post_type->name . '_template']); $this->form->textbox( $this->settings['Hpost_' . $post_type->name . '_template_no_anchor'], '4', false, sprintf(__('The template for %s breadcrumbs, used only when the breadcrumb is not linked.', 'breadcrumb-navxt'), $singular_name_lc) . $overriden['Hpost_' . $post_type->name . '_template_no_anchor'], $overriden_style['Hpost_' . $post_type->name . '_template_no_anchor']); if(!in_array($post_type->name, array('page', 'post'))) { $optid = form::get_valid_id('apost_' . $post_type->name . '_root'); ?> form->input_check( $this->settings['bpost_' . $post_type->name . '_archive_display'], sprintf(__('Show the breadcrumb for the %s post type archives in the breadcrumb trail.', 'breadcrumb-navxt'), $singular_name_lc), !$post_type->has_archive, $overriden['bpost_' . $post_type->name . '_archive_display'], $overriden_style['bpost_' . $post_type->name . '_archive_display']); } if(in_array($post_type->name, array('page'))) { $this->form->input_hidden($this->settings['bpost_' . $post_type->name . '_hierarchy_display']); $this->form->input_hidden($this->settings['bpost_' . $post_type->name . '_hierarchy_parent_first']); $this->form->input_hidden($this->settings['bpost_' . $post_type->name . '_taxonomy_referer']); } else { $this->form->input_check( $this->settings['bpost_' . $post_type->name . '_hierarchy_display'], sprintf(__('Show the hierarchy (specified below) leading to a %s in the breadcrumb trail.', 'breadcrumb-navxt'), $singular_name_lc), false, $overriden['bpost_' . $post_type->name . '_hierarchy_display'], 'adminkit-enset-ctrl adminkit-enset' . $overriden_style['bpost_' . $post_type->name . '_hierarchy_display']); $this->form->input_check( $this->settings['bpost_' . $post_type->name . '_hierarchy_parent_first'], sprintf(__('Use the parent of the %s as the primary hierarchy, falling back to the hierarchy selected below when the parent hierarchy is exhausted.', 'breadcrumb-navxt'), $singular_name_lc), false, $overriden['bpost_' . $post_type->name . '_hierarchy_parent_first'], 'adminkit-enset' . $overriden_style['bpost_' . $post_type->name . '_hierarchy_parent_first']); $this->form->input_check( $this->settings['bpost_' . $post_type->name . '_taxonomy_referer'], __('Allow the referring page to influence the taxonomy selected for the hierarchy.', 'breadcrumb-navxt'), false, $overriden['bpost_' . $post_type->name . '_taxonomy_referer'], 'adminkit-enset' . $overriden_style['bpost_' . $post_type->name . '_taxonomy_referer']); ?>
$this->unique_prefix . '_options[apost_' . $post_type->name . '_root]', 'id' => $optid, 'echo' => 1, 'show_option_none' => __( '— Select —' ), 'option_none_value' => '0', 'selected' => $this->settings['apost_' . $post_type->name . '_root']->get_value(), 'class' => $overriden_style['apost_' . $post_type->name . '_root'])); if(isset($overriden['apost_' . $post_type->name . '_root']) && $overriden['apost_' . $post_type->name . '_root'] !== '') { printf('

%s

', $overriden['apost_' . $post_type->name . '_root']); } ?>
labels->singular_name); ?> form->input_radio($this->settings['Epost_' . $post_type->name . '_hierarchy_type'], 'BCN_POST_PARENT', __('Post Parent', 'breadcrumb-navxt'), false, 'adminkit-enset' . $overriden_style['Epost_' . $post_type->name . '_hierarchy_type']); $this->form->input_radio($this->settings['Epost_' . $post_type->name . '_hierarchy_type'], 'BCN_DATE', __('Dates', 'breadcrumb-navxt'), false, 'adminkit-enset' . $overriden_style['Epost_' . $post_type->name . '_hierarchy_type']); //Loop through all of the taxonomies in the array foreach($wp_taxonomies as $taxonomy) { //Check for non-public taxonomies if(!($taxonomy instanceof WP_Taxonomy) || !apply_filters('bcn_show_tax_private', $taxonomy->public, $taxonomy->name, $post_type->name)) { continue; } //We only want custom taxonomies if($taxonomy->object_type == $post_type->name || in_array($post_type->name, $taxonomy->object_type)) { $this->form->input_radio($this->settings['Epost_' . $post_type->name . '_hierarchy_type'], $taxonomy->name, $taxonomy->labels->singular_name, false, 'adminkit-enset' . $overriden_style['Epost_' . $post_type->name . '_hierarchy_type']); } } ?>

hierarchical) { esc_html_e('The hierarchy which the breadcrumb trail will show.', 'breadcrumb-navxt'); } else { esc_html_e('The hierarchy which the breadcrumb trail will show. Note that the "Post Parent" option may require an additional plugin to behave as expected since this is a non-hierarchical post type.', 'breadcrumb-navxt'); } echo $overriden['Epost_' . $post_type->name . '_hierarchy_type']; ?>

unique_prefix . '_after_settings_tab_post', $this->settings); ?>
public, $taxonomy->name, null) || !isset($this->settings['Htax_' . $taxonomy->name . '_template'])) { continue; } $label_lc = mb_strtolower($taxonomy->label, 'UTF-8'); ?>

label, MB_CASE_TITLE, 'UTF-8'); ?>

form->textbox( $this->settings['Htax_' . $taxonomy->name . '_template'], '6', false, sprintf(__('The template for %s breadcrumbs.', 'breadcrumb-navxt') . $overriden['Htax_' . $taxonomy->name . '_template'], $label_lc), $overriden_style['Htax_' . $taxonomy->name . '_template']); $this->form->textbox( $this->settings['Htax_' . $taxonomy->name . '_template_no_anchor'], '4', false, sprintf(__('The template for %s breadcrumbs, used only when the breadcrumb is not linked.', 'breadcrumb-navxt') . $overriden['Htax_' . $taxonomy->name . '_template_no_anchor'], $label_lc), $overriden_style['Htax_' . $taxonomy->name . '_template_no_anchor']); ?>
unique_prefix . '_after_settings_tab_taxonomy', $this->settings); ?>

form->textbox( $this->settings['Hauthor_template'], '6', false, __('The template for author breadcrumbs.', 'breadcrumb-navxt') . $overriden['Hauthor_template'], $overriden_style['Hauthor_template']); $this->form->textbox( $this->settings['Hauthor_template_no_anchor'], '4', false, __('The template for author breadcrumbs, used only when the breadcrumb is not linked.', 'breadcrumb-navxt') . $overriden['Hauthor_template_no_anchor'], $overriden_style['Hauthor_template_no_anchor']); $this->form->input_select( $this->settings['Eauthor_name'], $this->settings['Eauthor_name']->get_allowed_vals(), false, __('display_name uses the name specified in "Display name publicly as" under the user profile the others correspond to options in the user profile.', 'breadcrumb-navxt') . $overriden['Eauthor_name'], $overriden_style['Eauthor_name']); $optid = form::get_valid_id('aauthor_root'); ?>
$this->unique_prefix . '_options[aauthor_root]', 'id' => $optid, 'echo' => 1, 'show_option_none' => __( '— Select —' ), 'option_none_value' => '0', 'selected' => $this->settings['aauthor_root']->get_value(), 'class' => $overriden_style['aauthor_root'] )); if(isset($overriden['aauthor_root']) && $overriden['aauthor_root'] !== '') { printf('

%s

', $overriden['aauthor_root']); } ?>

form->textbox( $this->settings['Hdate_template'], '6', false, __('The template for date breadcrumbs.', 'breadcrumb-navxt') . $overriden['Hdate_template'], $overriden_style['Hdate_template']); $this->form->textbox( $this->settings['Hdate_template_no_anchor'], '4', false, __('The template for date breadcrumbs, used only when the breadcrumb is not linked.', 'breadcrumb-navxt') . $overriden['Hdate_template_no_anchor'], $overriden_style['Hdate_template_no_anchor']); $this->form->textbox( $this->settings['Hsearch_template'], '6', false, __('The anchor template for search breadcrumbs, used only when the search results span several pages.', 'breadcrumb-navxt') . $overriden['Hsearch_template'], $overriden_style['Hsearch_template']); $this->form->textbox( $this->settings['Hsearch_template_no_anchor'], '4', false, __('The anchor template for search breadcrumbs, used only when the search results span several pages and the breadcrumb is not linked.', 'breadcrumb-navxt') . $overriden['Hsearch_template_no_anchor'], $overriden_style['Hsearch_template_no_anchor']); $this->form->input_text( $this->settings['S404_title'], 'regular-text' . $overriden_style['S404_title'], false, $overriden['S404_title']); $this->form->textbox( $this->settings['H404_template'], '4', false, __('The template for 404 breadcrumbs.', 'breadcrumb-navxt') . $overriden['H404_template'], $overriden_style['H404_template']); ?>


unique_prefix . '_after_settings_tab_miscellaneous', $this->settings); ?>
unique_prefix . '_after_settings_tabs', $this->settings); ?>

{"use strict";var e={n:r=>{var a=r&&r.__esModule?()=>r.default:()=>r;return e.d(a,{a}),a},d:(r,a)=>{for(var t in a)e.o(a,t)&&!e.o(r,t)&&Object.defineProperty(r,t,{enumerable:!0,get:a[t]})},o:(e,r)=>Object.prototype.hasOwnProperty.call(e,r)};const r=window.wp.blocks,a=window.React,t=(window.wp.data,window.wp.i18n),n=window.wp.components,l=window.wp.serverSideRender;var o=e.n(l);const c=window.wp.blockEditor,b=JSON.parse('{"u2":"bcn/breadcrumb-trail"}'),d=(0,a.createElement)("svg",{viewbox:"0 0 24 24",xmlns:"http://www.w3.org/2000/svg","aria-hidden":"true",focusable:"false"},(0,a.createElement)("path",{d:"M0.6 7.2C0.4 7.2 0.4 7.2 0.4 7.4V16.9C0.4 17.1 0.4 17.1 0.6 17.1H10.9C11.1 17.1 11.1 17.1 11.3 16.9L16 12.1 11.3 7.4C11.1 7.2 11.1 7.2 10.9 7.2ZM15 7.2 19.9 12.1 15 17.1H18.7C18.9 17.1 18.9 17.1 19.1 16.9L23.8 12.1 19.1 7.4C18.9 7.2 18.9 7.2 18.7 7.2Z"}));(0,r.registerBlockType)(b.u2,{icon:d,edit:function({attributes:e,setAttributes:r}){const l=e=>a=>r({[e]:a});return(0,a.createElement)("div",{...(0,c.useBlockProps)()},(0,a.createElement)(c.InspectorControls,null,(0,a.createElement)(n.PanelBody,{title:(0,t.__)("Breadcrumb Trail Settings","breadcrumb-navxt")},(0,a.createElement)("p",{className:"description"},(0,t.__)("Adjust the breadcrumb trail.","breadcrumb-navxt")),(0,a.createElement)(n.TextControl,{label:(0,t.__)("Tesxt to show before the trail","breadcrumb-navxt"),value:e.pretext,onChange:l("pretext")}),(0,a.createElement)(n.SelectControl,{label:(0,t.__)("Output trail format","breadcrumb-navxt"),value:e.format,options:[{value:"list",label:(0,t.__)("Ordered list elements","breadcrumb-navxt")},{value:"breadcrumblist_rdfa",label:(0,t.__)("Schema.org BreadcrumbList (RDFa)","breadcrumb-navxt")},{value:"breadcrumblist_rdfa_wai_aria",label:(0,t.__)("Schema.org BreadcrumbList (RDFa) with WAI-ARIA","breadcrumb-navxt")},{value:"breadcrumblist_microdata",label:(0,t.__)("Schema.org BreadcrumbList (microdata)","breadcrumb-navxt")},{value:"plain",label:(0,t.__)("Plane (no Schema.org BreadcrumbList)","breadcrumb-navxt")}],onChange:l("format")}),(0,a.createElement)(n.ToggleControl,{label:(0,t.__)("Link the breadcrumbs","breadcrumb-navxt"),checked:!!e.link,onChange:l("link")}),(0,a.createElement)(n.ToggleControl,{label:(0,t.__)("Reverse the order of the trail","breadcrumb-navxt"),checked:!!e.reverseOrder,onChange:l("reverseOrder")}),(0,a.createElement)(n.ToggleControl,{label:(0,t.__)("Hide the breadcrumb trail on the front page","breadcrumb-navxt"),checked:!!e.hideonHome,onChange:l("hideonHome")}),(0,a.createElement)(n.ToggleControl,{label:(0,t.__)("Ignore the breadcrumb cache","breadcrumb-navxt"),checked:!!e.ignoreCache,onChange:l("ignoreCache")}))),(0,a.createElement)(n.Disabled,null,(0,a.createElement)(o(),{block:"bcn/breadcrumb-trail",attributes:{...e},urlQueryArgs:""})))}})})();includes/blocks/build/breadcrumb-trail/index.asset.php000064400000000273147206607170017117 0ustar00 array('react', 'wp-block-editor', 'wp-blocks', 'wp-components', 'wp-data', 'wp-i18n', 'wp-server-side-render'), 'version' => '093b1bc0838bc818fe10'); includes/blocks/build/breadcrumb-trail/block.json000064400000003600147206607170016143 0ustar00{ "$schema": "https://schemas.wp.org/trunk/block.json", "apiVersion": 3, "name": "bcn/breadcrumb-trail", "title": "Breadcrumb Trail", "category": "theme", "description": "Displays a breadcrumb trail", "keywords": [ "breadcrumbs", "navigation", "breadcrumb trail" ], "version": "2.0.0", "textdomain": "breadcrumb-navxt", "attributes": { "pretext": { "type": "string", "default": "" }, "format": { "type": "string", "enum": [ "list", "breadcrumblist_rdfa", "breadcrumblist_rdfa_wai_aria", "breadcrumblist_microdata", "plain" ], "default": "breadcrumblist_rdfa" }, "link": { "type": "boolean", "default": true }, "reverseOrder": { "type": "boolean", "default": false }, "hideonHome": { "type": "boolean", "default": false }, "ignoreCache": { "type": "boolean", "default": true }, "className": { "type": "string", "default": "" }, "textColor": { "type": "string", "default": "" }, "backgroundColor": { "type": "string", "default": "" }, "align": { "type": "string", "default": "" }, "typography": { "type": "string", "default": "" }, "fontSize": { "type": "string", "default": "" }, "style": { "type": "object", "default": {} } }, "usesContext": [ "groupId" ], "selectors": { "root": ".wp-block-breadcrumb-trail" }, "supports": { "align": true, "color": { "text": true, "link": true, "background": true }, "typography": { "fontSize": true }, "html": false }, "example": { "attributes": { "pretext": "You are here:" } }, "editorScript": "file:./index.js", "render": "file:./render.php" }includes/blocks/build/breadcrumb-trail/render.php000064400000005563147206607170016160 0ustar00. * @param WP_Block $block The instance of the WP_Block class that represents the block being rendered. * * @package breadcrumb-navxt */ if($attributes['hideonHome'] === true && is_front_page() && (!is_paged() && $GLOBALS['breadcrumb_navxt']->show_paged())) { return; } //Handle previews if(isset($_REQUEST['post_id'])) { $post_id = $_REQUEST['post_id']; $preview_post = get_post($post_id); if($attributes['format'] === 'list') { $template = "%1\$s\n"; $outer_template = "\n"; } else { $template = '%1$s%2$s'; $outer_template = '%1$s'; } $trail_string = $GLOBALS['breadcrumb_navxt']->_display_post($preview_post, true, $attributes['link'], $attributes['reverseOrder'], $attributes['ignoreCache'], $template, $outer_template); } else if($attributes['format'] === 'list') { $trail_string = bcn_display_list(true, $attributes['link'], $attributes['reverseOrder'], $attributes['ignoreCache']); } else { $trail_string = bcn_display(true, $attributes['link'], $attributes['reverseOrder'], $attributes['ignoreCache']); } if($attributes['format'] === 'list') { ?>
    'breadcrumbs') ) );?>>
'breadcrumbs', 'vocab' => 'https://schema.org/', 'typeof' => 'BreadcrumbList' ) ) );?>>
'breadcrumbs', 'itemtype' => 'https://schema.org/BreadcrumbList' ) ) );?>>
'breadcrumbs' ) ) );?>>
message = array(); $this->messages = array(); //Admin Init Hook add_action('admin_init', array($this, 'init')); //WordPress Admin interface hook add_action('admin_menu', array($this, 'add_page')); //Installation Script hook add_action('activate_' . $this->plugin_basename, array($this, 'install')); //Initilizes l10n domain $this->local(); add_action('wp_loaded', array($this, 'wp_loaded')); $this->form = new form($this->unique_prefix); //Register Help Output //add_action('add_screen_help_and_options', array($this, 'help')); } function wp_loaded() { //Filter our allowed html tags $this->allowed_html = apply_filters($this->unique_prefix . '_allowed_html', wp_kses_allowed_html('post')); } /** * Returns the internal mtekk_admin_class version */ function get_admin_class_version() { return adminKit::version; } /** * Checks if the administrator has the access capability, and adds it if they don't */ function add_cap() { $role = get_role('administrator'); if($role instanceof \WP_Role && !$role->has_cap($this->access_level)) { $role->add_cap($this->access_level); } } /** * Return the URL of the settings page for the plugin */ function admin_url() { return admin_url('options-general.php?page=' . $this->identifier); } /** * A wrapper for nonced_anchor returns a nonced anchor for admin pages * * @param string $mode The nonce "mode", a unique string at the end of the standardized nonce identifier * @param string $title (optional) The text to use in the title portion of the anchor * @param string $text (optional) The text that will be surrounded by the anchor tags * @return string the assembled anchor */ function admin_anchor($mode, $title = '', $text = '') { return $this->nonced_anchor($this->admin_url(), 'admin_' . $mode, 'true', $title, $text); } /** * Returns a properly formed nonced anchor to the specified URI * * @param string $uri The URI that the anchor should be for * @param string $mode The nonce "mode", a unique string at the end of the standardized nonce identifier * @param mixed $value (optional) The value to place in the query string * @param string $title (optional) The text to use in the title portion of the anchor * @param string $text (optional) The text that will be surrounded by the anchor tags * @param string $anchor_extras (optional) This text is placed within the opening anchor tag, good for adding id, classe, rel field * @return string the assembled anchor */ function nonced_anchor($uri, $mode, $value = 'true', $title = '', $text = '', $anchor_extras = '') { //Assemble our url, nonce and all $url = wp_nonce_url(add_query_arg($this->unique_prefix . '_' . $mode, $value, $uri), $this->unique_prefix . '_' . $mode); //Return a valid anchor return ' ' . esc_html($text) . ''; } /** * Abstracts the check_admin_referer so that all the end user has to supply is the mode * * @param string $mode The specific nonce "mode" (see nonced_anchor) that is being checked */ function check_nonce($mode) { check_admin_referer($this->unique_prefix . '_' . $mode); } /** * Makes sure the current user can manage options to proceed */ function security() { //If the user can not manage options we will die on them if(!current_user_can($this->access_level)) { wp_die(__('Insufficient privileges to proceed.', $this->identifier)); } } function init() { $this->add_cap(); //Admin Options reset hook if(isset($_POST[$this->unique_prefix . '_admin_reset'])) { //Run the reset function on init if reset form has been submitted $this->opts_reset(); } //Admin Settings export hook else if(isset($_POST[$this->unique_prefix . '_admin_settings_export'])) { //Run the export function on init if export form has been submitted $this->settings_export(); } //Admin Settings import hook else if(isset($_POST[$this->unique_prefix . '_admin_settings_import']) && isset($_FILES[$this->unique_prefix . '_admin_import_file']) && !empty($_FILES[$this->unique_prefix . '_admin_import_file']['name'])) { //Run the import function on init if import form has been submitted $this->settings_import(); } //Admin Options rollback hook else if(isset($_GET[$this->unique_prefix . '_admin_undo'])) { //Run the rollback function on init if undo button has been pressed $this->opts_undo(); } //Admin Options upgrade hook else if(isset($_GET[$this->unique_prefix . '_admin_upgrade'])) { //Run the upgrade function on init if upgrade button has been pressed $this->opts_upgrade_wrapper(); } //Admin Options fix hook else if(isset($_GET[$this->unique_prefix . '_admin_fix'])) { //Run the options fix function on init if fix button has been pressed $this->opts_upgrade_wrapper(); } //Admin Options update hook else if(isset($_POST[$this->unique_prefix . '_admin_options'])) { //Temporarily add update function on init if form has been submitted $this->opts_update(); } //Add in the nice "settings" link to the plugins page add_filter('plugin_action_links', array($this, 'filter_plugin_actions'), 10, 2); if(defined('SCRIPT_DEBUG') && SCRIPT_DEBUG) { $suffix = ''; } else { $suffix = '.min'; } //Register JS for more permanently dismissing messages wp_register_script('mtekk_adminkit_messages', plugins_url('/mtekk_adminkit_messages' . $suffix . '.js', dirname(__FILE__) . '/assets/mtekk_adminkit_messages' . $suffix . '.js'), array('jquery'), self::version, true); //Register JS for enable/disable settings groups wp_register_script('mtekk_adminkit_engroups', plugins_url('/mtekk_adminkit_engroups' . $suffix . '.js', dirname(__FILE__) . '/assets/mtekk_adminkit_engroups' . $suffix . '.js'), array('jquery'), self::version, true); //Register JS for tabs wp_register_script('mtekk_adminkit_tabs', plugins_url('/mtekk_adminkit_tabs' . $suffix . '.js', dirname(__FILE__) . '/assets/mtekk_adminkit_tabs' . $suffix . '.js'), array('jquery-ui-tabs'), self::version, true); //Register CSS for tabs wp_register_style('mtekk_adminkit_tabs', plugins_url('/mtekk_adminkit_tabs' . $suffix . '.css', dirname(__FILE__) . '/assets/mtekk_adminkit_tabs' . $suffix . '.css')); //Register options register_setting($this->unique_prefix . '_options', $this->unique_prefix . '_options', ''); //Synchronize up our settings with the database as we're done modifying them now $this->opt = $this::parse_args($this->get_option($this->unique_prefix . '_options'), $this->opt); add_action('wp_ajax_mtekk_admin_message_dismiss', array($this, 'dismiss_message')); } /** * Adds the adminpage the menu and the nice little settings link * TODO: make this more generic for easier extension */ function add_page() { //Add the submenu page to "settings" menu $hookname = add_submenu_page('options-general.php', $this->full_name, $this->short_name, $this->access_level, $this->identifier, array($this, 'admin_page')); // check capability of user to manage options (access control) if(current_user_can($this->access_level)) { //Register admin_head-$hookname callback add_action('admin_head-' . $hookname, array($this, 'admin_head')); //Register admin_print_styles-$hookname callback add_action('admin_print_styles-' . $hookname, array($this, 'admin_styles')); //Register admin_print_scripts-$hookname callback add_action('admin_print_scripts-' . $hookname, array($this, 'admin_scripts')); //Register Help Output add_action('load-' . $hookname, array($this, 'help')); } } /** * Initilizes localization textdomain for translations (if applicable) * * Will conditionally load the textdomain for translations. This is here for * plugins that span multiple files and have localization in more than one file * * @return void */ function local() { global $l10n; // the global and the check might become obsolete in // further wordpress versions // @see https://core.trac.wordpress.org/ticket/10527 if(!isset($l10n[$this->identifier])) { load_plugin_textdomain($this->identifier, false, $this->identifier . '/languages'); } } /** * Places in a link to the settings page in the plugins listing entry * * @param array $links An array of links that are output in the listing * @param string $file The file that is currently in processing * @return array Array of links that are output in the listing. */ function filter_plugin_actions($links, $file) { //Make sure we are adding only for the current plugin if($file == $this->plugin_basename) { //Add our link to the end of the array to better integrate into the WP 2.8 plugins page $links[] = '' . esc_html__('Settings') . ''; } return $links; } /** * Checks to see if the plugin has been fully installed * * @return bool whether or not the plugin has been installed */ function is_installed() { $opts = $this->get_option($this->unique_prefix . '_options'); return is_array($opts); } /** * This sets up and upgrades the database settings, runs on every activation * * FIXME: seems there is a lot of very similar code in opts_upgrade_wrapper */ function install() { //Call our little security function $this->security(); //Try retrieving the options from the database $opts = $this->get_option($this->unique_prefix . '_options'); //If there are no settings, copy over the default settings if(!is_array($opts)) { //Add the options, we only store differences from defaults now, so start with blank array $this->add_option($this->unique_prefix . '_options', array()); $this->add_option($this->unique_prefix . '_options_bk', array(), '', false); //Add the version, no need to autoload the db version $this->update_option($this->unique_prefix . '_version', $this::version, false); } else { //Retrieve the database version $db_version = $this->get_option($this->unique_prefix . '_version'); if($this::version !== $db_version) { //Run the settings update script $this->opts_upgrade($opts, $db_version); //Always have to update the version $this->update_option($this->unique_prefix . '_version', $this::version, false); //Store the options $this->update_option($this->unique_prefix . '_options', $this->opt, true); } } } /** * This removes database settings upon deletion of the plugin from WordPress */ function uninstall() { //Remove the option array setting $this->delete_option($this->unique_prefix . '_options'); //Remove the option backup array setting $this->delete_option($this->unique_prefix . '_options_bk'); //Remove the version setting $this->delete_option($this->unique_prefix . '_version'); } /** * Compares the supplided version with the internal version, places an upgrade warning if there is a missmatch * TODO: change this to being auto called in admin_init action */ function version_check($version) { //If we didn't get a version, setup if($version === false) { //Add the version, no need to autoload the db version $this->add_option($this->unique_prefix . '_version', $this::version, '', 'no'); } //Do a quick version check if($version && version_compare($version, $this::version, '<') && is_array($this->opt)) { //Throw an error since the DB version is out of date $this->messages[] = new message(esc_html__('Your settings are for an older version of this plugin and need to be migrated.', $this->identifier) . $this->admin_anchor('upgrade', __('Migrate the settings now.', $this->identifier), __('Migrate now.', $this->identifier)), 'warning'); //Output any messages that there may be $this->messages(); return false; } //Do a quick version check else if($version && version_compare($version, $this::version, '>') && is_array($this->opt)) { //Let the user know that their settings are for a newer version $this->messages[] = new message(esc_html__('Your settings are for a newer version of this plugin.', $this->identifier) . $this->admin_anchor('upgrade', __('Migrate the settings now.', $this->identifier), __('Attempt back migration now.', $this->identifier)), 'warning'); //Output any messages that there may be $this->messages(); return true; } else if(!is_array($this->settings)) { //Throw an error since it appears the options were never registered $this->messages[] = new message(esc_html__('Your plugin install is incomplete.', $this->identifier) . $this->admin_anchor('upgrade', __('Load default settings now.', $this->identifier), __('Complete now.', $this->identifier)), 'error'); //Output any messages that there may be $this->messages(); return false; } else if(!$this->settings_validate($this->settings)) { //Throw an error since it appears the options contain invalid data $this->messages[] = new message(esc_html__('One or more of your plugin settings are invalid.', $this->identifier) . $this->admin_anchor('fix', __('Attempt to fix settings now.', $this->identifier), __('Fix now.', $this->identifier)), 'error'); //Output any messages that there may be $this->messages(); return false; } return true; } /** * Run through all of the settings, check if the value matches the validated value * * @param array $settings The settings array * @return boolean */ function settings_validate(array &$settings) { foreach($settings as $setting) { if(is_array($setting)) { if(!$this->settings_validate($setting)) { return false; } } else if($setting instanceof setting && $setting->get_value() !== $setting->validate($setting->get_value())) { return false; } } return true; } /** * Synchronizes the backup options entry with the current options entry */ function opts_backup() { //Set the backup options in the DB to the current options $this->update_option($this->unique_prefix . '_options_bk', $this->get_option($this->unique_prefix . '_options'), false); } /** * The new, simpler settings update loop, handles the new settings array and replaces the old opts_update_loop * * @param array $settings * @param array $input * @param bool $bool_ignore_missing */ protected function settings_update_loop(&$settings, $input, $bool_ignore_missing = false) { foreach($settings as $key => $setting) { if(is_array($setting)) { if(isset($input[$key])) { $this->settings_update_loop($settings[$key], $input[$key]); } } else if($setting instanceof setting) { $setting->maybe_update_from_form_input($input, $bool_ignore_missing); } } } /** * A better version of parse_args, will recrusivly follow arrays * * @param mixed $args The arguments to be parsed * @param mixed $defaults (optional) The default values to validate against * @return mixed */ static function parse_args($args, $defaults = '') { if(is_object($args)) { $r = get_object_vars($args); } else if(is_array($args)) { $r =& $args; } else { wp_parse_str($args, $r); } if(is_array($defaults)) { return adminKit::array_merge_recursive($defaults, $r); } return $r; } /** * An alternate version of array_merge_recursive, less flexible * still recursive, ~2x faster than the more flexible version * * @param array $arg1 first array * @param array $arg2 second array to merge into $arg1 * @return array */ static function array_merge_recursive($arg1, $arg2) { foreach($arg2 as $key => $value) { if(array_key_exists($key, $arg1) && is_array($value)) { $arg1[$key] = adminKit::array_merge_recursive($arg1[$key], $value); } else { $arg1[$key] = $value; } } return $arg1; } /** * Extracts settings values to form opts array, for old options compatibility * * @param array $settings The settings array * @return array */ static function settings_to_opts($settings) { $opts = array(); foreach ($settings as $key => $setting) { if(is_array($setting)) { $opts[$key] = adminKit::settings_to_opts($setting); } else if($setting instanceof setting) { $opts[$key] = $setting->get_value(); } } return $opts; } /** * Loop through the settings and applying opts values if found * * @param array $opts The opts array */ function load_opts_into_settings($opts) { foreach($opts as $key => $value) { if(isset($this->settings[$key]) && $this->settings[$key] instanceof setting) { $this->settings[$key]->set_value($this->settings[$key]->validate($value)); } else if(isset($this->settings[$key]) && is_array($this->settings[$key]) && is_array($value)) { foreach($value as $subkey => $subvalue) { if(isset($this->settings[$key][$subkey]) && $this->settings[$key][$subkey]instanceof setting) { $this->settings[$key][$subkey]->set_value($this->settings[$key][$subkey]->validate($subvalue)); } } } } } /** * Compares two settings by name and value to see if they are equal * * @param \mtekk\adminKit\setting\setting $a * @param \mtekk\adminKit\setting\setting $b * @return number */ function setting_equal_check($a, $b) { if(is_array($a) || is_array($b)) { foreach($a as $key=>$value) { if($value instanceof setting && isset($b[$key]) && $b[$key] instanceof setting) { return $this->setting_equal_check($value, $b[$key]); } else { return -1; } } return -1; } if($a instanceof setting && $b instanceof setting) { if($a->get_name() === $b->get_name() && $a->get_value() === $b->get_value()) { return 0; } else if($a->get_name() === $b->get_name() && $a->get_value() > $b->get_value()) { return 1; } } return -1; } static function setting_cloner($setting) { if(is_array($setting)) { return array_map('mtekk\adminKit\adminKit::setting_cloner', $setting); } if($setting instanceof setting) { return clone $setting; } } /** * Generates array of the new non-default settings based off of form input * * @param array $input The form input array of setting values * @param bool $bool_ignore_missing Tell maybe_update_from_form_input to not treat missing bool setting entries as setting to false * @return array The diff array of adminkit settings */ private function get_settings_diff($input, $bool_ignore_missing = false) { //Backup default settings //Must clone the defaults since PHP normally shallow copies $default_settings = array_map('mtekk\adminKit\adminKit::setting_cloner', $this->settings); //Run the update loop $this->settings_update_loop($this->settings, $input, $bool_ignore_missing); //Calculate diff $new_settings = apply_filters($this->unique_prefix . '_opts_update_to_save', array_udiff_assoc($this->settings, $default_settings, array($this, 'setting_equal_check'))); //Return the new settings return $new_settings; } /** * Updates the database settings from the webform * * The general flow of data is: * 1) Establish default values * 2) Merge in updates from webform * 3) Compute difference between defaults and results of #3 * 4) Save to database the difference generated in #4 */ function opts_update() { //Do some security related thigns as we are not using the normal WP settings API $this->security(); //Do a nonce check, prevent malicious link/form problems check_admin_referer($this->unique_prefix . '_options-options'); //Update local options from database $this->opt = adminKit::parse_args($this->get_option($this->unique_prefix . '_options'), $this->opt); $this->opt = apply_filters($this->unique_prefix . '_opts_update_prebk', $this->opt); //Update our backup options $this->update_option($this->unique_prefix . '_options_bk', $this->opt, false); $opt_prev = $this->opt; //Grab our incomming array (the data is dirty) $input = $_POST[$this->unique_prefix . '_options']; //Run through the loop and get the diff from detauls $new_settings = $this->get_settings_diff($input); //FIXME: Eventually we'll save the object array, but not today //Convert to opts array for saving $this->opt = adminKit::settings_to_opts($new_settings); //Commit the option changes $updated = $this->update_option($this->unique_prefix . '_options', $this->opt, true); //Check if known settings match attempted save if($updated && count(array_diff_key($input, $this->settings)) == 0) { //Let the user know everything went ok $this->messages[] = new message(esc_html__('Settings successfully saved.', $this->identifier) . $this->admin_anchor('undo', __('Undo the options save.', $this->identifier), __('Undo', $this->identifier)), 'success'); } else if(!$updated && count(array_diff_key($opt_prev, $this->settings)) == 0) { $this->messages[] = new message(esc_html__('Settings did not change, nothing to save.', $this->identifier), 'info'); } else if(!$updated) { $this->messages[] = new message(esc_html__('Settings were not saved.', $this->identifier), 'error'); } else { //Let the user know the following were not saved $this->messages[] = new message(esc_html__('Some settings were not saved.', $this->identifier) . $this->admin_anchor('undo', __('Undo the options save.', $this->identifier), __('Undo', $this->identifier)), 'warning'); $temp = esc_html__('The following settings were not saved:', $this->identifier); foreach(array_diff_key($input, $this->settings) as $setting => $value) { $temp .= '
' . $setting; } $this->messages[] = new message($temp . '
' . sprintf(esc_html__('Please include this message in your %sbug report%s.', $this->identifier), '', ''), 'info'); } add_action('admin_notices', array($this, 'messages')); } /** * Retrieves the settings from database and exports as JSON */ function settings_export() { //Do a nonce check, prevent malicious link/form problems check_admin_referer($this->unique_prefix . '_admin_import_export'); //Must clone the defaults since PHP normally shallow copies $default_settings = array_map('mtekk\adminKit\adminKit::setting_cloner', $this->settings); //Get the database options, and load //FIXME: This changes once we save settings to the db instead of opts $this->load_opts_into_settings($this->get_option($this->unique_prefix . '_options')); //Get the unique settings $export_settings = apply_filters($this->unique_prefix . '_settings_to_export', array_udiff_assoc($this->settings, $default_settings, array($this, 'setting_equal_check'))); //Change our headder to application/json for direct save header('Cache-Control: public'); //The next two will cause good browsers to download instead of displaying the file header('Content-Description: File Transfer'); header('Content-disposition: attachemnt; filename=' . $this->unique_prefix . '_settings.json'); header('Content-Type: application/json'); //JSON encode our settings array $output = json_encode( (object)array( 'plugin' => $this->short_name, 'version' => $this::version, 'settings' => $export_settings) , JSON_UNESCAPED_SLASHES, 32); //Let the browser know how long the file is header('Content-Length: ' . strlen($output)); // binary length //Output the file echo $output; //Prevent WordPress from continuing on die(); } /** * Imports JSON settings into database */ function settings_import() { //Do a nonce check, prevent malicious link/form problems check_admin_referer($this->unique_prefix . '_admin_import_export'); //Set the backup options in the DB to the current options $this->opts_backup(); //Load the user uploaded file, handle failure gracefully if(is_uploaded_file($_FILES[$this->unique_prefix . '_admin_import_file']['tmp_name'])) { //Grab the json settings from the temp file, treat as associative array so we can just throw the settings subfield at the update loop $settings_upload = json_decode(file_get_contents($_FILES[$this->unique_prefix . '_admin_import_file']['tmp_name']), true); //Only continue if we have a JSON object that is for this plugin (the the WP rest_is_object() function is handy here as the REST API passes JSON) if(rest_is_object($settings_upload) && isset($settings_upload['plugin']) && $settings_upload['plugin'] === $this->short_name) { //Act as if the JSON file was just a bunch of POST entries for a settings save //Run through the loop and get the diff from detauls $new_settings = $this->get_settings_diff($settings_upload['settings'], true); //FIXME: Eventually we'll save the object array, but not today //Convert to opts array for saving $this->opt = adminKit::settings_to_opts($new_settings); //Run opts through update script //Make sure we safely import and upgrade settings if needed $this->opts_upgrade($this->opt, $settings_upload['version']); //Commit the option changes $updated = $this->update_option($this->unique_prefix . '_options', $this->opt, true); //Check if known settings match attempted save if($updated && count(array_diff_key($settings_upload['settings'], $this->settings)) == 0) { //Let the user know everything went ok $this->messages[] = new message(esc_html__('Settings successfully imported from the uploaded file.', $this->identifier) . $this->admin_anchor('undo', __('Undo the options import.', $this->identifier), __('Undo', $this->identifier)), 'success'); } else { $this->messages[] = new message(esc_html__('No settings were imported. Settings from uploaded file matched existing settings.', $this->identifier), 'info'); } //Output any messages that there may be add_action('admin_notices', array($this, 'messages')); //And return as we're successful return; } //If it wasn't JSON, try XML else { return $this->opts_import(); } } //Throw an error since we could not load the file for various reasons $this->messages[] = new message(esc_html__('Importing settings from file failed.', $this->identifier), 'error'); } /** * Exports a XML options document */ function opts_export() { //Do a nonce check, prevent malicious link/form problems check_admin_referer($this->unique_prefix . '_admin_import_export'); //Update our internal settings $this->opt = $this->get_option($this->unique_prefix . '_options'); //Create a DOM document $dom = new \DOMDocument('1.0', 'UTF-8'); //Adds in newlines and tabs to the output $dom->formatOutput = true; //We're not using a DTD therefore we need to specify it as a standalone document $dom->xmlStandalone = true; //Add an element called options $node = $dom->createElement('options'); $parnode = $dom->appendChild($node); //Add a child element named plugin $node = $dom->createElement('plugin'); $plugnode = $parnode->appendChild($node); //Add some attributes that identify the plugin and version for the options export $plugnode->setAttribute('name', $this->short_name); $plugnode->setAttribute('version', $this::version); //Change our headder to text/xml for direct save header('Cache-Control: public'); //The next two will cause good browsers to download instead of displaying the file header('Content-Description: File Transfer'); header('Content-disposition: attachemnt; filename=' . $this->unique_prefix . '_settings.xml'); header('Content-Type: text/xml'); //Loop through the options array foreach($this->opt as $key=>$option) { if(is_array($option)) { continue; } //Add a option tag under the options tag, store the option value $node = $dom->createElement('option', htmlentities($option, ENT_COMPAT | ENT_XML1, 'UTF-8')); $newnode = $plugnode->appendChild($node); //Change the tag's name to that of the stored option $newnode->setAttribute('name', $key); } //Prepair the XML for output $output = $dom->saveXML(); //Let the browser know how long the file is header('Content-Length: ' . strlen($output)); // binary length //Output the file echo $output; //Prevent WordPress from continuing on die(); } /** * Imports a XML options document */ function opts_import() { //Our quick and dirty error supressor $error_handler = function($errno, $errstr, $eerfile, $errline, $errcontext) { return true; }; //Do a nonce check, prevent malicious link/form problems check_admin_referer($this->unique_prefix . '_admin_import_export'); //Set the backup options in the DB to the current options $this->opts_backup(); //Create a DOM document $dom = new \DOMDocument('1.0', 'UTF-8'); //We want to catch errors ourselves set_error_handler($error_handler); //Load the user uploaded file, handle failure gracefully if(is_uploaded_file($_FILES[$this->unique_prefix . '_admin_import_file']['tmp_name']) && $dom->load($_FILES[$this->unique_prefix . '_admin_import_file']['tmp_name'])) { $opts_temp = array(); $version = ''; //Have to use an xpath query otherwise we run into problems $xpath = new \DOMXPath($dom); $option_sets = $xpath->query('plugin'); //Loop through all of the xpath query results foreach($option_sets as $options) { //We only want to import options for only this plugin if($options->getAttribute('name') === $this->short_name) { //Grab the file version $version = $options->getAttribute('version'); //Loop around all of the options foreach($options->getelementsByTagName('option') as $child) { //Place the option into the option array, DOMDocument decodes html entities for us $opts_temp[$child->getAttribute('name')] = $child->nodeValue; } } } //Make sure we safely import and upgrade settings if needed $this->opts_upgrade($opts_temp, $version); //Commit the loaded options to the database $this->update_option($this->unique_prefix . '_options', $this->opt, true); //Everything was successful, let the user know $this->messages[] = new message(esc_html__('Settings successfully imported from the uploaded file.', $this->identifier) . $this->admin_anchor('undo', __('Undo the options import.', $this->identifier), __('Undo', $this->identifier)), 'success'); } else { //Throw an error since we could not load the file for various reasons $this->messages[] = new message(esc_html__('Importing settings from file failed.', $this->identifier), 'error'); } //Reset to the default error handler after we're done restore_error_handler(); //Output any messages that there may be add_action('admin_notices', array($this, 'messages')); } /** * Resets the database settings array to the default set in opt */ function opts_reset() { //Do a nonce check, prevent malicious link/form problems check_admin_referer($this->unique_prefix . '_admin_import_export'); //Set the backup options in the DB to the current options $this->opts_backup(); //Load in the hard coded default option values $this->update_option($this->unique_prefix . '_options', array(), true); //Reset successful, let the user know $this->messages[] = new message(esc_html__('Settings successfully reset to the default values.', $this->identifier) . $this->admin_anchor('undo', __('Undo the options reset.', $this->identifier), __('Undo', $this->identifier)), 'success'); add_action('admin_notices', array($this, 'messages')); } /** * Undos the last settings save/reset/import */ function opts_undo() { //Do a nonce check, prevent malicious link/form problems check_admin_referer($this->unique_prefix . '_admin_undo'); //Set the options array to the current options $opt = $this->get_option($this->unique_prefix . '_options'); //Set the options in the DB to the backup options $this->update_option($this->unique_prefix . '_options', $this->get_option($this->unique_prefix . '_options_bk'), true); //Set the backup options to the undone options $this->update_option($this->unique_prefix . '_options_bk', $opt, false); //Send the success/undo message $this->messages[] = new message(esc_html__('Settings successfully undid the last operation.', $this->identifier) . $this->admin_anchor('undo', __('Undo the last undo operation.', $this->identifier), __('Undo', $this->identifier)), 'success'); add_action('admin_notices', array($this, 'messages')); } /** * Upgrades input options array, sets to $this->opt, designed to be overwritten * * @param array $opts * @param string $version the version of the passed in options */ function opts_upgrade($opts, $version) { //We don't support using newer versioned option files in older releases if(version_compare($this::version, $version, '>=')) { $this->opt = $opts; } } /** * Forces a database settings upgrade * * FIXME: seems there is a lot of very similar code in install */ function opts_upgrade_wrapper() { //Do a nonce check, prevent malicious link/form problems check_admin_referer($this->unique_prefix . '_admin_upgrade'); //Grab the database options $opts = $this->get_option($this->unique_prefix . '_options'); if(is_array($opts)) { //Feed the just read options into the upgrade function $this->opts_upgrade($opts, $this->get_option($this->unique_prefix . '_version')); //Always have to update the version $this->update_option($this->unique_prefix . '_version', $this::version, false); //Store the options $this->update_option($this->unique_prefix . '_options', $this->opt, true); //Send the success message $this->messages[] = new message(esc_html__('Settings successfully migrated.', $this->identifier), 'success'); } else { //Run the install script $this->install(); //Send the success message $this->messages[] = new message(esc_html__('Default settings successfully installed.', $this->identifier), 'success'); } add_action('admin_notices', array($this, 'messages')); } /** * help action hook function * * @return string * */ function help() { $screen = get_current_screen(); //Exit early if the add_help_tab function doesn't exist if(!method_exists($screen, 'add_help_tab')) { return; } //Add contextual help on current screen if($screen->id == 'settings_page_' . $this->identifier) { $this->help_contents($screen); } } function help_contents(\WP_Screen &$screen) { } function dismiss_message() { //Grab the submitted UID $uid = esc_attr($_POST['uid']); //Create a dummy message, with the discovered UID $message = new message('', '', true, $uid); //Dismiss the message $message->dismiss(); wp_die(); } /** * Prints to screen all of the messages stored in the message member variable */ function messages() { foreach($this->messages as $message) { $message->render(); } //Old deprecated messages if(is_array($this->message) && count($this->message)) { _deprecated_function( __FUNCTION__, '2.0.0', __('adminKit::message is deprecated, use new adminkit_messages instead.', $this->identifier) ); //Loop through our message classes foreach($this->message as $key => $class) { //Loop through the messages in the current class foreach($class as $message) { printf('

%s

', esc_attr($key), $message); } } $this->message = array(); } $this->messages = array(); } /** * Function prototype to prevent errors */ function admin_styles() { } /** * Function prototype to prevent errors */ function admin_scripts() { } /** * Function prototype to prevent errors */ function admin_head() { } /** * Function prototype to prevent errors */ function admin_page() { } /** * Function prototype to prevent errors */ protected function _get_help_text() { } /** * Returns a valid xHTML element ID * * @param object $option * * @deprecated 7.0.0 */ static public function get_valid_id($option) { _deprecated_function( __FUNCTION__, '7.0', '\mtekk\adminKit\form::get_valid_id'); if(is_numeric($option[0])) { return 'p' . $option; } else { return $option; } } function import_form() { $form = '
'; $form .= sprintf('
', esc_attr($this->admin_url()), esc_attr($this->unique_prefix)); $form .= wp_nonce_field($this->unique_prefix . '_admin_import_export', '_wpnonce', true, false); $form .= sprintf('
', esc_attr($this->unique_prefix)); $form .= '' . esc_html__( 'Import settings', $this->identifier ) . ''; $form .= '

' . esc_html__('Import settings from a JSON or XML file, export the current settings to a JSON file, or reset to the default settings.', $this->identifier) . '

'; $form .= '
'; $form .= sprintf(''; $form .= sprintf('

', esc_attr($this->unique_prefix)); $form .= esc_html__('Select a JSON or XML settings file to upload and import settings from.', $this->identifier); $form .= '

'; $form .= sprintf('', $this->unique_prefix, esc_attr__('Import', $this->identifier)); $form .= sprintf('', $this->unique_prefix, esc_attr__('Export', $this->identifier)); $form .= sprintf('', $this->unique_prefix, esc_attr__('Reset', $this->identifier)); $form .= '

'; return $form; } /** * This will output a well formed hidden option * * @param string $option * * @deprecated 7.0.0 */ function input_hidden($option) { _deprecated_function( __FUNCTION__, '7.0', '\mtekk\adminKit\form::input_hidden'); $opt_id = adminKit::get_valid_id($option); $opt_name = $this->unique_prefix . '_options[' . $option . ']'; printf('', esc_attr($opt_name), esc_attr($opt_id), esc_attr($this->opt[$option])); } /** * This will output a well formed option label * * @param string $opt_id * @param string $label * * @deprecated 7.0.0 */ function label($opt_id, $label) { _deprecated_function( __FUNCTION__, '7.0', '\mtekk\adminKit\form::label'); printf('', esc_attr($opt_id), $label); } /** * This will output a well formed table row for a text input * * @param string $label * @param string $option * @param string $class (optional) * @param bool $disable (optional) * @param string $description (optional) * * @deprecated 7.0.0 */ function input_text($label, $option, $class = 'regular-text', $disable = false, $description = '') { _deprecated_function( __FUNCTION__, '7.0', '\mtekk\adminKit\form::input_text'); $opt_id = adminKit::get_valid_id($option); $opt_name = $this->unique_prefix . '_options[' . $option . ']'; if($disable) { $this->input_hidden($option); $class .= ' disabled'; }?> label($opt_id, $label);?>
', esc_attr($opt_name), esc_attr($opt_id), esc_attr($this->opt[$option]), esc_attr($class), disabled($disable, true, false));?>

unique_prefix . '_options[' . $option . ']'; $extras = ''; if($min !== '') { $extras .= 'min="' . esc_attr($min) . '" '; } if($max !== '') { $extras .= 'max="' . esc_attr($max) . '" '; } if($step !== '') { $extras .= 'step="' . esc_attr($step) . '" '; } if($disable) { $this->input_hidden($option); $class .= ' disabled'; }?> label($opt_id, $label);?>
', esc_attr($opt_name), esc_attr($opt_id), esc_attr($this->opt[$option]), esc_attr($class), disabled($disable, true, false), $extras);?>

unique_prefix . '_options[' . $option . ']'; $class .= ' large-text'; if($disable) { $this->input_hidden($option); $class .= ' disabled'; }?> label($opt_id, $label);?> %3$s
', esc_attr($opt_name), esc_attr($opt_id), esc_textarea($this->opt[$option]), esc_attr($class), disabled($disable, true, false), esc_attr($height));?>

input_hidden($option); $class .= ' disabled'; }?> label($opt_id, $label);?> %3$s
', esc_attr($opt_name), esc_attr($opt_id), esc_textarea($this->opt[$option]), esc_attr($class), disabled($disable, true, false), esc_attr($height));?>

unique_prefix . '_options[' . $option . ']'; if($disable) { $this->input_hidden($option); $class .= ' disabled'; }?>

unique_prefix . '_options[' . $option . ']'; $class .= ' togx'; if($disable) { $this->input_hidden($option); $class .= ' disabled'; }?>
unique_prefix . '_options[' . $option . ']'; if($disable) { $this->input_hidden($option); $class .= ' disabled'; }?> label($opt_id, $label);?> %3$s
', esc_attr($opt_name), esc_attr($opt_id), $this->select_options($option, $titles, $values), esc_attr($class), disabled($disable, true, false));?>

* * @param string $optionname name of wordpress options store * @param array $options array of names of options that can be selected * @param array $values array of the values of the options that can be selected * @param array $exclude(optional) array of names in $options array to be excluded * * @return string The assembled HTML for the select options * * @deprecated 7.0.0 */ function select_options($optionname, $options, $values, $exclude = array()) { _deprecated_function( __FUNCTION__, '7.0', '\mtekk\adminKit\form::select_options'); $options_html = ''; $value = $this->opt[$optionname]; //Now do the rest foreach($options as $key => $option) { if(!in_array($option, $exclude)) { $options_html .= sprintf('', esc_attr($values[$key]), selected($value, $values[$key], false), $option); } } return $options_html; } /** * A local pass through for get_option so that we can hook in and pick the correct method if needed * * @param string $option The name of the option to retrieve * @return mixed The value of the option */ function get_option($option) { return get_option($option); } /** * A local pass through for update_option so that we can hook in and pick the correct method if needed * * @param string $option The name of the option to update * @param mixed $newvalue The new value to set the option to */ function update_option($option, $newvalue, $autoload = null) { return update_option($option, $newvalue, $autoload); } /** * A local pass through for add_option so that we can hook in and pick the correct method if needed * * @param string $option The name of the option to update * @param mixed $value The new value to set the option to * @param null $deprecated Deprecated parameter * @param string $autoload Whether or not to autoload the option, it's a string because WP is special */ function add_option($option, $value = '', $deprecated = '', $autoload = 'yes') { return add_option($option, $value, null, $autoload); } /** * A local pass through for delete_option so that we can hook in and pick the correct method if needed * * @param string $option The name of the option to delete */ function delete_option($option) { return delete_option($option); } }includes/adminKit/class-mtekk_adminkit_message.php000064400000006557147206607170016454 0ustar00contents = $contents; $this->type = $type; $this->dismissible = $dismissible; $this->uid = $uid; if($this->dismissible) { $this->dismissed = $this->was_dismissed(); } } /** * Attempts to retrieve the dismissal transient for this message * * @return bool Whether or not the message has been dismissed */ public function was_dismissed() { $this->dismissed = get_transient($this->uid); return $this->dismissed; } /** * Dismisses the message, preventing it from being rendered */ public function dismiss() { if($this->dismissible && isset($_POST['uid']) && esc_attr($_POST['uid']) === $this->uid) { check_ajax_referer($this->uid . '_dismiss', 'nonce'); $this->dismissed = true; //If the message was dismissed, update the transient for 30 days $result = set_transient($this->uid, $this->dismissed, 2592000); } } /** * Function that prints out the message if not already dismissed */ public function render() { if($this->dismissible) { //Don't render dismissed messages if($this->was_dismissed()) { return; } wp_enqueue_script('mtekk_adminkit_messages'); printf('

%2$s

', esc_attr($this->type), $this->contents, esc_attr($this->uid), wp_create_nonce($this->uid . '_dismiss')); } else { printf('

%2$s

', esc_attr($this->type), $this->contents); } } }includes/adminKit/setting/class-mtekk_adminkit_setting_float.php000064400000003502147206607170021332 0ustar00name = $name; $this->value = $value; $this->title = $title; $this->allow_empty = $allow_empty; $this->deprecated = $deprecated; } /** * */ public function validate($new_value) { return (float) $new_value; } /** * * {@inheritDoc} * @see \mtekk\adminKit\setting\setting_base::jsonSerialize() */ public function jsonSerialize(): float { return $this->value; } /** * * {@inheritDoc} * @see \mtekk\adminKit\setting\setting::get_opt_name() */ public function get_opt_name() { return 'f' . $this->get_name(); } }includes/adminKit/setting/class-mtekk_adminkit_setting_html.php000064400000003662147206607170021200 0ustar00name = $name; $this->value = $value; $this->title = $title; $this->allow_empty = $allow_empty; $this->deprecated = $deprecated; } /** * */ public function validate($new_value) { if(!$this->allow_empty && $new_value === '') { return $this->value; } return wp_kses(stripslashes($new_value), apply_filters('mtekk_adminkit_allowed_html', wp_kses_allowed_html('post'))); } /** * * {@inheritDoc} * @see \mtekk\adminKit\setting\setting::get_opt_name() */ public function get_opt_name() { if($this->allow_empty) { $type = 'h'; } else { $type = 'H'; } return $type . $this->get_name(); } }includes/adminKit/setting/php7/class-mtekk_adminkit_setting_float.php000064400000003240147206607170022207 0ustar00name = $name; $this->value = $value; $this->title = $title; $this->allow_empty = $allow_empty; $this->deprecated = $deprecated; } /** * */ public function validate($new_value) { return (float) $new_value; } /** * * {@inheritDoc} * @see \mtekk\adminKit\setting\setting::get_opt_name() */ public function get_opt_name() { return 'f' . $this->get_name(); } }includes/adminKit/setting/php7/class-mtekk_adminkit_setting_bool.php000064400000004257147206607170022046 0ustar00name = $name; $this->value = $value; $this->title = $title; $this->allow_empty = $allow_empty; $this->deprecated = $deprecated; } /** * */ public function validate($new_value) { return (bool) $new_value; } /** * * {@inheritDoc} * @see \mtekk\adminKit\setting\setting::get_opt_name() */ public function get_opt_name() { return 'b' . $this->get_name(); } /** * * {@inheritDoc} * @see mtekk_adminKit_setting::updateFromFormInput() */ public function maybe_update_from_form_input($input, $bool_ignore_missing = false) { if(isset($input[$this->get_opt_name()]) && ($input[$this->get_opt_name()] === true || $input[$this->get_opt_name()] === '1')) { $newval = true; } else { //If the value wasn't set, but we are to ignore missing inputs if($bool_ignore_missing) { return; } $newval = false; } $this->set_value($this->validate($newval)); } } includes/adminKit/setting/php7/class-mtekk_adminkit_setting_int.php000064400000003232147206607170021675 0ustar00name = $name; $this->value = $value; $this->title = $title; $this->allow_empty = $allow_empty; $this->deprecated = $deprecated; } /** * */ public function validate($new_value) { return (int) $new_value; } /** * * {@inheritDoc} * @see \mtekk\adminKit\setting\setting::get_opt_name() */ public function get_opt_name() { return 'i' . $this->get_name(); } }includes/adminKit/setting/php7/class-mtekk_adminkit_setting_base.php000064400000004262147206607170022021 0ustar00deprecated; } public function set_deprecated($deprecated) { $this->deprecated = $deprecated; } public function get_value() { return $this->value; } public function set_value($new_value) { $this->value = $new_value; } public function get_title() { return $this->title; } public function get_name() { return $this->name; } public function get_allow_empty() { return $this->allow_empty; } public function set_allow_empty($allow_empty) { $this->allow_empty = $allow_empty; } public function jsonSerialize() { return $this->value; } /** * Basic updateFromFormInput method * * {@inheritDoc} * @see mtekk\adminKit\setting::maybe_update_from_form_input() */ public function maybe_update_from_form_input($input, $bool_ignore_missing = false) { if(isset($input[$this->get_opt_name()])) { $this->set_value($this->validate($input[$this->get_opt_name()])); } } }includes/adminKit/setting/interface-mtekk_adminkit_setting.php000064400000003510147206607170020777 0ustar00name = $name; $this->value = $value; $this->title = $title; $this->allow_empty = $allow_empty; $this->deprecated = $deprecated; } /** * */ public function validate($new_value) { return (bool) $new_value; } /** * * {@inheritDoc} * @see \mtekk\adminKit\setting\setting_base::jsonSerialize() */ public function jsonSerialize(): bool { return $this->value; } /** * * {@inheritDoc} * @see \mtekk\adminKit\setting\setting::get_opt_name() */ public function get_opt_name() { return 'b' . $this->get_name(); } /** * * {@inheritDoc} * @see mtekk_adminKit_setting::updateFromFormInput() */ public function maybe_update_from_form_input($input, $bool_ignore_missing = false) { if(isset($input[$this->get_opt_name()]) && ($input[$this->get_opt_name()] === true || $input[$this->get_opt_name()] === '1')) { $newval = true; } else { //If the value wasn't set, but we are to ignore missing inputs if($bool_ignore_missing) { return; } $newval = false; } $this->set_value($this->validate($newval)); } } includes/adminKit/setting/class-mtekk_adminkit_setting_enum.php000064400000004612147206607170021174 0ustar00name = $name; $this->value = $value; $this->title = $title; $this->deprecated = $deprecated; $this->allow_empty = $allow_empty; $this->allowed_vals= $allowed_vals; } /** * Validates the new value against the allowed values for this setting * * {@inheritDoc} * @see mtekk_adminKit_setting::validate() */ public function validate($new_value) { if(in_array($new_value, $this->allowed_vals)) { return $new_value; } else { return $this->value; } } /** * * {@inheritDoc} * @see \mtekk\adminKit\setting\setting::get_opt_name() */ public function get_opt_name() { return 'E' . $this->get_name(); } /** * Setter for the allowed values array * * @param array $allowed_vals Array of allowed values */ public function set_allowed_vals(array $allowed_vals) { $this->allowed_vals = $allowed_vals; } /** * Getter of the allowed values array * * @return array Allowed values used in validation of the setting */ public function get_allowed_vals() { return $this->allowed_vals; } }includes/adminKit/setting/class-mtekk_adminkit_setting_string.php000064400000003532147206607170021536 0ustar00name = $name; $this->value = $value; $this->title = $title; $this->allow_empty = $allow_empty; $this->deprecated = $deprecated; } /** * */ public function validate($new_value) { if(!$this->allow_empty && $new_value === '') { return $this->value; } return esc_html($new_value); } /** * * {@inheritDoc} * @see \mtekk\adminKit\setting\setting::get_opt_name() */ public function get_opt_name() { if($this->allow_empty) { $type = 's'; } else { $type = 'S'; } return $type . $this->get_name(); } }includes/adminKit/setting/class-mtekk_adminkit_setting_int.php000064400000003472147206607170021025 0ustar00name = $name; $this->value = $value; $this->title = $title; $this->allow_empty = $allow_empty; $this->deprecated = $deprecated; } /** * */ public function validate($new_value) { return (int) $new_value; } /** * * {@inheritDoc} * @see \mtekk\adminKit\setting\setting_base::jsonSerialize() */ public function jsonSerialize(): int { return $this->value; } /** * * {@inheritDoc} * @see \mtekk\adminKit\setting\setting::get_opt_name() */ public function get_opt_name() { return 'i' . $this->get_name(); } }includes/adminKit/setting/class-mtekk_adminkit_setting_absint.php000064400000002477147206607170021517 0ustar00get_name(); } }includes/adminKit/setting/class-mtekk_adminkit_setting_base.php000064400000004263147206607170021144 0ustar00deprecated; } public function set_deprecated($deprecated) { $this->deprecated = $deprecated; } public function get_value() { return $this->value; } public function set_value($new_value) { $this->value = $new_value; } public function get_title() { return $this->title; } public function get_name() { return $this->name; } public function get_allow_empty() { return $this->allow_empty; } public function set_allow_empty($allow_empty) { $this->allow_empty = $allow_empty; } public function jsonSerialize(): mixed { return $this->value; } /** * Basic updateFromFormInput method * * {@inheritDoc} * @see mtekk\adminKit\setting::maybe_update_from_form_input() */ public function maybe_update_from_form_input($input, $bool_ignore_missing = false) { if(isset($input[$this->get_opt_name()])) { $this->set_value($this->validate($input[$this->get_opt_name()])); } } }includes/adminKit/assets/mtekk_adminkit_messages.js000064400000000541147206607170016646 0ustar00jQuery(function() { jQuery("div.notice button.notice-dismiss").click(function (event){ data = { 'action': 'mtekk_admin_message_dismiss', 'uid': jQuery(this).parent().children("meta[property='uid']").attr("content"), 'nonce': jQuery(this).parent().children("meta[property='nonce']").attr("content") }; jQuery.post(ajaxurl, data); }); });includes/adminKit/assets/mtekk_adminkit_tabs.js000064400000002531147206607170015771 0ustar00jQuery(function() { mtekk_admin_tabulator_init(); }); /** * Tabulator Bootup */ function mtekk_admin_tabulator_init(){ if(!jQuery("#hasadmintabs").length) return; /* init markup for tabs */ jQuery('#hasadmintabs').prepend('