summaryrefslogtreecommitdiff
path: root/app/Datatables.php
diff options
context:
space:
mode:
authorGreg Roach <fisharebest@gmail.com>2017-03-07 12:02:25 +0000
committerGreg Roach <fisharebest@gmail.com>2017-06-17 16:17:44 +0100
commit15d603e7c7c15d20f055d3d9c38d6b133453c5be (patch)
tree14cd348cd8d2cbb465626429334a9558c0bf5a43 /app/Datatables.php
parent95664b44addad5559917902d85518988a3ea7bc4 (diff)
downloadwebtrees-15d603e7c7c15d20f055d3d9c38d6b133453c5be.tar.gz
webtrees-15d603e7c7c15d20f055d3d9c38d6b133453c5be.tar.bz2
webtrees-15d603e7c7c15d20f055d3d9c38d6b133453c5be.zip
jQuery-3, Bootstrap-4, FontAwesome-4.7, Select2-4, remove popup windows
Diffstat (limited to 'app/Datatables.php')
-rw-r--r--app/Datatables.php180
1 files changed, 180 insertions, 0 deletions
diff --git a/app/Datatables.php b/app/Datatables.php
new file mode 100644
index 0000000000..7418118f58
--- /dev/null
+++ b/app/Datatables.php
@@ -0,0 +1,180 @@
+<?php
+/**
+ * webtrees: online genealogy
+ * Copyright (C) 2017 webtrees development team
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+namespace Fisharebest\Webtrees;
+
+use Fisharebest\Webtrees\Functions\FunctionsEdit;
+
+/**
+ * Helper functions to generate markup for Datatables.
+ *
+ * @link https://www.datatables.net
+ */
+class Datatables {
+ /**
+ * Generate the HTML attributes for I18N.
+ *
+ * @return string[]
+ */
+ private static function defaultAttributes() {
+ return [
+ 'style' => 'display:none;', // Hide until processed, to prevent FOUC.
+ ];
+ }
+
+ /**
+ * Generate the HTML attributes for I18N.
+ *
+ * @param int[] $lengths
+ *
+ * @return string[]
+ */
+ private static function languageAttributes(array $lengths = [10, 25, 100, -1]) {
+ $length_menu = FunctionsEdit::numericOptions($lengths);
+
+ $language = [
+ 'paginate' => [
+ 'first' => /* I18N: A button label, first page */ I18N::translate('first'),
+ 'last' => /* I18N: A button label, last page */ I18N::translate('last'),
+ 'next' => /* I18N: A button label, next page */ I18N::translate('next'),
+ 'previous' => /* I18N: A button label, previous page */ I18N::translate('previous'),
+ ],
+ 'emptyTable' => I18N::translate('No records to display'),
+ 'info' => /* I18N: %s are placeholders for numbers */ I18N::translate('Showing %1$s to %2$s of %3$s', '_START_', '_END_', '_TOTAL_'),
+ 'infoEmpty' => I18N::translate('Showing %1$s to %2$s of %3$s', 0, 0, 0),
+ 'infoFiltered' => /* I18N: %s is a number */ I18N::translate('(filtered from %s total entries)', '_MAX_'),
+ 'lengthMenu' => /* I18N: %s is a number of records per page */ I18N::translate('Display %s', '_MENU_'),
+ 'loadingRecords' => I18N::translate('Loading…'),
+ 'processing' => I18N::translate('Calculating…'),
+ 'search' => I18N::translate('Filter'),
+ 'zeroRecords' => I18N::translate('No records to display'),
+ ];
+
+ return [
+ 'data-language' => json_encode($language),
+ 'data-length-menu' => json_encode([array_keys($length_menu), array_values($length_menu)])
+ ];
+ }
+
+ /**
+ * Generate the HTML attributes for a table of events.
+ *
+ * @return string
+ */
+ public static function eventTableAttributes() {
+ return Html::attributes([
+ 'class' => 'table table-bordered table-sm table-responsive datatables table-event',
+ //'data-columns' => '[{ type: "text" }, { type: "num" }, { type: "num" }, { type: "text" }]',
+ 'data-columns' => '[null, null, null, null]',
+ 'data-info' => 'false',
+ 'data-paging' => 'false',
+ 'data-searching' => 'false',
+ 'data-state-save' => 'true',
+ ] + self::languageAttributes());
+ }
+
+ /**
+ * Generate the HTML attributes for a table of given names.
+ *
+ * @return string
+ */
+ public static function givenNameTableAttributes() {
+ return Html::attributes([
+ 'class' => 'table table-bordered table-sm table-responsive datatables table-given-name',
+ //'data-columns' => '[{ type: "text" }, { type: "num" }]',
+ 'data-columns' => '[null, null]',
+ 'data-info' => 'false',
+ 'data-paging' => 'false',
+ 'data-searching' => 'false',
+ 'data-state-save' => 'true',
+ ]);
+ }
+
+ /**
+ * Generate the HTML attributes for a table of notes.
+ *
+ * @return string
+ */
+ public static function noteTableAttributes() {
+ return Html::attributes([
+ 'class' => 'table table-bordered table-sm table-responsive datatables table-note',
+ //'data-columns' => '[{ type: "text" }, { type: "text" }, { type: "num" }, { type: "num" }, { type: "num" }, { type: "text" }, { sorting: false }]',
+ 'data-columns' => '[null, null, null, null, null, null, null]',
+ 'data-state-save' => 'true',
+ ] + self::defaultAttributes() + self::languageAttributes());
+ }
+
+ /**
+ * Generate the HTML attributes for a table of research tasks.
+ *
+ * @return string
+ */
+ public static function researchTaskTableAttributes() {
+ return Html::attributes([
+ 'class' => 'table table-bordered table-sm table-responsive datatables table-research-task',
+ //'data-columns' => '[{ type: "num" }, { type: "text" }, { type: "text" }, { type: "text" }]',
+ 'data-columns' => '[null, null, null, null]',
+ 'data-info' => 'false',
+ 'data-paging' => 'false',
+ 'data-searching' => 'false',
+ 'data-state-save' => 'true',
+ ] + self::languageAttributes());
+ }
+
+ /**
+ * Generate the HTML attributes for a table of repositories.
+ *
+ * @return string
+ */
+ public static function repositoryTableAttributes() {
+ return Html::attributes([
+ 'class' => 'table table-bordered table-sm table-responsive datatables table-repository',
+ //'data-columns' => '[{ type: "text" }, { type: "num" }, { type: "text" }, { sorting: false }]',
+ 'data-columns' => '[null, null, null, null]',
+ 'data-state-save' => 'true',
+ ] + self::languageAttributes());
+ }
+
+ /**
+ * Generate the HTML attributes for a table of sources.
+ *
+ * @return string
+ */
+ public static function sourceTableAttributes() {
+ return Html::attributes([
+ 'class' => 'table table-bordered table-sm table-responsive datatables table-source',
+ //'data-columns' => '[{ type: "text" }, { type: "text" }, { type: "num" }, { type: "num" }, { type: "num" }, { type: "num" }, { type: "text" }, { sorting: false }]',
+ 'data-columns' => '[null, null, null, null, null, null, null, null]',
+ 'data-state-save' => 'true',
+ ] + self::languageAttributes());
+ }
+
+ /**
+ * Generate the HTML attributes for a table of surnames.
+ *
+ * @return string
+ */
+ public static function surnameTableAttributes() {
+ return Html::attributes([
+ 'class' => 'table table-bordered table-sm table-responsive datatables table-surname',
+ //'data-columns' => '[{ type: "text" }, { type: "num" }]',
+ 'data-columns' => '[null, null]',
+ 'data-info' => 'false',
+ 'data-paging' => 'false',
+ 'data-searching' => 'false',
+ 'data-state-save' => 'true',
+ ]);
+ }
+}