From: Jan Büren <jan@kivitendo.de>
Date: Tue, 26 Oct 2021 12:28:11 +0000 (+0200)
Subject: ShopConnector::Base POD Doku was die Schnittstelle erwartet
X-Git-Tag: kivitendo-mebil_0.1-0~10^2~2^2~218^2~38
X-Git-Url: http://wagnertech.de/git?a=commitdiff_plain;h=93f4876585007a50a0821ebe499a4153930ddc7d;p=kivitendo-erp.git

ShopConnector::Base POD Doku was die Schnittstelle erwartet
---

diff --git a/SL/ShopConnector/Base.pm b/SL/ShopConnector/Base.pm
index 56127e4c4..68c39d15f 100644
--- a/SL/ShopConnector/Base.pm
+++ b/SL/ShopConnector/Base.pm
@@ -17,7 +17,16 @@ sub get_article    { die 'get_article needs to be implemented' }
 
 sub get_categories { die 'get_categories needs to be implemented' }
 
-sub get_version    { die 'get_version needs to be implemented' }
+sub get_version    {
+
+  die 'get_version needs to be implemented';
+  # has to return a hashref with this structure:
+  # version has to return the connection error message
+  my $connect = {};
+  $connect->{success}         = 0 || 1;
+  $connect->{data}->{version} = '1234';
+  return $connect;
+}
 
 sub set_orderstatus { die 'set_orderstatus needs to be implemented' }
 
@@ -52,6 +61,16 @@ __END__
 
 =item C<get_version>
 
+IMPORTANT: This call is used to test the connection and if succesful
+it returns the version number of the shop. If not succesful the
+returning function has to make sure a error string is returned in
+the same data structure. Details of the returning hashref:
+
+ my $connect = {};
+ $connect->{success}         = 0 || 1;
+ $connect->{data}->{version} = '1234';
+ return $connect;
+
 =item C<set_orderstatus>
 
 =back