X-Cart forums

[The Knotty Celt]

I am working on a module which replaces the invoice templates. Following the guide here, I created the following template file:

skins/common/modules/LBS/OrderNumber/order/invoice/parts/title.twig

Since it is a part of the invoice.head viewList, I added the following to the end of my module's Main.php.

protected static function moveTemplatesInLists()
{
    $templates = [
        'order/invoice/parts/title.twig' => [
            static::TO_DELETE => [
                ['invoice.head', \XLite\Model\ViewList::INTERFACE_CUSTOMER],
            ],
        ],
    ];


    return $templates;
}
 

This results in both the original title.twig and my title.twig being rendered side-by-side on the invoice header. Since the original title.twig is located under the common skins, that INTERFACE_CUSTOMER is not correct. I looked in XLite\Model\ViewList.php for a possible INTERFACE_COMMON definition. Since there was none, I saw that INTERFACE_CUSTOMER returns the string 'customer', and INTERFACE_ADMIN returns the string 'admin', so I tried changing the line,

['invoice.head', \XLite\Model\ViewList::INTERFACE_CUSTOMER]

to,

['invoice.head', 'common']

which produced the same result.


What is the proper way to replace a template found within skins/common? Or is it it that the viewList 'invoice.head' is part of another viewList? Do I need to specify all the parents and grandparents of the viewList? I shall try something along those lines to see if it works in the meantime while waiting for some much appreciated feedback.

[Ed B.]

This may be a "dirty" work around, but should work: instead of bothering with viewlist, just override the viewer. So override XLite/View/Invoice.php to change
getDefaultTemplate() or XLite/View/InvoicePage.php to modify getDir(), getBody() or getHead(), whichever is appropriate.

[The Knotty Celt]

Originally Posted by Ed B.

This may be a "dirty" work around, but should work: instead of bothering with viewlist, just override the viewer. So override XLite/View/Invoice.php to change
getDefaultTemplate() or XLite/View/InvoicePage.php to modify getDir(), getBody() or getHead(), whichever is appropriate.

I have since tried that, by implementing IDecorator on both Invoice and InvoicePage View classes, and updating the getDir(), getBody() and getHead(), among other functions referring to various template files. Now, everything is duplicated. I also copied the template files into the appropriate modules' locations. The result is that both the original templates and module templates are appearing side-by-side. It's as though both sets of Invoice and InvoicePage classes are being loaded, rather than the module replacing the original view.

[The Knotty Celt]

SOLUTION

I was able to resolve my issue quite simply by amending the getSkins() function of my module's Main.php file as follows:

public static function getskins()
{
    return array(
        \XLite::CUSTOMER_INTERFACE => array(
            'customer/modules/LBS/OrderReference',
        ),
        'common' => array(
            'common/modules/LBS/OrderReference',
        ),
    );
}