2020-03-29 19:33:16 +01:00
< ? php
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-03-29 19:33:16 +01:00
namespace App\Entity ;
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 ' s email confimation
*
* @ 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 ConfirmAddress extends Entity
2020-03-29 19:33:16 +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 ;
2021-12-26 21:32:09 +00:00
private ? int $user_id = 0 ;
2020-03-30 16:13:51 +01:00
private string $address ;
2021-12-26 21:32:09 +00:00
private ? string $address_extra = null ;
2020-03-30 16:13:51 +01:00
private string $address_type ;
2021-12-26 21:32:09 +00:00
private ? \DateTimeInterface $claimed = null ;
2021-04-27 22:24:48 +01:00
private \DateTimeInterface $sent ;
private \DateTimeInterface $modified ;
2020-03-30 16:13:51 +01:00
public function setCode ( string $code ) : self
{
2021-12-26 15:12:06 +00:00
$this -> code = \mb_substr ( $code , 0 , 32 );
2020-03-30 16:13:51 +01:00
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
{
2021-12-26 15:12:06 +00:00
$this -> address = \mb_substr ( $address , 0 , 191 );
2020-03-30 16:13:51 +01:00
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 setAddressExtra ( ? string $address_extra ) : self
{
2021-12-26 21:32:09 +00:00
$this -> address_extra = \is_null ( $address_extra ) ? null : \mb_substr ( $address_extra , 0 , 191 );
2020-03-30 16:13:51 +01:00
return $this ;
}
2020-08-08 17:11:18 +01:00
2020-03-30 16:13:51 +01:00
public function getAddressExtra () : ? string
{
return $this -> address_extra ;
}
public function setAddressType ( string $address_type ) : self
{
2021-12-26 15:12:06 +00:00
$this -> address_type = \mb_substr ( $address_type , 0 , 8 );
2020-03-30 16:13:51 +01:00
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 ;
}
2021-12-26 15:12:06 +00:00
public function setClaimed ( ? \DateTimeInterface $claimed ) : self
2020-03-30 16:13:51 +01:00
{
$this -> claimed = $claimed ;
return $this ;
}
2020-08-08 17:11:18 +01:00
2021-12-26 15:12:06 +00:00
public function getClaimed () : ? \DateTimeInterface
2020-03-30 16:13:51 +01:00
{
return $this -> claimed ;
}
2021-12-26 15:12:06 +00:00
public function setSent ( \DateTimeInterface $sent ) : self
2020-03-30 16:13:51 +01:00
{
$this -> sent = $sent ;
return $this ;
}
2020-08-08 17:11:18 +01:00
2021-12-26 15:12:06 +00:00
public function getSent () : \DateTimeInterface
2020-03-30 16:13:51 +01:00
{
return $this -> sent ;
}
2021-12-26 15:12:06 +00:00
public function setModified ( \DateTimeInterface $modified ) : self
2020-03-30 16:13:51 +01:00
{
$this -> modified = $modified ;
return $this ;
}
2020-08-08 17:11:18 +01:00
2021-12-26 15:12:06 +00:00
public function getModified () : \DateTimeInterface
2020-03-30 16:13:51 +01:00
{
return $this -> modified ;
}
2021-05-05 17:03:03 +01:00
// @codeCoverageIgnoreEnd
2020-03-30 15:00:13 +01:00
// }}} Autocode
2020-03-29 19:33:16 +01:00
public static function schemaDef () : array
{
return [
'name' => 'confirm_address' ,
'fields' => [
2020-06-30 17:26:40 +01:00
'code' => [ 'type' => 'varchar' , 'length' => 32 , 'not null' => true , 'description' => 'good random code' ],
2021-02-22 21:34:59 +00:00
'user_id' => [ 'type' => 'int' , 'foreign key' => true , 'target' => 'LocalUser.id' , 'name' => 'confirm_address_user_id_fkey' , 'multiplicity' => 'one to one' , 'default' => 0 , 'description' => 'user who requested confirmation' ],
2020-06-30 17:26:40 +01:00
'address' => [ 'type' => 'varchar' , 'length' => 191 , 'not null' => true , 'description' => 'address (email, xmpp, SMS, etc.)' ],
'address_extra' => [ 'type' => 'varchar' , 'length' => 191 , 'description' => 'carrier ID, for SMS' ],
'address_type' => [ 'type' => 'varchar' , 'length' => 8 , 'not null' => true , 'description' => 'address type ("email", "xmpp", "sms")' ],
2020-03-29 19:33:16 +01:00
'claimed' => [ 'type' => 'datetime' , 'description' => 'date this was claimed for queueing' ],
2020-07-05 14:12:35 +01:00
'sent' => [ 'type' => 'datetime' , 'not null' => true , 'default' => 'CURRENT_TIMESTAMP' , 'description' => 'date this was sent for queueing' ],
'modified' => [ 'type' => 'timestamp' , 'not null' => true , 'default' => 'CURRENT_TIMESTAMP' , 'description' => 'date this record was modified' ],
2020-03-29 19:33:16 +01:00
],
2021-02-22 21:34:59 +00:00
'primary key' => [ 'code' ],
2020-03-29 19:33:16 +01:00
];
}
2020-06-30 17:26:40 +01:00
}