X-Cart forums

[cvaughan02]

Ok, i've been on this for two days. all the docs/walkthroughs are way too specific. I just need to know how to create a page in the admin section.

here's what I've done so far:

created a new controller that extends \XLite\Controller\Admin\AAdmin. It has getTitle and getAllowedTargets and both of those seem to be working as expected.

I have created a LeftMenu item to point to my new controllers target. this also seems to work.

NOW... how do I assign this controller an actual template and action? The ONLY thing I need this to do is export some data (which I can figure out), but first I need to get some type of information besides the title to display on the page. I don't need an itemlist or any other complex model. right now i'm just trying to add some static content to the page.

please help :'( it's been two days!

[totaltec]

I feel your pain! Maybe this will help:

Create a file:
XLite/Module/YourDevID/YourModule/Controller/Admin/MyPage.php

with these contents:

<?php

namespace XLite\Module\YourDevID\YourModule\Controller\Admin;

/**
 * My Page controller
 */
class MyPage extends \XLite\Controller\Admin\AAdmin
{
    /**
     * Return the current page title (for the content area)
     *
     * @return string
     */
    public function getTitle()
    {
        return static::t('My Admin Page');
    }
}

Create another file:
XLite/Module/YourDevID/YourModule/View/MyPage.php

with these contents:

<?php

namespace XLite\Module\YourDevID\YourModule\View;

/**
 * My Page Viewer Class
 *
 * @ListChild (list="admin.center", zone="admin")
 */
class MyPage extends \XLite\View\Dialog
{
    /**
     * Return list of allowed targets
     *
     * @return array
     */
    public static function getAllowedTargets()
    {
        $list = parent::getAllowedTargets();

        $list[] = 'my_page';

        return $list;
    }

    /**
     * Register JS files
     *
     * @return array
     */
    public function getJSFiles()
    {
        $list = parent::getJSFiles();

        $list[] = $this->getDir() . '/custom.js';

        return $list;
    }

    /**
     * Register CSS files
     *
     * @return array
     */
    public function getCSSFiles()
    {
        $list = parent::getCSSFiles();

        $list[] = $this->getDir() . '/style.css';

        return $list;
    }

    /**
     * Return templates directory name
     *
     * @return string
     */
    protected function getDir()
    {
        return 'modules/YourDevID/YourModule/my_page';
    }

}

The above of course assumes you already have a Main.php for your module.


Here is what has confused me in the past, and Tony helped me understand:
Your Controller, must be named the same as your target.

If your target is: some_funky_target

Then your controller must be: SomeFunkyTarget.php

[totaltec]

Okay now that we have the proper code established, we need a template.

Create your template:
skins/admin/en/modules/YourDevID/YourModule/my_page/body.tpl

with these contents:

<h1>Hello World!</h1>

X-Cart automatically looks in the result of getDir() for a template named body.tpl if getDefaultTemplate() is not specified. And it will look in the skin admin directory if this is an admin controller.

[cvaughan02]

Originally Posted by totaltec

Okay now that we have the proper code established, we need a template.

Create your template:
skins/admin/en/modules/YourDevID/YourModule/my_page/body.tpl

with these contents:

<h1>Hello World!</h1>

X-Cart automatically looks in the result of getDir() for a template named body.tpl if getDefaultTemplate() is not specified. And it will look in the skin admin directory if this is an admin controller.

OMG thank you! that's what I was missing (and what the docs are missing). I had just about everything correct, except the name of the target and couldn't figure out how to connect them.

[totaltec]

You are quite welcome! Glad it worked. It did sound like you were 90% of the way there. I just posted the other info to provide a complete picture for anyone else that needed the solution.