| 1 |
<?php |
| 2 |
|
| 3 |
// +----------------------------------------------------------------------+ |
| 4 |
// | Copyright 2013 Madpixels (email : visualizer@madpixels.net) | |
| 5 |
// +----------------------------------------------------------------------+ |
| 6 |
// | This program is free software; you can redistribute it and/or modify | |
| 7 |
// | it under the terms of the GNU General Public License, version 2, as | |
| 8 |
// | published by the Free Software Foundation. | |
| 9 |
// | | |
| 10 |
// | This program is distributed in the hope that it will be useful, | |
| 11 |
// | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 |
// | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 13 |
// | GNU General Public License for more details. | |
| 14 |
// | | |
| 15 |
// | You should have received a copy of the GNU General Public License | |
| 16 |
// | along with this program; if not, write to the Free Software | |
| 17 |
// | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, | |
| 18 |
// | MA 02110-1301 USA | |
| 19 |
// +----------------------------------------------------------------------+ |
| 20 |
// | Author: Eugene Manuilov <eugene@manuilov.org> | |
| 21 |
// +----------------------------------------------------------------------+ |
| 22 |
|
| 23 |
/** |
| 24 |
* The core plugin class. |
| 25 |
* |
| 26 |
* @category Visualizer |
| 27 |
* |
| 28 |
* @since 1.0.0 |
| 29 |
*/ |
| 30 |
class Visualizer_Plugin { |
| 31 |
|
| 32 |
const NAME = 'visualizer'; |
| 33 |
const VERSION = '1.0.0'; |
| 34 |
|
| 35 |
// custom post types |
| 36 |
const CPT_VISUALIZER = 'visualizer'; |
| 37 |
|
| 38 |
// custom meta fields |
| 39 |
const CF_CHART_TYPE = 'visualizer-chart-type'; |
| 40 |
const CF_SOURCE = 'visualizer-source'; |
| 41 |
const CF_SERIES = 'visualizer-series'; |
| 42 |
const CF_DEFAULT_DATA = 'visualizer-default-data'; |
| 43 |
const CF_SETTINGS = 'visualizer-settings'; |
| 44 |
|
| 45 |
// custom actions |
| 46 |
const ACTION_GET_CHARTS = 'visualizer-get-charts'; |
| 47 |
const ACTION_CREATE_CHART = 'visualizer-create-chart'; |
| 48 |
const ACTION_EDIT_CHART = 'visualizer-edit-chart'; |
| 49 |
const ACTION_CLONE_CHART = 'visualizer-clone-chart'; |
| 50 |
const ACTION_DELETE_CHART = 'visualizer-delete-chart'; |
| 51 |
const ACTION_UPLOAD_DATA = 'visualizer-upload-data'; |
| 52 |
|
| 53 |
/** |
| 54 |
* Singletone instance of the plugin. |
| 55 |
* |
| 56 |
* @since 1.0.0 |
| 57 |
* |
| 58 |
* @access private |
| 59 |
* @var Visualizer_Plugin |
| 60 |
*/ |
| 61 |
private static $_instance = null; |
| 62 |
|
| 63 |
/** |
| 64 |
* The array of registered modules. |
| 65 |
* |
| 66 |
* @since 1.0.0 |
| 67 |
* |
| 68 |
* @access private |
| 69 |
* @var array |
| 70 |
*/ |
| 71 |
private $_modules = array(); |
| 72 |
|
| 73 |
/** |
| 74 |
* Private constructor. |
| 75 |
* |
| 76 |
* @since 1.0.0 |
| 77 |
* |
| 78 |
* @access private |
| 79 |
*/ |
| 80 |
private function __construct() {} |
| 81 |
|
| 82 |
/** |
| 83 |
* Private clone method. |
| 84 |
* |
| 85 |
* @since 1.0.0 |
| 86 |
* |
| 87 |
* @access private |
| 88 |
*/ |
| 89 |
private function __clone() {} |
| 90 |
|
| 91 |
/** |
| 92 |
* Returns singletone instance of the plugin. |
| 93 |
* |
| 94 |
* @since 1.0.0 |
| 95 |
* |
| 96 |
* @static |
| 97 |
* @access public |
| 98 |
* @return Visualizer_Plugin |
| 99 |
*/ |
| 100 |
public static function instance() { |
| 101 |
if ( is_null( self::$_instance ) ) { |
| 102 |
self::$_instance = new Visualizer_Plugin(); |
| 103 |
} |
| 104 |
|
| 105 |
return self::$_instance; |
| 106 |
} |
| 107 |
|
| 108 |
/** |
| 109 |
* Returns a module if it was registered before. Otherwise NULL. |
| 110 |
* |
| 111 |
* @since 1.0.0 |
| 112 |
* |
| 113 |
* @access public |
| 114 |
* @param string $name The name of the module to return. |
| 115 |
* @return Visualizer_Module|null Returns a module if it was registered or NULL. |
| 116 |
*/ |
| 117 |
public function getModule( $name ) { |
| 118 |
return isset( $this->_modules[$name] ) ? $this->_modules[$name] : null; |
| 119 |
} |
| 120 |
|
| 121 |
/** |
| 122 |
* Determines whether the module has been registered or not. |
| 123 |
* |
| 124 |
* @since 1.0.0 |
| 125 |
* |
| 126 |
* @access public |
| 127 |
* @param string $name The name of a module to check. |
| 128 |
* @return boolean TRUE if the module has been registered. Otherwise FALSE. |
| 129 |
*/ |
| 130 |
public function hasModule( $name ) { |
| 131 |
return isset( $this->_modules[$name] ); |
| 132 |
} |
| 133 |
|
| 134 |
/** |
| 135 |
* Register new module in the plugin. |
| 136 |
* |
| 137 |
* @since 1.0.0 |
| 138 |
* |
| 139 |
* @access public |
| 140 |
* @param string $module The name of the module to use in the plugin. |
| 141 |
*/ |
| 142 |
public function setModule( $class ) { |
| 143 |
$this->_modules[$class] = new $class( $this ); |
| 144 |
} |
| 145 |
|
| 146 |
/** |
| 147 |
* Returns chart types. |
| 148 |
* |
| 149 |
* @since 1.0.0 |
| 150 |
* |
| 151 |
* @static |
| 152 |
* @access public |
| 153 |
* @return array |
| 154 |
*/ |
| 155 |
public static function getChartTypes() { |
| 156 |
return array( 'line', 'area', 'bar', 'column', 'pie', 'geo', 'scatter', 'candlestick', 'gauge' ); |
| 157 |
} |
| 158 |
|
| 159 |
} |
