| @@ -83,8 +83,24 @@ | ||
| 83 | 83 | */ |
| 84 | 84 | protected $_alignments; |
| 85 | 85 | |
| 86 | 86 | /** |
| 87 | + * Whether this chart supports animation or not. | |
| 88 | + * | |
| 89 | + * @access protected | |
| 90 | + * @var bool | |
| 91 | + */ | |
| 92 | + protected $_supportsAnimation = true; | |
| 93 | + | |
| 94 | + /** | |
| 95 | + * Which library does this this chart implement? | |
| 96 | + * | |
| 97 | + * @access protected | |
| 98 | + * @var string | |
| 99 | + */ | |
| 100 | + protected $_library = null; | |
| 101 | + | |
| 102 | + /** | |
| 87 | 103 | * Constructor. |
| 88 | 104 | * |
| 89 | 105 | * @since 1.0.0 |
| 90 | 106 | * |
| @@ -115,8 +131,10 @@ | ||
| 115 | 131 | '' => '', |
| 116 | 132 | '1' => esc_html__( 'Yes', 'visualizer' ), |
| 117 | 133 | '0' => esc_html__( 'No', 'visualizer' ), |
| 118 | 134 | ); |
| 135 | + | |
| 136 | + $this->hooks(); | |
| 119 | 137 | } |
| 120 | 138 | |
| 121 | 139 | /** |
| 122 | 140 | * Renders chart title settings. |
| @@ -141,8 +159,31 @@ | ||
| 141 | 159 | ); |
| 142 | 160 | } |
| 143 | 161 | |
| 144 | 162 | /** |
| 163 | + * Add the correct description for the manual configuration box. | |
| 164 | + */ | |
| 165 | + protected function _renderManualConfigDescription() { | |
| 166 | + self::_renderSectionStart(); | |
| 167 | + self::_renderSectionDescription( '<span class="viz-gvlink">' . sprintf( __( 'Configure the graph by providing configuration variables right from the %1$sGoogle Visualization API%2$s. You can refer to to some examples %3$shere%4$s.', 'visualizer' ), '<a href="https://developers.google.com/chart/interactive/docs/gallery/?#configuration-options" target="_blank">', '</a>', '<a href="https://docs.themeisle.com/article/728-manual-configuration" target="_blank">', '</a>' ) . '</span>' ); | |
| 168 | + } | |
| 169 | + | |
| 170 | + /** | |
| 171 | + * Add the correct example for the manual configuration box. | |
| 172 | + */ | |
| 173 | + protected function _renderManualConfigExample() { | |
| 174 | + return '{ | |
| 175 | + "vAxis": { | |
| 176 | + "ticks": [5, 10, 15, 20], | |
| 177 | + "titleTextStyle": { | |
| 178 | + "color": "red" | |
| 179 | + }, | |
| 180 | + "textPosition": "in" | |
| 181 | + } | |
| 182 | + }'; | |
| 183 | + } | |
| 184 | + | |
| 185 | + /** | |
| 145 | 186 | * Renders chart advanced settings group. |
| 146 | 187 | * |
| 147 | 188 | * @access protected |
| 148 | 189 | */ |
| @@ -148,9 +189,9 @@ | ||
| 148 | 189 | */ |
| 149 | 190 | protected function _renderAdvancedSettings() { |
| 150 | 191 | self::_renderGroupStart( esc_html__( 'Frontend Actions', 'visualizer' ) ); |
| 151 | 192 | self::_renderSectionStart(); |
| 152 | - self::_renderSectionDescription( esc_html__( 'Configure frontend actions here.', 'visualizer' ) ); | |
| 193 | + self::_renderSectionDescription( esc_html__( 'Configure frontend actions that need to be shown.', 'visualizer' ) ); | |
| 153 | 194 | self::_renderSectionEnd(); |
| 154 | 195 | |
| 155 | 196 | $this->_renderActionSettings(); |
| 156 | 197 | self::_renderGroupEnd(); |
| @@ -155,28 +196,16 @@ | ||
| 155 | 196 | $this->_renderActionSettings(); |
| 156 | 197 | self::_renderGroupEnd(); |
| 157 | 198 | |
| 158 | 199 | self::_renderGroupStart( esc_html__( 'Manual Configuration', 'visualizer' ) ); |
| 159 | - self::_renderSectionStart(); | |
| 160 | - self::_renderSectionDescription( __( 'Configure the graph by providing configuration variables right from the', 'visualizer' ) . ' <a href="https://developers.google.com/chart/interactive/docs/reference" target="_blank">Google Visualization</a> API.' ); | |
| 161 | - | |
| 162 | - $example = ' | |
| 163 | -{ | |
| 164 | - "vAxis": { | |
| 165 | - "ticks": [5, 10, 15, 20], | |
| 166 | - "titleTextStyle": { | |
| 167 | - "color": "red" | |
| 168 | - }, | |
| 169 | - "textPosition": "in" | |
| 170 | - } | |
| 171 | -}'; | |
| 172 | - | |
| 200 | + $this->_renderManualConfigDescription(); | |
| 173 | 201 | self::_renderTextAreaItem( |
| 174 | 202 | esc_html__( 'Configuration', 'visualizer' ), |
| 175 | 203 | 'manual', |
| 176 | 204 | $this->manual, |
| 177 | 205 | sprintf( |
| 178 | - esc_html__( 'One per line in valid JSON (key:value) format e.g. %s', 'visualizer' ), '<br><code>' . $example . '</code>' | |
| 206 | + esc_html__( 'One per line in valid JSON (key:value) format e.g. %s', 'visualizer' ), | |
| 207 | + '<br><code>' . $this->_renderManualConfigExample() . '</code>' | |
| 179 | 208 | ), |
| 180 | 209 | '', |
| 181 | 210 | array( 'rows' => 5 ) |
| 182 | 211 | ); |
| @@ -193,31 +222,33 @@ | ||
| 193 | 222 | */ |
| 194 | 223 | protected function _renderActionSettings() { |
| 195 | 224 | global $wp_version; |
| 196 | 225 | $disable_actions = version_compare( $wp_version, '4.7.0', '<' ); |
| 197 | - self::_renderSectionStart( esc_html__( 'Actions', 'visualizer' ), false ); | |
| 226 | + // default open this section when not testing through cypress because cypress expects to click and open each section | |
| 227 | + // and may not like finding a section is already open. | |
| 228 | + self::_renderSectionStart( esc_html__( 'Actions', 'visualizer' ), ! defined( 'TI_CYPRESS_TESTING' ) ); | |
| 198 | 229 | self::_renderCheckboxItem( |
| 199 | 230 | esc_html__( 'Print', 'visualizer' ), |
| 200 | 231 | 'actions[]', |
| 201 | - isset( $this->actions ) && in_array( 'print', $this->actions ) ? true : false, | |
| 232 | + isset( $this->actions ) && in_array( 'print', $this->actions, true ) ? true : false, | |
| 202 | 233 | 'print', |
| 203 | - $disable_actions ? '<span class="viz-section-error">' . esc_html__( 'Upgrade to at least WordPress 4.7 to use this.', 'visualizer' ) . '</span>' : esc_html__( 'To enable printing the data.', 'visualizer' ), | |
| 234 | + $disable_actions ? '<span class="viz-section-error">' . esc_html__( 'Upgrade to at least WordPress 4.7 to use this.', 'visualizer' ) . '</span>' : esc_html__( 'To enable printing the chart/data.', 'visualizer' ), | |
| 204 | 235 | $disable_actions |
| 205 | 236 | ); |
| 206 | 237 | self::_renderCheckboxItem( |
| 207 | 238 | esc_html__( 'CSV', 'visualizer' ), |
| 208 | 239 | 'actions[]', |
| 209 | - isset( $this->actions ) && in_array( 'csv;application/csv', $this->actions ) ? true : false, | |
| 240 | + isset( $this->actions ) && in_array( 'csv;application/csv', $this->actions, true ) ? true : false, | |
| 210 | 241 | 'csv;application/csv', |
| 211 | 242 | $disable_actions ? '<span class="viz-section-error">' . esc_html__( 'Upgrade to at least WordPress 4.7 to use this.', 'visualizer' ) . '</span>' : esc_html__( 'To enable downloading the data as a CSV.', 'visualizer' ), |
| 212 | 243 | $disable_actions |
| 213 | 244 | ); |
| 214 | 245 | |
| 215 | - $disabled = ! ( class_exists( 'PHPExcel' ) && extension_loaded( 'zip' ) && extension_loaded( 'xml' ) && version_compare( PHP_VERSION, '5.2.0', '>' ) ); | |
| 246 | + $disabled = ! self::is_excel_enabled(); | |
| 216 | 247 | self::_renderCheckboxItem( |
| 217 | 248 | esc_html__( 'Excel', 'visualizer' ), |
| 218 | 249 | 'actions[]', |
| 219 | - isset( $this->actions ) && in_array( 'xls;application/vnd.ms-excel', $this->actions ) ? true : false, | |
| 250 | + isset( $this->actions ) && in_array( 'xls;application/vnd.ms-excel', $this->actions, true ) ? true : false, | |
| 220 | 251 | 'xls;application/vnd.ms-excel', |
| 221 | 252 | $disable_actions ? '<span class="viz-section-error">' . esc_html__( 'Upgrade to at least WordPress 4.7 to use this.', 'visualizer' ) . '</span>' : ( $disabled ? '<span class="viz-section-error">' . esc_html__( 'Enable the ZIP and XML extensions to use this setting.', 'visualizer' ) . '</span>' : esc_html__( 'To enable downloading the data as an Excel spreadsheet.', 'visualizer' ) ), |
| 222 | 253 | $disable_actions || $disabled |
| 223 | 254 | ); |
| @@ -223,9 +254,9 @@ | ||
| 223 | 254 | ); |
| 224 | 255 | self::_renderCheckboxItem( |
| 225 | 256 | esc_html__( 'Copy', 'visualizer' ), |
| 226 | 257 | 'actions[]', |
| 227 | - isset( $this->actions ) && in_array( 'copy', $this->actions ) ? true : false, | |
| 258 | + isset( $this->actions ) && in_array( 'copy', $this->actions, true ) ? true : false, | |
| 228 | 259 | 'copy', |
| 229 | 260 | $disable_actions ? '<span class="viz-section-error">' . esc_html__( 'Upgrade to at least WordPress 4.7 to use this.', 'visualizer' ) . '</span>' : esc_html__( 'To enable copying the data to the clipboard.', 'visualizer' ), |
| 230 | 261 | $disable_actions |
| 231 | 262 | ); |
| @@ -232,8 +263,25 @@ | ||
| 232 | 263 | self::_renderSectionEnd(); |
| 233 | 264 | } |
| 234 | 265 | |
| 235 | 266 | /** |
| 267 | + * Checks if the Excel module can be enabled. | |
| 268 | + */ | |
| 269 | + private static function is_excel_enabled() { | |
| 270 | + $vendor_file = VISUALIZER_ABSPATH . '/vendor/autoload.php'; | |
| 271 | + if ( is_readable( $vendor_file ) ) { | |
| 272 | + include_once( $vendor_file ); | |
| 273 | + } | |
| 274 | + | |
| 275 | + if ( version_compare( phpversion(), '5.6.0', '<' ) ) { | |
| 276 | + do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'PHP version %s not supported', phpversion() ), 'error', __FILE__, __LINE__ ); | |
| 277 | + return false; | |
| 278 | + } | |
| 279 | + | |
| 280 | + return class_exists( 'PhpOffice\PhpSpreadsheet\Spreadsheet' ) && extension_loaded( 'zip' ) && extension_loaded( 'xml' ) && extension_loaded( 'fileinfo' ); | |
| 281 | + } | |
| 282 | + | |
| 283 | + /** | |
| 236 | 284 | * Renders chart general settings group. |
| 237 | 285 | * |
| 238 | 286 | * @since 1.0.0 |
| 239 | 287 | * |
| @@ -310,12 +358,63 @@ | ||
| 310 | 358 | |
| 311 | 359 | self::_renderSectionStart( esc_html__( 'Tooltip', 'visualizer' ), false ); |
| 312 | 360 | $this->_renderTooltipSettigns(); |
| 313 | 361 | self::_renderSectionEnd(); |
| 362 | + | |
| 363 | + $this->_renderAnimationSettings(); | |
| 364 | + | |
| 365 | + do_action( 'visualizer_chart_settings', get_class( $this ), $this->_data, 'general', array( 'generic' => true ) ); | |
| 366 | + | |
| 314 | 367 | self::_renderGroupEnd(); |
| 315 | 368 | } |
| 316 | 369 | |
| 317 | 370 | /** |
| 371 | + * Renders animation settings section. | |
| 372 | + * | |
| 373 | + * @access protected | |
| 374 | + */ | |
| 375 | + protected function _renderAnimationSettings() { | |
| 376 | + if ( ! $this->_supportsAnimation ) { | |
| 377 | + return; | |
| 378 | + } | |
| 379 | + | |
| 380 | + self::_renderSectionStart( esc_html__( 'Animation', 'visualizer' ), false ); | |
| 381 | + | |
| 382 | + self::_renderCheckboxItem( | |
| 383 | + esc_html__( 'Animate on startup', 'visualizer' ), | |
| 384 | + 'animation[startup]', | |
| 385 | + isset( $this->animation['startup'] ) ? $this->animation['startup'] : 0, | |
| 386 | + true, | |
| 387 | + esc_html__( 'Determines if the chart will animate on the initial draw.', 'visualizer' ) | |
| 388 | + ); | |
| 389 | + | |
| 390 | + self::_renderTextItem( | |
| 391 | + esc_html__( 'Duration', 'visualizer' ), | |
| 392 | + 'animation[duration]', | |
| 393 | + isset( $this->animation['duration'] ) ? $this->animation['duration'] : 0, | |
| 394 | + esc_html__( 'The duration of the animation, in milliseconds', 'visualizer' ), | |
| 395 | + 0, | |
| 396 | + 'number' | |
| 397 | + ); | |
| 398 | + | |
| 399 | + self::_renderSelectItem( | |
| 400 | + esc_html__( 'Easing', 'visualizer' ), | |
| 401 | + 'animation[easing]', | |
| 402 | + isset( $this->animation['easing'] ) ? $this->animation['easing'] : null, | |
| 403 | + array( | |
| 404 | + 'linear' => esc_html__( 'Constant speed', 'visualizer' ), | |
| 405 | + 'in' => esc_html__( 'Start slow and speed up', 'visualizer' ), | |
| 406 | + 'out' => esc_html__( 'Start fast and slow down', 'visualizer' ), | |
| 407 | + 'inAndOut' => esc_html__( 'Start slow, speed up, then slow down', 'visualizer' ), | |
| 408 | + ), | |
| 409 | + esc_html__( 'The easing function applied to the animation.', 'visualizer' ) | |
| 410 | + ); | |
| 411 | + | |
| 412 | + self::_renderSectionEnd(); | |
| 413 | + | |
| 414 | + } | |
| 415 | + | |
| 416 | + /** | |
| 318 | 417 | * Renders tooltip settings section. |
| 319 | 418 | * |
| 320 | 419 | * @since 1.4.0 |
| 321 | 420 | * |
| @@ -351,10 +450,10 @@ | ||
| 351 | 450 | * |
| 352 | 451 | * @access protected |
| 353 | 452 | */ |
| 354 | 453 | protected function _renderViewSettings() { |
| 355 | - self::_renderGroupStart( esc_html__( 'Layout & Chart Area', 'visualizer' ) ); | |
| 356 | - self::_renderSectionStart( esc_html__( 'Layout', 'visualizer' ), false ); | |
| 454 | + self::_renderGroupStart( esc_html__( 'Chart Size & Placement', 'visualizer' ) ); | |
| 455 | + self::_renderSectionStart( esc_html__( 'Chart Size/Layout', 'visualizer' ), false ); | |
| 357 | 456 | self::_renderSectionDescription( esc_html__( 'Configure the total size of the chart. Two formats are supported: a number, or a number followed by %. A simple number is a value in pixels; a number followed by % is a percentage.', 'visualizer' ) ); |
| 358 | 457 | |
| 359 | 458 | echo '<div class="viz-section-item">'; |
| 360 | 459 | echo '<a class="more-info" href="javascript:;">[?]</a>'; |
| @@ -371,9 +470,9 @@ | ||
| 371 | 470 | echo '</tr>'; |
| 372 | 471 | echo '</table>'; |
| 373 | 472 | |
| 374 | 473 | echo '<p class="viz-section-description">'; |
| 375 | - esc_html_e( 'Determines the total width and height of the chart.', 'visualizer' ); | |
| 474 | + esc_html_e( 'Determines the total width and height of the chart. This will only show in the front-end.', 'visualizer' ); | |
| 376 | 475 | echo '</p>'; |
| 377 | 476 | echo '</div>'; |
| 378 | 477 | |
| 379 | 478 | echo '<div class="viz-section-delimiter"></div>'; |
| @@ -410,9 +509,9 @@ | ||
| 410 | 509 | echo '</label>'; |
| 411 | 510 | echo '</div>'; |
| 412 | 511 | self::_renderSectionEnd(); |
| 413 | 512 | |
| 414 | - self::_renderSectionStart( esc_html__( 'Chart Area', 'visualizer' ), false ); | |
| 513 | + self::_renderSectionStart( esc_html__( 'Placement', 'visualizer' ), false ); | |
| 415 | 514 | self::_renderSectionDescription( esc_html__( 'Configure the placement and size of the chart area (where the chart itself is drawn, excluding axis and legends). Two formats are supported: a number, or a number followed by %. A simple number is a value in pixels; a number followed by % is a percentage.', 'visualizer' ) ); |
| 416 | 515 | |
| 417 | 516 | echo '<div class="viz-section-item">'; |
| 418 | 517 | echo '<a class="more-info" href="javascript:;">[?]</a>'; |
| @@ -484,8 +583,9 @@ | ||
| 484 | 583 | echo '<a class="more-info" href="javascript:;">[?]</a>'; |
| 485 | 584 | echo '<b>', $title, '</b>'; |
| 486 | 585 | echo '<select class="control-select ', implode( ' ', $classes ) , '" name="', $name, '" ', ( $multiple ? 'multiple' : '' ), ' ' , $atts, '>'; |
| 487 | 586 | foreach ( $options as $key => $label ) { |
| 587 | + // phpcs:ignore WordPress.PHP.StrictInArray.MissingTrueStrict | |
| 488 | 588 | $extra = $multiple && is_array( $value ) ? ( in_array( $key, $value ) ? 'selected' : '' ) : selected( $key, $value, false ); |
| 489 | 589 | echo '<option value="', $key, '"', $extra, '>'; |
| 490 | 590 | echo $label; |
| 491 | 591 | echo '</option>'; |
| @@ -510,9 +610,9 @@ | ||
| 510 | 610 | protected static function _renderColorPickerItem( $title, $name, $value, $default ) { |
| 511 | 611 | echo '<div class="viz-section-item">'; |
| 512 | 612 | echo '<b>', $title, '</b>'; |
| 513 | 613 | echo '<div>'; |
| 514 | - echo '<input type="text" class="color-picker-hex" name="', $name, '" maxlength="7" placeholder="', esc_attr__( 'Hex Value', 'visualizer' ), '" value="', is_null( $value ) ? $default : esc_attr( $value ), '" data-default-color="', $default, '">'; | |
| 614 | + echo '<input type="text" class="color-picker-hex color-picker" data-alpha="true" name="', $name, '" maxlength="7" placeholder="', esc_attr__( 'Hex Value', 'visualizer' ), '" value="', is_null( $value ) ? $default : esc_attr( $value ), '" data-default-color="', $default, '">'; | |
| 515 | 615 | echo '</div>'; |
| 516 | 616 | echo '</div>'; |
| 517 | 617 | } |
| 518 | 618 | |
| @@ -556,10 +656,10 @@ | ||
| 556 | 656 | * @param string $title The title of this group. |
| 557 | 657 | * @param string $html Any additional HTML. |
| 558 | 658 | * @param string $class Any additional classes. |
| 559 | 659 | */ |
| 560 | - public static function _renderGroupStart( $title, $html = '', $class = '' ) { | |
| 561 | - echo '<li class="viz-group ' . $class . '">'; | |
| 660 | + public static function _renderGroupStart( $title, $html = '', $class = '', $id = '' ) { | |
| 661 | + echo '<li id="' . $id . '" class="viz-group ' . $class . '">'; | |
| 562 | 662 | echo '<h3 class="viz-group-title">', $title, '</h3>'; |
| 563 | 663 | echo $html; |
| 564 | 664 | echo '<ul class="viz-group-content">'; |
| 565 | 665 | } |
| @@ -621,11 +721,11 @@ | ||
| 621 | 721 | * @static |
| 622 | 722 | * @access public |
| 623 | 723 | * @param string $description The description text. |
| 624 | 724 | */ |
| 625 | - public static function _renderSectionDescription( $description ) { | |
| 725 | + public static function _renderSectionDescription( $description, $classes = '' ) { | |
| 626 | 726 | echo '<div class="viz-section-item">'; |
| 627 | - echo '<div class="viz-section-description">', $description, '</div>'; | |
| 727 | + echo '<div class="viz-section-description ' . $classes . '">', $description, '</div>'; | |
| 628 | 728 | echo '</div>'; |
| 629 | 729 | } |
| 630 | 730 | |
| 631 | 731 | /** |
| @@ -667,8 +767,9 @@ | ||
| 667 | 767 | protected static function _renderCheckboxItem( $title, $name, $value, $default, $desc, $disabled = false ) { |
| 668 | 768 | echo '<div class="viz-section-item">'; |
| 669 | 769 | echo '<a class="more-info" href="javascript:;">[?]</a>'; |
| 670 | 770 | echo '<b>', $title, '</b>'; |
| 771 | + // phpcs:ignore WordPress.PHP.StrictComparisons.LooseComparison | |
| 671 | 772 | echo '<input type="checkbox" class="control-check" value="', $default, '" name="', $name, '" ', ( $value == $default ? 'checked' : '' ), ' ', ( $disabled ? 'disabled=disabled' : '' ), '>'; |
| 672 | 773 | echo '<p class="viz-section-description">', $desc, '</p>'; |
| 673 | 774 | echo '</div>'; |
| 674 | 775 | } |
| @@ -690,5 +791,25 @@ | ||
| 690 | 791 | echo '<p class="viz-section-description">', $desc, '</p>'; |
| 691 | 792 | echo '</div>'; |
| 692 | 793 | } |
| 693 | 794 | |
| 795 | + /** | |
| 796 | + * Returns the library this chart implements. | |
| 797 | + */ | |
| 798 | + public function getLibrary() { | |
| 799 | + return $this->_library; | |
| 800 | + } | |
| 801 | + | |
| 802 | + /** | |
| 803 | + * Loads generic libraries conditionally. | |
| 804 | + */ | |
| 805 | + protected function load_dependent_assets( $libs ) { | |
| 806 | + if ( in_array( 'moment', $libs, true ) && ! wp_script_is( 'moment', 'registered' ) ) { | |
| 807 | + wp_register_script( 'moment', VISUALIZER_ABSURL . 'js/lib/moment.min.js', array(), Visualizer_Plugin::VERSION ); | |
| 808 | + } | |
| 809 | + | |
| 810 | + if ( in_array( 'numeral', $libs, true ) && ! wp_script_is( 'numeral', 'registered' ) ) { | |
| 811 | + wp_register_script( 'numeral', VISUALIZER_ABSURL . 'js/lib/numeral.min.js', array(), Visualizer_Plugin::VERSION ); | |
| 812 | + } | |
| 813 | + | |
| 814 | + } | |
| 694 | 815 | } |
