Add note about locale requirement with underscore and not dash

[airbundle] / Entity / User.php

diff --git a/Entity/User.php b/Entity/User.php
index 151f1a10f86662f4c2d9d1724c40bf9a4ad83321..5738c3aa6f93fc00fcf313cf460b8352df462404 100644 (file)
--- a/Entity/User.php
+++ b/Entity/User.php
@@ -1,58 +1,143 @@
-<?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.
+ */

 
 

-// src/Rapsys/AirBundle/Entity/User.php

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

-use Rapsys\AirBundle\Entity\Application;
-use Rapsys\AirBundle\Entity\Group;
-use Rapsys\AirBundle\Entity\Link;
-use Rapsys\AirBundle\Entity\Snippet;
+use Doctrine\Common\Collections\ArrayCollection;
+

 use Rapsys\UserBundle\Entity\User as BaseUser;
 
 class User extends BaseUser {
 use Rapsys\UserBundle\Entity\User as BaseUser;
 
 class User extends BaseUser {

+       /**
+        * @var string
+        */
+       protected $city;
+

        /**
         * @var string
         */
        protected $phone;
 
        /**
        /**
         * @var string
         */
        protected $phone;
 
        /**

-        * @var \Doctrine\Common\Collections\Collection
+        * @var Country
+        */
+       protected $country;
+
+       /**
+        * @var string
+        */
+       protected $pseudonym;
+
+       /**
+        * @var string
+        */
+       protected $zipcode;
+
+       /**
+        * @var ArrayCollection

         */
        private $applications;
 
        /**
         */
        private $applications;
 
        /**

-        * @var \Doctrine\Common\Collections\Collection
+        * @var ArrayCollection
+        */
+       private $dances;
+
+       /**
+        * @var ArrayCollection

         */
        private $locations;
 
        /**
         */
        private $locations;
 
        /**

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

         */
        private $snippets;
 
        /**
         */
        private $snippets;
 
        /**

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

         */
        private $subscribers;
 
        /**
         */
        private $subscribers;
 
        /**

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

         */
        private $subscriptions;
 
        /**
         * Constructor
         */
        private $subscriptions;
 
        /**
         * Constructor

+        *
+        * @param string $mail The user mail

         */
         */

-       public function __construct() {
+       public function __construct(string $mail) {

                //Call parent constructor
                //Call parent constructor

-               parent::__construct();
+               parent::__construct($mail);
+
+               //Set defaults
+               $this->city = null;
+               $this->country = null;
+               $this->phone = null;
+               $this->pseudonym = null;
+               $this->zipcode = null;

 
                //Set collections
 
                //Set collections

-               $this->applications = new \Doctrine\Common\Collections\ArrayCollection();
-               $this->locations = new \Doctrine\Common\Collections\ArrayCollection();
-               $this->snippets = new \Doctrine\Common\Collections\ArrayCollection();
-               $this->subscribers = new \Doctrine\Common\Collections\ArrayCollection();
-               $this->subscriptions = new \Doctrine\Common\Collections\ArrayCollection();
+               $this->applications = new ArrayCollection();
+               $this->dances = new ArrayCollection();
+               $this->locations = new ArrayCollection();
+               $this->snippets = new ArrayCollection();
+               $this->subscribers = new ArrayCollection();
+               $this->subscriptions = new ArrayCollection();
+       }
+
+       /**
+        * Set country
+        *
+        * @param Country $country
+        *
+        * @return User
+        */
+       public function setCountry(Country $country) {
+               $this->country = $country;
+
+               return $this;
+       }
+
+       /**
+        * Get country
+        *
+        * @return Country
+        */
+       public function getCountry() {
+               return $this->country;
+       }
+
+       /**
+        * Set city
+        *
+        * @param string $city
+        *
+        * @return User
+        */
+       public function setCity(?string $city): User {
+               $this->city = $city;
+
+               return $this;
+       }
+
+       /**
+        * Get city
+        *
+        * @return string
+        */
+       public function getCity(): ?string {
+               return $this->city;

        }
 
        /**
        }
 
        /**


@@ -62,7 +147,7 @@ class User extends BaseUser {
         *
         * @return User
         */
         *
         * @return User
         */

-       public function setPhone($phone) {
+       public function setPhone(?string $phone): User {

                $this->phone = $phone;
 
                return $this;
                $this->phone = $phone;
 
                return $this;


@@ -73,62 +158,62 @@ class User extends BaseUser {
         *
         * @return string
         */
         *
         * @return string
         */

-       public function getPhone() {
+       public function getPhone(): ?string {

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

-        * Set donation
+        * Set pseudonym

         *
         *

-        * @param string $donation
+        * @param string $pseudonym

         *
         * @return User
         */
         *
         * @return User
         */

-       public function setDonation($donation) {
-               $this->donation = $donation;
+       public function setPseudonym(?string $pseudonym): User {
+               $this->pseudonym = $pseudonym;

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

-        * Get donation
+        * Get pseudonym

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

-       public function getDonation() {
-               return $this->donation;
+       public function getPseudonym(): ?string {
+               return $this->pseudonym;

        }
 
        /**
        }
 
        /**

-        * Set site
+        * Set zipcode

         *
         *

-        * @param string $site
+        * @param string $zipcode

         *
         * @return User
         */
         *
         * @return User
         */

-       public function setSite($site) {
-               $this->site = $site;
+       public function setZipcode(?string $zipcode): User {
+               $this->zipcode = $zipcode;

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

-        * Get site
+        * Get zipcode

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

-       public function getSite() {
-               return $this->site;
+       public function getZipcode(): ?string {
+               return $this->zipcode;

        }
 
        /**
         * Add application
         *
        }
 
        /**
         * Add application
         *

-        * @param \Rapsys\AirBundle\Entity\Application $application
+        * @param Application $application

         *
         * @return User
         */
         *
         * @return User
         */

-       public function addApplication(Application $application) {
+       public function addApplication(Application $application): User {

                $this->applications[] = $application;
 
                return $this;
                $this->applications[] = $application;
 
                return $this;


@@ -137,60 +222,62 @@ class User extends BaseUser {
        /**
         * Remove application
         *
        /**
         * Remove application
         *

-        * @param \Rapsys\AirBundle\Entity\Application $application
+        * @param Application $application

         */
         */

-       public function removeApplication(Application $application) {
-               $this->applications->removeElement($application);
+       public function removeApplication(Application $application): bool {
+               return $this->applications->removeElement($application);

        }
 
        /**
         * Get applications
         *
        }
 
        /**
         * Get applications
         *

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

         */
         */

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

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

-        * Add snippet
+        * Add dance

         *
         *

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

         *
         * @return User
         */
         *
         * @return User
         */

-       public function addSnippet(Snippet $snippet) {
-               $this->snippets[] = $snippet;
+       public function addDance(Dance $dance): User {
+               $this->dances[] = $dance;

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

-        * Remove snippet
+        * Remove dance

         *
         *

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

         */
         */

-       public function removeSnippet(Snippet $snippet) {
-               $this->snippets->removeElement($snippet);
+       public function removeDance(Dance $dance): bool {
+               return $this->dances->removeElement($dance);

        }
 
        /**
        }
 
        /**

-        * Get snippets
+        * Get dances

         *
         *

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

         */
         */

-       public function getSnippets() {
-               return $this->snippets;
+       public function getDances(): ArrayCollection {
+               return $this->dances;

        }
 
        /**
         * Add location
         *
        }
 
        /**
         * Add location
         *

-        * @param \Rapsys\AirBundle\Entity\Location $location
+        * @param Location $location

         *
         * @return User
         */
         *
         * @return User
         */

-       public function addLocation(Location $location) {
+       public function addLocation(Location $location): User {

                $this->locations[] = $location;
 
                return $this;
                $this->locations[] = $location;
 
                return $this;


@@ -199,29 +286,60 @@ class User extends BaseUser {
        /**
         * Remove location
         *
        /**
         * Remove location
         *

-        * @param \Rapsys\AirBundle\Entity\Location $location
+        * @param Location $location

         */
         */

-       public function removeLocation(Location $location) {
-               $this->locations->removeElement($location);
+       public function removeLocation(Location $location): bool {
+               return $this->locations->removeElement($location);

        }
 
        /**
         * Get locations
         *
        }
 
        /**
         * Get locations
         *

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

         */
         */

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

                return $this->locations;
        }
 
                return $this->locations;
        }
 

+       /**
+        * Add snippet
+        *
+        * @param Snippet $snippet
+        *
+        * @return User
+        */
+       public function addSnippet(Snippet $snippet): User {
+               $this->snippets[] = $snippet;
+
+               return $this;
+       }
+
+       /**
+        * Remove snippet
+        *
+        * @param Snippet $snippet
+        */
+       public function removeSnippet(Snippet $snippet): bool {
+               return $this->snippets->removeElement($snippet);
+       }
+
+       /**
+        * Get snippets
+        *
+        * @return ArrayCollection
+        */
+       public function getSnippets(): ArrayCollection {
+               return $this->snippets;
+       }
+

        /**
         * Add subscriber
         *
        /**
         * Add subscriber
         *

-        * @param \Rapsys\AirBundle\Entity\User $subscriber
+        * @param User $subscriber

         *
         * @return User
         */
         *
         * @return User
         */

-       public function addSubscriber(User $subscriber) {
+       public function addSubscriber(User $subscriber): User {

                $this->subscribers[] = $subscriber;
 
                return $this;
                $this->subscribers[] = $subscriber;
 
                return $this;


@@ -230,29 +348,29 @@ class User extends BaseUser {
        /**
         * Remove subscriber
         *
        /**
         * Remove subscriber
         *

-        * @param \Rapsys\AirBundle\Entity\User $subscriber
+        * @param User $subscriber

         */
         */

-       public function removeSubscriber(User $subscriber) {
-               $this->subscribers->removeElement($subscriber);
+       public function removeSubscriber(User $subscriber): bool {
+               return $this->subscribers->removeElement($subscriber);

        }
 
        /**
         * Get subscribers
         *
        }
 
        /**
         * Get subscribers
         *

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

         */
         */

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

                return $this->subscribers;
        }
 
        /**
         * Add subscription
         *
                return $this->subscribers;
        }
 
        /**
         * Add subscription
         *

-        * @param \Rapsys\AirBundle\Entity\User $subscription
+        * @param User $subscription

         *
         * @return User
         */
         *
         * @return User
         */

-       public function addSubscription(User $subscription) {
+       public function addSubscription(User $subscription): User {

                $this->subscriptions[] = $subscription;
 
                return $this;
                $this->subscriptions[] = $subscription;
 
                return $this;


@@ -261,18 +379,18 @@ class User extends BaseUser {
        /**
         * Remove subscription
         *
        /**
         * Remove subscription
         *

-        * @param \Rapsys\AirBundle\Entity\User $subscription
+        * @param User $subscription

         */
         */

-       public function removeSubscription(User $subscription) {
-               $this->subscriptions->removeElement($subscription);
+       public function removeSubscription(User $subscription): bool {
+               return $this->subscriptions->removeElement($subscription);

        }
 
        /**
         * Get subscriptions
         *
        }
 
        /**
         * Get subscriptions
         *

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

         */
         */

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

                return $this->subscriptions;
        }
 }
                return $this->subscriptions;
        }
 }