How to replace or extend Configuration.php of OroProductBundle?

I am trying to replace or extend the Configuration.php of OroProductBundle located at:
vendor/oro/commerce/src/Oro/Bundle/ProductBundle/DependencyInjection/Configuration.php

in my Custom Bundle.

I found no Oro or Symfony way of extending/replacing a Configuration.php class. Right now my code only works if I alter the original file.

I tried ways described in this article https://symfony.com/doc/current/bundles/prepend_extension.html
to prepend Configuration but looks like it only prepends on existing configs but does not add a new one.

So this is what I have done so far by adding this class in my Bundle:

PHP

class Configuration implements ConfigurationInterface { const ROOT_NODE = OroProductExtension::ALIAS; const NEW_BRANDS_SEGMENT_ID = 'new_brands_segment_id'; /** * {@inheritDoc} */ public function getConfigTreeBuilder() { $treeBuilder = new TreeBuilder(); $rootNode = $treeBuilder->root(static::ROOT_NODE); SettingsBuilder::append( $rootNode, [ static::NEW_BRANDS_SEGMENT_ID => [ 'value' => '@oro_product.provider.default_value.new_brands' ], ] ); return $treeBuilder; } /** * @param string $key * @return string */ public static function getConfigKeyByName($key) { return implode(ConfigManager::SECTION_MODEL_SEPARATOR, [static::ROOT_NODE, $key]); } }

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36

class Configuration implements ConfigurationInterface {     const ROOT_NODE = OroProductExtension::ALIAS;     const NEW_BRANDS_SEGMENT_ID = 'new_brands_segment_id';       /**      * {@inheritDoc}      */     public function getConfigTreeBuilder()     {         $treeBuilder = new TreeBuilder();           $rootNode = $treeBuilder->root(static::ROOT_NODE);           SettingsBuilder::append(             $rootNode,             [                 static::NEW_BRANDS_SEGMENT_ID => [                     'value' => '@oro_product.provider.default_value.new_brands'                 ],             ]         );           return $treeBuilder;     }         /**      * @param string $key      * @return string      */     public static function getConfigKeyByName($key)     {         return implode(ConfigManager::SECTION_MODEL_SEPARATOR, [static::ROOT_NODE, $key]);     } }

So this does not work. However, if I add this same node inside the original OroProductBundle Configuration.php class, it works.

Can anyone advise on how to make Oro to use my Bundle’s Configuration.php instead of the OroProductBundle’s one? Thank you

• This topic was modified 2 years, 5 months ago by  Shahriar.

Topic

[Andrey YatsenkoModerator]

Hi Shahriar,

First of all please clarify why do you need to extend the configuration.
It is not allowed because usually there is no need to do that and you always can define the configuration in your bundle only and reference it in the OroCommerce UI section if needed.

[ShahriarParticipant]

Hello Andrey,
Thanks for your reply. Let me give you more info on what am I trying to achieve here.

I created a custom segment called New Brands, which I want to show on my Home page similar to Featured Product or New Arrivals. My New Brand Segment uses a condition to show brands that are created between certain dates. Right now, I have created a NewBrandsProvider, where I used a segmentManager to fetch New Brands segment by id. This works when I pass in segment id with hard code. But I am trying to get the id dynamically as well. This is how my NewBrandsProvider looks:

PHP

<?php namespace Acme\BrandBundle\Layout\DataProvider; use Oro\Bundle\ConfigBundle\Config\ConfigManager; use Acme\BrandBundle\DependencyInjection\Configuration; use Oro\Bundle\SegmentBundle\Entity\Manager\SegmentManager; class NewBrandsProvider { private $segmentManager; private $configManager; public function __construct( SegmentManager $segmentManager, ConfigManager $configManager ) { $this->segmentManager = $segmentManager; $this->configManager = $configManager; } public function getBrands() { if(!is_null($this->getSegmentId())){ $segment = $this->segmentManager->findById($this->getSegmentId()); $qb = $this->segmentManager->getEntityQueryBuilder($segment); $result = $qb->getQuery()->getResult(); return $result; } else { $segment = $this->segmentManager->findById(50); $qb = $this->segmentManager->getEntityQueryBuilder($segment); $result = $qb->getQuery()->getResult(); return $result; } } protected function getSegmentId() { dump($this->getConfigManager() ->get(sprintf('%s.%s', 'oro_product', Configuration::NEW_BRANDS_SEGMENT_ID)) ); return $this->getConfigManager() ->get(sprintf('%s.%s', 'oro_product', Configuration::NEW_BRANDS_SEGMENT_ID)); } protected function getConfigManager() { return $this->configManager; } }

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57

<?php   namespace Acme\BrandBundle\Layout\DataProvider;   use Oro\Bundle\ConfigBundle\Config\ConfigManager; use Acme\BrandBundle\DependencyInjection\Configuration; use Oro\Bundle\SegmentBundle\Entity\Manager\SegmentManager;   class NewBrandsProvider {       private $segmentManager;       private $configManager;         public function __construct(         SegmentManager $segmentManager,         ConfigManager $configManager     ) {         $this->segmentManager = $segmentManager;         $this->configManager = $configManager;     }       public function getBrands()     {         if(!is_null($this->getSegmentId())){             $segment = $this->segmentManager->findById($this->getSegmentId());             $qb = $this->segmentManager->getEntityQueryBuilder($segment);             $result = $qb->getQuery()->getResult();               return $result;         }         else {             $segment = $this->segmentManager->findById(50);             $qb = $this->segmentManager->getEntityQueryBuilder($segment);             $result = $qb->getQuery()->getResult();               return $result;         }     }       protected function getSegmentId()     {         dump($this->getConfigManager()             ->get(sprintf('%s.%s', 'oro_product', Configuration::NEW_BRANDS_SEGMENT_ID))         );           return $this->getConfigManager()             ->get(sprintf('%s.%s', 'oro_product', Configuration::NEW_BRANDS_SEGMENT_ID));     }       protected function getConfigManager()     {         return $this->configManager;     } }

I also added a system_configuration_services.yml with below:

YAML

parameters: oro_product.segment.new_brands.name: 'New Brands' services: oro_product.provider.default_value.new_brands: parent: oro_config.provider.value.entity_id arguments: - '@oro_entity.doctrine_helper' - '%oro_segment.segment.entity.class%' - 'entity': '%oro_product.entity.brand.class%' 'name': '%oro_product.segment.new_brands.name%'

1 2 3 4 5 6 7 8 9 10 11 12

parameters:     oro_product.segment.new_brands.name: 'New Brands'   services:     oro_product.provider.default_value.new_brands:         parent: oro_config.provider.value.entity_id         arguments:             - '@oro_entity.doctrine_helper'             - '%oro_segment.segment.entity.class%'             -                 'entity': '%oro_product.entity.brand.class%'                 'name': '%oro_product.segment.new_brands.name%'

Now if I add the below NEW_BRANDS_SEGMENT_ID node inside OroProductBundle Configuration.php, my NewBrandsProvider can dynamically get the segment id with getSegmentId() function. Which tells me I can manually add a configuration node for my custom Segment ID which I can make query on.

PHP

/** * {@inheritDoc} */ public function getConfigTreeBuilder() { $treeBuilder = new TreeBuilder(); $rootNode = $treeBuilder->root(static::ROOT_NODE); SettingsBuilder::append( $rootNode, [ static::NEW_BRANDS_SEGMENT_ID => [ 'value' => '@oro_product.provider.default_value.new_brands' ], ] ); return $treeBuilder; }

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

/**      * {@inheritDoc}      */     public function getConfigTreeBuilder()     {         $treeBuilder = new TreeBuilder();         $rootNode = $treeBuilder->root(static::ROOT_NODE);         SettingsBuilder::append(             $rootNode,             [                 static::NEW_BRANDS_SEGMENT_ID => [                     'value' => '@oro_product.provider.default_value.new_brands'                 ],             ]         );         return $treeBuilder;     }

But obviously, I don’t want to edit core codes and want the same facility by using same logic in my custom bundle.

Which is why I wanted to make my own Configuration.php but it was returning “null” for getSegmentId().

Alternate Ways I tried: I thought I need to extend ProductBundle’s Configuration.php as Brand entity is defined inside ProductBundle. So, after my custom bundle’s(BrandBundle) Configuration.php was not working, I also added the below Extension class to extend ProductBundle’s configs from my Custom Bundle.

PHP

<?php namespace Acme\BrandBundle\DependencyInjection; use Symfony\Component\Config\FileLocator; use Symfony\Component\DependencyInjection\ContainerBuilder; use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface; use Symfony\Component\DependencyInjection\Loader; use Symfony\Component\HttpKernel\DependencyInjection\Extension; class AcmeBrandExtension extends Extension implements PrependExtensionInterface { const ALIAS = 'oro_product'; public function load(array $configs, ContainerBuilder $container) { $configuration = new Configuration(); $config = $this->processConfiguration($configuration, $configs); $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config')); $loader->load('services.yml'); $loader->load('system_configuration_services.yml'); $container->prependExtensionConfig($this->getAlias(), $config); } public function prepend(ContainerBuilder $container) { $configuration = new Configuration(); $configs = $container->getExtensionConfig('acme_brand'); $config = $this->processConfiguration($configuration, $configs); $container->prependExtensionConfig('oro_product', $config); if (isset($config['entity_manager_name'])) { $config = ['entity_manager_name' => $config['entity_manager_name']]; $container->prependExtensionConfig('oro_product', $config); } } }

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46

<?php   namespace Acme\BrandBundle\DependencyInjection;   use Symfony\Component\Config\FileLocator; use Symfony\Component\DependencyInjection\ContainerBuilder; use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface; use Symfony\Component\DependencyInjection\Loader; use Symfony\Component\HttpKernel\DependencyInjection\Extension;   class AcmeBrandExtension extends Extension implements PrependExtensionInterface {       const ALIAS = 'oro_product';       public function load(array $configs, ContainerBuilder $container)     {           $configuration = new Configuration();         $config = $this->processConfiguration($configuration, $configs);           $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));         $loader->load('services.yml');         $loader->load('system_configuration_services.yml');           $container->prependExtensionConfig($this->getAlias(), $config);       }       public function prepend(ContainerBuilder $container)     {         $configuration = new Configuration();           $configs = $container->getExtensionConfig('acme_brand');           $config = $this->processConfiguration($configuration, $configs);           $container->prependExtensionConfig('oro_product', $config);           if (isset($config['entity_manager_name'])) {             $config = ['entity_manager_name' => $config['entity_manager_name']];             $container->prependExtensionConfig('oro_product', $config);         }       } }

But after adding this extension, I was getting error on cache:clear saying NEW_BRANDS_SEGMENT_ID was not found.

I am sorry for this long post but will appreciate any advice to the right direction. :)

• This reply was modified 2 years, 5 months ago by  Shahriar.
• This reply was modified 2 years, 5 months ago by  Shahriar.

[ShahriarParticipant]

Then actual error looks like this:

new_brands_segment_id is not found in oro_product.settings

[ShahriarParticipant]

Okay, I fixed it. Thanks for the suggestion!
You are right, I dont need to extend ProductBundle’s Configuration instead I can just have my own bundle’s Configuration.

It looks like, I was adding Configuration for my own bundle but was not really calling it correct ALIAS.

I corrected this function in my NewBrandsProvider class

PHP

protected function getSegmentId() { return $this->getConfigManager() ->get(sprintf('%s.%s', 'acme_brand', Configuration::NEW_BRANDS_SEGMENT_ID)); }

1 2 3 4 5

protected function getSegmentId() {     return $this->getConfigManager()             ->get(sprintf('%s.%s', 'acme_brand', Configuration::NEW_BRANDS_SEGMENT_ID)); }

Also corrected the service name in system_configuration_services.yml

YAML

parameters: acme_brand.segment.new_brands.name: 'New Brands' services: acme_brand.provider.default_value.new_brands: parent: oro_config.provider.value.entity_id arguments: - '@oro_entity.doctrine_helper' - '%oro_segment.segment.entity.class%' - 'entity': '%oro_product.entity.brand.class%' 'name': '%acme_brand.segment.new_brands.name%'

1 2 3 4 5 6 7 8 9 10 11 12

parameters:     acme_brand.segment.new_brands.name: 'New Brands'   services:     acme_brand.provider.default_value.new_brands:         parent: oro_config.provider.value.entity_id         arguments:             - '@oro_entity.doctrine_helper'             - '%oro_segment.segment.entity.class%'             -                 'entity': '%oro_product.entity.brand.class%'                 'name': '%acme_brand.segment.new_brands.name%'

My getSegmentId() is now returning the id. This is resolved now. :)

• This reply was modified 2 years, 5 months ago by  Shahriar.

[Author]

Replies