Strict types

[airbundle] / Entity / Location.php

diff --git a/Entity/Location.php b/Entity/Location.php
index 73fc6b980ff79370d14e6fb6103b4fc0e87cd752..c379b560c8a614805d013845a31359e58553fb9b 100644 (file)
--- a/Entity/Location.php
+++ b/Entity/Location.php
@@ -1,7 +1,19 @@
-<?php
+<?php declare(strict_types=1);
+
+/*
+ * this file is part of the rapsys packbundle 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;
 
+use Doctrine\Common\Collections\ArrayCollection;
+use Doctrine\ORM\Event\PreUpdateEventArgs;
+
 /**
  * Location
  */
@@ -19,7 +31,7 @@ class Location {
        /**
         * @var string
         */
-       private $short;
+       protected $description;
 
        /**
         * @var string
@@ -47,7 +59,12 @@ class Location {
        private $longitude;
 
        /**
-        * @var boolean
+        * @var bool
+        */
+       private $indoor;
+
+       /**
+        * @var bool
         */
        private $hotspot;
 
@@ -62,15 +79,31 @@ class Location {
        private $updated;
 
        /**
-        * @var \Doctrine\Common\Collections\Collection
+        * @var ArrayCollection
         */
        private $sessions;
 
+       /**
+        * @var ArrayCollection
+        */
+       private $snippets;
+
+       /**
+        * @var ArrayCollection
+        */
+       private $users;
+
        /**
         * Constructor
         */
        public function __construct() {
-               $this->sessions = new \Doctrine\Common\Collections\ArrayCollection();
+               //Set defaults
+               $this->description = null;
+               $this->created = new \DateTime('now');
+               $this->updated = new \DateTime('now');
+               $this->sessions = new ArrayCollection();
+               $this->snippets = new ArrayCollection();
+               $this->users = new ArrayCollection();
        }
 
        /**
@@ -78,7 +111,7 @@ class Location {
         *
         * @return integer
         */
-       public function getId() {
+       public function getId(): int {
                return $this->id;
        }
 
@@ -89,7 +122,7 @@ class Location {
         *
         * @return Location
         */
-       public function setTitle($title) {
+       public function setTitle(string $title): Location {
                $this->title = $title;
 
                return $this;
@@ -100,30 +133,30 @@ class Location {
         *
         * @return string
         */
-       public function getTitle() {
+       public function getTitle(): string {
                return $this->title;
        }
 
        /**
-        * Set short
+        * Set description
         *
-        * @param string $short
+        * @param string $description
         *
         * @return Location
         */
-       public function setShort($short) {
-               $this->short = $short;
+       public function setDescription(?string $description): Location {
+               $this->description = $description;
 
                return $this;
        }
 
        /**
-        * Get short
+        * Get description
         *
         * @return string
         */
-       public function getShort() {
-               return $this->short;
+       public function getDescription(): ?string {
+               return $this->description;
        }
 
        /**
@@ -133,7 +166,7 @@ class Location {
         *
         * @return Location
         */
-       public function setAddress($address) {
+       public function setAddress(string $address): Location {
                $this->address = $address;
 
                return $this;
@@ -144,7 +177,7 @@ class Location {
         *
         * @return string
         */
-       public function getAddress() {
+       public function getAddress(): string {
                return $this->address;
        }
 
@@ -155,7 +188,7 @@ class Location {
         *
         * @return Location
         */
-       public function setZipcode($zipcode) {
+       public function setZipcode(string $zipcode): Location {
                $this->zipcode = $zipcode;
 
                return $this;
@@ -166,7 +199,7 @@ class Location {
         *
         * @return string
         */
-       public function getZipcode() {
+       public function getZipcode(): string {
                return $this->zipcode;
        }
 
@@ -177,7 +210,7 @@ class Location {
         *
         * @return Location
         */
-       public function setCity($city) {
+       public function setCity(string $city): Location {
                $this->city = $city;
 
                return $this;
@@ -188,7 +221,7 @@ class Location {
         *
         * @return string
         */
-       public function getCity() {
+       public function getCity(): string {
                return $this->city;
        }
 
@@ -199,7 +232,7 @@ class Location {
         *
         * @return Location
         */
-       public function setLatitude($latitude) {
+       public function setLatitude(string $latitude): Location {
                $this->latitude = $latitude;
 
                return $this;
@@ -210,7 +243,7 @@ class Location {
         *
         * @return string
         */
-       public function getLatitude() {
+       public function getLatitude(): string {
                return $this->latitude;
        }
 
@@ -221,7 +254,7 @@ class Location {
         *
         * @return Location
         */
-       public function setLongitude($longitude) {
+       public function setLongitude(string $longitude): Location {
                $this->longitude = $longitude;
 
                return $this;
@@ -232,18 +265,40 @@ class Location {
         *
         * @return string
         */
-       public function getLongitude() {
+       public function getLongitude(): string {
                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
         */
-       public function setHotspot($hotspot) {
+       public function setHotspot(bool $hotspot): Location {
                $this->hotspot = $hotspot;
 
                return $this;
@@ -252,9 +307,9 @@ class Location {
        /**
         * Get hotspot
         *
-        * @return boolean
+        * @return bool
         */
-       public function getHotspot() {
+       public function getHotspot(): bool {
                return $this->hotspot;
        }
 
@@ -265,7 +320,7 @@ class Location {
         *
         * @return Location
         */
-       public function setCreated($created) {
+       public function setCreated(\DateTime $created): Location {
                $this->created = $created;
 
                return $this;
@@ -276,7 +331,7 @@ class Location {
         *
         * @return \DateTime
         */
-       public function getCreated() {
+       public function getCreated(): \DateTime {
                return $this->created;
        }
 
@@ -287,7 +342,7 @@ class Location {
         *
         * @return Location
         */
-       public function setUpdated($updated) {
+       public function setUpdated(\DateTime $updated): Location {
                $this->updated = $updated;
 
                return $this;
@@ -298,18 +353,18 @@ class Location {
         *
         * @return \DateTime
         */
-       public function getUpdated() {
+       public function getUpdated(): \DateTime {
                return $this->updated;
        }
 
        /**
         * Add session
         *
-        * @param \Rapsys\AirBundle\Entity\Session $session
+        * @param Session $session
         *
         * @return Location
         */
-       public function addSession(\Rapsys\AirBundle\Entity\Session $session) {
+       public function addSession(Session $session): Location {
                $this->sessions[] = $session;
 
                return $this;
@@ -318,21 +373,97 @@ class Location {
        /**
         * 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
         *
-        * @return \Doctrine\Common\Collections\Collection
+        * @return ArrayCollection
         */
-       public function getSessions() {
+       public function getSessions(): ArrayCollection {
                return $this->sessions;
        }
 
+       /**
+        * Add snippet
+        *
+        * @param Snippet $snippet
+        *
+        * @return Location
+        */
+       public function addSnippet(Snippet $snippet): Location {
+               $this->snippets[] = $snippet;
+
+               return $this;
+       }
+
+       /**
+        * Remove snippet
+        *
+        * @param Snippet $snippet
+        * @return bool
+        */
+       public function removeSnippet(Snippet $snippet): bool {
+               return $this->snippets->removeElement($snippet);
+       }
+
+       /**
+        * Get snippets
+        *
+        * @return ArrayCollection
+        */
+       public function getSnippets(): ArrayCollection {
+               return $this->snippets;
+       }
+
+       /**
+        * Add user
+        *
+        * @param User $user
+        *
+        * @return Location
+        */
+       public function addUser(User $user): Location {
+               $this->users[] = $user;
+
+               return $this;
+       }
+
+       /**
+        * Remove user
+        *
+        * @param User $user
+        * @return bool
+        */
+       public function removeUser(User $user): bool {
+               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->getEntity()) instanceof Location) {
+                       //Set updated value
+                       $location->setUpdated(new \DateTime('now'));
+               }
+       }
+
        /**
         * Returns a string representation of the location
         *