Q: Magento zeigt nach der Extension-Installation eine weiße Seite ("Blank Page")

Symptom : Beim Ausführen einer bestimmten Aktion zeigt Magento nur eine weiße Seite ohne Inhalt. Dies ist i.d.R. der Fall, wenn ein sog. "Fatal PHP-Error" aufgetreten ist. Bitte sehen Sie zur Fehleranalyse in den PHP-/Webserver-Log-Dateien nach (z.B. unter /var/log/apache/.. , ggfs. bei Ihrem Hoster erkundigen) und/oder im Magento Fehler-Log im Verzeichnis var/log . Sofern es sich um eine lokale (Test-)Installation handelt, hilft auch ein Setzen der folgenden PHP-Settings in der Konfigurationsdatei php.ini : error_reporting = E_ALL;display_errors = On; Alternativ im PHP-Code analog: error_reporting(E_ALL);ini_set('display_errors', 1); Sollten Sie Hilfe bei der Auswertung des Fehlers benötigen, kontaktieren Sie mich bitte mit der Fehlermeldung und den exakten Schritten zur Reproduktion des Fehlers.

Q: Erweitertes Logging der Magento Extension aktivieren

Alle meine vianetz Magento Extensions bieten die Möglichkeit, über eine Konfiguration ein erweitertes Fehlerlogging zu aktivieren. Dies benötigen wir ggfs. für komplexere Supportanfragen oder es kann Ihnen zum Nachvollziehen von bestimmten Verhaltensweisen dienen. Um das erweiterte Logging zu aktivieren, sind folgende Schritte notwendig (erklärt am Beispiel unserer Advanced Invoice Layout -Extension; dies gilt für alle Extensions analog): Aktivieren Sie das Magento system.log unter System › Konfiguration › Entwickleroptionen › Log Einstellungen › Aktiviert: ja Führen Sie die entsprechende Aktion aus, die den Fehler verursacht (z.B. Druck einer PDF-Rechnung, Aufrufen des Crons, etc.) Anschließend wird in dem Ordner var/log/ der Magento-Installation eine Datei mit dem Namen des Moduls geschrieben, in diesem Fall vianetz_advancedinvoicelayout.log In dieser Datei stehen nun alle relevanten Informationen zur Verfügung.

Q: Fehler: PDF-Dokumente können nicht erstellt werden, wenn das Feature PDF-Briefpapier verwendet wird

Symptom: Bei Verwendung eines eigenen PDF-Briefpapiers lässt sich die PDF-Rechnung nicht drucken und es erscheinen z.T. Fehlermeldungen wie "Cross-reference streams are not supported yet" oder "This document probably uses a compression technique which is not supported by the free parser shipped with FPDI". Lösung: Versuchen Sie das PDF-Briefpapier unter anderen Optionen abzuspeichern, insbesondere sollte das PDF als PDF/A für Acrobat 1.4 und Acrobat 5 abgespeichert werden.

Q: Fehlermeldung "Fatal error: Access level to FPDI::_putformxobjects() must be public.."

Ausgangssituation Im Shop sind meine Advanced Invoice Layout Extension sowie die DHL_Intraship -Extension installiert. Bei Druck der Labels oder PDF-Rechnungen erscheint folgende Fehlermeldung: Fatal error: Access level to FPDI::_putformxobjects() must be public (as in class FPDF_TPL) in ..../lib/SetasignFpdi/fpdi.php on line 695 Lösung Aufgrund der unterschiedlichen FPDI-Library-Versionen sind Anpassungen an folgenden Dateien notwendig (vielen Dank an Tobias Bungers für die Lösung): app/code/community/Dhl/Intraship/Helper/Pdf.php (line 65) app/code/community/Dhl/Intraship/Helper/Pdf/Document.php (line 100) Bitte kontaktieren Sie mich , falls Sie die Patches benötigen.

Question 1

Magento zeigt nach der Extension-Installation eine weiße Seite ("Blank Page")

Accepted Answer

Symptom: Beim Ausführen einer bestimmten Aktion zeigt Magento nur eine weiße Seite ohne Inhalt.

Dies ist i.d.R. der Fall, wenn ein sog. "Fatal PHP-Error" aufgetreten ist.
Bitte sehen Sie zur Fehleranalyse in den PHP-/Webserver-Log-Dateien nach (z.B. unter /var/log/apache/.., ggfs. bei Ihrem Hoster erkundigen) und/oder im Magento Fehler-Log im Verzeichnis var/log.

Sofern es sich um eine lokale (Test-)Installation handelt, hilft auch ein Setzen der folgenden PHP-Settings in der Konfigurationsdatei php.ini:

error_reporting = E_ALL;display_errors = On;

Alternativ im PHP-Code analog:

error_reporting(E_ALL);ini_set('display_errors', 1);

Sollten Sie Hilfe bei der Auswertung des Fehlers benötigen, kontaktieren Sie mich bitte mit der Fehlermeldung und den exakten Schritten zur Reproduktion des Fehlers.

Question 2

Change font family in Magento PDF invoice layout

Accepted Answer

With my Advanced Invoice Layout extension it is easy to change the font family in the Magento PDF invoice.
Therefore the Advanced Invoice Layout extension ships with several default fonts which you can choose from: Courier, DejaVu Sans, Helvetica, Times

Due to licensing issues it is not possible to add other font families by default, but you can also easily add your own font family with the following possibilities:

Use Internet Fonts, e.g. Google Fonts
Use Local Fonts, e.g. in TTF format

Case #1: Use Internet Fonts, e.g. Google Fonts

Note: this is supported by our Advanced Invoice Layout Extension for Magento 1 from version 2.3.16 or newer or for Magento 2

Additional fonts can easily be embedded via CSS, e.g. with Google Fonts:

@import url('https://fonts.googleapis.com/css2?family=Roboto&display=swap');@import url('https://fonts.googleapis.com/css2?family=Roboto:wght@700&display=swap');body { font-family: Roboto !important }

Please note that in older versions of the used PDF library, the font files have to be downloaded and saved locally (due to a bug):

@font-face { font-family: 'Roboto'; src: url('/path/to/Roboto-Medium.ttf') format('truetype'); font-weight: normal; font-style: normal; }@font-face { font-family: 'Roboto'; src: url('/path/to/Roboto-Bold.ttf') format('truetype'); font-weight: bold; font-style: normal; }body { font-family: Roboto !important }

Case #2: Use local fonts, e.g. in TTF format

Advanced Invoice Layout for Magento 1 with version 2.3.16 or newer

You have to download the load_font.php utility from GitHub to the folder lib/dompdf-advancedinvoicelayout/ and change the third line of the file to

require_once "autoload.inc.php";

Then change into the directory lib/dompdf-advancedinvoicelayout.

Advanced Invoice Layout for Magento 2

You simply have to download the load_font.php utility from GitHub to the Magento root folder.

Then you need to make sure that the used DomPDF library gets to know the new font by executing the following command in the Magento root directory (replace MyFont with your desired font):
```
php -f load_font.php 'MyFont' /path/to/myfont
```
Finally you can use the font in your CSS with
```
font-family: MyFont;
```

Advanced Invoice Layout for Magento 1 with version 2.3.15 or older

You need to temporarily rename the file lib/dompdf/dompdf_config.custom.inc.php to something else.
Then change into the directory lib/dompdf-advancedinvoicelayout.
Execute the above mentioned load_font.php command.
Afterwards inject the new font into the XML config object (see app/code/community/Vianetz/AdvancedInvoiceLayout/etc/config.xml) by extending the XML node default/advancedinvoicelayout/fonts, e.g.
The node title must match the generated file in step 2.

And that's it! Now you can choose the new font family in the configuration section under System › Configuration › Advanced Invoice Layout.

For further explanations see also the PDF Library documentation about About Fonts and Character Encoding.

Question 3

Attribute der Bestellung auf der Magento Rechnung oder dem Lieferschein anzeigen

Accepted Answer

Um individuelle Felder/Attribute aus der Bestellung auf der PDF-Rechnung, dem -Lieferschein oder der -Gutschrift anzeigen zu können, gibt es mit unserem Advanced Invoice Layout Modul 2 Möglichkeiten (hier anhand des fiktiven Attributs my_attribute auf der Magento-Bestellung):

Über die Konfiguration kann in allen Textfeldern, z.B. im Freitext-Feld der Platzhalter {{var order.getMyAttribute()}} verwendet werden oder
es können direkt die PHP/HTML-Templates editiert werden und folgender Code an entsprechender Stelle eingefügt werden:
```
echo $this->getOrder()->getMyAttribute();
```

Question 4

Artikeloptionen nebeneinander anzeigen

Accepted Answer

Mit folgendem CSS-Code können die Artikel-Optionen in den Magento PDF-Layouts anstatt in einer Liste nebeneinander angezeigt werden:

#itemTable ul.itemOptionList { list-style-type: none;  padding: 0; }#itemTable ul.itemOptionList li { display: inline; }

Question 5

Available Variables for Magento PDF Layouts

Accepted Answer

With my Advanced Invoice Layout Extension you have lots of possibilities for dynamic content in your Magento PDF layouts.

For salutations, footer columns and other free texts in the Magento PDF invoices, shipments and creditmemos, the following variables are available in System › Configuration › Advanced Invoice Layout.

Please note: Simple existence of a variable can be checked with {{depend shipping_date}}, negations can be used with {{if is_shipment}}{{else}}No Shipment{{/if}}.

Variable/Expression	Explanation
`{{var increment_id}}`	Invoice/Shipment/Creditmemo Increment Id
`{{var customer_id}}`	Customer Id
`{{var order.getIncrementId()}}`	Order Id (all other order attributes can also be accessed with the order object)
`{{var increment_id}}`	Invoice/Shipment/Creditmemo Increment Id
`{{depend is_invoice}} Text only for invoices {{/depend}}`	"Text only for invoices" will only be shown on invoice PDFs.
`{{depend is_shipment}} Text only for shipments {{/depend}}`	"Text only for shipments" will only be shown on shipment PDFs.
`{{depend is_creditmemo}} Text only for creditmemos {{/depend}}`	"Text only for creditmemos" will only be shown on creditmemo PDFs.
`{{var billing_address}}`	Billing Address of Order (formatting can be configured)
`{{var shipping_address}}`	Shipping Address of Order (formatting can be configured)
`{{date}}`	Date of invoice/shipment/creditmemo creation (formatted in your locale)
`{{date+X}}`	Date of invoice/shipment/creditmemo creation plus specified number of days, e.g. for specifying due/delivery dates. (Replace "X" with number of days)
`{{var prefix}}`	Customer Prefix
`{{var firstname}}`	Customer Firstname
`{{var lastname}}`	Customer Lastname
`{{var shipping_date}}`	The date of the first shipment (if any)
`{{var payment_method.getTitle()}}`	The payment method title
`{{if payment_method_purchaseorder}} Only for invoices with payment method purchase order. {{else}}For all other payment methods.{{/if}}`	With this statement you can insert text that is dependent on the payment method, in this example purchaseorder. Just replace the text "purchaseorder" with your payment method code, e.g. "checkmo", "banktransfer", "payone", ..
`{{config path="design/head/default_description"}}`	Access any Magento configuration value. Please note that the variable has to be allowed in System › Permissions › Variables
`{{customVar code=test_variable}}`	Any Magento variable configured in System › Custom Variables

If you have the extension Firegento_MageSetup installed the following additional variables are available:

Variable/Expression	Explanation
`{{config path="general/imprint/tax_number"}}`	The configured tax number of the merchant
`{{config path="general/imprint/vat_id"}}`	The configured vat number of the merchant
`{{config path="general/imprint/bank_account"}}`	The configured bank account
`{{config path="general/imprint/bank_code_number"}}`	The configured bank code number
`{{config path="general/imprint/bank_name"}}`	The configured bank name
`{{config path="general/imprint/swift"}}`	The configured swift number
`{{config path="general/imprint/iban"}}`	The configured iban number

Question 6

Besteht die Möglichkeit, Anpassungen an dem Modul durchführen zu lassen?

Accepted Answer

Ja, bitte kontaktieren Sie mich diesbezüglich mit Ihrem Anliegen.

Question 7

Cyrillic characters are displayed as "?" on the Magento PDF invoice. What can I do?

Accepted Answer

The problem is that the chosen font family does not support the Cyrillic characters. So far no font with Cyrillic support is included into the Advanced Invoice Layout Extension. That means that you have to get your own font family with support for Cyrillic characters and include it into the Advanced Invoice Layout Extension.

Please also see my FAQ article about adding a new font.

Question 8

Das Magento PDF-Layout wird nicht korrekt angezeigt - was kann ich tun?

Accepted Answer

Wenn Sie meine Advanced Invoice Layout Extension für die Anpassung des PDF-Layouts von Rechnungen, Lieferscheinen und Gutschriften verwenden und das PDF nicht wie gewünscht gedruckt wird, gibt es mehrere Fehlermöglichkeiten:

Falls Sie URLs in dem Layout verwenden, muss in der PHP-Konfiguration die Option allow_url_fopen aktiviert sein.
Wurde die Extension gemäß der Installationsanleitung installiert? Sind insbesondere alle Dateien korrekt hochgeladen?

Falls sich Ihr Problem damit nicht beheben lässt, kontaktieren Sie mich gerne.

Question 9

Erhalte ich Lizenzen für unsere Entwicklungsumgebung?

Accepted Answer

Lizenzen für Entwicklungs-/Staging-/Test-Domains sind in der Lizenz für die Produktivdomain inklusive.

Prinzipiell können beliebige weitere Domains als Entwicklungsdomains in die Lizenz aufgenommen werden, allerdings muss klar erkennbar sein, dass es sich hierbei um eine Testumgebung handelt. Dies ist in der Regel immer der Fall, wenn es sich um lokale Domains wie *.local, *.test oder Subdomains beginnend mit test.*, dev.*, etc. handelt oder die Seite dauerhaft Passwort-geschützt ist.

Senden Sie uns bitte nach dem Kauf eine Email mit Ihrer Bestellnummer und der gewünschten Entwicklungsdomain. Wir erweitern die Lizenz dann entsprechend.

Question 10

Erweitertes Logging der Magento Extension aktivieren

Accepted Answer

Alle meine vianetz Magento Extensions bieten die Möglichkeit, über eine Konfiguration ein erweitertes Fehlerlogging zu aktivieren. Dies benötigen wir ggfs. für komplexere Supportanfragen oder es kann Ihnen zum Nachvollziehen von bestimmten Verhaltensweisen dienen.

Um das erweiterte Logging zu aktivieren, sind folgende Schritte notwendig (erklärt am Beispiel unserer Advanced Invoice Layout-Extension; dies gilt für alle Extensions analog):

Aktivieren Sie das Magento system.log unter System › Konfiguration › Entwickleroptionen › Log Einstellungen › Aktiviert: ja
Führen Sie die entsprechende Aktion aus, die den Fehler verursacht (z.B. Druck einer PDF-Rechnung, Aufrufen des Crons, etc.)
Anschließend wird in dem Ordner var/log/ der Magento-Installation eine Datei mit dem Namen des Moduls geschrieben, in diesem Fall vianetz_advancedinvoicelayout.log

In dieser Datei stehen nun alle relevanten Informationen zur Verfügung.

Question 11

Fehler: PDF-Dokumente können nicht erstellt werden, wenn das Feature PDF-Briefpapier verwendet wird

Accepted Answer

Symptom: Bei Verwendung eines eigenen PDF-Briefpapiers lässt sich die PDF-Rechnung nicht drucken und es erscheinen z.T. Fehlermeldungen wie "Cross-reference streams are not supported yet" oder "This document probably uses a compression technique which is not supported by the free parser shipped with FPDI".

Lösung:
Versuchen Sie das PDF-Briefpapier unter anderen Optionen abzuspeichern, insbesondere sollte das PDF als PDF/A für Acrobat 1.4 und Acrobat 5 abgespeichert werden.

Question 12

Fehlermeldung "Fatal error: Access level to FPDI::_putformxobjects() must be public.."

Accepted Answer

Ausgangssituation
Im Shop sind meine Advanced Invoice Layout Extension sowie die DHL_Intraship-Extension installiert.
Bei Druck der Labels oder PDF-Rechnungen erscheint folgende Fehlermeldung:
Fatal error: Access level to FPDI::_putformxobjects() must be public (as in class FPDF_TPL) in ..../lib/SetasignFpdi/fpdi.php on line 695

Lösung
Aufgrund der unterschiedlichen FPDI-Library-Versionen sind Anpassungen an folgenden Dateien notwendig (vielen Dank an Tobias Bungers für die Lösung):

app/code/community/Dhl/Intraship/Helper/Pdf.php (line 65)
app/code/community/Dhl/Intraship/Helper/Pdf/Document.php (line 100)

Bitte kontaktieren Sie mich, falls Sie die Patches benötigen.

Question 13

Fehlermeldung "Fatal error: Declaration of Zend_Pdf_FileParserDataSource_File .."

Accepted Answer

Symptom:Beim Ausdruck eines PDF-Dokuments in Magento erscheint die Fehlermeldung

Fatal error: Declaration of Zend_Pdf_FileParserDataSource_File::__construct() must be compatible with Zend_Pdf_FileParserDataSource::__construct()

Lösung:

Die Ursache ist eine Inkompatibilität des Zend Frameworks < 1.11.12 und PHP 5.4. Magento verwendet in der Version 1.8.1.0 das Zend Framework 1.11, daher tritt das Problem hier auf (siehe hierzu auch mein Blog-Eintrag).
Magento bietet einen Patch, der dieses Problem behebt.

Eine mögliche alternative Lösung ist auf StackOverflow beschrieben:
"Fixed it by change in this function lib/Zend/Pdf/FileParserDataSource.php.change

abstract public function __construct();

to

abstract public function __construct($filePath);

Question 14

Fehlermeldung "Mage registry key already exists" z.B. nach Installation einer Extension

Accepted Answer

Nach der Installation einer Magento Extension erhalten Sie folgende Fehlermeldung, bspw. wenn Sie im Magento Backend anmelden oder eine Seite im Frontend aufrufen:

Mage_Core_Exception: Mage registry key <...> already exists

Die Lösung ist in der Regel sehr einfach:

Falls Sie vor Kurzem eine neue Magento Extension installiert haben, prüfen Sie bitte, ob alle Schritte der Installationsanleitung durchgeführt wurden, die dem jeweiligen Modul beiliegt.
Die Installationsanleitung für meine Magento Extensions finden Sie in diesem FAQ-Eintrag.

Ansonsten ist das Problem meist gelöst, indem der Magento Cache geleert wird, beispielsweise durch Löschen des var/cache/-Verzeichnisses in einer Standard Magento-Installation, sowie ggfs. der Magento-Kompilierungsprozess neu gestartet wurde (wenn das Feature aktiviert ist).

Falls Sie Hilfe bei der Lösung des Problems benötigen, kontaktieren Sie mich gerne.

Question 15

How can I access the base64-encoded PDF file?

Accepted Answer

There may be circumstances where you need the base64-encoded value of one of the PDF documents in Magento 2 like creditmemo, e.g. for sending it other 3rd-party systems.

This can easily be achieved with the following sample code. This code assumes that you have \Vianetz\AdvancedInvoiceLayout\Model\PdfManager $pdfManager and e.g. \Magento\Sales\Api\CreditmemoRepositoryInterface $creditmemoRepository available, for example via Constructor Dependency Injection or as shown by direct Magento 2 Object Manager creation.

$objectManager = \Magento\Framework\App\ObjectManager::getInstance();$pdfManager = $objectManager->create('Vianetz\AdvancedInvoiceLayout\Model\PdfManager');$creditmemo = $objectManager->create('Magento\Sales\Api\CreditmemoRepositoryInterface')->get($creditmemoId);$pdfManager->addSource($creditmemo);// output the base64-encoded valueecho base64_encode($this->pdfManager->getPdf()->getContents());

This code uses parts of my PDF API for Magento.

Question 16

How can I force a page break in the Magento invoice PDF?

Accepted Answer

A page break can be forced in the invoice PDF by adding an HTML element with the CSS class pageBreak.

Question 17

How can I send Magento invoice/shipment emails to store owner only?

Accepted Answer

With my Automatic Invoice Extension for Magento you can send invoice emails to store owner exclusively (i.e. not to the customer). Therefore you have to set the following configurations:

System › Configuration › AutomaticInvoice › Invoice › Notify Customer: No
System › Configuration › Sales Emails › Invoice › Send Order Copy Method: Separate Email

The same applies to shipment emails as well:

System › Configuration › AutomaticInvoice › Shipment › Notify Customer: No
System› Configuration › Sales Emails › Shipment › Send Order Copy Method: Separate Email

Question 18

I cannot login to the Magento Admin - what can I do?

Accepted Answer

Sometimes you have the problem that you cannot login to the Magento Admin area - despite entering the correct username and password. There are several points that you can check in this case (it is most probably an issue with the cookies):

Check the cookie domain in the core_config_data table that it matches your backend domain
Also check that if you previously switched from HTTPS to HTTP that you drop all browser cookies, as if the adminhtml cookie already exists with the "Secure" flag, it cannot be overwritten

Question 19

Ich erhalte nach der Extension-Installation einen 404-Fehler in der Konfiguration

Accepted Answer

Symptom: Es wird ein 404-Fehler angezeigt, wenn unter System › Konfiguration z.B. der Menüpunkt Advanced Invoice Layout gewählt wird.

Um diesen Fehler zu beheben, bitte im Backend ab- und wieder anmelden. Dann sollte sich der Bereich problemlos aufrufen lassen.

Question 20

Ist der Quellcode verschlüsselt?

Accepted Answer

Nein, alle meine Magento Extensions werden ohne Verschlüsselung (ionCube o.ä.) ausgeliefert, so dass Sie einfach den Quellcode erweitern und anpassen können.

Question 21

Kompatibilität mit der Extension AITOC Checkout Fields Manager

Accepted Answer

Unter System › Manage AITOC Modules auf den Link "Manage Class Rewrites" klicken und am Ende in das Textfeld "Indicate names of all base Magento classes, that you wouldn't like to overwrite" den Wert Mage_Sales_Model_Order_Pdf_Invoiceergänzen.

Question 22

Migrate Advanced Invoice Layout templates from Magento 1 to Magento 2

Accepted Answer

If you use our Advanced Invoice Layout extension for Magento 1 and you want to migrate your shop to Magento 2, there are a few simple steps to make the invoice, packing slips and creditmemo PDF look nice:

Purchase the Advanced Invoice Layout extension for Magento 2
Copy all your template files from the Magento 1 extension from app/design/frontend/base/default/template/advancedinvoicelayout to the Magento 2 extension in view/base/templates/
Copy all the CSS files from Magento 1 from skin/frontend/base/default/advancedinvoicelayout to the Magento 2 extension in view/base/web/
Replace all occurrences of $this->__( .. %s .. ) with $this->__( .. %1 .. )

Question 23

Schweizer QR-Rechnung mit Magento generieren

Accepted Answer

Mit meiner Advanced Invoice Layout Extension kann sehr einfach ein QR-Zahlschein nach den offiziellen Schweizer Vorgaben generiert und an die Magento PDF-Rechnung angehängt werden.

Aktivierung der QR-Rechnung in Magento

Für das Layout des Zahlscheins kommt eine Open Source Bibliothek zum Einsatz. Diese muss zunächst installiert werden, da diese nicht Teil der Standard Advanced Invoice Layout Installation ist:

composer require sprain/swiss-qr-bill

Als nächsten Schritt muss noch in der Konfiguration unter Stores › Configuration › vianetz Extensions › Advanced Invoice Layout › QR Bill Options das Feature aktiviert sowie die QR-IBAN und der Reference Type ausgewählt werden. Weitere Hilfestellungen finden sich auch in der FAQ der QR-Bibliothek.

Es kann außerdem noch konfiguriert werden, dass die QR-Rechnung nur für bestimmte Zahlungsarten aktiviert wird.

Anpassen des Layouts der QR-Rechnung

Das Layout sieht standardmäßig wie folgt aus: QR-Rechnung Beispiellayout

Um das Layout der QR-Rechnung individuell anzupassen, kann - wie für die Anpassung der Magento PDF-Rechnung auch einfach CSS-Code verwendet werden und in der Advanced Invoice Layout Konfiguration unter Stores › Configuration › vianetz Extensions › Advanced Invoice Layout › Custom CSS hinterlegt werden.
Der Selektor für die Tabelle im Zahlungsschein lautet #qr-bill.

Um den freien Platz auf der zusätzlichen PDF-Seite besser zu nutzen, kann außerdem auch der Platz oberhalb des Zahlscheins genutzt werden, um z.B. ein (Werbe-)Bild oder ähnliches anzuzeigen. Hierzu kann folgender CSS-Code genutzt werden:

#customQrBillContent {     background-image: url('https://www.vianetz.com/skin/frontend/default/vianetz/images/products/placeholder.png');    background-repeat: none;    width: 700px;    height: 500px;}

Question 24

Unit-Tests für Eure Magento Extension ausführen

Accepted Answer

Die Unit-Tests unserer Magento 1 Extensions basieren auf der EcomDev_PHPUnit Extension, die auf Github kostenfrei verfügbar ist.
Die von mir empfohlene Installation ist über composer wie folgt:

composer config repositories.ecomdev-phpunit vcs git@github.com:vianetz/ecomdev-phpunit-magento1.gitcomposer require --dev ecomdev/ecomdev_phpunit dev-master

Für weitere Installationshinweise verweisen wir auf das entsprechende Handbuch.

Nach der Installation des EcomDev_PHPUnit Moduls, können die Unit-Tests z.B. für die Advanced Invoice Layout Extension mit folgendem Befehl im Hauptverzeichnis Ihrer Magento-Installation gestartet werden:

phpunit --group Vianetz_AdvancedInvoiceLayout

Wenn diese erfolgreich beendet werden, sieht die Ausgabe z.B. wie folgt aus:

PHPUnit 9.5.28 by Sebastian Bergmann and contributors...............................                                    30 / 30 (100%)Time: 00:19.833, Memory: 48.50 MBOK (30 tests, 34 assertions)

Question 25

Was bedeutet der Fehler "There has been an error processing your request"?

Accepted Answer

Die Fehlermeldung "There has been an error processing your request" ist eine der häufigsten Fehlermeldungen in Magento 1 und Magento 2. Diese Meldung wird allgemein angezeigt, wenn Fehler irgendeiner Art in Magento aufgetreten sind.

In diesem Fall legt Magento unter der in der Fehlermeldung genannten Nummer eine Datei im Verzeichnis var/report an, die weitere Informationen zu dem Fehler enthält.

Im folgenden Screenshot sehen Sie ein Beispiel für einen Fehler:

Magento: There has been an error processing your request

Anschließend prüfen wir den Inhalt der Datei var/report/var/report/71f20cdad8ceb5efde802084ba1eec158275937c822322eee3b1eac5ebde00b0 in unserem Magento Hauptverzeichnis auf den beispielhaften Fehler:

{  "0": "test",  "1": "#1 Composer\Autoload\includeFile('/home/vianetz/ma...') called at [vendor/composer/ClassLoader.php:322]
#2 Composer\Autoload\ClassLoader->loadClass('Magento\Framewor...')
#3 spl_autoload_call('Magento\Framewor...')
#4 is_subclass_of('Magento\Framewor...', '\Magento\Framewo...') called at [vendor/magento/framework/ObjectManager/InterceptableValidator.php:42]
#5 Magento\Framework\ObjectManager\InterceptableValidator->isInterceptable('Magento\Framewor...') called at [vendor/magento/framework/ObjectManager/InterceptableValidator.php:16]
#6 Magento\Framework\ObjectManager\InterceptableValidator->validate('Magento\Framewor...') called at [vendor/magento/framework/Interception/ObjectManager/Config/Developer.php:62]
#7 Magento\Framework\Interception\ObjectManager\Config\Developer->getInstanceType('Magento\Framewor...') called at [vendor/magento/framework/ObjectManager/Factory/Dynamic/Developer.php:47]
#8 Magento\Framework\ObjectManager\Factory\Dynamic\Developer->create('Magento\Framewor...') called at [vendor/magento/framework/ObjectManager/ObjectManager.php:70]
#9 Magento\Framework\ObjectManager\ObjectManager->get('Magento\Framewor...') called at [vendor/magento/framework/App/Http.php:115]
#10 Magento\Framework\App\Http->launch() called at [generated/code/Magento/Framework/App/Http/Interceptor.php:24]
#11 Magento\Framework\App\Http\Interceptor->launch() called at [vendor/magento/framework/App/Bootstrap.php:261]
#12 Magento\Framework\App\Bootstrap->run(&Magento\Framework\App\Http\Interceptor#000000006a1e7d590000000079678f99#) called at [index.php:39]
",  "url": "/",  "script_name": "/index.php",  "report_id": "71f20cdad8ceb5efde802084ba1eec158275937c822322eee3b1eac5ebde00b0"}

Wenn Sie keine Lösung für das Problem finden, senden Sie uns bitte diese Datei zu.

Question 26

Was sind die Vorteile, wenn ich Magento Extensions bei vianetz bestelle?

Accepted Answer

Technisch unterscheiden sich die Magento Extension-Versionen hier auf meiner Website und dem Magento Marketplace natürlich nicht. Allerdings profitieren Sie beim Kauf über vianetz von folgenden Vorteilen im Vergleich zum Magento Marketplace:

sofortiger Download nach Bezahlung
Rechnung nach deutschen Standards
vereinfachte Installation über composer
7-Tage Geld-zurück-Garantie
Teil der wachsenden Gemeinschaft von über 10.000 vianetz-Lizenzen
langfristige Stabilität und Verfügbarkeit der Downloads und der Lizenz im Kundenaccount (dies war z.B. für die Magento 1 Lizenzen auf dem Magento Marketplace nicht der Fall)
einfache Möglichkeit, die Lizenz zu verlängern
Zugang zur Magento Wissensdatenbank
Sie unterstützen meine Arbeit als Magento Freelancer mit einem höheren finanziellen Beitrag (der Extension-Preis ist für Sie natürlich auf beiden Plattformen derselbe)

Question 27

Welche Domain soll ich angeben?

Accepted Answer

Bitte die exakte Domain der Magento-Installation angeben, d.h. inklusive www. falls und inklusive HTTP-Protokoll wie https://.
Weitere Details auch in Lizenzvereinbarung.

Beispiele: https://www.vianetz.com, https://subdomain.example.com, http://vianetz.local

Question 28

Welche Magento Zugangsdaten werden für meine Anfrage benötigt?

Accepted Answer

Für den schnellstmöglichen Support und die Prüfung Ihres Anliegens bitten wir Sie folgende Daten zur Verfügung zu stellen:

Bestellnummer der Extension, die installiert werden soll (falls separate Bestellung)
Magento Administrations-URL, sowie temporären Benutzername und Passwort
Wichtig: Bitte prüfen Sie, dass der Account alle Magento-Berechtigungen besitzt und dass eine Anmeldung mit dem Benutzer erfolgreich ist.
SSH- Zugangsdaten mit temporären Schreibrechten für das Magento Hauptverzeichnis (alternativ FTP)
ggfs. Testdaten für eine Zahlungsart, damit ein Checkout im Shop durchgeführt werden kann

Wir setzen uns anschließend mit Ihnen in Verbindung.

Wichtiger Hinweis:
Es kann keine Haftung für evtl. Datenverlust und/oder Downtimes übernommen werden. Achten Sie daher bitte unbedingt darauf, ein Backup Ihres Systems vorzuhalten und sorgen Sie dafür, dass parallel keine Arbeiten durchgeführt werden, um eine möglichst reibungsfreie Installation zu ermöglichen.

Selbstverständlich werden alle Daten äußerst vertraulich behandelt.
Falls gewünscht kann vorab gerne eine Geheimhaltungsvereinbarung/NDA unterzeichnet werden. Kontaktieren Sie uns bitte diesbezüglich.

Question 29

Wie erstelle ich ein Backup meiner Magento-Installation?

Accepted Answer

Ein Backup der Magento-Installation kann auf unterschiedliche Arten erstellt werden:

Grundsätzlich sollte das Backup immer aus der Sicherung der Dateien (Magento-Verzeichnis oder zumindest der Dateien, die sich nicht in der Versionsverwaltung befinden, z.B media/, var/, ..) sowie einem Dump der Datenbank bestehen. Diese sollten immer zusammen erstellt werden, um Versionsunterschiede zu vermeiden.

Das Magento-Backend bietet unter System › Tools › Backups eine rudimentäre Möglichkeit, Datenbank-Backups zu erstellen. Zusätzlich müssen die Dateien der Magento-Installation manuell z.B. über (S)FTP gesichert werden.
Alternativ kann das Backup z.B. über den Hoster oder Tools wie PhpMyAdmin erfolgen oder ein Image eines virtuellen Servers erstellt werden.

Weiterführende Anleitungen finden sich z.B. auch im Blog von Matthias Zeis.

Question 30

Wie kann ich das Adressformat konfigurieren?

Accepted Answer

Das Adressformat auf der Magento PDF-Rechnung kann mit meiner Advanced Invoice Layout Extension sehr einfach und flexibel an alle Bedürfnisse angepasst werden. Je nach Land und Kundenadresse können so beliebige Formate auf PDF-Rechnung, -Lieferschein und -Gutschrift abgebildet werden.

Hinweis: Ab Advanced Invoice Layout Version 2.x befindet sich die Konfiguration unter
System › Konfiguration › Kundenkonfiguration › Adressvorlagen › HTML

Seit Magento (CE) Version 1.5 kann das Adressformat unter System › Konfiguration › Kundenkonfiguration › Adressvorlagen › PDF konfiguriert werden:
Adress-Konfiguration

Newlines werden mit dem Pipe-Symbol (|) dargestellt.

Question 31

Wie kann ich die Übersetzungen in den PDF-Dokumenten ändern?

Accepted Answer

Übersetzungen in Magento 2 ändern

Als Erstes kann der benötigte Übersetzungsstring in den Template-Dateien der Extension im Verzeichnis i18n ermittelt werden. Anschließend z.B. am besten im eigenen Frontend-Theme unter i18n/de_DE.csv folgende Zeile mit dem jeweiligen String einfügen:

"SKU","Artikelnr.",module,Vianetz_AdvancedInvoiceLayout

Abschließend den Magento Translation-Cache leeren.

Übersetzungen in Magento 1 / OpenMage ändern

Jedes Modul wird mit Übersetzungsdatei im Verzeichnis app/locale/.. ausgeliefert. Je nach gewünschter Sprache (z.B. deutsch) befindet sich in der Datei im Unterverzeichnis de_DE/Vianetz_AdvancedInvoiceLayout.csv alle verwendeten Text-Strings.
Alternativ können die Texte auch über die Magento Inline-Translation im Backend geändert werden.

Question 32

Wie kann ich eine Magento 1 Extension deaktivieren?

Accepted Answer

Magento Extensions können jederzeit deaktiviert werden. Beachtet werden sollten allerdings mögliche Abhängigkeiten der Extensions untereinander.

Zur Deaktivierung muss in der Datei app/etc/modules/Vianetz_MODULNAME.xml der Magento-Installation der Wert

true

auf false gesetzt werden.

Anschließend sollte der Magento Cache unter System › Cache Management geleert werden.

Alle Modul-Einstellungen bleiben nach erneuter Aktivierung weiterhin bestehen, sofern die in der Datenbank gespeicherten Einstellungen nicht zurückgesetzt werden.

Hinweis:
Ein Deaktivieren von Magento-Extensions über System › Konfiguration › Erweitert führt in den meisten Fällen nicht zu dem gewünschten Effekt, da dies - anhängig von der Implementierung des jeweiligen Moduls - nur die Ausgabe deaktiviert, die Extension (z.B. Cronjob, Events, etc.) aber weiterhin aktiv bleiben. Der sicherere Weg ist also wie oben beschrieben über die Konfigurations-XML.

Question 33

Wie kann ich zusätzliche Hinweise für Firmenkunden auf die PDF-Rechnung drucken?

Accepted Answer

Die Advanced Invoice Layout Extension bietet die Möglichkeit, kundengruppenspezifische Rechnungstexte unter Kunden › Kundengruppen im Magento Backend zu hinterlegen.

Damit können z.B. benötigte Hinweise für Firmenkunden oder Notizen wie "Steuerbefreit gemäß Paragraph X" oder "Steuerschuldnerschaft des Leistungsempfängers / Reverse-Charge-Verfahren" in die PDF-Rechnung hinzugefügt werden:

Question 34

Wie wird die Qualität der Extension sichergestellt?

Accepted Answer

Jede neue Extension-Version wird automatisiert über unseren Build-Server erstellt. Dieser führt automatisch Unit-Tests, statische Code-Analysen und Integrationstest durch, im Anschluss wird die Version nach QA-Freigabe veröffentlicht.

Weitere Informationen haben wir hierzu in den Milestones zusammengefasst.

Question 35

Wieso werden die PDF-Rechnungen nicht im Dateisystem gespeichert?

Accepted Answer

Problem: Die PDF-Rechnungen werden nicht wie beschrieben im Dateisystem unter dem Verzeichnis media/invoices abgelegt.

Lösung: Die wahrscheinlichste Ursache sind fehlende Berechtigungen für das genannte Verzeichnis. Bitte prüfen Sie, dass der Webserver-Benutzer (z.B. apache o.ä.) Schreibrechte für das Verzeichnis besitzt.

Question 36

Wieso wird die Steuer doppelt in der Rechnung ausgewiesen?

Accepted Answer

Die Konfigurationsoption System › Konfiguration › Steuern › Anzeige in Bestellungen, Rechnungen, Gutschriften › Steuern vollständig anzeigen beeinflusst dieses Verhalten. Im Frontend kann der Kunde auf den Steuersatz klicken und erhält die Aufsplittung in die einzelnen Mehrwertsteuerklassen. In den Emails und PDF-Dokumenten ist dies allerdings ungünstig, da hier alle Steuersätze + der Gesamtsteuersatz angezeigt werden und somit redundante, doppelte Informationen vorliegen, die Kunden eher verwirren.

Die Advanced Invoice Layout Extension berücksichtigt diesen Fall und zeigt - je nach Einstellung - nur den Gesamtsteuersatz oder nur die aufgesplitteten Steuersätze nach ihrem Prozentsatz.

Sofern nur 1 Steuersatz vorliegt könnte theoretisch auch die Steuerbezeichnung in den Übersetzungen geändert werden, dies ist aber ausdrücklich nicht empfohlen.

Question 37

Wieso wird meine Magento Rechnung nicht automatisch erstellt?

Accepted Answer

Mit meiner Automatic Invoice Extension für Magento können Sie die manuelle Rechnungserstellung in Magento automatisieren und z.B. in Verbindung mitmeiner Advanced Invoice Layout Extension für Magento das Rechnungs-PDF dem Kunden zukommen lassen.

Wenn Sie die Automatic Invoice Extension für Magento korrekt installiert haben, müssen Sie unter System › Konfiguration › Automatic Invoice die Konfiguration der Bedingungen bestehend aus Bestellstatus und Zahlungsart sowie die entsprechenden Aktionen (Erstellung der Rechnung/Lieferschein, Versand, Benachrichtigung des Kunden) konfigurieren.

Sollte die Rechnung nach erfolgter Konfiguration immer noch nicht automatisch nach Bestelleingang erstellt werden, prüfen Sie bitte folgende Punkte:

Stimmt die Kombination aus Bestellstatus und Zahlungsart? Prüfen Sie ggfs. die Konfiguration der Zahlungsart.
Läuft der Magento Cronjob? Die Rechnungen werden über eine Job-Queue generiert, um den Checkout-Prozess nicht unnötig zu verzögern. Damit diese abgearbeitet wird, muss der Magento Cronjob aktiviert sein und z.B. alle 5 Minuten ausgeführt werden.
Zusätzlich können Sie in der Automatic Invoice-Konfiguration ein erweitertes Logging aktivieren, dann wird eine Log-Datei in var/log/vianetz_automaticinvoice.log geschrieben, die weitere Hinweise auf den Fehler liefert.

Question 38

Zahlart auf der Magento PDF-Rechnung anpassen

Accepted Answer

Die Advanced Invoice Layout Extension zeigt einen Block mit Informationen über die gewählte Zahlungsart auf der PDF Rechnung an. Dieser Block wird dynamisch von der jeweiligen verwendeten Payment Extension befüllt, d.h. PayPal, DebitPayment, Credit Card, etc. und somit ist diese Information in der jeweiligen Extension enthalten. Beispielsweise zeigt PayPal die Bezahler-Emailadresse auf der Rechnung an, bei Kreditkartenzahlung wird die Kartennummer mit angezeigt, usw.

Wenn nun z.B. der Text oder die HTML-Formattierung dieses Zahlungsarten-Blocks für die Zahlart "Purchase Order" angepasst werden soll, sind folgende Schritte notwendig:

die Datei app/design/frontend/base/default/template/payment/info/purchaseorder.phtml in Ihr Theme-Verzeichnis kopieren, z.B. app/design/frontend/MYTHEME/default/template/payment/purchaseorder.phtml
die Datei gemäß Ihren Vorstellungen anpassen

Wenn die Zahlart kein eigenes Template vorsieht, kann das Default-Template unter app/design/frontend/base/default/template/payment/info/default.phtml verwendet werden.

Generell empfiehlt es sich, zum Testen von Layouts immer den Debug-Modus der Advanced Invoice Layout Extension unter System › Konfiguration › Advanced Invoice Layout zu aktivieren. Bei aktiviertem Debug-Modus wird bei jedem Druck der PDF-Rechnung, des -Lieferscheins oder der -Gutschrift das temporär erzeugte HTML-Dokument im Verzeichnis var/tmp/invoice_debug.html gespeichert. Dies ermöglicht Ihnen einfacher, die HTML-Struktur und die Style-Sheets zu analysieren und anzupassen.

In Produktiv-Umgebungen sollte dieses Feature aus Performance-Gründen nicht dauerhaft aktiviert sein.

Dieser Prozess kann analog auch für andere Zahlungsarten durchgeführt werden.

Bitte beachten Sie auch den Artikel zum Thema wie die Magento PDF-Rechnung im Allgemeinen angepasst werden kann.

Häufig gestellte Fragen

Allgemeines

Lizenz

Bestellung

Troubleshooting

Anfrage

Qualität

Magento 1

Rechnungslayout

Order Workflows

Installation Extension

Magento 2