← All changes | classes/Visualizer/Source.php +205 -251 3.1.1 → 1.5.3 View file →

		@@ -1,251 +1,205 @@
1		-<?php
2		-// +----------------------------------------------------------------------+
3		-// | Copyright 2013 Madpixels (email : visualizer@madpixels.net) |
4		-// +----------------------------------------------------------------------+
5		-// | This program is free software; you can redistribute it and/or modify |
6		-// | it under the terms of the GNU General Public License, version 2, as |
7		-// | published by the Free Software Foundation. |
8		-// | |
9		-// | This program is distributed in the hope that it will be useful, |
10		-// | but WITHOUT ANY WARRANTY; without even the implied warranty of |
11		-// | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
12		-// | GNU General Public License for more details. |
13		-// | |
14		-// | You should have received a copy of the GNU General Public License |
15		-// | along with this program; if not, write to the Free Software |
16		-// | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, |
17		-// | MA 02110-1301 USA |
18		-// +----------------------------------------------------------------------+
19		-// | Author: Eugene Manuilov <eugene@manuilov.org> |
20		-// +----------------------------------------------------------------------+
21		-/**
22		- * The abstract class for source managers.
23		- *
24		- * @category Visualizer
25		- * @package Source
26		- *
27		- * @since 1.0.0
28		- * @abstract
29		- */
30		-abstract class Visualizer_Source {
31		-
32		- /**
33		- * The array of allowed types.
34		- *
35		- * @since 1.0.0
36		- *
37		- * @access protected
38		- * @var array
39		- */
40		- protected static $allowed_types = array( 'string', 'number', 'boolean', 'date', 'datetime', 'timeofday' );
41		- /**
42		- * The array of data.
43		- *
44		- * @since 1.0.0
45		- *
46		- * @access protected
47		- * @var array
48		- */
49		- protected $_data = array();
50		- /**
51		- * The array of series.
52		- *
53		- * @since 1.0.0
54		- *
55		- * @access protected
56		- * @var array
57		- */
58		- protected $_series = array();
59		-
60		- /**
61		- * Return allowed types
62		- *
63		- * @since 1.0.1
64		- *
65		- * @static
66		- * @access public
67		- * @return array the allowed types
68		- */
69		- public static function getAllowedTypes() {
70		- return self::$allowed_types;
71		- }
72		-
73		- /**
74		- * Validates series tyeps.
75		- *
76		- * @since 1.0.1
77		- *
78		- * @static
79		- * @access protected
80		- *
81		- * @param array $types The icoming series types.
82		- *
83		- * @return boolean TRUE if sereis types are valid, otherwise FALSE.
84		- */
85		- protected static function _validateTypes( $types ) {
86		- foreach ( $types as $type ) {
87		- if ( ! in_array( $type, self::$allowed_types ) ) {
88		- return false;
89		- }
90		- }
91		-
92		- return true;
93		- }
94		-
95		- /**
96		- * Returns source name.
97		- *
98		- * @since 1.0.0
99		- *
100		- * @abstract
101		- * @access public
102		- * @return string The name of source.
103		- */
104		- public abstract function getSourceName();
105		-
106		- /**
107		- * Fetches information from source, parses it and builds series and data arrays.
108		- *
109		- * @since 1.0.0
110		- *
111		- * @abstract
112		- * @access public
113		- */
114		- public abstract function fetch();
115		-
116		- /**
117		- * Returns series parsed from source.
118		- *
119		- * @since 1.0.0
120		- *
121		- * @access public
122		- * @return array The array of series.
123		- */
124		- public function getSeries() {
125		- return $this->_series;
126		- }
127		-
128		- /**
129		- * Returns data parsed from source.
130		- *
131		- * @since 1.0.0
132		- *
133		- * @access public
134		- * @return string The serialized array of data.
135		- */
136		- public function getData() {
137		- return serialize( $this->_data );
138		- }
139		-
140		- /**
141		- * Returns raw data array.
142		- *
143		- * @since 1.1.0
144		- *
145		- * @access public
146		- * @return array
147		- */
148		- public function getRawData() {
149		- return $this->_data;
150		- }
151		-
152		- /**
153		- * Re populates series if the source is dynamic.
154		- *
155		- * @since 1.1.0
156		- *
157		- * @access public
158		- *
159		- * @param array $series The actual array of series.
160		- * @param int $chart_id The chart id.
161		- *
162		- * @return array The re populated array of series or old one.
163		- */
164		- public function repopulateSeries( $series, $chart_id ) {
165		- return $series;
166		- }
167		-
168		- /**
169		- * Re populates data if the source is dynamic.
170		- *
171		- * @since 1.1.0
172		- *
173		- * @access public
174		- *
175		- * @param array $data The actual array of data.
176		- * @param int $chart_id The chart id.
177		- *
178		- * @return array The re populated array of data or old one.
179		- */
180		- public function repopulateData( $data, $chart_id ) {
181		- return $data;
182		- }
183		-
184		- /**
185		- * Normalizes values according to series' type.
186		- *
187		- * @since 1.0.0
188		- *
189		- * @access protected
190		- *
191		- * @param array $data The row of data.
192		- *
193		- * @return array Normalized row of data.
194		- */
195		- protected function _normalizeData( $data ) {
196		- // normalize values
197		- // error_log(print_r($data,true));
198		- foreach ( $this->_series as $i => $series ) {
199		- // if no value exists for the seires, then add null
200		- if ( ! isset( $data[ $i ] ) ) {
201		- $data[ $i ] = null;
202		- }
203		- if ( is_null( $data[ $i ] ) ) {
204		- continue;
205		- }
206		- switch ( $series['type'] ) {
207		- case 'number':
208		- $data[ $i ] = ( is_numeric( $data[ $i ] ) ) ? floatval( $data[ $i ] ) : ( is_numeric( str_replace( ',', '', $data[ $i ] ) ) ? floatval( str_replace( ',', '', $data[ $i ] ) ) : null );
209		- break;
210		- case 'boolean':
211		- $data[ $i ] = ! empty( $data[ $i ] ) ? filter_var( $data[ $i ], FILTER_VALIDATE_BOOLEAN ) : null;
212		- break;
213		- case 'timeofday':
214		- $date = new DateTime( '1984-03-16T' . $data[ $i ] );
215		- if ( $date ) {
216		- $data[ $i ] = array(
217		- intval( $date->format( 'H' ) ),
218		- intval( $date->format( 'i' ) ),
219		- intval( $date->format( 's' ) ),
220		- 0,
221		- );
222		- }
223		- break;
224		- case 'string':
225		- $data[ $i ] = $this->toUTF8( $data[ $i ] );
226		- break;
227		- }
228		- }
229		-
230		- // error_log(print_r($data,true));
231		- return $data;
232		- }
233		-
234		-
235		- /**
236		- * Converts values to UTF8, if required.
237		- *
238		- * @access protected
239		- *
240		- * @param string $datum The data to convert.
241		- *
242		- * @return string The converted data.
243		- */
244		- protected final function toUTF8( $datum ) {
245		- if ( ! function_exists( 'mb_detect_encoding' ) || mb_detect_encoding( $datum ) !== 'ASCII' ) {
246		- $datum = \ForceUTF8\Encoding::toUTF8( $datum );
247		- }
248		- return $datum;
249		- }
250		-
251		-}
	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 abstract class for source managers.
	25	+ *
	26	+ * @category Visualizer
	27	+ * @package Source
	28	+ *
	29	+ * @since 1.0.0
	30	+ * @abstract
	31	+ */
	32	+abstract class Visualizer_Source {
	33	+
	34	+ /**
	35	+ * The array of data.
	36	+ *
	37	+ * @since 1.0.0
	38	+ *
	39	+ * @access protected
	40	+ * @var array
	41	+ */
	42	+ protected $_data = array();
	43	+
	44	+ /**
	45	+ * The array of series.
	46	+ *
	47	+ * @since 1.0.0
	48	+ *
	49	+ * @access protected
	50	+ * @var array
	51	+ */
	52	+ protected $_series = array();
	53	+
	54	+ /**
	55	+ * Returns source name.
	56	+ *
	57	+ * @since 1.0.0
	58	+ *
	59	+ * @abstract
	60	+ * @access public
	61	+ * @return string The name of source.
	62	+ */
	63	+ public abstract function getSourceName();
	64	+
	65	+ /**
	66	+ * Fetches information from source, parses it and builds series and data arrays.
	67	+ *
	68	+ * @since 1.0.0
	69	+ *
	70	+ * @abstract
	71	+ * @access public
	72	+ */
	73	+ public abstract function fetch();
	74	+
	75	+ /**
	76	+ * Returns series parsed from source.
	77	+ *
	78	+ * @since 1.0.0
	79	+ *
	80	+ * @access public
	81	+ * @return array The array of series.
	82	+ */
	83	+ public function getSeries() {
	84	+ return $this->_series;
	85	+ }
	86	+
	87	+ /**
	88	+ * Returns data parsed from source.
	89	+ *
	90	+ * @since 1.0.0
	91	+ *
	92	+ * @access public
	93	+ * @return string The serialized array of data.
	94	+ */
	95	+ public function getData() {
	96	+ return serialize( $this->_data );
	97	+ }
	98	+
	99	+ /**
	100	+ * Returns raw data array.
	101	+ *
	102	+ * @since 1.1.0
	103	+ *
	104	+ * @access public
	105	+ * @return array
	106	+ */
	107	+ public function getRawData() {
	108	+ return $this->_data;
	109	+ }
	110	+
	111	+ /**
	112	+ * Normalizes values according to series' type.
	113	+ *
	114	+ * @since 1.0.0
	115	+ *
	116	+ * @access protected
	117	+ * @param array $data The row of data.
	118	+ * @return array Normalized row of data.
	119	+ */
	120	+ protected function _normalizeData( $data ) {
	121	+ // normalize values
	122	+ //print_r($data);
	123	+ foreach ( $this->_series as $i => $series ) {
	124	+ // if no value exists for the seires, then add null
	125	+ if ( !isset( $data[$i] ) ) {
	126	+ $data[$i] = null;
	127	+ }
	128	+
	129	+ if ( is_null( $data[$i] ) && !is_numeric($data[$i])) {
	130	+ continue;
	131	+ }
	132	+
	133	+ switch ( $series['type'] ) {
	134	+ case 'number':
	135	+ $data[$i] = ( is_numeric($data[$i]) ) ? floatval( $data[$i] ) : null;
	136	+ break;
	137	+ case 'boolean':
	138	+ $data[$i] = !empty( $data[$i] ) ? filter_validate( $data[$i], FILTER_VALIDATE_BOOLEAN ) : null;
	139	+ break;
	140	+ case 'timeofday':
	141	+ $date = new DateTime( '1984-03-16T' . $data[$i] );
	142	+ if ( $date ) {
	143	+ $data[$i] = array(
	144	+ intval( $date->format( 'H' ) ),
	145	+ intval( $date->format( 'i' ) ),
	146	+ intval( $date->format( 's' ) ),
	147	+ 0,
	148	+ );
	149	+ }
	150	+ break;
	151	+ }
	152	+ }
	153	+ return $data;
	154	+ }
	155	+
	156	+ /**
	157	+ * Validates series tyeps.
	158	+ *
	159	+ * @since 1.0.1
	160	+ *
	161	+ * @static
	162	+ * @access protected
	163	+ * @param array $types The icoming series types.
	164	+ * @return boolean TRUE if sereis types are valid, otherwise FALSE.
	165	+ */
	166	+ protected static function _validateTypes( $types ) {
	167	+ $allowed_types = array( 'string', 'number', 'boolean', 'date', 'datetime', 'timeofday' );
	168	+ foreach ( $types as $type ) {
	169	+ if ( !in_array( $type, $allowed_types ) ) {
	170	+ return false;
	171	+ }
	172	+ }
	173	+
	174	+ return true;
	175	+ }
	176	+
	177	+ /**
	178	+ * Re populates series if the source is dynamic.
	179	+ *
	180	+ * @since 1.1.0
	181	+ *
	182	+ * @access public
	183	+ * @param array $series The actual array of series.
	184	+ * @param int $chart_id The chart id.
	185	+ * @return array The re populated array of series or old one.
	186	+ */
	187	+ public function repopulateSeries( $series, $chart_id ) {
	188	+ return $series;
	189	+ }
	190	+
	191	+ /**
	192	+ * Re populates data if the source is dynamic.
	193	+ *
	194	+ * @since 1.1.0
	195	+ *
	196	+ * @access public
	197	+ * @param array $data The actual array of data.
	198	+ * @param int $chart_id The chart id.
	199	+ * @return array The re populated array of data or old one.
	200	+ */
	201	+ public function repopulateData( $data, $chart_id ) {
	202	+ return $data;
	203	+ }
	204	+
	205	+}