Location: PHPKode > scripts > TablePress > tablepress/controllers/controller-frontend.php
<?php
/**
 * Frontend Controller for TablePress with functionality for the frontend
 *
 * @package TablePress
 * @subpackage Controllers
 * @author Tobias Bäthge
 * @since 1.0.0
 */

// Prohibit direct script loading
defined( 'ABSPATH' ) || die( 'No direct script access allowed!' );

/**
 * Frontend Controller class, extends Base Controller Class
 * @package TablePress
 * @subpackage Controllers
 * @author Tobias Bäthge
 * @since 1.0.0
 */
class TablePress_Frontend_Controller extends TablePress_Controller {

	/**
	 * List of tables that are shown for the current request
	 *
	 * @since 1.0.0
	 *
	 * @var array
	 */
	protected $shown_tables = array();

	/**
	 * Initiate Frontend functionality
	 *
	 * @since 1.0.0
	 */
	public function __construct() {
		parent::__construct();

		// enqueue CSS files
		if ( apply_filters( 'tablepress_use_default_css', true ) || $this->model_options->get( 'use_custom_css' ) )
			add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_css' ) );

		// add DataTables invocation calls
		add_action( 'wp_print_footer_scripts', array( $this, 'add_datatables_calls' ), 11 ); // after inclusion of files

		// Remove WP-Table Reloaded Shortcodes and CSS, and add TablePress Shortcodes
		add_action( 'init', array( $this, 'init_shortcodes' ), 20 ); // run on priority 20 as WP-Table Reloaded Shortcodes are registered at priority 10

		// make TablePress Shortcodes work in text widgets
		add_filter( 'widget_text', array( $this, 'widget_text_filter' ) );

		// extend WordPress Search to also find posts/pages that have a table with the one of the search terms in title (if shown), description (if shown), or content
		if ( apply_filters( 'tablepress_wp_search_integration', true ) )
			add_filter( 'posts_search', array( $this, 'posts_search_filter' ) );

		// load Template Tag functions
		require_once TABLEPRESS_ABSPATH . 'controllers/template-tag-functions.php';
	}

	/**
	 * Register TablePress Shortcodes, after removing WP-Table Reloaded Shortcodes
	 *
	 * @since 1.0.0
	 */
	public function init_shortcodes() {
		// Remove previously registered [table /] Shortcodes (e.g. from WP-Table Reloaded), as these would otherwise be used instead of TablePress's Shortcodes
		remove_shortcode( TablePress::$shortcode );
		remove_shortcode( TablePress::$shortcode_info );
		// Dequeue WP-Table Relaoded Default CSS, as it can influence TablePress table styling
		if ( isset( $GLOBALS['WP_Table_Reloaded_Frontend'] ) )
			remove_action( 'wp_head', array( $GLOBALS['WP_Table_Reloaded_Frontend'], 'add_frontend_css' ) );

		add_shortcode( TablePress::$shortcode, array( $this, 'shortcode_table' ) );
		add_shortcode( TablePress::$shortcode_info, array( $this, 'shortcode_table_info' ) );
	}

	/**
	 * Enqueue CSS files for default CSS and "Custom CSS" (if desired)
	 *
	 * @since 1.0.0
	 */
	public function enqueue_css() {
		// add "Default CSS"
		$use_default_css = apply_filters( 'tablepress_use_default_css', true );
		if ( $use_default_css ) {
			$rtl = ( is_rtl() ) ? '-rtl' : '';
			$suffix = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
			$default_css_url = plugins_url( "css/default{$rtl}{$suffix}.css", TABLEPRESS__FILE__ );
			$default_css_url = apply_filters( 'tablepress_default_css_url', $default_css_url );
			wp_enqueue_style( 'tablepress-default', $default_css_url, array(), TablePress::version );
		}

		// add "Custom CSS"
		if ( $this->model_options->get( 'use_custom_css' ) ) {
			$print_custom_css_inline = true; // will be overwritten if file is used
			if ( $this->model_options->get( 'use_custom_css_file' ) ) {
				// fall back to "Custom CSS" in options, if it could not be retrieved from file
				$custom_css_file_contents = '';
				if ( ! defined( 'SCRIPT_DEBUG' ) || ! SCRIPT_DEBUG ) {
					$custom_css_file_contents = $this->model_options->load_custom_css_from_file( 'minified' );
					$custom_css_file_type = 'minified';
				}
				if ( empty( $custom_css_file_contents ) ) {
					$custom_css_file_contents = $this->model_options->load_custom_css_from_file( 'normal' );
					$custom_css_file_type = 'normal';
				}
				if ( ! empty( $custom_css_file_contents ) ) {
					$print_custom_css_inline = false;
					$custom_css_url = $this->model_options->get_custom_css_location( $custom_css_file_type, 'url' );
					$custom_css_dependencies = array();
					if ( $use_default_css )
						$custom_css_dependencies[] = 'tablepress-default'; // if default CSS is desired, but also handled internally
					$custom_css_version = apply_filters( 'tablepress_custom_css_version', $this->model_options->get( 'custom_css_version' ) );
					wp_enqueue_style( 'tablepress-custom', $custom_css_url, $custom_css_dependencies, $custom_css_version );
				}
			}

			if ( $print_custom_css_inline ) {
				// get "Custom CSS" from options
				$custom_css = trim( $this->model_options->get( 'custom_css' ) );
				$custom_css = apply_filters( 'tablepress_custom_css', $custom_css );
				if ( ! empty( $custom_css ) ) {
					// wp_add_inline_style() requires a loaded CSS file, so we have to work around that if "Default CSS" is disabled
					if ( $use_default_css )
						wp_add_inline_style( 'tablepress-default', $custom_css ); // handle of the file to which the <style> shall be appended
					else
						add_action( 'wp_head', array( $this, '_print_custom_css' ), 8 ); // priority 8 to hook in right after WP_Styles has been processed
				}
			}
		}
	}

	/**
	 * Print "Custom CSS" to "wp_head" inline; Necessary if "Default CSS" is off, and saving "Custom CSS" to a file is not possible
	 *
	 * @since 1.0.0
	 */
	public function _print_custom_css() {
		$custom_css = trim( $this->model_options->get( 'custom_css' ) );
		$custom_css = apply_filters( 'tablepress_custom_css', $custom_css );
		echo "<style type='text/css'>\n{$custom_css}\n</style>\n";
	}

	/**
	 * Enqueue the DataTables JavaScript library (and jQuery)
	 *
	 * @since 1.0.0
	 */
	protected function _enqueue_datatables() {
		$js_file = 'js/jquery.datatables.min.js';
		$js_url = plugins_url( $js_file, TABLEPRESS__FILE__ );
		$js_url = apply_filters( 'tablepress_datatables_js_url', $js_url, $js_file );
		wp_enqueue_script( 'jquery' );
		wp_enqueue_script( 'tablepress-datatables', $js_url, array( 'jquery' ), TablePress::version, true );
	}

	/**
	 * Add JS code for invocation of DataTables JS library
	 *
	 * @since 1.0.0
	 */
	public function add_datatables_calls() {
		if ( empty( $this->shown_tables ) )
			return; // there are no tables with activated DataTables

		// storage for the DataTables languages
		$datatables_languages = array();
		// generate the specific JS commands, depending on chosen features on the "Edit" screen and the Shortcode parameters
		$commands = array();

		foreach ( $this->shown_tables as $table_id => $table_store ) {
			if ( empty( $table_store['instances'] ) )
				continue;
			foreach ( $table_store['instances'] as $html_id => $js_options ) {
				$parameters = array();

				// Settle dependencies/conflicts between certain features
				if ( false !== $js_options['datatables_scrolly'] ) // not necessarily a boolean!
					$js_options['datatables_paginate'] = false; // vertical scrolling and pagination don't work together
				$js_options['datatables_paginate_entries'] = intval( $js_options['datatables_paginate_entries'] ); // Sanitize, as it may come from Shortcode attribute

				// DataTables language/translation handling
				$datatables_locale = apply_filters( 'tablepress_datatables_locale', $js_options['datatables_locale'], $table_id );
				// only do the expensive language file checks if they haven't been done yet
				if ( ! isset( $datatables_languages[ $datatables_locale ] ) ) {
					$orig_language_file = TABLEPRESS_ABSPATH . "i18n/datatables/lang-{$datatables_locale}.js";
					$language_file = apply_filters( 'tablepress_datatables_language_file', $orig_language_file, $datatables_locale, TABLEPRESS_ABSPATH ); // make sure to check file_exists( $new_file ) when using this filter!
					// load translation if it's not "en_US" (included as the default in DataTables) and the language file exists, or if the filter was used to change the language file
					if ( ( 'en_US' != $datatables_locale && file_exists( $language_file ) )
						|| ( $orig_language_file != $language_file ) )
						$datatables_languages[ $datatables_locale ] = $language_file;
				}
				// if translation is registered to have its strings added to the JS, add corresponding parameter to DataTables call
				if ( isset( $datatables_languages[ $datatables_locale ] ) )
					$parameters['oLanguage'] = '"oLanguage":DataTables_oLanguage["' . $datatables_locale . '"]';
				// these parameters need to be added for performance gain or to overwrite unwanted default behavior
				$parameters['aaSorting'] = '"aaSorting":[]'; // no initial sort
				$parameters['bSortClasses'] = '"bSortClasses":false'; // don't add additional classes, to speed up sorting
				$parameters['asStripeClasses'] = '"asStripeClasses":' . ( ( $js_options['alternating_row_colors'] ) ? "['even','odd']" : '[]' ); // alternating row colors is default, so remove them if not wanted with []
				// the following options are activated by default, so we only need to "false" them if we don't want them, but don't need to "true" them if we do
				if ( ! $js_options['datatables_sort'] )
					$parameters['bSort'] = '"bSort":false';
				if ( $js_options['datatables_paginate'] ) {
					if ( $js_options['datatables_lengthchange'] ) {
						$length_menu = array( 10, 25, 50, 100 );
						if ( ! in_array( $js_options['datatables_paginate_entries'], $length_menu, true ) ) {
							$length_menu[] = $js_options['datatables_paginate_entries'];
							sort( $length_menu, SORT_NUMERIC );
							$parameters['aLengthMenu'] = '"aLengthMenu":[' . implode( ',', $length_menu ) . ']';
						}
					} else {
						$parameters['bLengthChange'] = '"bLengthChange":false';
					}
					if ( 10 != $js_options['datatables_paginate_entries'] )
						$parameters['iDisplayLength'] = '"iDisplayLength":'. $js_options['datatables_paginate_entries'];
				} else {
					$parameters['bPaginate'] = '"bPaginate":false';
				}
				if ( ! $js_options['datatables_filter'] )
					$parameters['bFilter'] = '"bFilter":false';
				if ( ! $js_options['datatables_info'] )
					$parameters['bInfo'] = '"bInfo":false';
				if ( $js_options['datatables_scrollx'] )
					$parameters['sScrollX'] = '"sScrollX":"100%"';
				if ( false !== $js_options['datatables_scrolly'] ) {
					$parameters['sScrollY'] = '"sScrollY":"' . preg_replace( '#[^0-9a-z.%]#', '', $js_options['datatables_scrolly'] ) . '"';
					$parameters['bScrollCollapse'] = '"bScrollCollapse":true';
				}
				if ( ! empty( $js_options['datatables_custom_commands'] ) )
					$parameters['custom_commands'] = $js_options['datatables_custom_commands'];

				$parameters = apply_filters( 'tablepress_datatables_parameters', $parameters, $table_id, $html_id, $js_options );

				// if an existing parameter is set in "Custom Commands", remove their default value
				if ( isset( $parameters['custom_commands'] ) ) {
					foreach ( array_keys( $parameters ) as $maybe_overwritten_parameter ) {
						if ( false !== strpos( $parameters['custom_commands'], $maybe_overwritten_parameter ) )
							unset( $parameters[ $maybe_overwritten_parameter ] );
					}
				}

				$parameters = implode( ',', $parameters );
				$parameters = ( ! empty( $parameters ) ) ? '{' . $parameters . '}' : '';

				$command = "$('#{$html_id}').dataTable({$parameters});";
				$command = apply_filters( 'tablepress_datatables_command', $command, $html_id, $parameters, $table_id, $js_options );
				if ( ! empty( $command ) )
					$commands[] = $command;
			}
		}

		$commands = implode( "\n", $commands );
		$commands = apply_filters( 'tablepress_all_datatables_commands', $commands );
		if ( empty( $commands ) )
			return;

		// DataTables language/translation handling
		$datatables_strings = '';
		foreach ( $datatables_languages as $locale => $language_file ) {
			$strings = file_get_contents( $language_file );
			// remove unnecessary white space
			$strings = str_replace( array( "\n", "\r", "\t" ), '', $strings );
			$datatables_strings .= "DataTables_oLanguage[\"{$locale}\"]={$strings};\n";
		}
		if ( ! empty( $datatables_strings ) )
			$datatables_strings = "var DataTables_oLanguage={};\n" . $datatables_strings;

		// echo DataTables strings and JS calls
		echo <<<JS
<script type="text/javascript">
jQuery(document).ready(function($){
{$datatables_strings}{$commands}
});
</script>
JS;
	}

	/**
	 * Handle Shortcode [table id=<ID> /] in the_content()
	 *
	 * @since 1.0.0
	 *
	 * @param array $shortcode_atts List of attributes that where included in the Shortcode
	 * @return string Resulting HTML code for the table with the ID <ID>
	 */
	public function shortcode_table( $shortcode_atts ) {
		$_render = TablePress::load_class( 'TablePress_Render', 'class-render.php', 'classes' );

		$default_shortcode_atts = $_render->get_default_render_options();
		$default_shortcode_atts = apply_filters( 'tablepress_shortcode_table_default_shortcode_atts', $default_shortcode_atts );
		// parse Shortcode attributes, only allow those that are specified
		$shortcode_atts = shortcode_atts( $default_shortcode_atts, $shortcode_atts ); // Optional third argument left out on purpose. Use filter in the next line instead.
		$shortcode_atts = apply_filters( 'tablepress_shortcode_table_shortcode_atts', $shortcode_atts );

		// check, if a table with the given ID exists
		$table_id = preg_replace( '/[^a-zA-Z0-9_-]/', '', $shortcode_atts['id'] );
		if ( ! $this->model_table->table_exists( $table_id ) ) {
			$message = "[table &#8220;{$table_id}&#8221; not found /]<br />\n";
			$message = apply_filters( 'tablepress_table_not_found_message', $message, $table_id );
			return $message;
		}

		// load the table
		$table = $this->model_table->load( $table_id );
		if ( false === $table ) {
			$message = "[table &#8220;{$table_id}&#8221; could not be loaded /]<br />\n";
			$message = apply_filters( 'tablepress_table_load_error_message', $message, $table_id );
			return $message;
		}

		// Disable the "datatables_custom_commands" Shortcode parameter by default, for security reasons
		if ( ! is_null( $shortcode_atts['datatables_custom_commands'] ) && apply_filters( 'tablepress_disable_custom_commands_shortcode_parameter', true ) )
			$shortcode_atts['datatables_custom_commands'] = null;

		// determine options to use (if set in Shortcode, use those, otherwise use stored options, i.e. "Edit Table" screen)
		$render_options = array();
		foreach ( $shortcode_atts as $key => $value ) {
			// have to check this, because strings 'true' or 'false' are not recognized as boolean!
			if ( 'true' == strtolower( $value ) )
				$render_options[$key] = true;
			elseif ( 'false' == strtolower( $value ) )
				$render_options[$key] = false;
			elseif ( is_null( $value ) && isset( $table['options'][$key] ) )
				$render_options[$key] = $table['options'][$key];
			else
				$render_options[$key] = $value;
		}

		// generate unique HTML ID, depending on how often this table has already been shown on this page
		if ( ! isset( $this->shown_tables[$table_id] ) ) {
			$this->shown_tables[$table_id] = array(
				'count' => 0,
				'instances' => array()
			);
		}
		$this->shown_tables[$table_id]['count']++;
		$count = $this->shown_tables[$table_id]['count'];
		$render_options['html_id'] = "tablepress-{$table_id}";
		if ( $count > 1 )
			$render_options['html_id'] .= "-no-{$count}";
		$render_options['html_id'] = apply_filters( 'tablepress_html_id', $render_options['html_id'], $table_id, $count );

		// generate "Edit Table" link
		$render_options['edit_table_url'] = '';
		if ( is_user_logged_in() && apply_filters( 'tablepress_edit_link_below_table', true ) && current_user_can( 'tablepress_edit_table', $table['id'] ) )
			$render_options['edit_table_url'] = TablePress::url( array( 'action' => 'edit', 'table_id' => $table['id'] ) );

		$render_options = apply_filters( 'tablepress_table_render_options', $render_options, $table );

		// eventually add this table to list of tables which have a JS library enabled and thus are to be included in the script's call in the footer
		if ( $render_options['use_datatables'] && $render_options['table_head'] && count( $table['data'] ) > 1 ) {
			// get options for the DataTables JavaScript library from the table's render options
			$js_options = array();
			foreach ( array( 'alternating_row_colors', 'datatables_sort', 'datatables_paginate',
								'datatables_paginate', 'datatables_paginate_entries', 'datatables_lengthchange',
								'datatables_filter', 'datatables_info', 'datatables_scrollx', 'datatables_scrolly',
								'datatables_locale', 'datatables_custom_commands' ) as $option ) {
				$js_options[ $option ] = $render_options[ $option ];
			}
			$js_options = apply_filters( 'tablepress_table_js_options', $js_options, $table_id, $render_options ); // need this filter to e.g. set JS parameters depending on Shortcode attributes
			$this->shown_tables[$table_id]['instances'][ $render_options['html_id'] ] = $js_options;
			$this->_enqueue_datatables();
		}

		// check if table output shall and can be loaded from the transient cache, otherwise generate the output
		if ( $render_options['cache_table_output'] && ! is_user_logged_in() ) {
			$table_hash = md5( json_encode( $render_options ) ); // hash the Render Options array to get a unique cache identifier
			$transient_name = 'tablepress_' . $table_hash; // Attention: This string must not be longer than 45 characters!
			$output = get_transient( $transient_name );
			if ( false === $output || '' == $output ) {
				// render/generate the table HTML, as it was not found in the cache
				$_render->set_input( $table, $render_options );
				$output = $_render->get_output();
				// save output to a transient
				set_transient( $transient_name, $output, DAY_IN_SECONDS ); // store $output in a transient, set cache timeout to 24 hours
				// update output caches list transient (necessary for cache invalidation upon table saving)
				$caches_list_transient_name = 'tablepress_c_' . md5( $table_id );
				$caches_list = get_transient( $caches_list_transient_name );
				if ( false === $caches_list )
					$caches_list = array();
				else
					$caches_list = json_decode( $caches_list, true );
				if ( ! in_array( $transient_name, $caches_list, true ) )
					$caches_list[] = $transient_name;
				set_transient( $caches_list_transient_name, json_encode( $caches_list ), 2*DAY_IN_SECONDS );
			} else {
				$output .= apply_filters( 'tablepress_cache_hit_comment', "<!-- #{$render_options['html_id']} from cache -->" );
			}
		} else {
			// render/generate the table HTML, as no cache is to be used
			$_render->set_input( $table, $render_options );
			$output = $_render->get_output();
		}

		return $output;
	}

	/**
	 * Handle Shortcode [table-info id=<ID> field=<name> /] in the_content()
	 *
	 * @since 1.0.0
	 *
	 * @param array $atts list of attributes that where included in the Shortcode
	 * @return string Text that replaces the Shortcode (error message or asked-for information)
	 */
	public function shortcode_table_info( $shortcode_atts ) {
		// parse Shortcode attributes, only allow those that are specified
		$default_shortcode_atts = array(
				'id' => 0,
				'field' => '',
				'format' => ''
		);
		$default_shortcode_atts = apply_filters( 'tablepress_shortcode_table_info_default_shortcode_atts', $default_shortcode_atts );
		$shortcode_atts = shortcode_atts( $default_shortcode_atts, $shortcode_atts ); // Optional third argument left out on purpose. Use filter in the next line instead.
		$shortcode_atts = apply_filters( 'tablepress_shortcode_table_info_shortcode_atts', $shortcode_atts );

		// allow a filter to determine behavior of this function, by overwriting its behavior, just need to return something other than false
		$overwrite = apply_filters( 'tablepress_shortcode_table_info_overwrite', false, $shortcode_atts );
		if ( $overwrite )
			return $overwrite;

		// check, if a table with the given ID exists
		$table_id = preg_replace( '/[^a-zA-Z0-9_-]/', '', $shortcode_atts['id'] );
		if ( ! $this->model_table->table_exists( $table_id ) ) {
			$message = "[table &#8220;{$table_id}&#8221; not found /]<br />\n";
			$message = apply_filters( 'tablepress_table_not_found_message', $message, $table_id );
			return $message;
		}

		// load the table
		$table = $this->model_table->load( $table_id );
		if ( false === $table ) {
			$message = "[table &#8220;{$table_id}&#8221; could not be loaded /]<br />\n";
			$message = apply_filters( 'tablepress_table_load_error_message', $message, $table_id );
			return $message;
		}

		$field = preg_replace( '/[^a-z_]/', '', strtolower( $shortcode_atts['field'] ) );
		$format = preg_replace( '/[^a-z]/', '', strtolower( $shortcode_atts['format'] ) );

		// generate output, depending on what information (field) was asked for
		switch ( $field ) {
			case 'name':
			case 'description':
				$output = $table[ $field ];
				break;
			case 'last_modified':
				switch ( $format ) {
					case 'raw':
						$output = $table['last_modified'];
						break 2;
					case 'human':
						$modified_timestamp = strtotime( $table['last_modified'] );
						$current_timestamp = current_time( 'timestamp' );
						$time_diff = $current_timestamp - $modified_timestamp;
						if ( $time_diff >= 0 && $time_diff < DAY_IN_SECONDS ) // time difference is only shown up to one day
							$output = sprintf( __( '%s ago', 'tablepress' ), human_time_diff( $modified_timestamp, $current_timestamp ) );
						else
							$output = TablePress::format_datetime( $table['last_modified'], 'mysql', '<br />' );
						break 2;
					case 'mysql':
					default:
						$output = TablePress::format_datetime( $table['last_modified'], 'mysql', ' ' );
						break 2;
				}
				break;
			case 'last_editor':
				$output = TablePress::get_user_display_name( $table['options']['last_editor'] );
				break;
			case 'author':
				$output = TablePress::get_user_display_name( $table['author'] );
				break;
			case 'number_rows':
				$output = count( $table['data'] );
				if ( 'raw' != $format ) {
					if ( $table['options']['table_head'] )
						$output = $output - 1;
					if ( $table['options']['table_foot'] )
						$output = $output - 1;
				}
				break;
			case 'number_columns':
				$output = count( $table['data'][0] );
				break;
			default:
				$output = "[table-info field &#8220;{$field}&#8221; not found in table &#8220;{$table_id}&#8221; /]<br />\n";
				$output = apply_filters( 'tablepress_table_info_not_found_message', $output, $table, $field, $format );
		}

		$output = apply_filters( 'tablepress_shortcode_table_info_output', $output, $table, $shortcode_atts );
		return $output;
	}

	/**
	 * Handle Shortcodes in text widgets, by temporarily removing all Shortcodes, registering only the plugin's two,
	 * running WP's Shortcode routines, and then restoring old behavior/Shortcodes
	 *
	 * @since 1.0.0
	 * @uses $shortcode_tags global variable
	 *
	 * @param string $content Text content of the text widget, will be searched for one of TablePress's Shortcodes
	 * @return string Text of the text widget, with eventually found Shortcodes having been replaced by corresponding output
	 */
	public function widget_text_filter( $content ) {
		global $shortcode_tags;
		// backup the currently registered Shortcodes and clear the global array
		$orig_shortcode_tags = $shortcode_tags;
		$shortcode_tags = array();
		// register TablePress's Shortcodes (which are then the only ones registered)
		add_shortcode( TablePress::$shortcode_info, array( $this, 'shortcode_table_info' ) );
		add_shortcode( TablePress::$shortcode, array( $this, 'shortcode_table' ) );
		// do the WP Shortcode routines on the widget text (i.e. search for TablePress's Shortcodes)
		$content = do_shortcode( $content );
		// restore the original Shortcodes (which includes TablePress's Shortcodes, for use in posts and pages)
		$shortcode_tags = $orig_shortcode_tags;
		return $content;
	}

	/**
	 * Expand WP Search to also find posts and pages that have a search term in a table that is shown in them
	 *
	 * This is done by looping through all search terms and TablePress tables and searching there for the search term,
	 * saving all tables's IDs that have a search term and then expanding the WP query to search for posts or pages that have the
	 * Shortcode for one of these tables in their content.
	 *
	 * @since 1.0.0
	 * @uses $wpdb
	 *
	 * @param string $search Current part of the "WHERE" clause of the SQL statement used to get posts/pages from the WP database that is related to searching
	 * @return string Eventually extended SQL "WHERE" clause, to also find posts/pages with Shortcodes in them
	 */
	public function posts_search_filter( $search_sql ) {
		if ( ! is_search() )
			return $search_sql;

		global $wpdb;

		// get variable that contains all search terms, parsed from $_GET['s'] by WP
		$search_terms = get_query_var( 'search_terms' );
		if ( empty( $search_terms ) || ! is_array( $search_terms ) )
			return $search_sql;

		// load all tables, and remove hidden cells, as those will not be searched
		// do this here once, so that we don't have to do it in each loop for each search term again
		$search_tables = array();
		$tables = $this->model_table->load_all(); // does not contain table data
		foreach ( $tables as $table_id => $table ) {
			$table = $this->model_table->load( $table_id ); // load table again, to also get table data
			// load information about hidden rows and columns
			$hidden_rows = array_keys( $table['visibility']['rows'], 0 ); // get indexes of hidden rows (array value of 0))
			$hidden_columns = array_keys( $table['visibility']['columns'], 0 ); // get indexes of hidden columns (array value of 0))
			// remove hidden rows and re-index
			foreach ( $hidden_rows as $row_idx ) {
				unset( $table['data'][$row_idx] );
			}
			$table['data'] = array_merge( $table['data'] );
			// remove hidden columns and re-index
			foreach ( $table['data'] as $row_idx => $row ) {
				foreach ( $hidden_columns as $col_idx ) {
					unset( $row[$col_idx] );
				}
				$table['data'][$row_idx] = array_merge( $row );
			}

			// @TODO: Cells are not evaluated here, so math formulas are searched

			// add name and description to searched items, if they are displayed with the table
			$table_name = ( $table['options']['print_name'] ) ? $table['name'] : '';
			$table_description = ( $table['options']['print_description'] ) ? $table['description'] : '';

			$search_tables[ $table_id ] = array(
				'data' => $table['data'],
				'name' => $table_name,
				'description' => $table_description
			);
		}

		// for all search terms loop through all tables's cells (those cells are all visible, because we filtered before!)
		$query_result = array(); // array of all search words that were found, and the table IDs where they were found
		foreach ( $search_terms as $search_term ) {
			$search_term = addslashes_gpc( $search_term ); // escapes with esc_sql
			foreach ( $search_tables as $table_id => $table ) {
				if ( false !== stripos( $table['name'], $search_term ) || false !== stripos( $table['description'], $search_term ) ) {
					// we found the $search_term in the name or description (and they are shown)
					$query_result[ $search_term ][] = $table_id; // add table ID to result list
					continue; // don't need to search through this table any further, continue with next table
				}
				foreach ( $table['data'] as $table_row ) {
					foreach ( $table_row as $table_cell ) {
						if ( false !== stripos( $table_cell, $search_term ) ) {
							// we found the $search_term in the cell
							$query_result[ $search_term ][] = $table_id; // add table ID to result list
							break 2; // don't need to search through this table any further, "2" means that we leave both foreach loops
						}
					}
				}
			}
		}

		// for all found table IDs for each search term, add additional OR statement to the SQL "WHERE" clause
		$exact = get_query_var( 'exact' ); // if $_GET['exact'] is set, WordPress doesn't use % in SQL LIKE clauses
		$n = ( empty( $exact ) ) ? '%' : '';
		foreach ( $query_result as $search_term => $tables ) {
			$old_or = "OR ({$wpdb->posts}.post_content LIKE '{$n}{$search_term}{$n}')";
			$table_ids = implode( '|', $tables );
			$regexp = '\\\\[table id=(["\\\']?)(' . $table_ids . ')(["\\\' /])'; // ' needs to be single escaped, [ double escaped (with \\) in mySQL
			$new_or = $old_or . " OR ({$wpdb->posts}.post_content REGEXP '{$regexp}')";
			$search_sql = str_replace( $old_or, $new_or, $search_sql );
		}

		return $search_sql;
	}

} // class TablePress_Frontend_Controller
Return current item: TablePress