Strict types

[userbundle] / Entity / Group.php

diff --git a/Entity/Group.php b/Entity/Group.php
index dad79b0132c1a17902541465aa54d317211df0af..13b16ef821049e9bcfa41682b038911d33cd2b7a 100644 (file)
--- a/Entity/Group.php
+++ b/Entity/Group.php
@@ -1,74 +1,89 @@
-<?php
+<?php declare(strict_types=1);
+
+/*
+ * This file is part of the Rapsys UserBundle package.
+ *
+ * (c) Raphaël Gertz <symfony@rapsys.eu>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */

 
 

-// src/Rapsys/UserBundle/Entity/Group.php

 namespace Rapsys\UserBundle\Entity;
 
 namespace Rapsys\UserBundle\Entity;
 

-class Group {
-       /**
-        * @var integer
-        */
-       protected $id;
+use Doctrine\Common\Collections\Collection;
+use Doctrine\Common\Collections\ArrayCollection;
+use Doctrine\ORM\Event\PreUpdateEventArgs;
+
+use Rapsys\UserBundle\Entity\User;

 
 

+/**
+ * Group
+ */
+class Group {

        /**
        /**

-        * @var string
+        * Primary key

         */
         */

-       protected $role;
+       protected ?int $id = null;

 
        /**
 
        /**

-        * @var \DateTime
+        * Creation datetime

         */
         */

-       protected $created;
+       protected \DateTime $created;

 
        /**
 
        /**

-        * @var \DateTime
+        * Update datetime

         */
         */

-       protected $updated;
+       protected \DateTime $updated;

 
        /**
 
        /**

-        * @var \Doctrine\Common\Collections\Collection
+        * Users collection

         */
         */

-       protected $users;
+       protected Collection $users;

 
        /**
         * Constructor
 
        /**
         * Constructor

-        * @param string $role The role name
+        *
+        * @param string $title The group name

         */
         */

-       public function __construct(string $role) {
-               $this->role = (string) $role;
-               $this->users = new \Doctrine\Common\Collections\ArrayCollection();
+       public function __construct(protected string $title) {
+               //Set defaults
+               $this->created = new \DateTime('now');
+               $this->updated = new \DateTime('now');
+
+               //Set collections
+               $this->users = new ArrayCollection();

        }
 
        /**
        }
 
        /**

-        * Set role
+        * Get id

         *
         *

-        * @param string $role
-        *
-        * @return User
+        * @return integer

         */
         */

-       public function setRole($role) {
-               $this->role = $role;
-
-               return $this;
+       public function getId(): ?int {
+               return $this->id;

        }
 
        /**
        }
 
        /**

-        * Get role
+        * Set title

         *
         *

-        * @return string
+        * @param string $title The group name
+        *
+        * @return Group

         */
         */

-       public function getRole() {
-               return $this->role;
+       public function setTitle(string $title): Group {
+               $this->title = $title;
+
+               return $this;

        }
 
        /**
        }
 
        /**

-        * Returns a string representation of the role.
-        *
-        * @xxx Replace the deprecated "extends \Symfony\Component\Security\Core\Role\Role"
+        * Get title

         *
         * @return string
         */
         *
         * @return string
         */

-       public function __toString(): string {
-               return $this->role;
+       public function getTitle(): string {
+               return $this->title;

        }
 
        /**
        }
 
        /**


@@ -76,9 +91,9 @@ class Group {
         *
         * @param \DateTime $created
         *
         *
         * @param \DateTime $created
         *

-        * @return User
+        * @return Group

         */
         */

-       public function setCreated($created) {
+       public function setCreated(\DateTime $created): Group {

                $this->created = $created;
 
                return $this;
                $this->created = $created;
 
                return $this;


@@ -89,7 +104,7 @@ class Group {
         *
         * @return \DateTime
         */
         *
         * @return \DateTime
         */

-       public function getCreated() {
+       public function getCreated(): \DateTime {

                return $this->created;
        }
 
                return $this->created;
        }
 


@@ -98,9 +113,9 @@ class Group {
         *
         * @param \DateTime $updated
         *
         *
         * @param \DateTime $updated
         *

-        * @return User
+        * @return Group

         */
         */

-       public function setUpdated($updated) {
+       public function setUpdated(\DateTime $updated): Group {

                $this->updated = $updated;
 
                return $this;
                $this->updated = $updated;
 
                return $this;


@@ -111,18 +126,18 @@ class Group {
         *
         * @return \DateTime
         */
         *
         * @return \DateTime
         */

-       public function getUpdated() {
+       public function getUpdated(): \DateTime {

                return $this->updated;
        }
 
        /**
         * Add user
         *
                return $this->updated;
        }
 
        /**
         * Add user
         *

-        * @param \Rapsys\UserBundle\Entity\User $user
+        * @param User $user

         *
         * @return Group
         */
         *
         * @return Group
         */

-       public function addUser(\Rapsys\UserBundle\Entity\User $user) {
+       public function addUser(User $user) {

                $this->users[] = $user;
 
                return $this;
                $this->users[] = $user;
 
                return $this;


@@ -131,18 +146,48 @@ class Group {
        /**
         * Remove user
         *
        /**
         * Remove user
         *

-        * @param \Rapsys\UserBundle\Entity\User $user
+        * @param User $user

         */
         */

-       public function removeUser(\Rapsys\UserBundle\Entity\User $user) {
+       public function removeUser(User $user) {

                $this->users->removeElement($user);
        }
 
        /**
         * Get users
         *
                $this->users->removeElement($user);
        }
 
        /**
         * Get users
         *

-        * @return \Doctrine\Common\Collections\Collection
+        * @return ArrayCollection

         */
         */

-       public function getUsers() {
+       public function getUsers(): ArrayCollection {

                return $this->users;
        }
                return $this->users;
        }

+
+       /**
+        * {@inheritdoc}
+        */
+       public function preUpdate(PreUpdateEventArgs $eventArgs) {
+               //Check that we have a group instance
+               if (($user = $eventArgs->getObject()) instanceof Group) {
+                       //Set updated value
+                       $user->setUpdated(new \DateTime('now'));
+               }
+       }
+
+       /**
+        * Returns a string representation of the group
+        *
+        * @return string
+        */
+       public function __toString(): string {
+               return $this->title;
+       }
+
+       /**
+        * Get role
+        *
+        * @return string
+        */
+       public function getRole(): string {
+               //XXX: $prefix = 'ROLE_' set in Role*Voter classes
+               return 'ROLE_'.strtoupper($this->title);
+       }

 }
 }