|
// +----------------------------------------------------------------------+
/**
* Base class for all modules. Implements routine methods required by all modules.
*
* @category Visualizer
* @package Module
*
* @since 1.0.0
*/
class Visualizer_Module {
/**
* The instance of wpdb class.
*
* @since 1.0.0
*
* @access protected
* @var wpdb
*/
protected $_wpdb = null;
/**
* The plugin instance.
*
* @since 1.0.0
*
* @access protected
* @var Visualizer_Plugin
*/
protected $_plugin = null;
/**
* Constructor.
*
* @since 1.0.0
* @global wpdb $wpdb Current database connection.
*
* @access public
* @param Visualizer_Plugin $plugin The instance of the plugin.
*/
public function __construct( Visualizer_Plugin $plugin ) {
global $wpdb;
$this->_wpdb = $wpdb;
$this->_plugin = $plugin;
}
/**
* Registers an action hook.
*
* @since 1.0.0
* @uses add_action() To register action hook.
*
* @access protected
* @param string $tag The name of the action to which the $method is hooked.
* @param string $method The name of the method to be called.
* @param bool $methodClass The root of the method.
* @param int $priority optional. Used to specify the order in which the functions associated with a particular action are executed (default: 10). Lower numbers correspond with earlier execution, and functions with the same priority are executed in the order in which they were added to the action.
* @param int $accepted_args optional. The number of arguments the function accept (default 1).
* @return Visualizer_Module
*/
protected function _addAction( $tag, $method, $methodClass = null, $priority = 10, $accepted_args = 1 ) {
add_action( $tag, array( $methodClass ? $methodClass : $this, $method ), $priority, $accepted_args );
return $this;
}
/**
* Registers AJAX action hook.
*
* @since 1.0.0
*
* @access public
* @param string $tag The name of the AJAX action to which the $method is hooked.
* @param string $method Optional. The name of the method to be called. If the name of the method is not provided, tag name will be used as method name.
* @param bool $methodClass The root of the method.
* @param boolean $private Optional. Determines if we should register hook for logged in users.
* @param boolean $public Optional. Determines if we should register hook for not logged in users.
* @return Visualizer_Module
*/
protected function _addAjaxAction( $tag, $method = '', $methodClass = null, $private = true, $public = false ) {
if ( $private ) {
$this->_addAction( 'wp_ajax_' . $tag, $method, $methodClass );
}
if ( $public ) {
$this->_addAction( 'wp_ajax_nopriv_' . $tag, $method, $methodClass );
}
return $this;
}
/**
* Registers a filter hook.
*
* @since 1.0.0
* @uses add_filter() To register filter hook.
*
* @access protected
* @param string $tag The name of the filter to hook the $method to.
* @param type $method The name of the method to be called when the filter is applied.
* @param int $priority optional. Used to specify the order in which the functions associated with a particular action are executed (default: 10). Lower numbers correspond with earlier execution, and functions with the same priority are executed in the order in which they were added to the action.
* @param int $accepted_args optional. The number of arguments the function accept (default 1).
* @return Visualizer_Module
*/
protected function _addFilter( $tag, $method, $priority = 10, $accepted_args = 1 ) {
add_filter( $tag, array( $this, $method ), $priority, $accepted_args );
return $this;
}
/**
* Registers a hook for shortcode tag.
*
* @since 1.0.0
* @uses add_shortcode() To register shortcode hook.
*
* @access protected
* @param string $tag Shortcode tag to be searched in post content.
* @param string $method Hook to run when shortcode is found.
* @return Visualizer_Module
*/
protected function _addShortcode( $tag, $method ) {
add_shortcode( $tag, array( $this, $method ) );
return $this;
}
/**
* Extracts the data for a chart and prepares it for the given type.
*
* @access public
* @param int $chart_id The chart id.
* @param string $type The exported type.
*/
public function _getDataAs( $chart_id, $type ) {
$final = null;
$success = false;
if ( $chart_id ) {
$chart = get_post( $chart_id );
$success = $chart && $chart->post_type == Visualizer_Plugin::CPT_VISUALIZER;
}
if ( $success ) {
$settings = get_post_meta( $chart_id, Visualizer_Plugin::CF_SETTINGS, true );
$rows = array();
$series = get_post_meta( $chart_id, Visualizer_Plugin::CF_SERIES, true );
$data = unserialize( $chart->post_content );
if ( ! empty( $series ) ) {
$row = array();
foreach ( $series as $array ) {
$row[] = $array['label'];
}
$rows[] = $row;
$row = array();
foreach ( $series as $array ) {
$row[] = $array['type'];
}
$rows[] = $row;
}
if ( ! empty( $data ) ) {
foreach ( $data as $array ) {
// ignore strings
if ( ! is_array( $array ) ) {
continue;
}
// if this is an array of arrays...
if ( is_array( $array[0] ) ) {
foreach ( $array as $arr ) {
$rows[] = $arr;
}
} else {
// just an array
$rows[] = $array;
}
}
}
$filename = isset( $settings['title'] ) && ! empty( $settings['title'] ) ? $settings['title'] : 'visualizer#' . $chart_id;
switch ( $type ) {
case 'csv':
$final = $this->_getCSV( $rows, $filename );
break;
case 'xls':
$final = $this->_getExcel( $rows, $filename );
break;
case 'print':
$final = $this->_getHTML( $rows );
break;
}
}
return $final;
}
/**
* Prepares a CSV.
*
* @access private
* @param array $rows The array of data.
* @param string $filename The name of the file to use.
*/
private function _getCSV( $rows, $filename ) {
$filename .= '.csv';
$fp = tmpfile();
// support for MS Excel
fprintf( $fp, $bom = ( chr( 0xEF ) . chr( 0xBB ) . chr( 0xBF ) ) );
foreach ( $rows as $row ) {
fputcsv( $fp, $row );
}
rewind( $fp );
$csv = '';
while ( ( $array = fgetcsv( $fp ) ) !== false ) {
if ( strlen( $csv ) > 0 ) {
$csv .= PHP_EOL;
}
$csv .= implode( ',', $array );
}
fclose( $fp );
return array(
'csv' => $csv,
'name' => $filename,
);
}
/**
* Prepares an Excel file.
*
* @access private
* @param array $rows The array of data.
* @param string $filename The name of the file to use.
*/
private function _getExcel( $rows, $filename ) {
// PHPExcel does not like sheet names longer than 31 characters.
$chart = substr( $filename, 0, 30 );
$filename .= '.xlsx';
$xlsData = '';
if ( class_exists( 'PHPExcel' ) ) {
$doc = new PHPExcel();
$doc->getActiveSheet()->fromArray( $rows, null, 'A1' );
$doc->getActiveSheet()->setTitle( $chart );
$doc = apply_filters( 'visualizer_excel_doc', $doc );
$writer = PHPExcel_IOFactory::createWriter( $doc, 'Excel2007' );
ob_start();
$writer->save( 'php://output' );
$xlsData = ob_get_contents();
ob_end_clean();
} else {
do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, 'Class PHPExcel does not exist!', 'error', __FILE__, __LINE__ );
error_log( 'Class PHPExcel does not exist!' );
}
return array(
'csv' => 'data:application/vnd.ms-excel;base64,' . base64_encode( $xlsData ),
'name' => $filename,
);
}
/**
* Prepares an HTML table.
*
* @access private
* @param array $rows The array of data.
*/
private function _getHTML( $rows ) {
$css = '
table.visualizer-print {
border-collapse: collapse;
}
table.visualizer-print, table.visualizer-print th, table.visualizer-print td {
border: 1px solid #000;
}
';
$html = '';
$html .= '
';
$table = '';
$index = 0;
foreach ( $rows as $row ) {
$table .= '';
foreach ( $row as $col ) {
if ( $index === 0 ) {
$table .= '| ' . $col . ' | ';
} else {
$table .= '' . $col . ' | ';
}
}
$table .= '
';
$index++;
}
$table .= '
';
$html .= apply_filters( 'visualizer_print_table', $table ) . '
';
return array(
'csv' => $html,
);
}
}