<?php
-
/**
- * @file src/Model/Register.php
+ * @copyright Copyright (C) 2010-2024, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program 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.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
*/
namespace Friendica\Model;
+use Friendica\Content\Pager;
use Friendica\Database\DBA;
+use Friendica\Network\HTTPException;
use Friendica\Util\DateTimeFormat;
use Friendica\Util\Strings;
/**
* Class interacting with the register database table
- *
- * @author Hypolite Petovan <mrpetovan@gmail.com>
*/
class Register
{
/**
* Return the list of pending registrations
*
- * @return array
+ * @param int $start Start count (Default is 0)
+ * @param int $count Count of the items per page (Default is @see Pager::ITEMS_PER_PAGE)
+ * @return array|bool Array on succes, false on failure
* @throws \Exception
*/
- public static function getPending()
+ public static function getPending(int $start = 0, int $count = Pager::ITEMS_PER_PAGE)
{
- $stmt = DBA::p(
- "SELECT `register`.*, `contact`.`name`, `contact`.`url`, `contact`.`micro`, `user`.`email`
- FROM `register`
- INNER JOIN `contact` ON `register`.`uid` = `contact`.`uid`
- INNER JOIN `user` ON `register`.`uid` = `user`.`uid`"
- );
-
- return DBA::toArray($stmt);
+ return DBA::selectToArray('pending-view', [], [], ['limit' => [$start, $count]]);
+ }
+
+ /**
+ * Returns the pending user based on a given user id
+ *
+ * @param int $uid The user id
+ *
+ * @return array|bool Array on succes, false on failure
+ * @throws \Exception
+ */
+ public static function getPendingForUser(int $uid)
+ {
+ return DBA::selectFirst('pending-view', [], ['uid' => $uid, 'self' => true]);
}
/**
* @return int
* @throws \Exception
*/
- public static function getPendingCount()
+ public static function getPendingCount(): int
{
- $register = DBA::fetchFirst(
- "SELECT COUNT(*) AS `count`
- FROM `register`
- INNER JOIN `contact` ON `register`.`uid` = `contact`.`uid` AND `contact`.`self`"
- );
-
- return $register['count'];
+ return DBA::count('pending-view', ['self' => true]);
}
/**
* Returns the register record associated with the provided hash
*
* @param string $hash
- * @return array
+ * @return array|bool Array on succes, false on failure
* @throws \Exception
*/
- public static function getByHash($hash)
+ public static function getByHash(string $hash)
{
return DBA::selectFirst('register', [], ['hash' => $hash]);
}
* @return boolean
* @throws \Exception
*/
- public static function existsByHash($hash)
+ public static function existsByHash(string $hash): bool
{
return DBA::exists('register', ['hash' => $hash]);
}
* @return string
* @throws \Exception
*/
- public static function createForInvitation()
+ public static function createForInvitation(): string
{
$code = Strings::getRandomName(8) . random_int(1000, 9999);
}
/**
- * Creates a register record for approval and returns the success of the database insert
+ * Creates a register record for approval
* Checks for the existence of the provided user id
*
- * @param integer $uid The ID of the user needing approval
- * @param string $language The registration language
- * @param string $note An additional message from the user
- * @return boolean
- * @throws \Exception
+ * @param integer $uid The ID of the user needing approval
+ * @param string $language The registration language
+ * @param string $note An additional message from the user
+ * @return void
+ * @throws \OutOfBoundsException
+ * @throws HTTPException\InternalServerErrorException
+ * @throws HTTPException\NotFoundException
*/
- public static function createForApproval($uid, $language, $note = '')
+ public static function createForApproval(int $uid, string $language, string $note = ''): void
{
$hash = Strings::getRandomHex();
+ if (!$uid) {
+ throw new \OutOfBoundsException("User ID can't be empty");
+ }
+
if (!User::exists($uid)) {
- return false;
+ throw new HTTPException\NotFoundException("User ID doesn't exist");
}
$fields = [
'note' => $note
];
- return DBA::insert('register', $fields);
+ if (!DBA::insert('register', $fields)) {
+ throw new HTTPException\InternalServerErrorException('Unable to insert a `register` record');
+ }
}
/**
* @return boolean
* @throws \Exception
*/
- public static function deleteByHash($hash)
+ public static function deleteByHash(string $hash): bool
{
return DBA::delete('register', ['hash' => $hash]);
}
projects / friendica.git / blobdiff