OroCommerce Forums

Participant

Hello! I’ve been following the Quick Start guide for Layout Themes, and have run into a couple problems after making the controller. Below is my controller (example copied from the guide):

<?php
 
namespace E7\StoreThemeBundle\Controller; 
 
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Oro\Bundle\LayoutBundle\Annotation\Layout;
 
class UserController extends Controller
{
    /**
     * @Route("/test", name="demo_layout_test")
     * @Layout
     */
    public function testAction()
    {
        return [];
    }
}

<?php

namespace E7\StoreThemeBundle\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\Controller;

use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;

use Oro\Bundle\LayoutBundle\Annotation\Layout;

class UserController extends Controller

{

/**

* @Route("/test", name="demo_layout_test")

* @Layout

public function testAction()

{

return [];

}

First, I was blocked by the fact that routing would not work in the Controller (annotation type). The ‘/test’ route was not recognized by Symfony. After research I tried including this in app/config/routing.yml:

demo_layout_test:
    resource: "@StoreThemeBundle/Controller/"
    type:     annotation

demo_layout_test:

resource: "@StoreThemeBundle/Controller/"

type: annotation

… and that worked! So, I think it should be noted in the docs that this change is required for routing to work.

However, I then went to /test and the page only contained a header and footer, with empty content. I tried to place some HTML in various places in the default.html.twig file, but none of it showed up. Does anyone know what I might be missing? I followed the Quick Start exactly as far as I know.

UI Developer at E7 Solutions
http://www.e7solutions.com

Creator
Topic

Viewing 15 replies - 1 through 15 (of 15 total)

Author
Replies

April 28, 2017 at 1:56 pm #31710

Participant

Is it possible my reference to the layout is not written correctly? It is in the same directory as the default. (everything else is directly copied from the Quick Start)

# src/E7/StoreThemeBundle/Resources/views/layouts/store/default.yml

layout:
    actions:
        - @setBlockTheme:
            themes: 'E7:StoreThemeBundle:layouts:store/default.html.twig'
        - @addTree:
            items:
                ...

# src/E7/StoreThemeBundle/Resources/views/layouts/store/default.yml

layout:

actions:

- @setBlockTheme:

themes: 'E7:StoreThemeBundle:layouts:store/default.html.twig'

- @addTree:

items:

...

UI Developer at E7 Solutions
http://www.e7solutions.com

May 8, 2017 at 12:29 am #31711

dnahrebecki

Moderator

Hello mike,
please check following points:
– if your definition of “store” theme meets requirements link
– if you set your theme as a default link
– if you are working in dev mode you can check all layout structure in debug toolbar
– if you are working in dev mode you can enable “System -> Configuration -> General setup -> Development settings -> Include Block Debug Info Into HTML” and check in your browser which layout blocks are rendered

Also, you can have a look at theme and layout documentation

Best Regards,
Daniel Nahrebecki

May 8, 2017 at 7:43 am #31712

Participant

Sorry Daniel, I had to continue this through email. Here are some points that helped me solve the issue, that I didn’t get from the docs:

1. Be sure to set the theme in the Admin panel, not just in config.yml. Otherwise the ‘default’ theme (which is actually the id of Oro’s layout theme) overrides it.
2. The Quick Start docs work for Platform, but not for OroCommerce. When you set ‘groups’ in theme.yml, you need to include the ‘commerce’ group:

# src/E7/StoreThemeBundle/Resources/views/layouts/store/theme.yml
label:      E7 Store Theme
icon:       bundles/storetheme/themes/e7admin/images/favicon.png
groups:     [ main, commerce ]
parent:     default

# src/E7/StoreThemeBundle/Resources/views/layouts/store/theme.yml

label: E7 Store Theme

icon: bundles/storetheme/themes/e7admin/images/favicon.png

groups: [ main, commerce ]

parent: default

UI Developer at E7 Solutions
http://www.e7solutions.com

May 9, 2017 at 12:19 am #31713

dnahrebecki

Moderator

Thanks for pointing this out. I’ve created a ticket to make documentation more clear for this case.

May 9, 2017 at 12:34 pm #31714

Participant

Thanks!

UI Developer at E7 Solutions
http://www.e7solutions.com

March 19, 2018 at 10:59 am #31715

Participant

Hi Mike,

I’m having the same as you were before, but I’m stuck with my controller not being detected or not routed properly in my bundle since I get a 404 error when I try to load to page with the assigned route. Any tips?

// bundles.yml
bundles:
    - Custom\Bundle\TestBundle\TestBundle

// routing.yml
test:
    resource:   '@TestBundle/Controller'
    type:       annotation

// TestController.php
<?php

namespace Custom\Bundle\TestBundle\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Oro\Bundle\LayoutBundle\Annotation\Layout;

class TestController extends Controller
{
    /**
     * @Route("/test", name="test")
     * @Layout
     */
    public function testAction()
    {
        return [];
    }
}

// bundles.yml

bundles:

- Custom\Bundle\TestBundle\TestBundle

// routing.yml

test:

resource: '@TestBundle/Controller'

type: annotation

// TestController.php

<?php

namespace Custom\Bundle\TestBundle\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\Controller;

use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;

use Oro\Bundle\LayoutBundle\Annotation\Layout;

class TestController extends Controller

{

/**

* @Route("/test", name="test")

* @Layout

public function testAction()

{

return [];

}

March 22, 2018 at 7:33 am #31716

Check our free technical guide ”How to Build a Reliable and Secure Infrastructure for OroCommerce”.

Moderator

Hello, karl.arreola.

It seems few mistakes in your code. Please pay attention on file paths and namespaces of php classes.
Next I added you code with fixes and it works correct.

<?php

namespace Custom\Bundle\TestBundle\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Oro\Bundle\LayoutBundle\Annotation\Layout;

class TestController extends Controller
{
    /**
     * @Route("/test", name="test")
     * @Layout
     */
    public function testAction()
    {
        return [];
    }
}

<?php

namespace Custom\Bundle\TestBundle\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\Controller;

use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;

use Oro\Bundle\LayoutBundle\Annotation\Layout;

class TestController extends Controller

{

/**

* @Route("/test", name="test")

* @Layout

public function testAction()

{

return [];

}

bundles:
    - { name: Custom\Bundle\TestBundle\CustomTestBundle, priority: 255 }

1 2	bundles: - { name: Custom\Bundle\TestBundle\CustomTestBundle, priority: 255 }

test:
    resource: '@CustomTestBundle/Controller'
    type:     annotation
    options:
        frontend: true

test:

resource: '@CustomTestBundle/Controller'

type: annotation

options:

frontend: true

You need frontend: true to use this route on front store part of OroCommerce application.

<?php
namespace Custom\Bundle\TestBundle;

use Symfony\Component\HttpKernel\Bundle\Bundle;

class CustomTestBundle extends Bundle
{
}

<?php

namespace Custom\Bundle\TestBundle;

use Symfony\Component\HttpKernel\Bundle\Bundle;

class CustomTestBundle extends Bundle

{

}

And check that required route is available:

$ app/console router:debug --env=prod | grep test
  test                                                                 ANY        ANY      ANY    /test

1 2	$ app/console router:debug --env=prod \| grep test test ANY ANY ANY /test

March 22, 2018 at 8:56 am #31717

Participant

I was able to register the bundle the previous way before, I just thought my controller wasn’t routed correctly but will try this anyways. I have a few questions though, Is it just a convention with the way you packaged the bundle or is it an actual requirement with oro/symfony? What does priority 255 do in bundles.yml?

March 22, 2018 at 9:09 am #31718

Check our free technical guide ”How to Build a Reliable and Secure Infrastructure for OroCommerce”.

Moderator

Is it just a convention with the way you packaged the bundle or is it an actual requirement with oro/symfony?

This is recommendations for Symfony bundles. http://symfony.com/doc/2.3/cookbook/bundles/best_practices.html

What does priority 255 do in bundles.yml?

This is order of bundle for loading it in Symfony kernel. As result, will be generated /app/cache/prod/bundles.php and your bundle will be in the end of list bundles to loading in application.

March 22, 2018 at 2:19 pm #31719

Participant

The controller seems to be working but the theme and layout aren’t loading. I have the theme and layout exactly the same as the quickstart doc. I also ran clear:cache, assets:install, and assetic:dump but hasn’t changed anything.

March 23, 2018 at 1:16 am #31720

Check our free technical guide ”How to Build a Reliable and Secure Infrastructure for OroCommerce”.

Moderator

Did you choose your custom theme in System Configuration?

March 23, 2018 at 9:20 am #31721

Participant

It doesn’t show up in System Configuration

March 23, 2018 at 9:29 am #31722

Check our free technical guide ”How to Build a Reliable and Secure Infrastructure for OroCommerce”.

Moderator

Open “System / Configuration” in menu on admin panel.
Then open “System Configuration / Commerce / Design / Theme” and choose your theme in “Theme Settings”.
Next click “Save settings”.

March 23, 2018 at 9:32 am #31723

Participant

I meant the theme is not showing up in the drop down of themes

March 23, 2018 at 10:03 am #31724