Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feature/drupal 10 compatibility #98

Merged
merged 4 commits into from
Aug 29, 2023
Merged

Feature/drupal 10 compatibility #98

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bbb20c7
Apply drupal 10 compatibility fix
lem-doghouse Aug 18, 2023
abefdb2
Remove Jquery once
lem-doghouse Aug 18, 2023
370bcf7
Update D3, Billborad, Datatables and FileSaver.js dependencies to lat…
lem-doghouse Aug 18, 2023
21a0306
Fix unreactive Visualisation Style Dropdownlist and X-axis grouping
lem-doghouse Aug 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions dvf.info.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,4 @@ name: Data Visualisation Framework
description: 'Data Visualisation Framework makes it easy to generate visualisations from different data sources.'
type: module
package: Data Visualisation Framework
core: 8.x
core_version_requirement: ^8 || ^9
core_version_requirement: ^9 || ^10
17 changes: 10 additions & 7 deletions dvf.libraries.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ billboard:
url: https://github.com/naver/billboard.js/blob/master/LICENSE
gpl-compatible: true
js:
https://cdnjs.cloudflare.com/ajax/libs/billboard.js/3.0.3/billboard.min.js: { type: external, minified: true }
https://cdnjs.cloudflare.com/ajax/libs/billboard.js/3.9.3/billboard.min.js: { type: external, minified: true }
css:
component:
https://cdnjs.cloudflare.com/ajax/libs/billboard.js/3.0.3/billboard.min.css: { type: external, minified: true }
https://cdnjs.cloudflare.com/ajax/libs/billboard.js/3.9.3/billboard.min.css: { type: external, minified: true }

d3:
remote: https://github.com/d3/d3
Expand All @@ -19,7 +19,7 @@ d3:
url: https://github.com/d3/d3/blob/master/LICENSE
gpl-compatible: true
js:
https://cdnjs.cloudflare.com/ajax/libs/d3/6.7.0/d3.min.js: { type: external, minified: true }
https://cdnjs.cloudflare.com/ajax/libs/d3/7.8.5/d3.min.js: { type: external, minified: true }

datatables:
remote: https://github.com/DataTables/DataTables
Expand All @@ -29,10 +29,10 @@ datatables:
url: https://github.com/DataTables/DataTables/blob/master/license.txt
gpl-compatible: true
js:
https://cdn.datatables.net/v/dt/dt-1.10.25/datatables.min.js: { type: external, minified: true }
https://cdn.datatables.net/1.13.6/js/jquery.dataTables.min.js: { type: external, minified: true }
css:
component:
https://cdn.datatables.net/v/dt/dt-1.10.25/datatables.min.css: { type: external, minified: true }
https://cdn.datatables.net/1.13.6/css/jquery.dataTables.min.css: { type: external, minified: true }

filesaver:
remote: https://github.com/eligrey/FileSaver.js
Expand All @@ -41,7 +41,7 @@ filesaver:
name: MIT
url: https://github.com/eligrey/FileSaver.js/blob/master/LICENSE.md
js:
https://cdnjs.cloudflare.com/ajax/libs/FileSaver.js/1.3.8/FileSaver.min.js: { type: external, minified: true }
https://cdnjs.cloudflare.com/ajax/libs/FileSaver.js/2.0.5/FileSaver.min.js: { type: external, minified: true }

jquery.dvfCharts:
version: "1.0.0"
Expand All @@ -51,6 +51,7 @@ jquery.dvfCharts:
dependencies:
- core/jquery
- core/drupal
- core/once
- core/drupalSettings
- dvf/d3
- dvf/billboard
Expand All @@ -62,21 +63,23 @@ dvfCharts:
js/dvfCharts.js: {}
dependencies:
- dvf/jquery.dvfCharts
- core/once

dvfTables:
version: "1.0.0"
js:
js/dvfTables.js: {}
dependencies:
- dvf/jquery.dvfTables
- core/once

jquery.dvfTables:
version: "1.0.0"
js:
js/jquery.dvfTables.js: {}
dependencies:
- core/jquery
- core/drupal
- core/jquery
- core/drupalSettings
- dvf/datatables

Expand Down
3 changes: 1 addition & 2 deletions dvf_ckan/dvf_ckan.info.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@ name: CKAN Data Visualisation
description: 'CKAN integration for the Data Visualisation Framework module.'
type: module
package: Data Visualisation Framework
core: 8.x
core_version_requirement: ^8 || ^9
core_version_requirement: ^9 || ^10
dependencies:
- ckan_connect:ckan_connect
- dvf:dvf
3 changes: 1 addition & 2 deletions dvf_csv/dvf_csv.info.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ name: CSV Data Visualisation
description: 'CSV integration for the Data Visualisation Framework module.'
type: module
package: Data Visualisation Framework
core: 8.x
core_version_requirement: ^8 || ^9
core_version_requirement: ^9 || ^10
dependencies:
- dvf:dvf
3 changes: 1 addition & 2 deletions dvf_json/dvf_json.info.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ name: JSON Data Visualisation
description: 'JSON integration for the Data Visualisation Framework module.'
type: module
package: Data Visualisation Framework
core: 8.x
core_version_requirement: ^8 || ^9
core_version_requirement: ^9 || ^10
dependencies:
- dvf:dvf
8 changes: 4 additions & 4 deletions js/dvfCharts.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
;(function ($, Drupal, drupalSettings) {
;(function ($, Drupal, once, drupalSettings) {

'use strict';

Expand All @@ -7,12 +7,12 @@
*/
Drupal.behaviors.dvfCharts = {
attach: function (context) {
$('[data-dvfcharts]', context).once('dvf-charts').each(function () {
var $chart = $(this),
once('dvf-charts', '[data-dvfcharts]', context).forEach(element => {
var $chart = $(element),
chartId = $chart.data('dvfcharts');
$chart.dvfCharts(drupalSettings.dvf.charts[chartId]);
});
}
};

})(jQuery, Drupal, drupalSettings);
})(jQuery, Drupal, once, drupalSettings);
18 changes: 10 additions & 8 deletions js/dvfTables.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
;(function ($, Drupal, drupalSettings) {
;(function ($, Drupal, once, drupalSettings) {

'use strict';

Expand All @@ -7,9 +7,9 @@
*/
Drupal.behaviors.dvfTables = {
attach: function (context) {
$('[data-dvftables]', context).once('dvf-tables').each(function () {
var $table = $(this),
tableId = $table.data('dvftables');
once('dvf-tables', '[data-dvftables]', context).forEach(element => {
var $table = $(element),
tableId = $table.data('dvftables');
$table.dvfTables(drupalSettings.dvf.tables[tableId]);
});
}
Expand All @@ -22,12 +22,14 @@
*/
Drupal.behaviors.dvfTablesDownloadData = {
attach: function (context) {
$('.dvf-table--wrapper .download-data', context).once('download-data').each(function () {
$(this).click(function() {
window.open($(this).data('file-uri'));
once('download-data', '.dvf-table--wrapper .download-data', context).forEach(element => {
var $downloadButton = $(element);

$($downloadButton).click(function() {
window.open($($downloadButton).data('file-uri'));
});
});
}
}

})(jQuery, Drupal, drupalSettings);
})(jQuery, Drupal, once, drupalSettings);
19 changes: 9 additions & 10 deletions js/jquery.dvfCharts.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
;(function ($, bb) {
;(function ($, bb, once) {

'use strict';

Expand Down Expand Up @@ -405,10 +405,10 @@

var self = this,
buttonTypes = ['png', 'svg'],
$chartWrapper = $(this.element).closest('.dvf--wrapper');
$chartWrapper = this.element.closest('.dvf--wrapper');

// For each chart, add download buttons.
$chartWrapper.once('download-buttons').each(function(i, el){
once('download-buttons', $chartWrapper ).forEach(el => {
var $buttonWrapper = $(el).find('.table-chart--actions'),
$chart = $(el).find('.dvf-chart svg');

Expand All @@ -430,10 +430,9 @@
.appendTo($buttonWrapper);
})

// Set download data click listener.
$('.download-data', $buttonWrapper).once('download-data').each(function(i, dlEl) {
$(this).on('click', function() {
window.open($(this).data('file-uri'));
once('download-data', '.table-chart--actions .download-data').forEach(element => {
$(element).on('click', function() {
window.open($(element).data('file-uri'));
});
})
});
Expand All @@ -447,10 +446,10 @@
* @returns {Plugin}
*/
addToggleTableButton: function () {
var $chartWrapper = $(this.element).closest('.dvf--wrapper');
var $chartWrapper = this.element.closest('.dvf--wrapper');

// For each chart, add download buttons.
$chartWrapper.once('table-toggle').each(function(i, el){
once('table-toggle', $chartWrapper).forEach(el => {
var $buttonWrapper = $(el).find('.table-chart--actions');

if ( $('.dvf-table', el).length === 0) {
Expand Down Expand Up @@ -615,4 +614,4 @@
});
};

})(jQuery, bb);
})(jQuery, bb, once);
5 changes: 1 addition & 4 deletions src/DvfHelpers.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

namespace Drupal\dvf;

use Drupal\Core\Link;
use Drupal\Core\Url;
use Drupal\Component\Render\FormattableMarkup;

/**
Expand Down Expand Up @@ -50,8 +48,7 @@ public function transformMachineName($string) {
* The link.
*/
public function getHelpPageLink($template_name) {
$link = Link::fromTextAndUrl('Help', Url::fromUserInput($this->helpPageBasePath . $template_name));
return new FormattableMarkup('<span class="dvf-admin-popup">' . $link->toString() . ' &#x29c9;</span>', []);
return new FormattableMarkup('<span class="dvf-admin-popup"><a href="/dvf/help/@template_name">Help</a> &#x29c9;</span>', ['@template_name' => $template_name]);
}

/**
Expand Down
2 changes: 1 addition & 1 deletion src/FieldWidgetTrait.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ protected function getAjaxWrapperId(array $form, $field_name, $delta) {
$parents = !empty($form['#parents']) ? $form['#parents'] : [];
$id_prefix = implode('-', array_merge($parents, [$field_name, $delta]));

return Html::getUniqueId($id_prefix . '-dvf-options');
return $id_prefix . '-dvf-options';
}

}
6 changes: 4 additions & 2 deletions src/Plugin/Field/FieldWidget/VisualisationFileWidget.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ public function formElement(FieldItemListInterface $items, $delta, array $elemen
'#tree' => TRUE,
];

$ajaxWrapperId = $this->getAjaxWrapperId($form, $this->fieldDefinition->getName(), $delta);

$element['options']['visualisation_style'] = [
'#type' => 'select',
'#title' => $this->t('Visualisation style'),
Expand All @@ -110,13 +112,13 @@ public function formElement(FieldItemListInterface $items, $delta, array $elemen
'#required' => $element['#required'],
'#ajax' => [
'callback' => [$this, 'updateVisualisationOptions'],
'wrapper' => $this->getAjaxWrapperId($form, $this->fieldDefinition->getName(), $delta),
'wrapper' => $ajaxWrapperId,
],
];

$element['options']['visualisation_style_options'] = [
'#type' => 'container',
'#attributes' => ['id' => $element['options']['visualisation_style']['#ajax']['wrapper']],
'#attributes' => ['id' => $ajaxWrapperId],
];

$style_id = $this->getElementOptions($items, $delta, $form, $form_state, 'visualisation_style');
Expand Down
6 changes: 4 additions & 2 deletions src/Plugin/Field/FieldWidget/VisualisationUrlWidget.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ public function formElement(FieldItemListInterface $items, $delta, array $elemen
'#tree' => TRUE,
];

$ajaxWrapperId = $this->getAjaxWrapperId($form, $this->fieldDefinition->getName(), $delta);

$element['options']['visualisation_style'] = [
'#type' => 'select',
'#title' => $this->t('Visualisation style'),
Expand All @@ -81,13 +83,13 @@ public function formElement(FieldItemListInterface $items, $delta, array $elemen
'#required' => $element['#required'],
'#ajax' => [
'callback' => [$this, 'updateVisualisationOptions'],
'wrapper' => $this->getAjaxWrapperId($form, $this->fieldDefinition->getName(), $delta),
'wrapper' => $ajaxWrapperId,
],
];

$element['options']['visualisation_style_options'] = [
'#type' => 'container',
'#attributes' => ['id' => $element['options']['visualisation_style']['#ajax']['wrapper']],
'#attributes' => ['id' => $ajaxWrapperId],
];

$style_id = $this->getElementOptions($items, $delta, $form, $form_state, 'visualisation_style');
Expand Down
12 changes: 6 additions & 6 deletions src/Plugin/Visualisation/Source/VisualisationSourceBase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,42 +197,42 @@ protected function getIterator() {
/**
* {@inheritdoc}
*/
public function current() {
public function current(): mixed {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lem-doghouse, I'm curious about what else could be returned here. Is there a way to avoid mixed return type.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @amjad1233 ,

An alternative solution is to add the #[\ReturnTypeWillChange] attribute. It's worth noting that the current() method in the Iterator's Interface is marked with #[TentativeType], indicating that the return type can change dynamically based on runtime conditions.

If you find it suitable, I'm more than willing to make adjustments by replacing the mixed return type and integrating the #[\ReturnTypeWillChange] attribute instead. Please let me know your thoughts on this matter.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh cool thanks for the run down just checked the interface... Let's leave it as it is for now... I think #[\ReturnTypeWillChange] has compatibility issues with older PHP from memory.

return $this->getIterator()->current();
}

/**
* {@inheritdoc}
*/
public function next() {
public function next(): void {
$this->getIterator()->next();
}

/**
* {@inheritdoc}
*/
public function key() {
public function key(): mixed {
return $this->getIterator()->key();
}

/**
* {@inheritdoc}
*/
public function valid() {
public function valid(): bool {
return $this->getIterator()->valid();
}

/**
* {@inheritdoc}
*/
public function rewind() {
public function rewind(): void {
$this->getIterator()->rewind();
}

/**
* {@inheritdoc}
*/
public function count() {
public function count(): int {
$iterator = $this->getIterator();
return ($iterator instanceof \Countable) ? $iterator->count() : iterator_count($this->initializeIterator());
}
Expand Down
8 changes: 6 additions & 2 deletions src/Plugin/Visualisation/Style/AxisChart.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,8 @@ public function settingsForm(array $form, FormStateInterface $form_state) {
'#default_value' => $this->config('axis', 'x', 'tick', 'culling'),
];

$ajaxWrapperId = $form['#attributes']['id'] . '--x-axis-grouping';

$form['axis']['x']['tick']['values']['field'] = [
'#type' => 'select',
'#title' => $this->t('Tick values field'),
Expand All @@ -202,7 +204,7 @@ public function settingsForm(array $form, FormStateInterface $form_state) {
'#default_value' => $this->config('axis', 'x', 'tick', 'values', 'field'),
'#ajax' => [
'callback' => [$this, 'updateAxisGrouping'],
'wrapper' => 'x-axis-grouping',
'wrapper' => $ajaxWrapperId,
],
];

Expand All @@ -214,7 +216,7 @@ public function settingsForm(array $form, FormStateInterface $form_state) {
];

$form['axis']['x']['x_axis_grouping'] = [
'#prefix' => '<div id="x-axis-grouping">',
'#prefix' => "<div id=$ajaxWrapperId>",
'#suffix' => '</div>',
'#type' => 'select',
'#title' => $this->t('X Axis Grouping'),
Expand All @@ -234,6 +236,8 @@ public function settingsForm(array $form, FormStateInterface $form_state) {

if (!$this->config('axis', 'x', 'tick', 'values', 'field')) {
$form['axis']['x']['x_axis_grouping']['#attributes']['disabled'] = 'disabled';
} else {
unset($form['axis']['x']['x_axis_grouping']['#attributes']['disabled']);
}

$form['axis']['x']['tick']['format']['indexed'] = [
Expand Down
Loading