Fix header comment

[airbundle] / Entity / Location.php

diff --git a/Entity/Location.php b/Entity/Location.php
index 4af12808f9cf23e92cd57565941383fe03ee3048..75f6f45e29774f85ca6187d48aa56cea97666aef 100644 (file)
--- a/Entity/Location.php
+++ b/Entity/Location.php
@@ -1,16 +1,17 @@
 <?php declare(strict_types=1);
 
 /*
- * this file is part of the rapsys packbundle package.
+ * This file is part of the Rapsys AirBundle package.
  *
- * (c) raphaël gertz <symfony@rapsys.eu>
+ * (c) Raphaël Gertz <symfony@rapsys.eu>
  *
- * for the full copyright and license information, please view the license
+ * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
 
 namespace Rapsys\AirBundle\Entity;
 
+use Doctrine\Common\Collections\Collection;
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\ORM\Event\PreUpdateEventArgs;
 
@@ -19,15 +20,20 @@ use Doctrine\ORM\Event\PreUpdateEventArgs;
  */
 class Location {
        /**
-        * @var integer
+        * Primary key
         */
-       private $id;
+       private ?int $id = null;
 
        /**
         * @var string
         */
        private $title;
 
+       /**
+        * @var string
+        */
+       private ?string $description = null;
+
        /**
         * @var string
         */
@@ -54,39 +60,49 @@ class Location {
        private $longitude;
 
        /**
-        * @var boolean
+        * @var bool
+        */
+       private $indoor;
+
+       /**
+        * @var bool
         */
        private $hotspot;
 
        /**
-        * @var \DateTime
+        * Create datetime
         */
-       private $created;
+       private \DateTime $created;
 
        /**
-        * @var \DateTime
+        * Update datetime
         */
-       private $updated;
+       private \DateTime $updated;
 
        /**
-        * @var ArrayCollection
+        * Sessions collection
         */
-       private $sessions;
+       private Collection $sessions;
 
        /**
-        * @var ArrayCollection
+        * Snippets collection
         */
-       private $snippets;
+       private Collection $snippets;
 
        /**
-        * @var ArrayCollection
+        * Users collection
         */
-       private $users;
+       private Collection $users;
 
        /**
         * Constructor
         */
        public function __construct() {
+               //Set defaults
+               $this->created = new \DateTime('now');
+               $this->updated = new \DateTime('now');
+
+               //Set collections
                $this->sessions = new ArrayCollection();
                $this->snippets = new ArrayCollection();
                $this->users = new ArrayCollection();
@@ -97,7 +113,7 @@ class Location {
         *
         * @return integer
         */
-       public function getId(): int {
+       public function getId(): ?int {
                return $this->id;
        }
 
@@ -123,6 +139,28 @@ class Location {
                return $this->title;
        }
 
+       /**
+        * Set description
+        *
+        * @param string $description
+        *
+        * @return Location
+        */
+       public function setDescription(?string $description): Location {
+               $this->description = $description;
+
+               return $this;
+       }
+
+       /**
+        * Get description
+        *
+        * @return string
+        */
+       public function getDescription(): ?string {
+               return $this->description;
+       }
+
        /**
         * Set address
         *
@@ -233,10 +271,32 @@ class Location {
                return $this->longitude;
        }
 
+       /**
+        * Set indoor
+        *
+        * @param bool $indoor
+        *
+        * @return Session
+        */
+       public function setIndoor(bool $indoor): Location {
+               $this->indoor = $indoor;
+
+               return $this;
+       }
+
+       /**
+        * Get indoor
+        *
+        * @return bool
+        */
+       public function getIndoor(): bool {
+               return $this->indoor;
+       }
+
        /**
         * Set hotspot
         *
-        * @param boolean $hotspot
+        * @param bool $hotspot
         *
         * @return Session
         */
@@ -249,7 +309,7 @@ class Location {
        /**
         * Get hotspot
         *
-        * @return boolean
+        * @return bool
         */
        public function getHotspot(): bool {
                return $this->hotspot;
@@ -316,7 +376,7 @@ class Location {
         * Remove session
         *
         * @param Session $session
-        * @return boolean
+        * @return bool
         */
        public function removeSession(Session $session): bool {
                return $this->sessions->removeElement($session);
@@ -348,7 +408,7 @@ class Location {
         * Remove snippet
         *
         * @param Snippet $snippet
-        * @return boolean
+        * @return bool
         */
        public function removeSnippet(Snippet $snippet): bool {
                return $this->snippets->removeElement($snippet);
@@ -371,6 +431,9 @@ class Location {
         * @return Location
         */
        public function addUser(User $user): Location {
+               //Add from owning side
+               $user->addLocation($this);
+
                $this->users[] = $user;
 
                return $this;
@@ -380,9 +443,16 @@ class Location {
         * Remove user
         *
         * @param User $user
-        * @return boolean
+        * @return bool
         */
        public function removeUser(User $user): bool {
+               if (!$this->locations->contains($user)) {
+                       return true;
+               }
+
+               //Remove from owning side
+               $user->removeLocation($this);
+
                return $this->users->removeElement($user);
        }
 
@@ -400,7 +470,7 @@ class Location {
         */
        public function preUpdate(PreUpdateEventArgs $eventArgs) {
                //Check that we have a location instance
-               if (($location = $eventArgs->getEntity()) instanceof Location) {
+               if (($location = $eventArgs->getObject()) instanceof Location) {
                        //Set updated value
                        $location->setUpdated(new \DateTime('now'));
                }