";
}
}
/**
* Renders an option whose type is "sortable-list". Invoked by add_settings_field.
*
* @param $value
* @return void
*/
function create_section_for_sortable_list($value) {
global $suffusion_options;
$this->create_opening_tag($value);
if (!isset($suffusion_options[$value['id']])) {
$list_order = $value['std'];
}
else {
$list_order = $suffusion_options[$value['id']];
}
if (is_array($list_order)) { // The order has not been set. These are the default values
$list_order_array = $list_order;
$list_order = implode(',', array_keys($list_order_array));
}
else { // The order may have been set. We need to reconcile any additions / deletions from the standard list.
$defaults = $value['std'];
$keys = explode(',',$list_order);
$clean_keys = array();
$list_order_array = array();
foreach ($keys as $key) {
if (isset($defaults[$key])) {
$clean_keys[] = $key;
$list_order_array[$key] = $defaults[$key];
}
}
foreach ($defaults as $key => $key_value) {// Checking for additions
if (!in_array($key, $clean_keys)) {
$clean_keys[] = $key;
$list_order_array[$key] = $key_value;
}
}
$list_order = implode(',', $clean_keys);
}
?>
\n";
/* foreach ($list_order_array as $list_item) {
echo "
\n";
}
}
echo "\n";
}
/**
* Retrieves the sections for a given submenu page.
*
* @param $sub_menu
* @return array
*/
function get_sections_for_submenu($sub_menu) {
$options = $this->options;
$ret = array();
if ($sub_menu == "all") {
return $options;
}
foreach ($options as $value) {
if (isset($value['parent']) && $value['parent'] == $sub_menu) {
$ret[] = $value;
}
}
return $ret;
}
/**
* Makes calls to add_settings_field for different types of options.
*
* @param $section
* @param $parent
* @return void
*/
function add_settings_fields($section, $parent) {
$filtered_options = $this->get_sections_for_submenu($section);
$ctr = 0;
foreach ($filtered_options as $value) {
if (isset($value['conditional']) && true === $value['conditional']) {
$show = true;
if (isset($value['conditions'])) {
$conditions = $value['conditions'];
$show = $this->evaluate_conditions($conditions);
}
if (!$show) {
continue;
}
}
$ctr++;
switch ($value['type']) {
case "title":
add_settings_field('', '', array(&$this, "create_title"), $parent, $section, $value);
break;
case "sub-section-2":
add_settings_field('', '', array(&$this, "create_suf_header_2"), $parent, $section, $value);
break;
case "sub-section-3":
add_settings_field('', '', array(&$this, "create_suf_header_3"), $parent, $section, $value);
break;
case "sub-section-4":
add_settings_field($section.'-'.$ctr, '', array(&$this, "create_suf_grouping"), $parent, $section, $value);
break;
case "text";
add_settings_field($value['id'], '', array(&$this, "create_section_for_text"), $parent, $section, $value);
break;
case "textarea":
add_settings_field($value['id'], '', array(&$this, "create_section_for_textarea"), $parent, $section, $value);
break;
case "select":
add_settings_field($value['id'], '', array(&$this, "create_section_for_select"), $parent, $section, $value);
break;
case "multi-select":
add_settings_field($value['id'], '', array(&$this, "create_section_for_multi_select"), $parent, $section, $value);
break;
case "radio":
add_settings_field($value['id'], '', array(&$this, "create_section_for_radio"), $parent, $section, $value);
break;
case "checkbox":
add_settings_field($value['id'], '', array(&$this, "create_section_for_checkbox"), $parent, $section, $value);
break;
case "color-picker":
add_settings_field($value['id'], '', array(&$this, "create_section_for_color_picker"), $parent, $section, $value);
break;
case "upload";
add_settings_field($value['id'], '', array(&$this, "create_section_for_upload"), $parent, $section, $value);
break;
case "sortable-list":
add_settings_field($value['id'], '', array(&$this, "create_section_for_sortable_list"), $parent, $section, $value);
break;
case "slider":
add_settings_field($value['id'], '', array(&$this, "create_section_for_slider"), $parent, $section, $value);
break;
case "background":
add_settings_field($value['id'], '', array(&$this, "create_section_for_background"), $parent, $section, $value);
break;
case "border":
add_settings_field($value['id'], '', array(&$this, "create_section_for_border"), $parent, $section, $value);
break;
case "font":
add_settings_field($value['id'], '', array(&$this, "create_section_for_font"), $parent, $section, $value);
break;
case "associative-array":
add_settings_field($value['id'], '', array(&$this, 'create_section_for_associative_array'), $parent, $section, $value);
break;
case "blurb":
add_settings_field($section.'-'.$ctr, '', array(&$this, "create_section_for_blurb"), $parent, $section, $value);
break;
case "button":
add_settings_field($value['id'], '', array(&$this, "create_section_for_button"), $parent, $section, $value);
break;
}
}
}
/**
* Controls the display of conditional fields.
*
* @param $conditions
* @return bool
*/
function evaluate_conditions($conditions) {
// Operators: NOT, OR, AND, NOR, NAND. XOR is too complex
if (isset($conditions['operator'])) {
$operator = $conditions['operator'];
}
else {
$operator = 'OR';
}
$nested_conditions = $conditions['conditions'];
if (isset($nested_conditions['operator'])) {
return $this->evaluate_conditions($nested_conditions);
}
else {
$evals = array();
foreach ($nested_conditions as $variable => $check_value) {
$suf_variable = 'suf_'.$variable;
global $$suf_variable;
$actual_value = $$suf_variable;
if ($operator == 'NOT') {
return $actual_value != $check_value;
}
else {
$evals[] = $actual_value == $check_value ? 1 : 0;
}
}
return $this->array_join_boolean($evals, $operator);
}
}
function array_join_boolean($conditions, $operator) {
if (count($conditions) == 1) {
return $conditions[0];
}
else {
$first = $conditions[0];
$rest = array_slice($conditions, 1);
if ($operator == 'AND') {
$result = $first * $this->array_join_boolean($rest, $operator);
return $result != 0;
}
else if ($operator == 'NOR') {
$result = $first + $this->array_join_boolean($rest, $operator);
return $result == 0;
}
else if ($operator == 'NAND') {
$result = $first * $this->array_join_boolean($rest, $operator);
return $result == 0;
}
else { // Everything else is treated as OR
$result = $first + $this->array_join_boolean($rest, $operator);
return $result != 0;
}
}
}
/**
* Top level rendering call for a sub-menu page. This in turn invokes the rendering calls for individual sections (tabs) within
* a sub-menu page.
*
* @param $option_structure
* @return void
*/
function get_options_html($option_structure = null) {
if (is_null($option_structure)) {
$option_structure = $this->get_option_structure();
}
foreach ($option_structure as $l1) {
if (!isset($l1['parent']) || $l1['parent'] == null) {
foreach ($l1['children'] as $l2slug => $l2name) {
$this->get_options_html_for_group($option_structure, $l2slug);
}
}
}
}
/**
* Registers settings, then adds individual settings sections and their fields to the queue for rendering. The result of this
* is used by do_settings_sections.
*
* @param $structure
* @return void
*
* @uses register_setting
* @uses add_settings_section
* @uses $this->add_settings_fields
*/
function initialize_settings($structure = null) {
$options = $this->options;
if (is_null($structure)) {
$structure = $this->get_option_structure($options);
}
foreach ($structure as $option_entity) {
if (!isset($option_entity['parent'])) {
// Do nothing. This is the root node.
}
else if (isset($option_entity['parent']) && $option_entity['parent'] == 'root') {
// This is the sub-menu that we are seeing. Options have already been registered for each of these.
// If we weren't using tabs for building the options page we would have registered suffusion-options-$option_entity['slug'] here.
// register_setting('suffusion-options-'.$option_entity['slug'], 'suffusion_options', array(&$this, "validate_options"));
}
else if (isset($option_entity['parent']) && $option_entity['parent'] != 'root') {
// This is a section under the current sub-menu. Let's add sections and options
register_setting('suffusion-options-'.$option_entity['slug'], 'suffusion_options', array(&$this, "validate_options"));
add_settings_section($option_entity['slug'], "", array(&$this, "create_settings_section"), $this->file);
$this->add_settings_fields($option_entity['slug'], $this->file);
}
}
}
/**
* Validates the inputs provided by users. For now:
* 1. All text type of options including slider, color-picture etc. are simply checked for special characters
* 2. Radio buttons/select items are checked for presence in a master list defined by the 'options' key in the inbuilt options array
* 3. Each item in Multi-select and sortable-list fields is checked against a master list defined by the 'options' key in the options array
*
* @param $options
* @return array|void
*/
function validate_options($options) {
foreach ($options as $option => $option_value) {
if (isset($this->reverse_options[$option])) {
//Sanitize options
switch ($this->reverse_options[$option]) {
// For all text type of options make sure that the eventual text is properly escaped.
case "text":
case "textarea":
case "slider":
case "color-picker":
case "background":
case "border":
case "font":
case "upload":
case "template":
case "associative-array":
$options[$option] = esc_attr($option_value);
break;
case "select":
case "radio":
if (isset($this->allowed_values[$option])) {
if (!array_key_exists($option_value, $this->allowed_values[$option])) {
$options[$option] = $this->option_defaults[$option];
}
}
break;
case "multi-select":
if (is_array($option_value)) {
$selections = $option_value;
}
else {
$selections = explode(',', $option_value);
}
$final_selections = array();
foreach ($selections as $selection) {
if (array_key_exists($selection, $this->allowed_values[$option])) {
$final_selections[] = $selection;
}
}
$options[$option] = implode(',', $final_selections);
break;
case "sortable-list":
if (is_array($option_value)) {
$selections = $option_value;
}
else {
$selections = explode(',', $option_value);
}
$final_selections = array();
$master_list = $this->option_defaults[$option]; // Sortable lists don't have their values in ['options']
foreach ($selections as $selection) {
if (array_key_exists($selection, $master_list)) {
$final_selections[] = $selection;
}
}
$options[$option] = implode(',', $final_selections);
break;
case "checkbox":
if (!in_array($option_value, array('on', 'off', 'true', 'false')) && isset($this->option_defaults[$option])) {
$options[$option] = $this->option_defaults[$option];
}
break;
}
}
}
/* The Settings API does an update_option($option, $value), overwriting the $suffusion_options array with the values on THIS page
* This is problematic because all options are stored in a single array, but are displayed on different options pages.
* Hence the overwrite kills the options from the other pages.
* So this is a workaround to include the options from other pages as hidden fields on this page, so that the array gets properly updated.
* The alternative would be to separate options for each page, but that would cause a migration headache for current users.
*/
if (isset($this->hidden_options) && is_array($this->hidden_options)) {
foreach ($this->hidden_options as $hidden_option => $hidden_value) {
if (strlen($hidden_option) >= 7 && (substr($hidden_option, 0, 7) == 'submit-' || substr($hidden_option, 0, 6) == 'reset-')) {
continue;
}
$options[$hidden_option] = esc_attr($hidden_value);
}
}
foreach ($this->nested_options as $section => $children) {
if (isset($options['submit-'.$section])) {
$options['last-set-section'] = $section;
if (substr($options['submit-'.$section], 0, 9) == 'Save page' || substr($options['submit-'.$section], 0, 10) == 'Reset page') {
global $suffusion_options;
foreach ($this->nested_options as $inner_section => $inner_children) {
if ($inner_section != $section) {
foreach ($inner_children as $inner_child) {
if (isset($suffusion_options[$inner_child])) {
$options[$inner_child] = $suffusion_options[$inner_child];
}
}
}
}
if (substr($options['submit-'.$section], 0, 10) == 'Reset page') {
unset($options['submit-'.$section]);
// This is a reset for an individual section. So we will unset the child fields.
foreach ($children as $child) {
unset($options[$child]);
}
}
unset($options['submit-'.$section]);
}
else if (substr($options['submit-'.$section], 0, 12) == 'Save changes') {
unset($options['submit-'.$section]);
}
else if (substr($options['submit-'.$section], 0, 13) == 'Reset changes') {
unset($options['submit-'.$section]);
// This is a reset for all options in the sub-menu. So we will unset all child fields.
foreach ($this->nested_options as $section => $children) {
foreach ($children as $child) {
unset($options[$child]);
}
}
}
else if (substr($options['submit-'.$section], 0, 6) == 'Delete') {
return;
}
else if ($options['submit-'.$section] == 'Migrate from 3.0.2 or lower') {
unset($options['submit-'.$section]);
$options = $this->migrate_from_v302($options);
}
else if ($options['submit-'.$section] == 'Migrate from 3.4.3 or lower') {
unset($options['submit-'.$section]);
$options = $this->migrate_from_v343($options);
}
else if ($options['submit-'.$section] == 'Export core options to a file') {
$this->export_settings('core');
}
else if ($options['submit-'.$section] == 'Export all options to a file') {
$this->export_settings('all');
}
else if ($options['submit-'.$section] == 'Import options') {
$options = $this->import_settings($options);
}
break;
}
}
$options['theme-version'] = SUFFUSION_THEME_VERSION;
$options['option-date'] = date(get_option('date_format').' '.get_option('time_format'));
$options = array_merge(suffusion_default_options(), $options);
return $options;
}
/**
* Workaround for the default behavior in do_settings_sections. Native WP behaviour has this markup:
*
Section Title
*
*
*
Field 1 title
*
Result of callback defined for field 1
*
*
*
Field 2 title
*
Result of callback defined for field 2
*
* ...
*
* This doesn't work well if you need to do tabbed layouts or accordions etc. Hence we kill the section's h3 tag and
* don't print the field titles. We also include section-specific floating button-bars.
*
* @param $section
* @return void
*/
function create_settings_section($section) {
$option_structure = $this->option_structure;
if ($this->displayed_sections != 0) {
echo "\n";
echo "\n";
}
echo "