summaryrefslogtreecommitdiff
path: root/app/Datatables.php
blob: b6759601194326d83ed002040606de0aba70cbd4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
<?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[]
	 */
	public 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 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]',
				'data-state-save' => 'true',
			] + self::defaultAttributes() + 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',
		]);
	}
}