Breadcrumb NavXT.
Version: 4.0.1
Author: John Havlik
Author URI: http://mtekk.us/
License: GPL2
TextDomain: breadcrumb_navxt
DomainPath: /languages/
*/
/* Copyright 2007-2012 John Havlik (email : mtekkmonkey@gmail.com)
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
//Do a PHP version check, require 5.2 or newer
if(version_compare(phpversion(), '5.2.0', '<'))
{
//Only purpose of this function is to echo out the PHP version error
function bcn_phpold()
{
printf('
' . __('Your PHP version is too old, please upgrade to a newer version. Your version is %s, Breadcrumb NavXT requires %s', 'breadcrumb_navxt') . '
', phpversion(), '5.2.0');
}
//If we are in the admin, let's print a warning then return
if(is_admin())
{
add_action('admin_notices', 'bcn_phpold');
}
return;
}
if(!function_exists('mb_strlen'))
{
require_once(dirname(__FILE__) . '/includes/multibyte_supplicant.php');
}
//Include the breadcrumb class
require_once(dirname(__FILE__) . '/breadcrumb_navxt_class.php');
//Include the WP 2.8+ widget class
require_once(dirname(__FILE__) . '/breadcrumb_navxt_widget.php');
//Include admin base class
if(!class_exists('mtekk_adminKit'))
{
require_once(dirname(__FILE__) . '/includes/mtekk_adminkit.php');
}
/**
* The administrative interface class
*
*/
class bcn_admin extends mtekk_adminKit
{
protected $version = '4.0.50';
protected $full_name = 'Breadcrumb NavXT Settings';
protected $short_name = 'Breadcrumb NavXT';
protected $access_level = 'manage_options';
protected $identifier = 'breadcrumb_navxt';
protected $unique_prefix = 'bcn';
protected $plugin_basename = 'breadcrumb-navxt/breadcrumb_navxt_admin.php';
protected $support_url = 'http://mtekk.us/archives/wordpress/plugins-wordpress/breadcrumb-navxt-';
public $breadcrumb_trail;
/**
* Administrative interface class default constructor
*/
function bcn_admin()
{
//We'll let it fail fataly if the class isn't there as we depend on it
$this->breadcrumb_trail = new bcn_breadcrumb_trail;
//Grab defaults from the breadcrumb_trail object
$this->opt = $this->breadcrumb_trail->opt;
//We need to add in the defaults for CPTs and custom taxonomies after all other plugins are loaded
add_action('wp_loaded', array($this, 'wp_loaded'));
//We set the plugin basename here, could manually set it, but this is for demonstration purposes
//$this->plugin_basename = plugin_basename(__FILE__);
//Register the WordPress 2.8 Widget
add_action('widgets_init', create_function('', 'return register_widget("'. $this->unique_prefix . '_widget");'));
//We're going to make sure we load the parent's constructor
parent::__construct();
}
/**
* admin initialization callback function
*
* is bound to wpordpress 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();
}
function wp_loaded()
{
//First make sure our defaults are safe
$this->find_posttypes($this->opt);
$this->find_taxonomies($this->opt);
}
/**
* 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.', 'breadcrumb_navxt'));
}
}
/**
* 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)
{
global $wp_post_types;
//If our version is not the same as in the db, time to update
if($version !== $this->version)
{
//Upgrading to 3.8.1
if(version_compare($version, '3.8.1', '<'))
{
$opts['post_page_root'] = get_option('page_on_front');
$opts['post_post_root'] = get_option('page_for_posts');
}
//Upgrading to 4.0
if(version_compare($version, '4.0.0', '<'))
{
//Only migrate if we haven't migrated yet
if(isset($opts['current_item_linked']))
{
//Loop through the old options, migrate some of them
foreach($opts as $option => $value)
{
//Handle all of our boolean options first, they're real easy, just add a 'b'
if(strpos($option, 'display') > 0 || $option == 'current_item_linked')
{
$this->breadcrumb_trail->opt['b'.$option] = $value;
}
//Handle migration of anchor templates to the templates
else if(strpos($option, 'anchor') > 0)
{
$parts = explode('_', $option);
//Do excess slash removal sanitation
$this->breadcrumb_trail->opt['H' . $parts[0] . '_template'] = $value . '%htitle%';
}
//Handle our abs integers
else if($option == 'max_title_length' || $option == 'post_post_root' || $option == 'post_page_root')
{
$this->breadcrumb_trail->opt['a' . $option] = $value;
}
//Now everything else, minus prefix and suffix
else if(strpos($option, 'prefix') === false && strpos($option, 'suffix') === false)
{
$this->breadcrumb_trail->opt['S' . $option] = $value;
}
}
}
//Add in the new settings for CPTs introduced in 4.0
foreach($wp_post_types as $post_type)
{
//We only want custom post types
if(!$post_type->_builtin)
{
//Add in the archive_display option
$this->breadcrumb_trail->opt['bpost_' . $post_type->name . '_archive_display'] = $post_type->has_archive;
}
}
$opts = $this->breadcrumb_trail->opt;
}
if(version_compare($version, '4.0.1', '<'))
{
if(isset($opts['Hcurrent_item_template_no_anchor']))
{
unset($opts['Hcurrent_item_template_no_anchor']);
}
if(isset($opts['Hcurrent_item_template']))
{
unset($opts['Hcurrent_item_template']);
}
}
//Add custom post types
$this->find_posttypes($opts);
//Add custom taxonomy types
$this->find_taxonomies($opts);
//Save the passed in opts to the object's option array
$this->opt = $opts;
}
}
/**
* 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)
{
$general_tab = '' . __('Tips for the settings are located below select options.', $this->identifier) .
'
' . __('Resources', $this->identifier) . '
- ' .
sprintf(__("%sTutorials and How Tos%s: There are several guides, tutorials, and how tos available on the author's website.", $this->identifier),'', '') . '
- ' .
sprintf(__('%sOnline Documentation%s: Check out the documentation for more indepth technical information.', 'breadcrumb_navxt'), '', '') . '
- ' .
sprintf(__('%sReport a Bug%s: If you think you have found a bug, please include your WordPress version and details on how to reproduce the bug.', $this->identifier),'', '') . '
' .
'' . __('Giving Back', $this->identifier) . '
- ' .
sprintf(__('%sDonate%s: Love Breadcrumb NavXT and want to help development? Consider buying the author a beer.', $this->identifier),'', '') . '
- ' .
sprintf(__('%sTranslate%s: Is your language not available? Contact John Havlik to get translating.', $this->identifier),'', '') . '
';
$screen->add_help_tab(
array(
'id' => $this->identifier . '-base',
'title' => __('General', $this->identifier),
'content' => $general_tab
));
$quickstart_tab = '' . __('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') .
'
' . __('Breadcrumb trail with separators', 'breadcrumb_navxt') . '
<div class="breadcrumbs">' . "
<?php if(function_exists('bcn_display'))
{
bcn_display();
}?>
</div>
" .
'' . __('Breadcrumb trail in list form', 'breadcrumb_navxt').'
<ol class="breadcrumbs">'."
<?php if(function_exists('bcn_display_list'))
{
bcn_display_list();
}?>
</ol>
";
$screen->add_help_tab(
array(
'id' => $this->identifier . '-quick-start',
'title' => __('Quick Start', $this->identifier),
'content' => $quickstart_tab
));
$styling_tab = '' . __('Using the code from the Quick Start section above, the following CSS can be used as base for styling your breadcrumb trail.', $this->identifier) . '
' .
'.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', $this->identifier),
'content' => $styling_tab
));
$screen->add_help_tab(
array(
'id' => $this->identifier . '-import-export-reset',
'title' => __('Import/Export/Reset', $this->identifier),
'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', $this->identifier),
'mtad_export' => __('Export', $this->identifier),
'mtad_reset' => __('Reset', $this->identifier),
));
}
/**
* The administrative page for Breadcrumb NavXT
*/
function admin_page()
{
global $wp_taxonomies, $wp_post_types;
$this->security();
//Let's call the parent version of the page, will handle our setting stuff
parent::admin_page();
?>
version_check(get_option($this->unique_prefix . '_version')))
{
return;
}
?>
import_form(); ?>
find_posttypes($this->opt);
//Add custom taxonomy types
$this->find_taxonomies($this->opt);
}
/**
* Places settings into $opts array, if missing, for the registered post types
*
* @param array $opts
*/
function find_posttypes(&$opts)
{
global $wp_post_types, $wp_taxonomies;
//Loop through all of the post types in the array
foreach($wp_post_types as $post_type)
{
//We only want custom post types
if(!$post_type->_builtin)
{
//If the post type does not have settings in the options array yet, we need to load some defaults
if(!array_key_exists('Hpost_' . $post_type->name . '_template', $opts) || !$post_type->hierarchical && !array_key_exists('Spost_' . $post_type->name . '_taxonomy_type', $opts))
{
//Add the necessary option array members
$opts['Hpost_' . $post_type->name . '_template'] = __('%htitle%', 'breadcrumb_navxt');
$opts['Hpost_' . $post_type->name . '_template_no_anchor'] = __('%htitle%', 'breadcrumb_navxt');
$opts['bpost_' . $post_type->name . '_archive_display'] = $post_type->has_archive;
//Do type dependent tasks
if($post_type->hierarchical)
{
//Set post_root for hierarchical types
$opts['apost_' . $post_type->name . '_root'] = get_option('page_on_front');
}
//If it is flat, we need a taxonomy selection
else
{
//Set post_root for flat types
$opts['apost_' . $post_type->name . '_root'] = get_option('page_for_posts');
}
//Default to not displaying a taxonomy
$opts['bpost_' . $post_type->name . '_taxonomy_display'] = false;
//Loop through all of the possible taxonomies
foreach($wp_taxonomies as $taxonomy)
{
//Activate the first taxonomy valid for this post type and exit the loop
if($taxonomy->object_type == $post_type->name || in_array($post_type->name, $taxonomy->object_type))
{
$opts['bpost_' . $post_type->name . '_taxonomy_display'] = true;
$opts['Spost_' . $post_type->name . '_taxonomy_type'] = $taxonomy->name;
break;
}
}
//If there are no valid taxonomies for this type, we default to not displaying taxonomies for this post type
if(!isset($opts['Spost_' . $post_type->name . '_taxonomy_type']))
{
$opts['Spost_' . $post_type->name . '_taxonomy_type'] = 'date';
}
}
}
}
}
/**
* Places settings into $opts array, if missing, for the registered taxonomies
*
* @param $opts
*/
function find_taxonomies(&$opts)
{
global $wp_taxonomies;
//We'll add our custom taxonomy stuff at this time
foreach($wp_taxonomies as $taxonomy)
{
//We only want custom taxonomies
if(!$taxonomy->_builtin)
{
//If the taxonomy does not have settings in the options array yet, we need to load some defaults
if(!array_key_exists('H' . $taxonomy->name . '_template', $opts))
{
//Add the necessary option array members
$opts['H' . $taxonomy->name . '_template'] = __(sprintf('%%htitle%%', $taxonomy->labels->singular_name), 'breadcrumb_navxt');
$opts['H' . $taxonomy->name . '_template_no_anchor'] = __(sprintf('%%htitle%%', $taxonomy->labels->singular_name), 'breadcrumb_navxt');
}
}
}
}
/**
* Outputs the breadcrumb trail
*
* @param (bool) $return Whether to return or echo the trail.
* @param (bool) $linked Whether to allow hyperlinks in the trail or not.
* @param (bool) $reverse Whether to reverse the output or not.
*/
function display($return = false, $linked = true, $reverse = false)
{
//Grab the current settings from the db
$this->breadcrumb_trail->opt = wp_parse_args(get_option('bcn_options'), $this->breadcrumb_trail->opt);
//Generate the breadcrumb trail
$this->breadcrumb_trail->fill();
return $this->breadcrumb_trail->display($return, $linked, $reverse);
}
/**
* Outputs the breadcrumb trail
*
* @since 3.2.0
* @param (bool) $return Whether to return or echo the trail.
* @param (bool) $linked Whether to allow hyperlinks in the trail or not.
* @param (bool) $reverse Whether to reverse the output or not.
*/
function display_list($return = false, $linked = true, $reverse = false)
{
//Grab the current settings from the db
$this->breadcrumb_trail->opt = wp_parse_args(get_option('bcn_options'), $this->breadcrumb_trail->opt);
//Generate the breadcrumb trail
$this->breadcrumb_trail->fill();
return $this->breadcrumb_trail->display_list($return, $linked, $reverse);
}
}
//Let's make an instance of our object takes care of everything
$bcn_admin = new bcn_admin;
/**
* A wrapper for the internal function in the class
*
* @param bool $return Whether to return or echo the trail. (optional)
* @param bool $linked Whether to allow hyperlinks in the trail or not. (optional)
* @param bool $reverse Whether to reverse the output or not. (optional)
*/
function bcn_display($return = false, $linked = true, $reverse = false)
{
global $bcn_admin;
if($bcn_admin !== null)
{
return $bcn_admin->display($return, $linked, $reverse);
}
}
/**
* A wrapper for the internal function in the class
*
* @param bool $return Whether to return or echo the trail. (optional)
* @param bool $linked Whether to allow hyperlinks in the trail or not. (optional)
* @param bool $reverse Whether to reverse the output or not. (optional)
*/
function bcn_display_list($return = false, $linked = true, $reverse = false)
{
global $bcn_admin;
if($bcn_admin !== null)
{
return $bcn_admin->display_list($return, $linked, $reverse);
}
}