Flag of Ukraine
SymfonyCasts stands united with the people of Ukraine
This tutorial has a new version, check it out!

Inserting new Objects

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.

Fearless aquanauts are constantly discovering and re-classifying deep-sea animals. If a new genus needed to be added to the system, what would that look like? Well, we would probably have a URL like /genus/new. The user would fill out a form, hit submit, and the database fairies would insert a new record into the genus table.

Sounds good to me! In GenusController, create a newAction() with the URL /genus/new. I won't give the route a name yet - that's not needed until we link to it:

... lines 1 - 11
class GenusController extends Controller
{
/**
* @Route("/genus/new")
*/
public function newAction()
{
... line 19
}
/**
* @Route("/genus/{genusName}")
*/
public function showAction($genusName)
{
... lines 27 - 46
}
... lines 48 - 65
}

Be Careful with Route Ordering!

Oh, and side-note: I put newAction() above showAction(). Does that matter? In this case, absolutely. Remember, routes match from top to bottom. If I had put newAction() below showAction(), going to /genus/new would have matched showAction() - passing the word "new" as the genusName(). To avoid this, put your most generic-matching routes near the bottom.

Go Deeper!

You can often also use route requirements to make a wildcard only match certain patterns (instead of matching everything).

Inserting a Genus

Ok, back to the database-world. Let's be really lazy and skip creating a form - there's a whole series on forms later, and, I'd just hate to spoil the fun.

Instead, insert some hardcoded data. How? Simple: start with $genus = new Genus(), put some data on that object, and tell Doctrine to save it:

... lines 1 - 4
use AppBundle\Entity\Genus;
... lines 6 - 11
class GenusController extends Controller
{
/**
* @Route("/genus/new")
*/
public function newAction()
{
$genus = new Genus();
}
... lines 21 - 65
}

Doctrine wants you to stop thinking about queries, and instead think about objects.

Right now... name is the only real field we have. And it's a private property, so we can't actually put data on it. To make this mutable - to use a really fancy term that means "changeable" - go to the bottom of the class and open the "Code"->"Generate" menu. Select "Getters and Setters" - we'll need the getter function later:

... lines 1 - 10
class Genus
{
... lines 13 - 24
public function getName()
{
return $this->name;
}
public function setName($name)
{
$this->name = $name;
}
}

Great! Now use $genus->setName() and call it Octopus with a random ending to make things more fun!

... lines 1 - 11
class GenusController extends Controller
{
... lines 14 - 16
public function newAction()
{
$genus = new Genus();
$genus->setName('Octopus'.rand(1, 100));
... lines 21 - 26
}
... lines 28 - 72
}

Object, check! Populated with data, check! The last step is to say:

Hey Doctrine. I want you to save this to our genus table.

Remember how everything in Symfony is done with a service? Doctrine is no exception: it has one magical service that saves and queries. It's called, the entity manager. In fact, it's so hip that it has its own controller shortcut to get it: $em = $this->getDoctrine()->getManager(). What a celebrity.

To save data, use two methods $em->persist($genus) and $em->flush():

... lines 1 - 18
$genus = new Genus();
$genus->setName('Octopus'.rand(1, 100));
$em = $this->getDoctrine()->getManager();
$em->persist($genus);
$em->flush();
... lines 25 - 74

And yes, you need both lines. The first just tells Doctrine that you want to save this. But the query isn't made until you call flush(). What's really cool is that you'll use these exact two lines whether you're inserting a new Genus or updating an existing one. Doctrine figures out the right query to use.

Finishing the New Page

Ok, let's finish up! Do you remember what a controller must always return? Yep! A Response object. Skip a template and just return new Response() - the one from the HttpFoundation component - with Genus Created:

... lines 1 - 11
class GenusController extends Controller
{
... lines 14 - 16
public function newAction()
{
... lines 19 - 25
return new Response('Genus created!');
}
... lines 28 - 72
}

Deep breath. Head to /genus/new. Okay, okay - no errors. I think we're winning?

Debugging with the Web Debug Toolbar

The web debug toolbar has a way to see the queries that were made... but huh, it's missing! Why? Because we don't have a full, valid HTML page. That's a bummer - so go back to the controller and hack in some HTML markup into the response:

... lines 1 - 25
return new Response('<html><body>Genus created!</body></html>');
... lines 27 - 74

Try it again! Ah, there you are fancy web debug toolbar. There are actually three database queries. Interesting. Click the icon to enter the profiler. Ah, there's the insert query, hiding inside a transaction.

And by the way, how sweet is this for debugging? You can see a formatted query, a runnable version, or run EXPLAIN on a slow query.

Running SQL Queries in the Terminal

I still can't believe it's working - things never work on the first try! To triple-check it, head to the terminal. To run a raw SQL query, use:

./bin/console doctrine:query:sql 'SELECT * FROM genus'

There they are. So inserting objects with Doctrine... pretty darn easy.

Leave a comment!

35
Login or Register to join the conversation
Default user avatar
Default user avatar Andrew Grudin | posted 5 years ago

When you just start to type word ( action ) you get choice ( action ) and then make auto complete of function and @Rote annotation above, two in one. How do you manage this?))
When I type ( action ) I have only one choice ( abstract ). There is no ( action ) at all. ((

3 Reply

Hey Andrew! Here's the magic: https://knpuniversity.com/b... I have a live template for "action" - very handy!

3 Reply
Default user avatar
Default user avatar Gremet Laurent | weaverryan | posted 5 years ago

Oh yeah it shreds !
great, thanks.

Reply
Fabrizio S. Avatar

I was wondering the same :) thought it was some kind of problem with PhpStorm and Annotations plugin.

Reply

We all love PhpStorm :)

1 Reply
Fabrizio S. Avatar

Yes! It's incredibly powerful with Symfony and Annotations plugins!
For more basic/easy stuff SublimeText is still my favorite but, when you start working hardly with complex architectures and git, PhpStorm is indeed the Best IDE ever! :) Awesome namespaces feature.

1 Reply
Default user avatar

It is not mentioned to add " use AppBundle\Entity\Genus; " in the Controller. Without this an exception occurs.

1 Reply

Nice catch! This was included in the code block, but the `use` line wasn't being displayed by default. I'm updating the code block right now to show it :).

Thanks!

Reply
Default user avatar
Default user avatar Terry Caliendo | posted 5 years ago

Do you need getters and setters for Doctrine/Symfony to work? Or can you just make the Entity properties public?

Also... along the same lines... why even use getters and setters? I've read that its so that you can later add further functionality to do more in the "get" or "set" function if you need to, but if you did need to inject that extra functionality later, couldn't you just set the variable equal to an anonymous function or a closure? (or is that not allowed in a php property?)

Reply

Yo Terry!

You can absolutely just make the properties public. And you're also right about why we do this (i.e. needing to tweak how it works later). And no, there's no way to do this later. If you make the public property, then all of your code will look like $myObj->name = 'foo'. But then later if you need to add some logic, your only option is to add a setter, which means also needing to update your code everywhere to look like $myObj->setName('foo').

It is a bit of a shortcoming imo with PHP. Other languages (and this is still be discussed for PHP, I believe) allow you to just have the property, but use the getter/setter syntax (so that later, if you do need logic, THEN you can add the getter/setter without needing to change any other code).

Cheers!

Reply
Default user avatar

In php, later, you always can to make field private and add your business logic to __set/__get magic.

Reply
Default user avatar
Default user avatar Helene Shaikh | posted 5 years ago

EDIT: found the solution, i had to use app_dev.php in my URL.

While using your code in my newAction() method, and going to ../genus/new, I get the same page as showAction but with "NEW" instead of the genus name. It probably routes to showAction's @Route("/genus/{genusName}"). The $genus is also not persisted in my db (I'm working with MAMP pro and using the php server).

Here's my code:

class GenusController extends Controller
{
/**
* @Route("/genus/new")
*/
public function newAction()
{
$genus = new Genus();
$genus->setName('Octopus'.rand(1, 100));
$em = $this->getDoctrine()->getManager();
$em->persist($genus);
$em->flush();
return new Response('<html><body>Genus created!</body></html>');
}

/**
* @Route("/genus/{genusName}")
*/
public function showAction($genusName)
{
//...
}

Reply

Hey Helene Shaikh!

If you are not using the built-in server as shown in the tutorial, you need to specify *app_dev.php* in your paths like this: http://localhost/app_dev.php/genus/new
So you can hit the dev environment, otherwise you would be hitting app.php and that's the file for production environment

You can check the .htaccess in the web directory so you can really see why is this happening.

Have a nice day!

Reply
Default user avatar
Default user avatar Richie Hamburg | posted 5 years ago

Heh. Was about to ask "Why doesnt http://localhost:8000/app.php/genus/new" work. Of course because I had to clear the cache so that the new routes would work.

Reply

Hey Richie,

Yeah, you're right! ;) you have to clear the prod cache each time you change configuration files, templates, etc.

Cheers!

Reply
Default user avatar
Default user avatar Richie Hamburg | posted 5 years ago

One Q : why is Doctrine so "obvious" at the newAction level ($this->getDoctrin()->...) ? Do we discover later how to abstract it yet further where our entire controller could just change from Doctrine to something different?

Reply

Hey Richie,

Well, Doctrine is already an abstraction layer for low level database drivers: MySQL, PgSQL, Sqlite, etc. - see the http://docs.doctrine-projec... . So switching from MySQL to PgSQL will be pretty easy, since you have to tweak some config values and DB queries and that's it. But if you decide to get rid of Doctrine one day - probably you have to do much more work :) Actually, Doctrine is defacto standard in Symfony applications, so doing more layers is pointless, especially for education purposes - it involves more complex code. And fair enough, this tutorial about Doctrine, so we explains only Doctrine examples in it ;)

Anyway, if you want to consider something different from Doctrine in the future - you will probably have to do a lot of changes: implement other repositories, tweak ALL your queries, since you won't have Doctrine Query Builder, etc. So specifying Doctrine so "obvious" in actions is a too minor in comparison with it.

Cheers!

Reply
Default user avatar
Default user avatar Mauricio Marini | posted 5 years ago

Hello guys!
Everything is working perfect so far (some changes because of Symfony version - I'm using 3.3.6, but is fine) but now, as soon as I inserted the data into Genus table, the debug toolbar doesn't show up.
Any ideas?
Thanks
[ SOLVED ]
Forget it, my fault!

Reply

Hey Mauricio Marini!

We are glad to hear you could fix your problem by yourself :)

Have a nice day

Reply
Default user avatar

I can insert my data. I checked it via mysql workbench and i could see the data ^^.
But when try this : php bin/console doctrine:query:sql 'SELECT * FROM genus';

this sweet exception said hi to me;

[Symfony\Component\Console\Exception\RuntimeException]
Too many arguments.

Reply

Hi there!

Hmm - try removing the ; at the end - that doesn't need to be there (or, it should be inside the quotes at least!). Also, if that doesn't work, try double-quotes. You should be able to wrap the argument with single or double quotes, but just in case, try it - if you happen to be using Windows, sometimes weird things happen. Basically, this error is saying that the doctrine:query:sql command takes a single argument and you are giving it more than 1 argument. Arguments are separated by spaces, so it appears to think that you are passing it 2 or more arguments. It could just be that extra ; :)

Cheers!

Reply
Default user avatar

hi
yes, I am on windows and double quotes work for me (too) :)

Thanks a lot

Reply
Default user avatar
Default user avatar Robert Went | posted 5 years ago | edited

If anyone has issues with the new route not showing up after clearing cache, my problem was that I started the annotation with a single *


/*
 * @Route("/genus/new")
 */

symfony only seems to pick it up if you use 2 **


/**
 * @Route("/genus/new")
 */
Reply

Hey Robert,

Yes, you're totally correct! Symfony parses only doc-block comments, it's a feature of PHP, so you should start all your annotations with "/**". Thanks for this tip!

Cheers!

Reply
Default user avatar
Default user avatar OnePanda | posted 5 years ago

For query, single quotes doesn't work for me (I'm on windows). But it's ok with double quotes.

Reply

Ah, fascinating - I didn't know Windows didn't like the single quotes. Thanks for sharing!

Reply

Anyone else run into this issue when trying to create the table?

"An exception occured in driver: could not find driver
500 Internal Server Error - DriverException
2 linked Exceptions: PDOException » PDOException »"

Everything worked ok when creating the database itself. The database is remote, but creating it from my local machine worked out ok (though I did get a similar error my first time through until I uncommented a line in php.ini)

Reply

Hey somecallmetim ,

I suppose you're trying to use MySQL DB, so It looks like you don't have php5-pdo_mysql (or php70-pdo_mysql) PHP extension. You can easily install it with `apt-get` package manager on Ubuntu/Debian machine. If it doesn't help, or it's already installed, then please, double check your php.ini configuration and ensure you include mysql extension

Cheers!

Reply

Awesome. Thanks for the reply. How do I install that on a Windows machine? (I typically work on Ubuntu, but this is my gaming/hobby computer I've been doing this on).

[Edit] PS just checked. My php.ini has this line of code uncommented

extension=php_pdo_mysql.dll

and I have a file called php_pdo_mysql.dll in my ext folder in php\ext

Am I maybe missing some kind of screwy windows configuration setting or something?

Reply

Ah, it difficult to say for windows - it depends on how did you install PHP on it. I doesn't work on Windows, so I think you just need to google "How to install pdo_mysql PHP %your_version_here% extension for Windows".

Cheers!

Reply

Figured it out. Part of the confusion comes from the fact that php_msql.dll has been deprecated in php7 and replaced by php_mysqli.dll

My specific problem was I forgot to restart the php webserver after altering the php.ini file

1 Reply

Oh, interesting to know! I don't know this. And yes, forgetting restart server is the most common mistake - good investigation :)

Reply

Thanks. I'll take a look and let you know what I find...

Reply
Default user avatar

I got same issue, and resolve it using this step:
1.) Installing pdo_mysql: apt-get install php7.0-pdo-mysql
2.) Write to symfony homepage phpinfo(); Then in browser see something like: "Loaded Configuration File: /etc/php7.0/cli/php.ini".
3.) sudo vi /etc/php7.0/cli/php.ini and uncommented "extension=php_pdo_mysql.dll"
4.) Restart PHP
5.) Restart Symfony process

Sorry for my english, just I recently started learning

Reply

Hey Aidas,

Thanks for sharing this with others!

Cheers!

Reply
Cat in space

"Houston: no signs of life"
Start the conversation!

What PHP libraries does this tutorial use?

// composer.json
{
    "require": {
        "php": ">=5.5.9",
        "symfony/symfony": "3.1.*", // v3.1.4
        "doctrine/orm": "^2.5", // v2.7.2
        "doctrine/doctrine-bundle": "^1.6", // 1.6.4
        "doctrine/doctrine-cache-bundle": "^1.2", // 1.3.0
        "symfony/swiftmailer-bundle": "^2.3", // v2.3.11
        "symfony/monolog-bundle": "^2.8", // 2.11.1
        "symfony/polyfill-apcu": "^1.0", // v1.2.0
        "sensio/distribution-bundle": "^5.0", // v5.0.22
        "sensio/framework-extra-bundle": "^3.0.2", // v3.0.16
        "incenteev/composer-parameter-handler": "^2.0", // v2.1.2
        "composer/package-versions-deprecated": "^1.11", // 1.11.99
        "knplabs/knp-markdown-bundle": "^1.4", // 1.4.2
        "doctrine/doctrine-migrations-bundle": "^1.1" // 1.1.1
    },
    "require-dev": {
        "sensio/generator-bundle": "^3.0", // v3.0.7
        "symfony/phpunit-bridge": "^3.0", // v3.1.3
        "nelmio/alice": "^2.1", // 2.1.4
        "doctrine/doctrine-fixtures-bundle": "^2.3" // 2.3.0
    }
}
userVoice