3 * @copyright Copyright (C) 2010-2022, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Model;
24 use Friendica\Content\Pager;
25 use Friendica\Database\DBA;
26 use Friendica\Util\DateTimeFormat;
27 use Friendica\Util\Strings;
30 * Class interacting with the register database table
35 * Return the list of pending registrations
37 * @param int $start Start count (Default is 0)
38 * @param int $count Count of the items per page (Default is @see Pager::ITEMS_PER_PAGE)
39 * @return array|bool Array on succes, false on failure
42 public static function getPending(int $start = 0, int $count = Pager::ITEMS_PER_PAGE)
44 return DBA::selectToArray('pending-view', [], [], ['limit' => [$start, $count]]);
48 * Returns the pending user based on a given user id
50 * @param int $uid The user id
52 * @return array|bool Array on succes, false on failure
55 public static function getPendingForUser(int $uid)
57 return DBA::selectFirst('pending-view', [], ['uid' => $uid, 'self' => true]);
61 * Returns the pending registration count
66 public static function getPendingCount(): int
68 return DBA::count('pending-view', ['self' => true]);
72 * Returns the register record associated with the provided hash
75 * @return array|bool Array on succes, false on failure
78 public static function getByHash(string $hash)
80 return DBA::selectFirst('register', [], ['hash' => $hash]);
84 * Returns true if a register record exists with the provided hash
90 public static function existsByHash(string $hash): bool
92 return DBA::exists('register', ['hash' => $hash]);
96 * Creates a register record for an invitation and returns the auto-generated code for it
101 public static function createForInvitation(): string
103 $code = Strings::getRandomName(8) . random_int(1000, 9999);
107 'created' => DateTimeFormat::utcNow()
110 DBA::insert('register', $fields);
116 * Creates a register record for approval and returns the success of the database insert
117 * Checks for the existence of the provided user id
119 * @param integer $uid The ID of the user needing approval
120 * @param string $language The registration language
121 * @param string $note An additional message from the user
125 public static function createForApproval(int $uid, string $language, string $note = ''): bool
127 $hash = Strings::getRandomHex();
129 if (!User::exists($uid)) {
135 'created' => DateTimeFormat::utcNow(),
137 'password' => '', // Obsolete, slated for deletion
138 'language' => $language,
142 return DBA::insert('register', $fields);
146 * Deletes a register record by the provided hash and returns the success of the database deletion
148 * @param string $hash
152 public static function deleteByHash(string $hash): bool
154 return DBA::delete('register', ['hash' => $hash]);