Fix header comment

[airbundle] / Entity / Location.php

diff --git a/Entity/Location.php b/Entity/Location.php
index e57f235f3f0ef753f85a2c5c4684d47fada90b33..75f6f45e29774f85ca6187d48aa56cea97666aef 100644 (file)
--- a/Entity/Location.php
+++ b/Entity/Location.php
@@ -1,15 +1,28 @@
-<?php
+<?php declare(strict_types=1);
+
+/*
+ * This file is part of the Rapsys AirBundle 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.
+ */

 
 namespace Rapsys\AirBundle\Entity;
 
 
 namespace Rapsys\AirBundle\Entity;
 

+use Doctrine\Common\Collections\Collection;
+use Doctrine\Common\Collections\ArrayCollection;
+use Doctrine\ORM\Event\PreUpdateEventArgs;
+

 /**
  * Location
  */
 class Location {
        /**
 /**
  * Location
  */
 class Location {
        /**

-        * @var integer
+        * Primary key

         */
         */

-       private $id;
+       private ?int $id = null;

 
        /**
         * @var string
 
        /**
         * @var string


@@ -19,7 +32,7 @@ class Location {
        /**
         * @var string
         */
        /**
         * @var string
         */

-       private $short;
+       private ?string $description = null;

 
        /**
         * @var string
 
        /**
         * @var string


@@ -47,36 +60,52 @@ class Location {
        private $longitude;
 
        /**
        private $longitude;
 
        /**

-        * @var boolean
+        * @var bool
+        */
+       private $indoor;
+
+       /**
+        * @var bool

         */
        private $hotspot;
 
        /**
         */
        private $hotspot;
 
        /**

-        * @var \DateTime
+        * Create datetime
+        */
+       private \DateTime $created;
+
+       /**
+        * Update datetime

         */
         */

-       private $created;
+       private \DateTime $updated;

 
        /**
 
        /**

-        * @var \DateTime
+        * Sessions collection

         */
         */

-       private $updated;
+       private Collection $sessions;

 
        /**
 
        /**

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

         */
         */

-       private $sessions;
+       private Collection $snippets;

 
        /**
 
        /**

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

         */
         */

-       private $snippets;
+       private Collection $users;

 
        /**
         * Constructor
         */
        public function __construct() {
 
        /**
         * Constructor
         */
        public function __construct() {

-               $this->sessions = new \Doctrine\Common\Collections\ArrayCollection();
-               $this->snippets = new \Doctrine\Common\Collections\ArrayCollection();
+               //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();

        }
 
        /**
        }
 
        /**


@@ -84,7 +113,7 @@ class Location {
         *
         * @return integer
         */
         *
         * @return integer
         */

-       public function getId() {
+       public function getId(): ?int {

                return $this->id;
        }
 
                return $this->id;
        }
 


@@ -95,7 +124,7 @@ class Location {
         *
         * @return Location
         */
         *
         * @return Location
         */

-       public function setTitle($title) {
+       public function setTitle(string $title): Location {

                $this->title = $title;
 
                return $this;
                $this->title = $title;
 
                return $this;


@@ -106,30 +135,30 @@ class Location {
         *
         * @return string
         */
         *
         * @return string
         */

-       public function getTitle() {
+       public function getTitle(): string {

                return $this->title;
        }
 
        /**
                return $this->title;
        }
 
        /**

-        * Set short
+        * Set description

         *
         *

-        * @param string $short
+        * @param string $description

         *
         * @return Location
         */
         *
         * @return Location
         */

-       public function setShort($short) {
-               $this->short = $short;
+       public function setDescription(?string $description): Location {
+               $this->description = $description;

 
                return $this;
        }
 
        /**
 
                return $this;
        }
 
        /**

-        * Get short
+        * Get description

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

-       public function getShort() {
-               return $this->short;
+       public function getDescription(): ?string {
+               return $this->description;

        }
 
        /**
        }
 
        /**


@@ -139,7 +168,7 @@ class Location {
         *
         * @return Location
         */
         *
         * @return Location
         */

-       public function setAddress($address) {
+       public function setAddress(string $address): Location {

                $this->address = $address;
 
                return $this;
                $this->address = $address;
 
                return $this;


@@ -150,7 +179,7 @@ class Location {
         *
         * @return string
         */
         *
         * @return string
         */

-       public function getAddress() {
+       public function getAddress(): string {

                return $this->address;
        }
 
                return $this->address;
        }
 


@@ -161,7 +190,7 @@ class Location {
         *
         * @return Location
         */
         *
         * @return Location
         */

-       public function setZipcode($zipcode) {
+       public function setZipcode(string $zipcode): Location {

                $this->zipcode = $zipcode;
 
                return $this;
                $this->zipcode = $zipcode;
 
                return $this;


@@ -172,7 +201,7 @@ class Location {
         *
         * @return string
         */
         *
         * @return string
         */

-       public function getZipcode() {
+       public function getZipcode(): string {

                return $this->zipcode;
        }
 
                return $this->zipcode;
        }
 


@@ -183,7 +212,7 @@ class Location {
         *
         * @return Location
         */
         *
         * @return Location
         */

-       public function setCity($city) {
+       public function setCity(string $city): Location {

                $this->city = $city;
 
                return $this;
                $this->city = $city;
 
                return $this;


@@ -194,7 +223,7 @@ class Location {
         *
         * @return string
         */
         *
         * @return string
         */

-       public function getCity() {
+       public function getCity(): string {

                return $this->city;
        }
 
                return $this->city;
        }
 


@@ -205,7 +234,7 @@ class Location {
         *
         * @return Location
         */
         *
         * @return Location
         */

-       public function setLatitude($latitude) {
+       public function setLatitude(string $latitude): Location {

                $this->latitude = $latitude;
 
                return $this;
                $this->latitude = $latitude;
 
                return $this;


@@ -216,7 +245,7 @@ class Location {
         *
         * @return string
         */
         *
         * @return string
         */

-       public function getLatitude() {
+       public function getLatitude(): string {

                return $this->latitude;
        }
 
                return $this->latitude;
        }
 


@@ -227,7 +256,7 @@ class Location {
         *
         * @return Location
         */
         *
         * @return Location
         */

-       public function setLongitude($longitude) {
+       public function setLongitude(string $longitude): Location {

                $this->longitude = $longitude;
 
                return $this;
                $this->longitude = $longitude;
 
                return $this;


@@ -238,18 +267,40 @@ class Location {
         *
         * @return string
         */
         *
         * @return string
         */

-       public function getLongitude() {
+       public function getLongitude(): string {

                return $this->longitude;
        }
 
                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
         *
        /**
         * Set hotspot
         *

-        * @param boolean $hotspot
+        * @param bool $hotspot

         *
         * @return Session
         */
         *
         * @return Session
         */

-       public function setHotspot($hotspot) {
+       public function setHotspot(bool $hotspot): Location {

                $this->hotspot = $hotspot;
 
                return $this;
                $this->hotspot = $hotspot;
 
                return $this;


@@ -258,9 +309,9 @@ class Location {
        /**
         * Get hotspot
         *
        /**
         * Get hotspot
         *

-        * @return boolean
+        * @return bool

         */
         */

-       public function getHotspot() {
+       public function getHotspot(): bool {

                return $this->hotspot;
        }
 
                return $this->hotspot;
        }
 


@@ -271,7 +322,7 @@ class Location {
         *
         * @return Location
         */
         *
         * @return Location
         */

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

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


@@ -282,7 +333,7 @@ class Location {
         *
         * @return \DateTime
         */
         *
         * @return \DateTime
         */

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

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


@@ -293,7 +344,7 @@ class Location {
         *
         * @return Location
         */
         *
         * @return Location
         */

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

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


@@ -304,18 +355,18 @@ class Location {
         *
         * @return \DateTime
         */
         *
         * @return \DateTime
         */

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

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

-        * @param \Rapsys\AirBundle\Entity\Session $session
+        * @param Session $session

         *
         * @return Location
         */
         *
         * @return Location
         */

-       public function addSession(\Rapsys\AirBundle\Entity\Session $session) {
+       public function addSession(Session $session): Location {

                $this->sessions[] = $session;
 
                return $this;
                $this->sessions[] = $session;
 
                return $this;


@@ -324,29 +375,30 @@ class Location {
        /**
         * Remove session
         *
        /**
         * Remove session
         *

-        * @param \Rapsys\AirBundle\Entity\Session $session
+        * @param Session $session
+        * @return bool

         */
         */

-       public function removeSession(\Rapsys\AirBundle\Entity\Session $session) {
-               $this->sessions->removeElement($session);
+       public function removeSession(Session $session): bool {
+               return $this->sessions->removeElement($session);

        }
 
        /**
         * Get sessions
         *
        }
 
        /**
         * Get sessions
         *

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

         */
         */

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

                return $this->sessions;
        }
 
        /**
         * Add snippet
         *
                return $this->sessions;
        }
 
        /**
         * Add snippet
         *

-        * @param \Rapsys\AirBundle\Entity\Snippet $snippet
+        * @param Snippet $snippet

         *
         * @return Location
         */
         *
         * @return Location
         */

-       public function addSnippet(\Rapsys\AirBundle\Entity\Snippet $snippet) {
+       public function addSnippet(Snippet $snippet): Location {

                $this->snippets[] = $snippet;
 
                return $this;
                $this->snippets[] = $snippet;
 
                return $this;


@@ -355,21 +407,75 @@ class Location {
        /**
         * Remove snippet
         *
        /**
         * Remove snippet
         *

-        * @param \Rapsys\AirBundle\Entity\Snippet $snippet
+        * @param Snippet $snippet
+        * @return bool

         */
         */

-       public function removeSnippet(\Rapsys\AirBundle\Entity\Snippet $snippet) {
-               $this->snippets->removeElement($snippet);
+       public function removeSnippet(Snippet $snippet): bool {
+               return $this->snippets->removeElement($snippet);

        }
 
        /**
         * Get snippets
         *
        }
 
        /**
         * Get snippets
         *

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

         */
         */

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

                return $this->snippets;
        }
 
                return $this->snippets;
        }
 

+       /**
+        * Add user
+        *
+        * @param User $user
+        *
+        * @return Location
+        */
+       public function addUser(User $user): Location {
+               //Add from owning side
+               $user->addLocation($this);
+
+               $this->users[] = $user;
+
+               return $this;
+       }
+
+       /**
+        * Remove user
+        *
+        * @param User $user
+        * @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);
+       }
+
+       /**
+        * Get users
+        *
+        * @return ArrayCollection
+        */
+       public function getUsers(): ArrayCollection {
+               return $this->users;
+       }
+
+       /**
+        * {@inheritdoc}
+        */
+       public function preUpdate(PreUpdateEventArgs $eventArgs) {
+               //Check that we have a location instance
+               if (($location = $eventArgs->getObject()) instanceof Location) {
+                       //Set updated value
+                       $location->setUpdated(new \DateTime('now'));
+               }
+       }
+

        /**
         * Returns a string representation of the location
         *
        /**
         * Returns a string representation of the location
         *