CODEWITHSUNDEEP
phpsymfonydependency-injectiondoctrine
DomingoSL
DomingoSL

Reputation: 15504

How to get Doctrine to work inside a helper function on Symfony2

I need to get doctrine working inside my helper, im trying to use like i normaly do in a controller:

$giftRepository = $this->getDoctrine( )->getRepository( 'DonePunctisBundle:Gift' );

But this gave me:

FATAL ERROR: CALL TO UNDEFINED METHOD DONE\PUNCTISBUNDLE\HELPER\UTILITYHELPER::GETDOCTRINE() IN /VAR/WWW/VHOSTS/PUNCTIS.COM/HTTPDOCS/SRC/DONE/PUNCTISBUNDLE/HELPER/UTILITYHELPER.PH

What Im missing here?

EDIT:

services file

services:
    templating.helper.utility:
        class: Done\PunctisBundle\Helper\UtilityHelper
        arguments: [@service_container]
        tags:
            - { name: templating.helper, alias: utility }

Firts lines of helper file

<?php
namespace Done\PunctisBundle\Helper;

use Symfony\Component\Templating\Helper\Helper;
use Symfony\Component\Templating\EngineInterface;



class UtilityHelper extends Helper {

    /*
     * Dependency injection
     */

    private $container;

    public function __construct( $container )
    {
        $this->container = $container;
    }

Upvotes: 5

Views: 10332

Answers (2)

Thomas Kelley
Thomas Kelley

Reputation: 10302

The problem here is that your Helper class is not container-aware; that is, it has no idea about all the services Symfony has loaded (monolog, twig, ...and doctrine).

You fix this by passing "doctrine" to it. This is called Dependency Injection, and is one of the core things that makes Symfony awesome. Here's how it works:

First, give your Helper class a place for the Doctrine service to live, and require it in the Helper's constructor:

class UtilityHelper
{
    private $doctrine;

    public function __construct($doctrine)
    {
        $this->doctrine = $doctrine;
    }

    public function doSomething()
    {
        // Do something here
    }
}

Then, you use services.yml to define how Symfony should construct that instance of Helper:

services:
    helper:
        class: Done\PunctisBundle\Helper\UtilityHelper
        arguments: [@doctrine]

In this case, @doctrine is a placeholder that means "insert the Doctrine service here".

So now, in your Controller, or in anything else that is container-aware, you can get access to Doctrine through the Helper class like this:

class SomeController()
{
    public function someAction()
    {
        $this->get("helper")->doctrine->getRepository(...);
    }
}

EDIT

After looking at your edit, it appears that you're injecting the entire service container into the Helper class. That's not a best practice -- you should only inject what you need. However, you can still do it:

services.yml

services:
    helper:
        class: Done\PunctisBundle\Helper\UtilityHelper
        arguments: [@service_container]

UtilityHelper.php

class UtilityHelper
{
    private $container;

    public function __construct($container)
    {
        $this->container = $container;
    }

    public function doSomething()
    {
        // This won't work, because UtilityHelper doesn't have a getDoctrine() method:
        // $this->getDoctrine()->getRepository(...)

        // Instead, think about what you have access to...
        $container = $this->container;

        // Now, you need to get Doctrine

        // This won't work... getDoctrine() is a shortcut method, available only in a Controller
        // $container->getDoctrine()->getRepository(...)

        $container->get("doctrine")->getRepository(...)  
    }
}

I've included a few comments there that highlight some common pitfalls. Hope this helps.

Upvotes: 11

sean662
sean662

Reputation: 706

In Helper, Services etc you cannot use it like in actions. You need to pass it like argument to youre Helper via service description in conf file(services.yml or *.xml).

Example:

  services:
   %service_name%:
    class: %path_to_youre_helper_class%
    arguments: [@doctrine.orm.entity_manager]
    tags:
        - { name: %name% }

And dont forget catch it in __construct of youre Helper.

Example:

use Doctrine\ORM\EntityManager;
....    

private $em;
public function __construct(EntityManager $em)
{
  $this->em = $em;
}

You can use it like:

public function myMethod()
{
  $repo = $this->em->getRepository('DonePunctisBundle:Gift');
}

Upvotes: 0

Related Questions