Doctrine

Video not working?

It looks like your browser may not support the H264 codec. If you're using Linux, try a different browser or try installing the gstreamer0.10-ffmpeg gstreamer0.10-plugins-good packages.

Thanks! This saves us from needing to use Flash or encode videos in multiple formats. And that let's us get back to making more videos :). But as always, please feel free to message us.

We have a Movie class, but its missing all of its annotations! Yikes! I really don't feel like typing all of that.

Let me introduce you to another really important shortcut: generate. You can get to it with command+n. Or just click the code menu at the top, and select generate. Either way in this class, go down to "Generate ORM Class": and just like all menus in PhpStorm, you can just start typing to search for it.

Sweet - this automatically added all the Entity annotation stuff on top for us.

... lines 1 - 4
/**
* @Doctrine\ORM\Mapping\Entity
* @Doctrine\ORM\Mapping\Table(name="movie")
*/
class Movie
{
}

But it looks different: usually we'd just have the @ORM\Entity stuff on top, and it added it this way because we don't have the use statement yet. There's a simple solution to that. Just copy the full Entity annotation, say use, paste that and then delete the last part and instead stay as ORM;:

... lines 1 - 4
use Doctrine\ORM\Mapping as ORM;
... lines 6 - 15

That's the standard use statement that you see at the top of all Doctrine entities.

Let's get rid of these lines here, then get back inside of the class because context] is important with command+n. Hit command n and search for 'ORM' and select "Generate ORM Class":

... lines 1 - 4
use Doctrine\ORM\Mapping as ORM;
/**
* @ORM\Entity
* @ORM\Table(name="movie")
*/
class Movie
{
}

Perfect!

Let's add our properties, private $id;, private $title; for the movie title, private $samsCharacterName for Sam's character, private $rating to give the movie appearance a rating, private $isMainCharacter so we can see if Sam was the lead in that movie, and lastly private $releasedAt which will tell us exactly when the movie came out.

... lines 1 - 10
class Movie
{
private $id;
private $title;
private $samsCharacterName;
private $rating;
private $isMainCharacter;
private $releasedAt;
}

Easy!

The warning here is that each of these is an unused private field, which is true so far. But good to know, in the future that could just be extra code.

Generate ORM Annotations

Now that we have these we can go back to command n, search ORM and select "Generate ORM annotations". Select all of the fields that are in the menu and hit ok:

... lines 1 - 10
class Movie
{
/**
* @ORM\Id
* @ORM\GeneratedValue(strategy="AUTO")
* @ORM\Column(type="integer")
*/
private $id;
/**
* @ORM\Column(type="string")
*/
private $title;
/**
* @ORM\Column(type="string")
*/
private $samsCharacterName;
/**
* @ORM\Column(type="string")
*/
private $rating;
/**
* @ORM\Column(type="boolean")
*/
private $isMainCharacter;
/**
* @ORM\Column(type="datetime")
*/
private $releasedAt;
}

Awesome! Each field has all its annotations! Even better than that, it recognizes that id is our primary key so it set that up and it noticed that $isMainCharacter is probably a boolean, because of the 'is' in the beginning. And it also saw that $releasedAt is a datetime. This isn't perfect, I would prefer $releasedAt to just be a date, and rating up here is not a string, but an integer:

... lines 1 - 10
class Movie
{
... lines 13 - 29
/**
* @ORM\Column(type="integer")
*/
private $rating;
... lines 34 - 39
/**
* @ORM\Column(type="date", nullable=true)
*/
private $releasedAt;
}

But I do love getting autocomplete on all of those different types. Pressing control+space gives you a list of all the different types you have access to.

Ok, let's give $isMainCharacter a default value just in case it's ever not set. We'll make $releasedAt optional since a movie might not be released yet: set nullable=true: more autocomplete:

... lines 1 - 10
class Movie
{
... lines 13 - 34
/**
* @ORM\Column(type="boolean")
*/
private $isMainCharacter = false;
/**
* @ORM\Column(type="date", nullable=true)
*/
private $releasedAt;
}

Up here for $samsCharacterName, well this probably won't be too long so we can give it a length of 100 instead of the default 255:

... lines 1 - 10
class Movie
{
... lines 13 - 24
/**
* @ORM\Column(type="string", length=100)
*/
private $samsCharacterName;
... lines 29 - 43
}

Alright, this is all looking really nice.

Generating Getters and Setters

At this point we just have private properties so we need our getters and setters. Back to generate! Use our favorite shortcut, command+n, select getters and then $id:

... lines 1 - 10
class Movie
{
... lines 13 - 47
public function getId()
{
return $this->id;
}
}

Then back to generate and select getters and setters and select everything else. Before I finish this I want to pause and say that you don't necessarily need a getter and setter for every field in Doctrine. Sometimes you might want to wait to add the getters and setters until you actually need them. Then when the need arises you have these awesome shortcuts available.

... lines 1 - 10
class Movie
{
... lines 13 - 49
public function getTitle()
{
return $this->title;
}
public function setTitle($title)
{
$this->title = $title;
}
public function getSamsCharacterName()
{
return $this->samsCharacterName;
}
public function setSamsCharacterName($samsCharacterName)
{
$this->samsCharacterName = $samsCharacterName;
}
... lines 69 - 98
}

If I press command+, to get into preferences, you'll find that the templates that generate these methods are editable. Search for "templates", and you'll see the area where you can modify the getter and setter templates. I've already done this: usually they generate with some PHPDoc, which to me is kind of meaningless, so I've already removed it for nice clean rendering.

Generating the Repository

One last thing here! This entity needs a repository. Back to the action shortcut, which is... alt+enter! This opens up a menu to add the doctrine repository, which as you may have guessed, adds a repository class here:

... lines 1 - 2
namespace AppBundle\Entity;
use Doctrine\ORM\EntityRepository;
... lines 6 - 12
class MovieRepository extends EntityRepository
{
}

... lines 1 - 6
/**
* @ORM\Entity(repositoryClass="MovieRepository")
... line 9
*/
class Movie
{
... lines 13 - 98
}

In my case I prefer to have these in a Repository directory. So that's nice that it helped me create that, but I'll move it manually.

A quick copy and paste will do that, then update the namespace to end with Repository:

... lines 1 - 2
namespace AppBundle\Repository;
use Doctrine\ORM\EntityRepository;
... lines 6 - 12
class MovieRepository extends EntityRepository
{
}

Even though I had to move that manually, what's really cool is that it's highlighting and saying "Yo! Your repository Class is messed up! You can't use the short class name because now it's in a different namespace." I can delete what's there and type MovieRepository and I get autocomplete on the entire name:

... lines 1 - 6
/**
* @ORM\Entity(repositoryClass="AppBundle\Repository\MovieRepository")
... line 9
*/
class Movie
{
... lines 13 - 98
}

And there's more autocompleting goodness I won't show here for when you're building relationships and using the Query Builder.

Leave a comment!

This is an older tutorial using an older version of PhpStorm. However, most of the tricks we show in PhpStorm still work beautifully.

What PHP libraries does this tutorial use?

// composer.json
{
    "require": {
        "php": ">=5.3.9, <7.3.0",
        "symfony/symfony": "2.8.*", // v2.8.15
        "doctrine/orm": "^2.4.8", // v2.4.8
        "doctrine/dbal": "<2.5", // v2.4.5
        "doctrine/doctrine-bundle": "~1.4", // 1.6.4
        "symfony/assetic-bundle": "~2.3", // v2.8.1
        "symfony/swiftmailer-bundle": "~2.3,>=2.3.10", // v2.4.2
        "symfony/monolog-bundle": "^3.0.2", // v3.0.2
        "sensio/distribution-bundle": "~5.0", // v5.0.17
        "sensio/framework-extra-bundle": "^3.0.2", // v3.0.18
        "incenteev/composer-parameter-handler": "~2.0" // v2.1.2
    },
    "require-dev": {
        "sensio/generator-bundle": "~3.0", // v3.1.2
        "symfony/phpunit-bridge": "~2.7" // v2.8.15
    }
}