Personalizar la clase de usuario
Lo bueno de la clase User es que... ¡es nuestra clase! Mientras implementemosUserInterface, podemos añadir lo que queramos:
| // ... lines 1 - 7 | |
| use Symfony\Component\Security\Core\User\UserInterface; | |
| // ... lines 9 - 12 | |
| class User implements UserInterface | |
| { | |
| // ... lines 15 - 113 | |
| } |
Por ejemplo, me gustaría almacenar el nombre de mis usuarios. Así que vamos a añadir una propiedad para eso. En tu terminal, ejecuta:
symfony console make:entity
Editaremos la entidad User, añadiremos una propiedad firstName, haremos que sea una cadena, de 255 de longitud... y diremos "sí" a anulable. Hagamos que esta propiedad sea opcional en la base de datos.
Ya está De vuelta a la clase User, ¡no hay sorpresas! Tenemos una nueva propiedad... y nuevos métodos getter y setter:
| // ... lines 1 - 12 | |
| class User implements UserInterface | |
| { | |
| // ... lines 15 - 31 | |
| /** | |
| * @ORM\Column(type="string", length=255, nullable=true) | |
| */ | |
| private $firstName; | |
| // ... lines 36 - 119 | |
| public function getFirstName(): ?string | |
| { | |
| return $this->firstName; | |
| } | |
| public function setFirstName(string $firstName): self | |
| { | |
| $this->firstName = $firstName; | |
| return $this; | |
| } | |
| } |
Ve a generar una migración para nuestro nuevo User. En el terminal, ejecuta
symfony console make:migration
¡Genial! Gira y abre eso para asegurarte de que no esconde ninguna sorpresa:
| // ... lines 1 - 2 | |
| declare(strict_types=1); | |
| namespace DoctrineMigrations; | |
| use Doctrine\DBAL\Schema\Schema; | |
| use Doctrine\Migrations\AbstractMigration; | |
| /** | |
| * Auto-generated Migration: Please modify to your needs! | |
| */ | |
| final class Version20211001172813 extends AbstractMigration | |
| { | |
| public function getDescription(): string | |
| { | |
| return ''; | |
| } | |
| public function up(Schema $schema): void | |
| { | |
| // this up() migration is auto-generated, please modify it to your needs | |
| $this->addSql('CREATE TABLE user (id INT AUTO_INCREMENT NOT NULL, email VARCHAR(180) NOT NULL, roles JSON NOT NULL, first_name VARCHAR(255) DEFAULT NULL, UNIQUE INDEX UNIQ_8D93D649E7927C74 (email), PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8mb4 COLLATE `utf8mb4_unicode_ci` ENGINE = InnoDB'); | |
| } | |
| public function down(Schema $schema): void | |
| { | |
| // this down() migration is auto-generated, please modify it to your needs | |
| $this->addSql('DROP TABLE user'); | |
| } | |
| } |
Ejecuta: CREATE TABLE user con las columnas id, email, roles y first_name. Cierra esto... y ejecútalo:
symfony console doctrine:migrations:migrate
¡Éxito!
Añadiendo las entidades de los usuarios
Y como la entidad User es... una entidad normal de Doctrine, también podemos añadir usuarios ficticios a nuestra base de datos utilizando el sistema de accesorios.
Abre src/DataFixtures/AppFixtures.php. Vamos a utilizar Foundry para ayudarnos a cargar los datos. Así que vamos a crear una nueva fábrica de Foundry para User. Como nos estamos divirtiendo tanto ejecutando comandos en este vídeo, vamos a colar uno... o tres más:
symfony console make:factory
¡Sí! Queremos una para User. Ve a abrirlo: src/Factory/UserFactory.php:
| // ... lines 1 - 2 | |
| namespace App\Factory; | |
| use App\Entity\User; | |
| use App\Repository\UserRepository; | |
| use Zenstruck\Foundry\RepositoryProxy; | |
| use Zenstruck\Foundry\ModelFactory; | |
| use Zenstruck\Foundry\Proxy; | |
| // ... lines 10 - 28 | |
| final class UserFactory extends ModelFactory | |
| { | |
| public function __construct() | |
| { | |
| parent::__construct(); | |
| // TODO inject services if required (https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#factories-as-services) | |
| } | |
| protected function getDefaults(): array | |
| { | |
| return [ | |
| // TODO add your default values here (https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#model-factories) | |
| 'email' => self::faker()->text(), | |
| 'roles' => [], | |
| 'firstName' => self::faker()->text(), | |
| ]; | |
| } | |
| protected function initialize(): self | |
| { | |
| // see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#initialization | |
| return $this | |
| // ->afterInstantiate(function(User $user) {}) | |
| ; | |
| } | |
| protected static function getClass(): string | |
| { | |
| return User::class; | |
| } | |
| } |
Nuestro trabajo en getDefaults() es asegurarnos de que todas las propiedades necesarias tienen buenos valores por defecto. Establece email en self::faker()->email(), no estableceré ninguna función por ahora y establece firstName en self::faker()->firstName():
| // ... lines 1 - 28 | |
| final class UserFactory extends ModelFactory | |
| { | |
| // ... lines 31 - 37 | |
| protected function getDefaults(): array | |
| { | |
| return [ | |
| 'email' => self::faker()->email(), | |
| 'firstName' => self::faker()->firstName(), | |
| ]; | |
| } | |
| // ... lines 45 - 57 | |
| } |
¡Genial! En AppFixtures, en la parte inferior, crea un usuario: UserFactory::createOne(). Pero utiliza un correo electrónico específico para que podamos iniciar sesión con él más tarde. Qué tal,abraca_admin@example.com:
| // ... lines 1 - 11 | |
| use App\Factory\UserFactory; | |
| // ... lines 13 - 15 | |
| class AppFixtures extends Fixture | |
| { | |
| public function load(ObjectManager $manager) | |
| { | |
| // ... lines 20 - 41 | |
| AnswerFactory::new(function() use ($questions) { | |
| // ... lines 43 - 45 | |
| })->needsApproval()->many(20)->create(); | |
| UserFactory::createOne(['email' => 'abraca_admin@example.com']); | |
| // ... lines 49 - 51 | |
| } | |
| } |
Luego, para rellenar un poco el sistema, añade UserFactory::createMany(10):
| // ... lines 1 - 11 | |
| use App\Factory\UserFactory; | |
| // ... lines 13 - 15 | |
| class AppFixtures extends Fixture | |
| { | |
| public function load(ObjectManager $manager) | |
| { | |
| // ... lines 20 - 47 | |
| UserFactory::createOne(['email' => 'abraca_admin@example.com']); | |
| UserFactory::createMany(10); | |
| // ... lines 50 - 51 | |
| } | |
| } |
¡Vamos a probarlo! De vuelta al terminal, ejecuta:
symfony console doctrine:fixtures:load
¡No hay errores! Comprueba la nueva tabla:
symfony console doctrine:query:sql 'SELECT * FROM user'
Y... ¡ahí están! Ahora que tenemos usuarios en la base de datos, tenemos que añadir una o varias formas para que se autentiquen. ¡Es hora de construir un formulario de acceso!
31 Comments
Hi, the symfony console make:factroy command is not defined, I'm with symfony 6.3.x what can I replace it with ? Thanks
hi, the same here, thanks for your tips!
Hey yannick_boz,
Thanks for letting us know it was helpful for you!
Cheers!
I must install this bundle ->
composer require zenstruck/foundry --devHey @pasquale_pellicani ,
Yep, you need to install that bundle - that's how MakerBundle works, it does not have all possible dependencies and suggests you install specific ones on the go when you're trying to use more features. Good catch!
Cheers!
Hello,
thank you for clarify:)
Hey Mahmut,
You're misleading commands with different purposes:
symfony console make:fixturesis a Symfony console command indeed is used to make a fixtures file, whilecomposer require --dev orm-fixturesis a completely different Composer command that is used to install some package dependencies to your project, in particular it installs some Doctrine bundles, including ORM and fixtures bundle. I.e. if you don't have fixtures bundle in your project - you will not be able to run thatmake:fixturesbundle at all unless instal the bundle that is responsible for fixtures :)Yes, that should be so, you should make sure you have that "factory" installed before being able to create Foundry factories in your project. However, if you already have the foundry installed in your project - than
make:factorywill just work for you, so no need to run thatcomposer require --dev factory. Moreover, if you have Foundry lib already installed - then running this command will do nothing, because nothing new to install for you project, you already have that dependency :)I hope that clarify things for you :)
Cheers!
If you are considering a CRM system with member information, what is the best practice for saving the member's detailed information and relation to other entities?
Should they be added directly to the User Class or should I link them to another entity?
Hey @Mahmoud-A,
Good question! Are the member details shared between users in any way? If not, you could consider a one-to-one relationship but that's probably overkill to start. So I'd add these fields directly to the User and let performance dictate whether another entity is required later.
The CRM's I've worked with have had the concept of a Company, which has Locations (or Branches), then these Locations have Users (or Employees).
Company: McDonalds
Location: Main St., Orlando
User: John Smith
Dear SymfonyCasts,
I am reaching out to report an issue I encountered while utilizing the SymfonyCasts website with a screen reader. Specifically, I am experiencing difficulty in downloading the course code despite multiple attempts to do so.
Outlined below are the steps I followed, provided from the perspective of a screen reader user:
1. Navigated to the top of the website by pressing
CTRL + HOME.2. Focused on the main heading "Customizing the User Class" by pressing
1on the alphanumeric row.3. Moved focus to an unlabeled button preceding the main heading using
SHIFT + TAB.4. Accessed a menu containing four items ("Course Code," "This Video," "Subtitles," and "Course Script") by pressing the
spacebar.5. Attempted to initiate the download by pressing
SPACEBARon the "Course Code" link. Unfortunately, the download did not commence, and the menu closed immediately after the action.6. Additionally, attempting to copy the link of the "Course Code" resulted in "
javascript:void(0)" being copied to the clipboard instead of the expected link.Furthermore, I encountered a similar issue with the course code link in the "Unit Testing With a Byte" course. Despite numerous attempts, I was unable to download the code. Ultimately, I resorted to obtaining the code from GitHub. However, it took a considerable amount of time to know that downloading from GitHub was an available option.
Request: For future courses, please include the GitHub link to the initial course code. This would greatly benefit both screen reader and normal users.
Thanks.
Best regards,
Easwaran Chinraj
Hey @Easwaran_Chinraj
Have you tried to press "Enter" instead of "Spacebar" to download the course code? I managed to download it that way, but I'm on Google Chrome, I'm not sure if that makes a difference
Dear Mollo Khan and leannapelham,
Thank you for dedicating your invaluable time to this matter. I apologize for any inconvenience caused by taking up hours and days of your precious time unintentionally. Unfortunately, I can't fully explain the issue here in the comments section, so I've sent an email to hello@symfonycasts.com with more details.
Cheers,
Easwaran Chinraj
Thank you so much for the very clear report here - we are working to get this resolved!
Hi, I have a problem with fixtures.
when I run:
it works fine the first time, but the second time, it gives me this error:
etc...
It's from a marketingChannel > marketingChannel relation.
I put
die('asdf');in the fixtureload(), but it never reaches this command. It appears to be due to the "purge" command from the fixtures command (when it runs). It appears this command is not intelligently deleting my marketingChannel records.Any idea how I could fix this? I tried orphanRemoval too, but it didn't work.
Hey Cameron,
First, make sure you have valid mapping, run:
to see all green.
Also, maybe try
onDelete="CASCADE"for the relations that cannot be deleted.Cheers!
I got the stack trace (but not the sql query).
It looks like it has to do with the ORMpurger not deleting fixtures correctly.
Where are all these files coming from in the AppFixtures? Did you just create them? I can't find where they are coming from following your tutorials.. they just exist.
Hey Ramon,
Yes, those files are already exist in this course. They come from past tutorials from the fundamental section: https://symfonycasts.com/tracks/symfony5#the-fundamentals - we base every new tutorial on the previous one.
Cheers!
Ah I see! Thanks a lot for the info! :)
Hey,
Maybe silly question but I can't figure out how to display
symfony console doctrine:query:sql 'SELECT * FROM user'<br />in the same array format like in video? :)))Hey Szymon,
It seems you can't anymore :) They output is displayed in a table now instead of a raw dump as it was before.
Cheers!
For some reason, the "doctrine:fixtures:load" command fails with my PostgresSQL container. I get the error
Question: Is there a way I can tell Doctrine to use
"user"instead ofuserfor that Entity?Or do I need to rename the Entity to something else?
I've tried to apply the quotes via an annotation
#[ORM\Table(name: '"user"')]but that caused a different errorHey Philipp,
Yeah, most probably that's because of that table name,
useris a reserved word in PostgreSql. You need to rename that table to something, likeapp_user.Another trick, you might try to use ticks around the table name, i.e. use `, instead of ":
It might also work, though I've never tried it in PostgreSql, though in MySQL it worked. But safer would be not use reserved words at all, better use a unique name :)
Cheers!
Thanks for the clarification, Victor!
As you suggested, I could solve the issue by renaming the DB table via an annotation + recreating the DB schema
Hey Philipp,
Awesome, thanks for confirming it works for you!
Cheers!
hey ! I have a error
***********
SQLSTATE[42000]: Syntax error or access violation: 1064 You have an error in your SQL syntax; check the manual
that corresponds to your MariaDB server version for the right syntax to use near 'INDEX idx_9474526c1e27f6bf
TO IDX_DADD4A251E27F6BF' at line 1
********
Column Already exist 'status'
Hey Anass,
It looks like you already have that "status" column. Please, try to validate your DB schema with:
$ symfony console doctrine:schema:validate
If it's not OK - try to apply the required changes, to know what queries you need to execute - see:
$ symfony console doctrine:schema:update --dump-sql
Of if you're working locally and don't worry about losing your data in the DB - instead you can run:
$ symfony console doctrine:schema:update --force
Cheers!
In case anyone else runs into an error trying to run the simple query at the end try using double quotes around the SQL statement instead of single quotes.
Hey Aaron,
Thanks for this tip! Are you talking about "symfony console doctrine:query:sql 'SELECT * FROM user'" command? It somehow does not work for you with single quotes around the SQL query? I wonder what OS do you use and what terminal?
Cheers!
Yes that's the command I'm talking about. When running it on the DOS console on Windows 10 using single quotes it throws an error but with double quotes it does not.
Ha! Windows likes to complicate things. Thanks for sharing your problem + solution with others
"Houston: no signs of life"
Start the conversation!