2008-08-23 20:10:15 +01:00
< ? php
2020-06-28 23:41:46 +01:00
2020-03-29 20:56:35 +01:00
// {{{ License
2020-05-20 17:53:53 +01:00
// This file is part of GNU social - https://www.gnu.org/software/social
2020-03-29 20:56:35 +01:00
//
// GNU social is free software: you can redistribute it and/or modify
2020-05-10 21:43:15 +01:00
// it under the terms of the GNU Affero General Public License as published by
2020-03-29 20:56:35 +01:00
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// GNU social is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
2020-05-10 21:43:15 +01:00
// You should have received a copy of the GNU Affero General Public License
2020-03-29 20:56:35 +01:00
// along with GNU social. If not, see <http://www.gnu.org/licenses/>.
// }}}
2020-06-28 23:41:46 +01:00
2020-03-29 19:33:16 +01:00
namespace App\Entity ;
2008-08-23 20:10:15 +01:00
2020-08-15 07:18:23 +01:00
use App\Core\Entity ;
2020-05-10 21:43:15 +01:00
use DateTimeInterface ;
2020-03-29 19:33:16 +01:00
/**
* Entity for user invitations
*
* @ category DB
* @ package GNUsocial
*
* @ author Zach Copley < zach @ status . net >
* @ copyright 2010 StatusNet Inc .
* @ author Mikael Nordfeldth < mmn @ hethane . se >
* @ copyright 2009 - 2014 Free Software Foundation , Inc http :// www . fsf . org
2021-02-19 23:29:43 +00:00
* @ author Hugo Sales < hugo @ hsal . es >
* @ copyright 2020 - 2021 Free Software Foundation , Inc http :// www . fsf . org
2020-03-29 19:33:16 +01:00
* @ license https :// www . gnu . org / licenses / agpl . html GNU AGPL v3 or later
*/
2020-08-15 07:18:23 +01:00
class Invitation extends Entity
2008-08-23 20:10:15 +01:00
{
2020-03-30 15:00:13 +01:00
// {{{ Autocode
2021-05-05 17:03:03 +01:00
// @codeCoverageIgnoreStart
2020-03-30 16:13:51 +01:00
private string $code ;
private int $user_id ;
private string $address ;
private string $address_type ;
private ? int $registered_user_id ;
2021-04-27 22:24:48 +01:00
private \DateTimeInterface $created ;
2020-03-30 16:13:51 +01:00
public function setCode ( string $code ) : self
{
$this -> code = $code ;
return $this ;
}
2020-08-08 17:11:18 +01:00
2020-03-30 16:13:51 +01:00
public function getCode () : string
{
return $this -> code ;
}
public function setUserId ( int $user_id ) : self
{
$this -> user_id = $user_id ;
return $this ;
}
2020-08-08 17:11:18 +01:00
2020-03-30 16:13:51 +01:00
public function getUserId () : int
{
return $this -> user_id ;
}
public function setAddress ( string $address ) : self
{
$this -> address = $address ;
return $this ;
}
2020-08-08 17:11:18 +01:00
2020-03-30 16:13:51 +01:00
public function getAddress () : string
{
return $this -> address ;
}
public function setAddressType ( string $address_type ) : self
{
$this -> address_type = $address_type ;
return $this ;
}
2020-08-08 17:11:18 +01:00
2020-03-30 16:13:51 +01:00
public function getAddressType () : string
{
return $this -> address_type ;
}
2020-07-22 02:49:40 +01:00
public function setRegisteredUserId ( ? int $registered_user_id ) : self
2020-03-30 16:13:51 +01:00
{
2020-07-22 02:49:40 +01:00
$this -> registered_user_id = $registered_user_id ;
2020-03-30 16:13:51 +01:00
return $this ;
}
2020-08-08 17:11:18 +01:00
2020-07-22 02:49:40 +01:00
public function getRegisteredUserId () : ? int
2020-03-30 16:13:51 +01:00
{
2020-07-22 02:49:40 +01:00
return $this -> registered_user_id ;
2020-03-30 16:13:51 +01:00
}
2021-05-05 17:03:03 +01:00
public function setCreated ( DateTimeInterface $created ) : self
2020-03-30 16:13:51 +01:00
{
2020-07-22 02:49:40 +01:00
$this -> created = $created ;
2020-03-30 16:13:51 +01:00
return $this ;
}
2020-08-08 17:11:18 +01:00
2021-05-05 17:03:03 +01:00
public function getCreated () : DateTimeInterface
2020-03-30 16:13:51 +01:00
{
2020-07-22 02:49:40 +01:00
return $this -> created ;
2020-03-30 16:13:51 +01:00
}
2021-05-05 17:03:03 +01:00
// @codeCoverageIgnoreEnd
2020-03-30 15:00:13 +01:00
// }}} Autocode
2011-05-23 22:25:00 +01:00
2020-03-29 19:33:16 +01:00
public static function schemaDef () : array
2011-05-23 22:25:00 +01:00
{
2020-03-29 19:33:16 +01:00
return [
2020-06-30 17:26:40 +01:00
'name' => 'invitation' ,
2020-03-29 19:33:16 +01:00
'fields' => [
2021-02-22 21:34:59 +00:00
'code' => [ 'type' => 'varchar' , 'length' => 32 , 'not null' => true , 'description' => 'random code for an invitation' ],
2021-03-11 22:16:17 +00:00
'user_id' => [ 'type' => 'int' , 'foreign key' => true , 'target' => 'LocalUser.id' , 'multiplicity' => 'many to one' , 'name' => 'invitation_user_id_fkey' , 'not null' => true , 'description' => 'who sent the invitation' ],
2021-02-22 21:34:59 +00:00
'address' => [ 'type' => 'varchar' , 'length' => 191 , 'not null' => true , 'description' => 'invitation sent to' ],
'address_type' => [ 'type' => 'varchar' , 'length' => 8 , 'not null' => true , 'description' => 'address type ("email", "xmpp", "sms")' ],
2021-03-11 22:16:17 +00:00
'registered_user_id' => [ 'type' => 'int' , 'foreign key' => true , 'target' => 'LocalUser.id' , 'multiplicity' => 'one to one' , 'name' => 'invitation_registered_user_id_fkey' , 'type' => 'int' , 'not null' => false , 'description' => 'if the invitation is converted, who the new user is' ],
2021-02-22 21:34:59 +00:00
'created' => [ 'type' => 'datetime' , 'not null' => true , 'default' => 'CURRENT_TIMESTAMP' , 'description' => 'date this record was created' ],
2020-03-29 19:33:16 +01:00
],
2021-02-22 21:34:59 +00:00
'primary key' => [ 'code' ],
'indexes' => [
2020-03-29 19:33:16 +01:00
'invitation_address_idx' => [ 'address' , 'address_type' ],
'invitation_user_id_idx' => [ 'user_id' ],
'invitation_registered_user_id_idx' => [ 'registered_user_id' ],
],
];
2011-08-22 22:52:02 +01:00
}
2008-08-23 20:10:15 +01:00
}