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 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
|
# --
# Copyright (C) 2001-2019 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::TicketZoom::Customer::Base;
use strict;
use warnings;
use Digest::MD5 qw(md5_hex);
use Kernel::System::VariableCheck qw(IsHashRefWithData);
our @ObjectDependencies = (
'Kernel::Config',
'Kernel::Output::HTML::Layout',
'Kernel::System::DynamicField',
'Kernel::System::DynamicField::Backend',
'Kernel::System::Log',
'Kernel::System::Ticket::Article',
);
sub new {
my ( $Type, %Param ) = @_;
# allocate new hash for object
my $Self = {};
bless( $Self, $Type );
return $Self;
}
=head2 ArticleRender()
Returns article html.
my $HTML = $ArticleBaseObject->ArticleRender(
TicketID => 123, # (required)
ArticleID => 123, # (required)
ShowBrowserLinkMessage => 1, # (optional) Default: 0.
ArticleActions => [], # (optional)
);
Result:
$HTML = "<div>...</div>";
=cut
sub ArticleRender {
die 'Virtual method in base class must not be called.';
}
=head2 ArticleMetaFields()
Returns common fields for any article.
my %ArticleMetaFields = $ArticleBaseObject->ArticleMetaFields(
TicketID => 123, # (required)
ArticleID => 123, # (required)
);
Returns:
%ArticleMetaFields = (
DynamicField_Item => {
Label => 'Item', # mandatory
Value => 'Value', # mandatory
Link => 'http://...', # optional
},
AccountedTime => {
...
},
);
=cut
sub ArticleMetaFields {
my ( $Self, %Param ) = @_;
# Check needed stuff.
for my $Needed (qw(TicketID ArticleID)) {
if ( !$Param{$Needed} ) {
$Kernel::OM->Get('Kernel::System::Log')->Log(
Priority => 'error',
Message => "Need $Needed!",
);
return;
}
}
my $ConfigObject = $Kernel::OM->Get('Kernel::Config');
my $ArticleObject = $Kernel::OM->Get('Kernel::System::Ticket::Article');
my $LayoutObject = $Kernel::OM->Get('Kernel::Output::HTML::Layout');
my $BackendObject = $Kernel::OM->Get('Kernel::System::DynamicField::Backend');
my %Result;
# show accounted article time
if ( $ConfigObject->Get('Ticket::Frontend::CustomerTicketZoom')->{ZoomTimeDisplay} ) {
my $ArticleTime = $ArticleObject->ArticleAccountedTimeGet(
ArticleID => $Param{ArticleID},
);
if ($ArticleTime) {
$Result{Time} = {
Label => "Time",
Value => $ArticleTime,
};
}
}
# get dynamic field config for frontend module
my $DynamicFieldFilter = {
%{ $ConfigObject->Get("Ticket::Frontend::CustomerTicketZoom")->{DynamicField} || {} },
# TODO: Check if there are process dynamic fields for customer interface
# %{
# $ConfigObject->Get("Ticket::Frontend::CustomerTicketZoom")->{ProcessWidgetDynamicField}
# || {}
# },
};
# get the dynamic fields for article object
my $DynamicField = $Kernel::OM->Get('Kernel::System::DynamicField')->DynamicFieldListGet(
Valid => 1,
ObjectType => ['Article'],
FieldFilter => $DynamicFieldFilter || {},
);
my $DynamicFieldBackendObject = $Kernel::OM->Get('Kernel::System::DynamicField::Backend');
# cycle trough the activated Dynamic Fields
DYNAMICFIELD:
for my $DynamicFieldConfig ( @{$DynamicField} ) {
next DYNAMICFIELD if !IsHashRefWithData($DynamicFieldConfig);
# skip the dynamic field if is not desinged for customer interface
my $IsCustomerInterfaceCapable = $BackendObject->HasBehavior(
DynamicFieldConfig => $DynamicFieldConfig,
Behavior => 'IsCustomerInterfaceCapable',
);
next DYNAMICFIELD if !$IsCustomerInterfaceCapable;
my $Value = $DynamicFieldBackendObject->ValueGet(
DynamicFieldConfig => $DynamicFieldConfig,
ObjectID => $Param{ArticleID},
);
next DYNAMICFIELD if !$Value;
next DYNAMICFIELD if $Value eq '';
# get print string for this dynamic field
my $ValueStrg = $DynamicFieldBackendObject->DisplayValueRender(
DynamicFieldConfig => $DynamicFieldConfig,
Value => $Value,
ValueMaxChars => 160,
LayoutObject => $LayoutObject,
);
my $Label = $DynamicFieldConfig->{Label};
$Result{ $DynamicFieldConfig->{Name} } = {
Label => $Label,
Value => $ValueStrg->{Value},
Title => $ValueStrg->{Title},
};
if ( $ValueStrg->{Link} ) {
$Result{ $DynamicFieldConfig->{Name} }->{Link} = $ValueStrg->{Link};
}
if ( $ValueStrg->{LinkPreview} ) {
$Result{ $DynamicFieldConfig->{Name} }->{LinkPreview} = $ValueStrg->{LinkPreview};
}
}
return %Result;
}
1;
|