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
|
# --
# Copyright (C) 2001-2021 OTRS AG, https://otrs.com/
# --
# This software comes with ABSOLUTELY NO WARRANTY. For details, see
# the enclosed file COPYING for license information (GPL). If you
# did not receive this file, see https://www.gnu.org/licenses/gpl-3.0.txt.
# --
package Kernel::Output::HTML::Layout::AJAX;
use strict;
use warnings;
use Kernel::System::JSON ();
our $ObjectManagerDisabled = 1;
=head1 NAME
Kernel::Output::HTML::Layout::AJAX - all AJAX-related HTML functions
=head1 DESCRIPTION
All AJAX-related HTML functions
=head1 PUBLIC INTERFACE
=head2 BuildSelectionJSON()
build a JSON output which can be used for e. g. data for pull downs
my $JSON = $LayoutObject->BuildSelectionJSON(
[
{
Data => $ArrayRef, # use $HashRef, $ArrayRef or $ArrayHashRef (see below)
Name => 'TheName', # name of element
SelectedID => [1, 5, 3], # (optional) use integer or arrayref (unable to use with ArrayHashRef)
SelectedValue => 'test', # (optional) use string or arrayref (unable to use with ArrayHashRef)
Sort => 'NumericValue', # (optional) (AlphanumericValue|NumericValue|AlphanumericKey|NumericKey|TreeView) unable to use with ArrayHashRef
SortReverse => 0, # (optional) reverse the list
Translation => 1, # (optional) default 1 (0|1) translate value
PossibleNone => 0, # (optional) default 0 (0|1) add a leading empty selection
Max => 100, # (optional) default 100 max size of the shown value
},
{
# ...
}
]
);
=cut
sub BuildSelectionJSON {
my ( $Self, $Array ) = @_;
my %DataHash;
for my $Data ( @{$Array} ) {
my %Param = %{$Data};
# log object
my $LogObject = $Kernel::OM->Get('Kernel::System::Log');
# check needed stuff
for (qw(Name)) {
if ( !defined $Param{$_} ) {
$LogObject->Log(
Priority => 'error',
Message => "Need $_!"
);
return;
}
}
if ( !defined( $Param{Data} ) ) {
if ( !$Param{PossibleNone} ) {
$LogObject->Log(
Priority => 'error',
Message => "Need Data!"
);
return;
}
$DataHash{''} = '-';
}
elsif ( ref $Param{Data} eq '' ) {
$DataHash{ $Param{Name} } = $Param{Data};
}
elsif ( defined $Param{KeepData} && $Param{KeepData} ) {
$DataHash{ $Param{Name} } = $Param{Data};
}
else {
# create OptionRef
my $OptionRef = $Self->_BuildSelectionOptionRefCreate(
%Param,
HTMLQuote => 0,
);
# create AttributeRef
my $AttributeRef = $Self->_BuildSelectionAttributeRefCreate(%Param);
# create DataRef
my $DataRef = $Self->_BuildSelectionDataRefCreate(
Data => $Param{Data},
AttributeRef => $AttributeRef,
OptionRef => $OptionRef,
);
# create data structure
if ( $AttributeRef && $DataRef ) {
my @DataArray;
for my $Row ( @{$DataRef} ) {
my $Key = '';
if ( defined $Row->{Key} ) {
$Key = $Row->{Key};
}
my $Value = '';
if ( defined $Row->{Value} ) {
$Value = $Row->{Value};
}
# DefaultSelected parameter for JavaScript New Option
my $DefaultSelected = Kernel::System::JSON::False();
# to set a disabled option (Disabled is not included in JavaScript New Option)
my $Disabled = Kernel::System::JSON::False();
if ( $Row->{Selected} ) {
$DefaultSelected = Kernel::System::JSON::True();
}
elsif ( $Row->{Disabled} ) {
$DefaultSelected = Kernel::System::JSON::False();
$Disabled = Kernel::System::JSON::True();
}
# Selected parameter for JavaScript NewOption
my $Selected = $DefaultSelected;
push @DataArray, [ $Key, $Value, $DefaultSelected, $Selected, $Disabled ];
}
$DataHash{ $AttributeRef->{name} } = \@DataArray;
}
}
}
return $Self->JSONEncode(
Data => \%DataHash,
);
}
1;
=head1 TERMS AND CONDITIONS
This software is part of the OTRS project (L<https://otrs.org/>).
This software comes with ABSOLUTELY NO WARRANTY. For details, see
the enclosed file COPYING for license information (GPL). If you
did not receive this file, see L<https://www.gnu.org/licenses/gpl-3.0.txt>.
=cut
|
