Migrating Services & Security

Don't know if I missed some forum rule or something, I tried twice with my question and it just gets removed, not sure whether that's automatic or intentionally done by someone. Too much code sample in the question?

Just posted this but it got marked as spam, so I'll try it again 😎

Moving from symfony 3 to 4 I started injecting the service according to this.

Most functions where I inject the "helper" service it works fine, but for some reason it fails on a few of them and I can't figure out what I've done differently... Here's the error:

Could not resolve argument $helper of
"App\Controller\Poslog\OperatorController::historyindividualaction()",
maybe you forgot to register the controller as a service or missed
tagging it with the "controller.service_arguments"?

I've omitted the contents if the functions completely as it doesn't matter what they contain, I can comment out the entire code inside the HistoryIndividualAction() and still get the exact same error message.

The OperatorController::newAction() below works perfectly fine (as well as a number of other functions within the same object), while the OperatorController::HistoryIndividualAction() fails.

    use App\Service\globalHelper as globalHelper;
    ...
    class OperatorController extends AbstractController
    {
    
      public function newAction(Request $request, ACRGroup $ACRGroup = null, globalHelper $helper)
      {
      ...
      }
    
      public function HistoryIndividualAction($operatorId, globalHelper $helper)
      {
      ...
      }
    }

The routing looks like this

    operator_new:
        path:     /new/{ACRGroup}
        defaults: { _controller: App\Controller\Poslog\OperatorController::newAction, ACRGroup: null }
        methods:  [GET, POST]
    
    operator_history_individual:
        path:     /history/individual/{operatorId}
        defaults: { _controller: App\Controller\Poslog\OperatorController::historyIndividualAction }
        methods:  GET

Services.yml

    # This file is the entry point to configure your own services.
    # Files in the packages/ subdirectory configure your dependencies.
    
    # Put parameters here that don't need to change on each machine where the app is deployed
    # https://symfony.com/doc/current/best_practices/configuration.html#application-related-configuration
    parameters:
        locale: en
    
    
    services:
        # default configuration for services in *this* file
        _defaults:
            autowire: true      # Automatically injects dependencies in your services.
            autoconfigure: true # Automatically registers your services as commands, event subscribers, etc.
    
        # makes classes in src/ available to be used as services
        # this creates a service per class whose id is the fully-qualified class name
        App\:
            resource: '../src/'
            exclude:
                - '../src/DependencyInjection/'
                - '../src/Entity/'
                - '../src/Kernel.php'
    
        # controllers are imported separately to make sure services can be injected
        # as action arguments even if you don't extend any base controller class
        App\Controller\:
            resource: '../src/Controller/'
            tags: ['controller.service_arguments']
    
    
        # add more service definitions when explicit configuration is needed
        # please note that last definitions always *replace* previous ones
    
        globalHelper:
            class: App\Service\globalHelper
            public: false
            arguments: ['@service_container', '@doctrine.orm.entity_manager']

GlobalHelper starts out like this:

    namespace App\Service;
    
    use Symfony\Component\DependencyInjection\ContainerInterface as Container;
    //use Doctrine\ORM\EntityManager as EntityManager; //gave deprecation notice, profiler suggested to change to below and the deprecation notice disappeared.
    use Doctrine\ORM\EntityManagerInterface as EntityManager;
    
    
    class globalHelper {
    
    	private $container;
    	private $em;
    
    	public function __construct(Container $container, EntityManager $em) {
    		$this->container = $container;
    		$this->em = $em;
    	}

Just posted a question (below). I went to format it a little nicer (adding the PRE tags to the code blocks) and then it got marked as SPAM for some reason...

Moving from symfony 3 to 4 I started injecting the service according to this.

Most functions where I inject the "helper" service it works fine, but for some reason it fails on a few of them and I can't figure out what I've done differently... Here's the error:

<blockquote>Could not resolve argument $helper of "App\Controller\Poslog\OperatorController::historyindividualaction()", maybe you forgot to register the controller as a service or missed tagging it with the "controller.service_arguments"?</blockquote>

I've omitted the contents if the functions completely as it doesn't matter what they contain, I can comment out the entire code inside the HistoryIndividualAction() and still get the exact same error message.

The OperatorController::newAction() below works perfectly fine (as well as a number of other functions within the same object), while the OperatorController::HistoryIndividualAction() fails.

use App\Service\globalHelper as globalHelper;
...
class OperatorController extends AbstractController
{

  public function newAction(Request $request, ACRGroup $ACRGroup = null, globalHelper $helper)
  {
  ...
  }

  public function HistoryIndividualAction($operatorId, globalHelper $helper)
  {
  ...
  }

The routing looks like this

operator_new:
    path:     /new/{ACRGroup}
    defaults: { _controller: App\Controller\Poslog\OperatorController::newAction, ACRGroup: null }
    methods:  [GET, POST]

operator_history_individual:
    path:     /history/individual/{operatorId}
    defaults: { _controller: App\Controller\Poslog\OperatorController::historyIndividualAction }
    methods:  GET```


Services.yml

# This file is the entry point to configure your own services.
# Files in the packages/ subdirectory configure your dependencies.

# Put parameters here that don't need to change on each machine where the app is deployed
# https://symfony.com/doc/current/best_practices/configuration.html#application-related-configuration
parameters:

locale: en

services:

# default configuration for services in *this* file
_defaults:
    autowire: true      # Automatically injects dependencies in your services.
    autoconfigure: true # Automatically registers your services as commands, event subscribers, etc.

# makes classes in src/ available to be used as services
# this creates a service per class whose id is the fully-qualified class name
App\:
    resource: '../src/'
    exclude:
        - '../src/DependencyInjection/'
        - '../src/Entity/'
        - '../src/Kernel.php'

# controllers are imported separately to make sure services can be injected
# as action arguments even if you don't extend any base controller class
App\Controller\:
    resource: '../src/Controller/'
    tags: ['controller.service_arguments']

# add more service definitions when explicit configuration is needed
# please note that last definitions always *replace* previous ones

globalHelper:
    class: App\Service\globalHelper
    public: false
    arguments: ['@service_container', '@doctrine.orm.entity_manager']```

GlobalHelper starts out like this:

namespace App\Service;

use Symfony\Component\DependencyInjection\ContainerInterface as Container;
//use Doctrine\ORM\EntityManager as EntityManager; //gave deprecation notice, profiler suggested to change to below and the deprecation notice disappeared.
use Doctrine\ORM\EntityManagerInterface as EntityManager;

class globalHelper {

    private $container;
    private $em;

    public function __construct(Container $container, EntityManager $em) {
        $this->container = $container;
        $this->em = $em;
    }```

Hey Mattias,

This problem is unexpected, let's try a few things. First, capitalize your class name GlobalHelper, double-check that the name of the class match the name of the file (this is just to be compliant with PSR-4)
Second, update your services.yaml config. Change it to:

services:
    ...
    App\Service\GlobalHelper:
        public: false
        arguments: ['@service_container', '@doctrine.orm.entity_manager']

We need the service ID to be the FQNS of the class

Give it a try and let me know. Oh, by the way, we use Disqus for the comments and it decided to mark your messages as a spam, possibly due to the length of the comment

Cheers!

Thank you - I found the solution. In the controller, the function name is with a leading capital "H"
public function HistoryIndividualAction

Whereas in the routing yaml file, it is written with a small leading "h"
defaults: { _controller: App\Controller\Poslog\OperatorController::historyIndividualAction }

Changing the routing to
defaults: { _controller: App\Controller\Poslog\OperatorController::HistoryIndividualAction }
fixed the problem =)

Hi, the video only shows a bundle called AppBundle but I have several bundles. Do I have to create a mapping for each bundle?

Hey Antonio S.

Yes, you're correct. You have to map all of your bundles

Cheers!

In a Symfony 3.4 project, I have several bundles in the src directory. Each of these bundles has a services.yml file and an DependencyInjection/Extension class. Some also have a config.yml file and a DependencyInjection/Configuration class.

Now I'm trying to convert to Symfony 4.3.

• Where should these internal bundle service definitions go?

• And more importantly, how do I deal with bundle configuration of these internal bundles when internal bundles aren't supposed to exist anymore?

Hey halifaxious

You can merge all your services.yml files into config/services.yaml, or just move them there config/ and tell the Kernel to load them:

// src/Kernel.php
protected function configureContainer(ContainerBuilder $container, LoaderInterface $loader)
{
    ...
    $loader->load($confDir.'/services_bundleOne'.self::CONFIG_EXTS, 'glob');
    $loader->load($confDir.'/services_bundleTwo'.self::CONFIG_EXTS, 'glob');
    ...
}

About config.yml files, those are trickier because you will have to split the configuration into multiple files. For example, if in any of your config.yml files you have something like this.

stof_doctrine_extensions:
    default_locale: en_US
    orm:
        default:
            sluggable: true
            timestampable: true
...

You have to copy the whole block stof_doctrine_extensions and move it into config/packages/stof_doctrine_extensions.yaml file

About your DependencyInjection files you can just move them into src/DependencyInjection and it should just work out of the box (just check for name collision)

• And more importantly, how do I deal with bundle configuration of these internal bundles when internal bundles aren't supposed to exist anymore?

What kind of configuration do you have?

Cheers!

My most problematic internal bundle is HazardBundle. Its services look like this:

 
 HazardBundle\:
  resource: '../src/HazardBundle/*'
  exclude: '../src/HazardBundle/{Entity,Repository}'
 HazardBundle\Controller\:
   resource: '../src/HazardBundle/Controller'
   public: true
   tags: ['controller.service_arguments']
 HazardBundle\Manager\PictogramManager:
   arguments: ['%acrd_hazard.pictograms%']

There is a config file that I have moved to /config/packages/hazard.yaml which is the source for the %acrd_hazard.pictograms% parameter. The parameter is built in the HazardBundle/DependencyInjection/HazardExtension class using the HazardBundle/DependencyInjection/Configuration class as follows:

class HazardExtension extends Extension
{
  const ALIAS = 'acrd_hazard';

   /**
  * {@inheritdoc}
  */
  public function load(array $configs, ContainerBuilder $container)
  {

    $fileLocator = new FileLocator(__DIR__.'/../Resources/config');
    $configs[] = Yaml::parse(file_get_contents($fileLocator->locate('hazard.yml')));
    $configuration = new Configuration();
    $processedConfig = $this->processConfiguration($configuration, $configs);

    $container->setParameter(self::ALIAS.'.pictograms', $processedConfig['hazard']['pictograms']);
    $container->setParameter(self::ALIAS.'.GHS', $processedConfig['hazard']['GHS']);
    $container->setParameter(self::ALIAS.'.icon_class_prefix', $processedConfig['hazard']['icon_class_prefix']);

    $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
    $loader->load('services.yml');
  }
//etc.
}

The hazard.yaml begins like this:

hazard:
  icon_class_prefix: 'haz'
  pictograms:
    explosive:
     title: 'pict.explosive'
    //etc.
  GHS:
    //etc.

Before I moved hazard.yaml to /config/packages, my services file failed because the %acrd_hazard.pictogram% parameter was undefined. After I moved it, I got the error "There is no extension able to load the configuration for hazard". Moving HazardExtension to src/DependencyInjection does not change that.

What am I missing?

Ok, so your Extension is not being detected for some reason. Double check its namespace and it should extend from Symfony\Component\DependencyInjection\Extension\Extension. Also it must live inside src/DepedencyInjection folder

I hope it helps

Hi,
I must have skipped one page, I don't have the config/packages/doctrine.yaml file. I tried "composer require doctrine/doctrine-bundle" which added "doctrine/doctrine-bundle": "^1.9" in my composer.json but nothing else happens. What am I missing here ? How can I install Doctrine in my project ?
Thanks.

Edit : I found that I should use "require symfony/orm-pack" but the console answers "nothing to install or update"
Edit 2 : I deleted the vendor directory then re-ran (?) the previous command. Suddenly 83 installs, including doctrine, and "doctrine.yaml" is now in the packages directory (with several others - previously missing too - like google_recaptcha.yaml). All right, then, I can continue the migration ! I'll be back for many other questions ;)

Hey Jean-tilapin

I'm glad to hear that you could fix your problem, but I believe what happened was that for some reason the doctrine bundle recipe didn't get installed. When that happens, you can run composer fix-recipes and if it was missing, it will install it for you :)

Cheers!

Hi !

I'm actually facing a really weird error, the problem is 99% due to me, but I'm stuck.

First my error is :

In FileLoader.php line 168:

Expected to find class "UTM\CoreBundle\Controller\CoreController" in file "C:\Users\legof\Documents\GitHub\utm-website\src\UTM/CoreBundle\Controller\CoreController.php" while importing services from resource "../src/UTM/*", but it was not found! Check the namespa
ce prefix used with the resource in C:\Users\legof\Documents\GitHub\utm-website\config/services.yaml (which is loaded in resource "C:\Users\legof\Documents\GitHub\utm-website\config/services.yaml").

But I checked it couple times, the file and the namespace are ok.

Here are my services.yaml and the CoreController.php file

locale: fr

services:
    _defaults:
        autowire: true      # Automatically injects dependencies in your services.
        autoconfigure: true # Automatically registers your services as commands, event subscribers, etc.
        public: false       # Allows optimizing the container by removing unused services; this also means
                            # fetching services directly from the container via $container->get() won't work.
                            # The best practice is to be explicit about your dependencies anyway.
    App\:
        resource: '../src/*'
        exclude: '../src/{Entity,Migrations,Tests,UTM}'

    App\Controller\:
        resource: '../src/Controller'
        tags: ['controller.service_arguments']

    # REMOVE when AppBundle is removed
    UTM\:
        resource: '../src/UTM/*'
        exclude: '../src/UTM/{Entity,Repository}'

    UTM\Controller\:
        resource: '../src/UTM/Controller'
        public: true
        tags: ['controller.service_arguments']
    # END REMOVE

    UTM\UserBundle\Security\LoginFormAuthenticator: ~

    UTM\UserBundle\Security\UserProvider: ~

    UTM\UserBundle\Mojang\MojangAPI: ~

    UTM\UserBundle\Mojang\Uuid: ~

    UTM\FactionBundle\Twig\Extension\FactionExtension: ~

namespace UTM\CoreBundle\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\Controller;

class CoreController extends Controller
{
    public function indexAction()
    {
        return $this->render('UTMCoreBundle:Core:index.html.twig');
    }
}

Hey Hugo L.

I believe I found your problem, here:

UTM\Controller\:
        resource: '../src/UTM/Controller'

you specified the folder ../src/UTM/Controller, but it actually lives in: ../src/UTM/CoreBundle/Controller, isn't it?

I think I clearly don't get the utility of the AppBundle lines in services.yaml. I guess it is loading my old code, but I at least don't get how doing it. In my project I have in src folder another folder called UTM where there is 6 bundles (CoreBundle, User Bundle...).

I tried to only load CoreBundle by making the changes you suggested to me but I was facing the same error.

So I removed the "AppBundle" block for the moment and it's working fine, but I guess it is the wrong way to do it.

It would be super cool if you quickly explain me how to do it properly.

Thank you very much !

EDIT:

Ok, I'm now moving my bundles into src, so maybe I do not need anymore those lines. Instead, I have another question, as I said, actually on my src folder I have a UTM folder where there is 6 bundles like this :

src
├───Controller
├───Entity
├───Repository
└───UTM
--├───CoreBundle
--├───FactionBundle
--├───ForumBundle
--├───LimitsBundle
--├───ShopBundle
--└───UserBundle
Now should I move all thoses bundles on src and rename them without the "Bundle" like this (and also remove the Controller, Entity and Repository folder) ?

src
├───Core
├───Faction
├───Forum
├───Limits
├───Shop
└───User

Thank you again

In Symfony4 there is no more a bundle structure, everything lives inside "src" folder (if you check composer.json you will notice that "App" namespace points to the "src" folder), so, yes, you have to move all your files living in bundles into the root of "src", but without deleting "Entity", "Controller", etc. folders, you just have to merge them

After moving the files, you have to double check that all your namespaces did change correctly, and fix any service configuration problem you may face (because all your classes will be automatically registered and configured as services)

Yes, that's what I figured out after this message, that's easier to use and manage at all.

Thank you !