typo3/sysext/extbase/Classes/Domain/Model/FrontendUser.php

   1 <?php
   2 namespace TYPO3\CMS\Extbase\Domain\Model;
   3
   4 /*
   5  * This file is part of the TYPO3 CMS project.
   6  *
   7  * It is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU General Public License, either version 2
   9  * of the License, or any later version.
  10  *
  11  * For the full copyright and license information, please read the
  12  * LICENSE.txt file that was distributed with this source code.
  13  *
  14  * The TYPO3 project - inspiring people to share!
  15  */
  16
  17 /**
  18  * A Frontend User
  19  *
  20  * @api
  21  */
  22 class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
  23 {
  24     /**
  25      * @var string
  26      */
  27     protected $username = '';
  28
  29     /**
  30      * @var string
  31      */
  32     protected $password = '';
  33
  34     /**
  35      * @var \TYPO3\CMS\Extbase\Persistence\ObjectStorage<\TYPO3\CMS\Extbase\Domain\Model\FrontendUserGroup>
  36      */
  37     protected $usergroup;
  38
  39     /**
  40      * @var string
  41      */
  42     protected $name = '';
  43
  44     /**
  45      * @var string
  46      */
  47     protected $firstName = '';
  48
  49     /**
  50      * @var string
  51      */
  52     protected $middleName = '';
  53
  54     /**
  55      * @var string
  56      */
  57     protected $lastName = '';
  58
  59     /**
  60      * @var string
  61      */
  62     protected $address = '';
  63
  64     /**
  65      * @var string
  66      */
  67     protected $telephone = '';
  68
  69     /**
  70      * @var string
  71      */
  72     protected $fax = '';
  73
  74     /**
  75      * @var string
  76      */
  77     protected $email = '';
  78
  79     /**
  80      * @var string
  81      */
  82     protected $lockToDomain = '';
  83
  84     /**
  85      * @var string
  86      */
  87     protected $title = '';
  88
  89     /**
  90      * @var string
  91      */
  92     protected $zip = '';
  93
  94     /**
  95      * @var string
  96      */
  97     protected $city = '';
  98
  99     /**
 100      * @var string
 101      */
 102     protected $country = '';
 103
 104     /**
 105      * @var string
 106      */
 107     protected $www = '';
 108
 109     /**
 110      * @var string
 111      */
 112     protected $company = '';
 113
 114     /**
 115      * @var \TYPO3\CMS\Extbase\Persistence\ObjectStorage<\TYPO3\CMS\Extbase\Domain\Model\FileReference>
 116      */
 117     protected $image = null;
 118
 119     /**
 120      * @var \DateTime|null
 121      */
 122     protected $lastlogin = null;
 123
 124     /**
 125      * Constructs a new Front-End User
 126      *
 127      * @param string $username
 128      * @param string $password
 129      * @api
 130      */
 131     public function __construct($username = '', $password = '')
 132     {
 133         $this->username = $username;
 134         $this->password = $password;
 135         $this->usergroup = new \TYPO3\CMS\Extbase\Persistence\ObjectStorage();
 136     }
 137
 138     /**
 139      * Sets the username value
 140      *
 141      * @param string $username
 142      * @api
 143      */
 144     public function setUsername($username)
 145     {
 146         $this->username = $username;
 147     }
 148
 149     /**
 150      * Returns the username value
 151      *
 152      * @return string
 153      * @api
 154      */
 155     public function getUsername()
 156     {
 157         return $this->username;
 158     }
 159
 160     /**
 161      * Sets the password value
 162      *
 163      * @param string $password
 164      * @api
 165      */
 166     public function setPassword($password)
 167     {
 168         $this->password = $password;
 169     }
 170
 171     /**
 172      * Returns the password value
 173      *
 174      * @return string
 175      * @api
 176      */
 177     public function getPassword()
 178     {
 179         return $this->password;
 180     }
 181
 182     /**
 183      * Sets the usergroups. Keep in mind that the property is called "usergroup"
 184      * although it can hold several usergroups.
 185      *
 186      * @param \TYPO3\CMS\Extbase\Persistence\ObjectStorage $usergroup
 187      * @api
 188      */
 189     public function setUsergroup(\TYPO3\CMS\Extbase\Persistence\ObjectStorage $usergroup)
 190     {
 191         $this->usergroup = $usergroup;
 192     }
 193
 194     /**
 195      * Adds a usergroup to the frontend user
 196      *
 197      * @param \TYPO3\CMS\Extbase\Domain\Model\FrontendUserGroup $usergroup
 198      * @api
 199      */
 200     public function addUsergroup(\TYPO3\CMS\Extbase\Domain\Model\FrontendUserGroup $usergroup)
 201     {
 202         $this->usergroup->attach($usergroup);
 203     }
 204
 205     /**
 206      * Removes a usergroup from the frontend user
 207      *
 208      * @param \TYPO3\CMS\Extbase\Domain\Model\FrontendUserGroup $usergroup
 209      * @api
 210      */
 211     public function removeUsergroup(\TYPO3\CMS\Extbase\Domain\Model\FrontendUserGroup $usergroup)
 212     {
 213         $this->usergroup->detach($usergroup);
 214     }
 215
 216     /**
 217      * Returns the usergroups. Keep in mind that the property is called "usergroup"
 218      * although it can hold several usergroups.
 219      *
 220      * @return \TYPO3\CMS\Extbase\Persistence\ObjectStorage An object storage containing the usergroup
 221      * @api
 222      */
 223     public function getUsergroup()
 224     {
 225         return $this->usergroup;
 226     }
 227
 228     /**
 229      * Sets the name value
 230      *
 231      * @param string $name
 232      * @api
 233      */
 234     public function setName($name)
 235     {
 236         $this->name = $name;
 237     }
 238
 239     /**
 240      * Returns the name value
 241      *
 242      * @return string
 243      * @api
 244      */
 245     public function getName()
 246     {
 247         return $this->name;
 248     }
 249
 250     /**
 251      * Sets the firstName value
 252      *
 253      * @param string $firstName
 254      * @api
 255      */
 256     public function setFirstName($firstName)
 257     {
 258         $this->firstName = $firstName;
 259     }
 260
 261     /**
 262      * Returns the firstName value
 263      *
 264      * @return string
 265      * @api
 266      */
 267     public function getFirstName()
 268     {
 269         return $this->firstName;
 270     }
 271
 272     /**
 273      * Sets the middleName value
 274      *
 275      * @param string $middleName
 276      * @api
 277      */
 278     public function setMiddleName($middleName)
 279     {
 280         $this->middleName = $middleName;
 281     }
 282
 283     /**
 284      * Returns the middleName value
 285      *
 286      * @return string
 287      * @api
 288      */
 289     public function getMiddleName()
 290     {
 291         return $this->middleName;
 292     }
 293
 294     /**
 295      * Sets the lastName value
 296      *
 297      * @param string $lastName
 298      * @api
 299      */
 300     public function setLastName($lastName)
 301     {
 302         $this->lastName = $lastName;
 303     }
 304
 305     /**
 306      * Returns the lastName value
 307      *
 308      * @return string
 309      * @api
 310      */
 311     public function getLastName()
 312     {
 313         return $this->lastName;
 314     }
 315
 316     /**
 317      * Sets the address value
 318      *
 319      * @param string $address
 320      * @api
 321      */
 322     public function setAddress($address)
 323     {
 324         $this->address = $address;
 325     }
 326
 327     /**
 328      * Returns the address value
 329      *
 330      * @return string
 331      * @api
 332      */
 333     public function getAddress()
 334     {
 335         return $this->address;
 336     }
 337
 338     /**
 339      * Sets the telephone value
 340      *
 341      * @param string $telephone
 342      * @api
 343      */
 344     public function setTelephone($telephone)
 345     {
 346         $this->telephone = $telephone;
 347     }
 348
 349     /**
 350      * Returns the telephone value
 351      *
 352      * @return string
 353      * @api
 354      */
 355     public function getTelephone()
 356     {
 357         return $this->telephone;
 358     }
 359
 360     /**
 361      * Sets the fax value
 362      *
 363      * @param string $fax
 364      * @api
 365      */
 366     public function setFax($fax)
 367     {
 368         $this->fax = $fax;
 369     }
 370
 371     /**
 372      * Returns the fax value
 373      *
 374      * @return string
 375      * @api
 376      */
 377     public function getFax()
 378     {
 379         return $this->fax;
 380     }
 381
 382     /**
 383      * Sets the email value
 384      *
 385      * @param string $email
 386      * @api
 387      */
 388     public function setEmail($email)
 389     {
 390         $this->email = $email;
 391     }
 392
 393     /**
 394      * Returns the email value
 395      *
 396      * @return string
 397      * @api
 398      */
 399     public function getEmail()
 400     {
 401         return $this->email;
 402     }
 403
 404     /**
 405      * Sets the lockToDomain value
 406      *
 407      * @param string $lockToDomain
 408      * @api
 409      */
 410     public function setLockToDomain($lockToDomain)
 411     {
 412         $this->lockToDomain = $lockToDomain;
 413     }
 414
 415     /**
 416      * Returns the lockToDomain value
 417      *
 418      * @return string
 419      * @api
 420      */
 421     public function getLockToDomain()
 422     {
 423         return $this->lockToDomain;
 424     }
 425
 426     /**
 427      * Sets the title value
 428      *
 429      * @param string $title
 430      * @api
 431      */
 432     public function setTitle($title)
 433     {
 434         $this->title = $title;
 435     }
 436
 437     /**
 438      * Returns the title value
 439      *
 440      * @return string
 441      * @api
 442      */
 443     public function getTitle()
 444     {
 445         return $this->title;
 446     }
 447
 448     /**
 449      * Sets the zip value
 450      *
 451      * @param string $zip
 452      * @api
 453      */
 454     public function setZip($zip)
 455     {
 456         $this->zip = $zip;
 457     }
 458
 459     /**
 460      * Returns the zip value
 461      *
 462      * @return string
 463      * @api
 464      */
 465     public function getZip()
 466     {
 467         return $this->zip;
 468     }
 469
 470     /**
 471      * Sets the city value
 472      *
 473      * @param string $city
 474      * @api
 475      */
 476     public function setCity($city)
 477     {
 478         $this->city = $city;
 479     }
 480
 481     /**
 482      * Returns the city value
 483      *
 484      * @return string
 485      * @api
 486      */
 487     public function getCity()
 488     {
 489         return $this->city;
 490     }
 491
 492     /**
 493      * Sets the country value
 494      *
 495      * @param string $country
 496      * @api
 497      */
 498     public function setCountry($country)
 499     {
 500         $this->country = $country;
 501     }
 502
 503     /**
 504      * Returns the country value
 505      *
 506      * @return string
 507      * @api
 508      */
 509     public function getCountry()
 510     {
 511         return $this->country;
 512     }
 513
 514     /**
 515      * Sets the www value
 516      *
 517      * @param string $www
 518      * @api
 519      */
 520     public function setWww($www)
 521     {
 522         $this->www = $www;
 523     }
 524
 525     /**
 526      * Returns the www value
 527      *
 528      * @return string
 529      * @api
 530      */
 531     public function getWww()
 532     {
 533         return $this->www;
 534     }
 535
 536     /**
 537      * Sets the company value
 538      *
 539      * @param string $company
 540      * @api
 541      */
 542     public function setCompany($company)
 543     {
 544         $this->company = $company;
 545     }
 546
 547     /**
 548      * Returns the company value
 549      *
 550      * @return string
 551      * @api
 552      */
 553     public function getCompany()
 554     {
 555         return $this->company;
 556     }
 557
 558     /**
 559      * Sets the image value
 560      *
 561      * @api
 562      * @param \TYPO3\CMS\Extbase\Persistence\ObjectStorage $image
 563      */
 564     public function setImage(\TYPO3\CMS\Extbase\Persistence\ObjectStorage $image)
 565     {
 566         $this->image = $image;
 567     }
 568
 569     /**
 570      * Gets the image value
 571      *
 572      * @api
 573      * @return \TYPO3\CMS\Extbase\Persistence\ObjectStorage
 574      */
 575     public function getImage()
 576     {
 577         return $this->image;
 578     }
 579
 580     /**
 581      * Sets the lastlogin value
 582      *
 583      * @param \DateTime $lastlogin
 584      * @api
 585      */
 586     public function setLastlogin(\DateTime $lastlogin)
 587     {
 588         $this->lastlogin = $lastlogin;
 589     }
 590
 591     /**
 592      * Returns the lastlogin value
 593      *
 594      * @return \DateTime
 595      * @api
 596      */
 597     public function getLastlogin()
 598     {
 599         return $this->lastlogin;
 600     }
 601 }