How to enable tag and attachments for BusinessUnit

This topic contains 2 replies, has 2 voices, and was last updated by Sergey 6 years, 8 months ago.

Starting from March 1, 2020 the forum has been switched to the read-only mode. Please head to StackOverflow for support.

Creator
Topic

July 31, 2017 at 12:49 pm #29344

Sergey

Participant

Hi. I need to enable Tags and Attachments for BusinessUnit
I can do that in ENTITY MANAGEMENT or in console with command

php app/console oro:entity-config:debug "Oro\Bundle\OrganizationBundle\Entity\BusinessUnit" --scope tag --attr enabled --val true --set

1	php app/console oro:entity-config:debug "Oro\Bundle\OrganizationBundle\Entity\BusinessUnit" --scope tag --attr enabled --val true --set

but when i use entity-config:update

php app/console oro:entity-config:update --force

1	php app/console oro:entity-config:update --force

all my changes desapearing

 php app/console oro:entity-config:debug "Oro\Bundle\OrganizationBundle\Entity\BusinessUnit" --scope tag --attr enabled --val true
Class: Oro\Bundle\OrganizationBundle\Entity\BusinessUnit
Mode:  default
Values:
Array
(
    [tag] => Array
        (
            [enabled] => false
        )

)

php app/console oro:entity-config:debug "Oro\Bundle\OrganizationBundle\Entity\BusinessUnit" --scope tag --attr enabled --val true

Class: Oro\Bundle\OrganizationBundle\Entity\BusinessUnit

Mode: default

Values:

Array

(

[tag] => Array

(

[enabled] => false

)

It is easy issue for custom entities where I can add annotations

 * @Config(
 *     defaultValues={
 *          "tag"={
 *              "enabled"=true
 *          },
 *          "attachment"={
 *              "enabled"=true,
 *              "maxsize"=50
 *          },
 *     }
 * )

* @Config(

* defaultValues={

* "tag"={

* "enabled"=true

* },

* "attachment"={

* "enabled"=true,

* "maxsize"=50

* },

* }

* )

BusinessUnit is ORO entity ( vendor/Oro/Bundle/OrganizationBundle/Entity/BusinessUnit.php)
and it is a very bad practice to edit it but I can’t find another.

Can you recommend some better solution of this problem?

Creator
Topic

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

Author
Replies

July 31, 2017 at 1:19 pm #29345

mmiasnikov

Participant

Hi, @sergey.stepanchuk!

Probably the only solution at the moment – use DB migration for this. Please, take a look at example how to set up options in OroCRMTaskBundle https://github.com/oroinc/OroCRMTaskBundle/blob/2.3/Migrations/Schema/v1_2/OroTaskBundle.php#L96-L127.

August 1, 2017 at 10:48 am #29346

Sergey

Participant

Hi, mmiasnikov. Thanks for your answer.

I created migration as you proposed.

namespace Test\Bundle\TestBundle\Migrations\Schema\v7_4;

use Doctrine\DBAL\Schema\Schema;
use Oro\Bundle\MigrationBundle\Migration\Migration;
use Oro\Bundle\MigrationBundle\Migration\OrderedMigrationInterface;
use Oro\Bundle\MigrationBundle\Migration\QueryBag;
use Oro\Bundle\EntityExtendBundle\Migration\ExtendOptionsManager;
use Oro\Bundle\EntityExtendBundle\Migration\OroOptions;

class ChangeBusinessUnitTable implements Migration, OrderedMigrationInterface
{
    /**
     * {@inheritdoc}
     */
    public function up(Schema $schema, QueryBag $queries)
    {
        $tableName = 'oro_business_unit';
        if ($schema->hasTable($tableName)) {
            $table = $schema->getTable($tableName);
            $table->addOption(OroOptions::KEY, ['tag' => ['enabled' => true]]);
            $table->addOption(OroOptions::KEY, ['attachment' => ['enabled' => true]]);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function getOrder()
    {
        return 1;
    }

namespace Test\Bundle\TestBundle\Migrations\Schema\v7_4;

use Doctrine\DBAL\Schema\Schema;

use Oro\Bundle\MigrationBundle\Migration\Migration;

use Oro\Bundle\MigrationBundle\Migration\OrderedMigrationInterface;

use Oro\Bundle\MigrationBundle\Migration\QueryBag;

use Oro\Bundle\EntityExtendBundle\Migration\ExtendOptionsManager;

use Oro\Bundle\EntityExtendBundle\Migration\OroOptions;

class ChangeBusinessUnitTable implements Migration, OrderedMigrationInterface

{

/**

* {@inheritdoc}

public function up(Schema $schema, QueryBag $queries)

{

$tableName = 'oro_business_unit';

if ($schema->hasTable($tableName)) {

$table = $schema->getTable($tableName);

$table->addOption(OroOptions::KEY, ['tag' => ['enabled' => true]]);

$table->addOption(OroOptions::KEY, ['attachment' => ['enabled' => true]]);

}

/**

* {@inheritdoc}

public function getOrder()

{

return 1;

}

After run migration options ‘enable’ were set to ‘true’

php app/console oro:entity-config:debug "Oro\Bundle\OrganizationBundle\Entity\BusinessUnit" --scope tag  --attr enabled
    [tag] => Array
        (
            [enabled] => true
        )

php app/console oro:entity-config:debug "Oro\Bundle\OrganizationBundle\Entity\BusinessUnit" --scope attachment  --attr enabled
    [attachment] => Array
        (
            [enabled] => true
        )

php app/console oro:entity-config:debug "Oro\Bundle\OrganizationBundle\Entity\BusinessUnit" --scope tag --attr enabled

[tag] => Array

(

[enabled] => true

)

php app/console oro:entity-config:debug "Oro\Bundle\OrganizationBundle\Entity\BusinessUnit" --scope attachment --attr enabled

[attachment] => Array

(

[enabled] => true

)

Unfortunately after execute

app/console oro:entity-config:update --force

1	app/console oro:entity-config:update --force

changes disappeared

I found another solution maybe it will be useful for other.
I modified bundle’s install script to enable Tags and Attachments for BusinessUnit after config:update

php app/console oro:entity-config:update --force
#This commands enable tags and attachment for BusinessUnit
php app/console oro:entity-config:debug "Oro\Bundle\OrganizationBundle\Entity\BusinessUnit" --scope tag --attr enabled --val true --set
php app/console oro:entity-config:debug "Oro\Bundle\OrganizationBundle\Entity\BusinessUnit" --scope attachment --attr enabled --val true --set

php app/console oro:entity-config:update --force

#This commands enable tags and attachment for BusinessUnit

php app/console oro:entity-config:debug "Oro\Bundle\OrganizationBundle\Entity\BusinessUnit" --scope tag --attr enabled --val true --set

php app/console oro:entity-config:debug "Oro\Bundle\OrganizationBundle\Entity\BusinessUnit" --scope attachment --attr enabled --val true --set

So after every deploy and update with force, Tags and Attachments are always enabled.

Then I found another bad thing. When we disable Tags (in ‘entity manager’ or after ‘php app/console oro:entity-config:update –force’) all tags that we had set for BusinessUnits disapeared from them.
I found that Tag’s relation deleted in Tag’s Entity listener – class EntityConfigListener, function postFlush (oro/platform/src/Oro/Bundle/TagBundle/EventListener/EntityConfigListener.php)
So I decided to overwrite this listener and extend TagBundle

#src/Test/Bundle/TagBundle/Resources/config/services.yml
services:
    #Rewritten OroTag Deletes tags relations for given entity class functionality
    oro_tag.eventlistener.entity_config:
        class: Test\Bundle\TagBundle\EventListener\EntityConfigListener
        arguments:
            - '@oro_tag.tag.manager'
        tags:
            - { name: kernel.event_listener, event: oro.entity_config.post_flush, method: postFlush }

#src/Test/Bundle/TagBundle/Resources/config/services.yml

services:

#Rewritten OroTag Deletes tags relations for given entity class functionality

oro_tag.eventlistener.entity_config:

class: Test\Bundle\TagBundle\EventListener\EntityConfigListener

arguments:

- '@oro_tag.tag.manager'

tags:

- { name: kernel.event_listener, event: oro.entity_config.post_flush, method: postFlush }

And add exception for BusinessUnit

#src/Test/Bundle/TagBundle/EventListener/EntityConfigListener.php
<?php

namespace Test\Bundle\TagBundle\EventListener;

use Oro\Bundle\EntityConfigBundle\Entity\EntityConfigModel;
use Oro\Bundle\EntityConfigBundle\Event\PostFlushConfigEvent;
use Oro\Bundle\TagBundle\Entity\TagManager;

class EntityConfigListener
{
    /** @var TagManager */
    protected $tagManager;

    /** @param TagManager $tagManager */
    public function __construct(TagManager $tagManager)
    {
        $this->tagManager = $tagManager;
    }

    /**
     * Deletes tags relations for $className in cases when "tagging" option has been disabled for it.
     *
     * @param PostFlushConfigEvent $event
     */
    public function postFlush(PostFlushConfigEvent $event)
    {
        foreach ($event->getModels() as $model) {
            if ($model instanceof EntityConfigModel) {
                $configManager = $event->getConfigManager();
                $className = $model->getClassName();
                $changeSet = $configManager->getConfigChangeSet(
                    $configManager->getProvider('tag')->getConfig($className)
                );

                if (isset($changeSet['enabled']) && $changeSet['enabled'][0] && (!$changeSet['enabled'][1])) {
                    if ($className != 'Oro\Bundle\OrganizationBundle\Entity\BusinessUnit') {
                        $this->tagManager->deleteRelations($className);
                    }
                }
            }
        }
    }
}

#src/Test/Bundle/TagBundle/EventListener/EntityConfigListener.php

<?php

namespace Test\Bundle\TagBundle\EventListener;

use Oro\Bundle\EntityConfigBundle\Entity\EntityConfigModel;

use Oro\Bundle\EntityConfigBundle\Event\PostFlushConfigEvent;

use Oro\Bundle\TagBundle\Entity\TagManager;

class EntityConfigListener

{

/** @var TagManager */

protected $tagManager;

/** @param TagManager $tagManager */

public function __construct(TagManager $tagManager)

{

$this->tagManager = $tagManager;

}

/**

* Deletes tags relations for $className in cases when "tagging" option has been disabled for it.

* @param PostFlushConfigEvent $event

public function postFlush(PostFlushConfigEvent $event)

{

foreach ($event->getModels() as $model) {

if ($model instanceof EntityConfigModel) {

$configManager = $event->getConfigManager();

$className = $model->getClassName();

$changeSet = $configManager->getConfigChangeSet(

$configManager->getProvider('tag')->getConfig($className)

);

if (isset($changeSet['enabled']) && $changeSet['enabled'][0] && (!$changeSet['enabled'][1])) {

if ($className != 'Oro\Bundle\OrganizationBundle\Entity\BusinessUnit') {

$this->tagManager->deleteRelations($className);

}

Well, that’s how I achieved my goal

Author
Replies

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

The forum ‘OroCRM – How do I? Questions’ is closed to new topics and replies.

OroCRM Forums