Changes:
- added some type-hints - added some documentation - used self::exists() instead of DBA::exists('user', ['uid' => $uid])
This commit is contained in:
parent
a2a7d04fa1
commit
ba1c1049d6
2 changed files with 68 additions and 41 deletions
|
@ -96,6 +96,7 @@ class Profile
|
||||||
*
|
*
|
||||||
* @param array $fields Profile fields to update
|
* @param array $fields Profile fields to update
|
||||||
* @param integer $uid User id
|
* @param integer $uid User id
|
||||||
|
*
|
||||||
* @return boolean Whether update was successful
|
* @return boolean Whether update was successful
|
||||||
*/
|
*/
|
||||||
public static function update(array $fields, int $uid): bool
|
public static function update(array $fields, int $uid): bool
|
||||||
|
@ -139,6 +140,7 @@ class Profile
|
||||||
*
|
*
|
||||||
* @param int $uid User id
|
* @param int $uid User id
|
||||||
* @param bool $force Force publishing to the directory
|
* @param bool $force Force publishing to the directory
|
||||||
|
*
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public static function publishUpdate(int $uid, bool $force = false)
|
public static function publishUpdate(int $uid, bool $force = false)
|
||||||
|
@ -162,6 +164,7 @@ class Profile
|
||||||
* Returns a formatted location string from the given profile array
|
* Returns a formatted location string from the given profile array
|
||||||
*
|
*
|
||||||
* @param array $profile Profile array (Generated from the "profile" table)
|
* @param array $profile Profile array (Generated from the "profile" table)
|
||||||
|
*
|
||||||
* @return string Location string
|
* @return string Location string
|
||||||
*/
|
*/
|
||||||
public static function formatLocation(array $profile): string
|
public static function formatLocation(array $profile): string
|
||||||
|
@ -212,13 +215,13 @@ class Profile
|
||||||
* @param App $a
|
* @param App $a
|
||||||
* @param string $nickname string
|
* @param string $nickname string
|
||||||
* @param bool $show_contacts
|
* @param bool $show_contacts
|
||||||
* @return array Profile
|
|
||||||
*
|
*
|
||||||
|
* @return array Profile
|
||||||
* @throws HTTPException\NotFoundException
|
* @throws HTTPException\NotFoundException
|
||||||
* @throws HTTPException\InternalServerErrorException
|
* @throws HTTPException\InternalServerErrorException
|
||||||
* @throws \ImagickException
|
* @throws \ImagickException
|
||||||
*/
|
*/
|
||||||
public static function load(App $a, string $nickname, bool $show_contacts = true)
|
public static function load(App $a, string $nickname, bool $show_contacts = true): array
|
||||||
{
|
{
|
||||||
$profile = User::getOwnerDataByNick($nickname);
|
$profile = User::getOwnerDataByNick($nickname);
|
||||||
if (!isset($profile['account_removed']) || $profile['account_removed']) {
|
if (!isset($profile['account_removed']) || $profile['account_removed']) {
|
||||||
|
@ -285,7 +288,7 @@ class Profile
|
||||||
* @hooks 'profile_sidebar'
|
* @hooks 'profile_sidebar'
|
||||||
* array $arr
|
* array $arr
|
||||||
*/
|
*/
|
||||||
public static function getVCardHtml(array $profile, bool $block, bool $show_contacts)
|
public static function getVCardHtml(array $profile, bool $block, bool $show_contacts): string
|
||||||
{
|
{
|
||||||
$o = '';
|
$o = '';
|
||||||
$location = false;
|
$location = false;
|
||||||
|
@ -484,7 +487,6 @@ class Profile
|
||||||
* Returns the upcoming birthdays of contacts of the current user as HTML content
|
* Returns the upcoming birthdays of contacts of the current user as HTML content
|
||||||
*
|
*
|
||||||
* @return string The upcoming birthdays (HTML)
|
* @return string The upcoming birthdays (HTML)
|
||||||
*
|
|
||||||
* @throws HTTPException\InternalServerErrorException
|
* @throws HTTPException\InternalServerErrorException
|
||||||
* @throws HTTPException\ServiceUnavailableException
|
* @throws HTTPException\ServiceUnavailableException
|
||||||
* @throws \ImagickException
|
* @throws \ImagickException
|
||||||
|
@ -583,7 +585,12 @@ class Profile
|
||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
|
|
||||||
public static function getEventsReminderHTML()
|
/**
|
||||||
|
* Renders HTML for event reminder (e.g. contact birthdays
|
||||||
|
*
|
||||||
|
* @return string Rendered HTML
|
||||||
|
*/
|
||||||
|
public static function getEventsReminderHTML(): string
|
||||||
{
|
{
|
||||||
$a = DI::app();
|
$a = DI::app();
|
||||||
$o = '';
|
$o = '';
|
||||||
|
@ -674,9 +681,9 @@ class Profile
|
||||||
*
|
*
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
public static function getMyURL()
|
public static function getMyURL(): string
|
||||||
{
|
{
|
||||||
return Session::get('my_url');
|
return Session::get('my_url') ?? '';
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -695,6 +702,8 @@ class Profile
|
||||||
* It would be favourable to harmonize the two implementations.
|
* It would be favourable to harmonize the two implementations.
|
||||||
*
|
*
|
||||||
* @param App $a Application instance.
|
* @param App $a Application instance.
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||||
* @throws \ImagickException
|
* @throws \ImagickException
|
||||||
*/
|
*/
|
||||||
|
@ -764,9 +773,10 @@ class Profile
|
||||||
* Set the visitor cookies (see remote_user()) for the given handle
|
* Set the visitor cookies (see remote_user()) for the given handle
|
||||||
*
|
*
|
||||||
* @param string $handle Visitor handle
|
* @param string $handle Visitor handle
|
||||||
|
*
|
||||||
* @return array Visitor contact array
|
* @return array Visitor contact array
|
||||||
*/
|
*/
|
||||||
public static function addVisitorCookieForHandle($handle)
|
public static function addVisitorCookieForHandle(string $handle): array
|
||||||
{
|
{
|
||||||
$a = DI::app();
|
$a = DI::app();
|
||||||
|
|
||||||
|
@ -798,9 +808,10 @@ class Profile
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the visitor cookies (see remote_user()) for signed HTTP requests
|
* Set the visitor cookies (see remote_user()) for signed HTTP requests
|
||||||
|
(
|
||||||
* @return array Visitor contact array
|
* @return array Visitor contact array
|
||||||
*/
|
*/
|
||||||
public static function addVisitorCookieForHTTPSigner()
|
public static function addVisitorCookieForHTTPSigner(): array
|
||||||
{
|
{
|
||||||
$requester = HTTPSignature::getSigner('', $_SERVER);
|
$requester = HTTPSignature::getSigner('', $_SERVER);
|
||||||
if (empty($requester)) {
|
if (empty($requester)) {
|
||||||
|
@ -815,10 +826,12 @@ class Profile
|
||||||
* Ported from Hubzilla: https://framagit.org/hubzilla/core/blob/master/include/zid.php
|
* Ported from Hubzilla: https://framagit.org/hubzilla/core/blob/master/include/zid.php
|
||||||
*
|
*
|
||||||
* @param string $token
|
* @param string $token
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||||
* @throws \ImagickException
|
* @throws \ImagickException
|
||||||
*/
|
*/
|
||||||
public static function openWebAuthInit($token)
|
public static function openWebAuthInit(string $token)
|
||||||
{
|
{
|
||||||
$a = DI::app();
|
$a = DI::app();
|
||||||
|
|
||||||
|
@ -857,23 +870,34 @@ class Profile
|
||||||
Logger::info('OpenWebAuth: auth success from ' . $visitor['addr']);
|
Logger::info('OpenWebAuth: auth success from ' . $visitor['addr']);
|
||||||
}
|
}
|
||||||
|
|
||||||
public static function zrl($s, $force = false)
|
/**
|
||||||
|
* Returns URL with URL-encoded zrl parameter
|
||||||
|
*
|
||||||
|
* @param string $url URL to enhance
|
||||||
|
* @param bool $force Either to force adding zrl parameter
|
||||||
|
*
|
||||||
|
* @return string URL with 'zrl' parameter or original URL in case of no Friendica profile URL
|
||||||
|
*/
|
||||||
|
public static function zrl(string $url, bool $force = false)
|
||||||
{
|
{
|
||||||
if (!strlen($s)) {
|
if (!strlen($url)) {
|
||||||
return $s;
|
return $url;
|
||||||
}
|
}
|
||||||
if (!strpos($s, '/profile/') && !$force) {
|
if (!strpos($url, '/profile/') && !$force) {
|
||||||
return $s;
|
return $url;
|
||||||
}
|
}
|
||||||
if ($force && substr($s, -1, 1) !== '/') {
|
if ($force && substr($url, -1, 1) !== '/') {
|
||||||
$s = $s . '/';
|
$url = $url . '/';
|
||||||
}
|
}
|
||||||
$achar = strpos($s, '?') ? '&' : '?';
|
|
||||||
|
$achar = strpos($url, '?') ? '&' : '?';
|
||||||
$mine = self::getMyURL();
|
$mine = self::getMyURL();
|
||||||
if ($mine && !Strings::compareLink($mine, $s)) {
|
|
||||||
return $s . $achar . 'zrl=' . urlencode($mine);
|
if ($mine && !Strings::compareLink($mine, $url)) {
|
||||||
|
return $url . $achar . 'zrl=' . urlencode($mine);
|
||||||
}
|
}
|
||||||
return $s;
|
|
||||||
|
return $url;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -897,15 +921,15 @@ class Profile
|
||||||
/**
|
/**
|
||||||
* search for Profiles
|
* search for Profiles
|
||||||
*
|
*
|
||||||
* @param int $start
|
* @param int $start Starting record (see LIMIT start,count)
|
||||||
* @param int $count
|
* @param int $count Maximum records (see LIMIT start,count)
|
||||||
* @param null $search
|
* @param string $search Optional search word (see LIKE %s?%s)
|
||||||
*
|
*
|
||||||
* @return array [ 'total' => 123, 'entries' => [...] ];
|
* @return array [ 'total' => 123, 'entries' => [...] ];
|
||||||
*
|
*
|
||||||
* @throws \Exception
|
* @throws \Exception
|
||||||
*/
|
*/
|
||||||
public static function searchProfiles($start = 0, $count = 100, $search = null)
|
public static function searchProfiles(int $start = 0, int $count = 100, string $search = null)
|
||||||
{
|
{
|
||||||
if (!empty($search)) {
|
if (!empty($search)) {
|
||||||
$publish = (DI::config()->get('system', 'publish_all') ? '' : "AND `publish` ");
|
$publish = (DI::config()->get('system', 'publish_all') ? '' : "AND `publish` ");
|
||||||
|
@ -946,6 +970,8 @@ class Profile
|
||||||
* Multi profiles are converted to ACl-protected custom fields and deleted.
|
* Multi profiles are converted to ACl-protected custom fields and deleted.
|
||||||
*
|
*
|
||||||
* @param array $profile One profile array
|
* @param array $profile One profile array
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
* @throws \Exception
|
* @throws \Exception
|
||||||
*/
|
*/
|
||||||
public static function migrate(array $profile)
|
public static function migrate(array $profile)
|
||||||
|
|
|
@ -276,7 +276,8 @@ class User
|
||||||
/**
|
/**
|
||||||
* Returns true if a user record exists with the provided id
|
* Returns true if a user record exists with the provided id
|
||||||
*
|
*
|
||||||
* @param integer $uid
|
* @param int $uid
|
||||||
|
*
|
||||||
* @return boolean
|
* @return boolean
|
||||||
* @throws Exception
|
* @throws Exception
|
||||||
*/
|
*/
|
||||||
|
@ -412,7 +413,7 @@ class User
|
||||||
|
|
||||||
$owner = DBA::selectFirst('owner-view', [], ['uid' => $uid]);
|
$owner = DBA::selectFirst('owner-view', [], ['uid' => $uid]);
|
||||||
if (!DBA::isResult($owner)) {
|
if (!DBA::isResult($owner)) {
|
||||||
if (!DBA::exists('user', ['uid' => $uid]) || !$repairMissing) {
|
if (!self::exists($uid) || !$repairMissing) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
if (!DBA::exists('profile', ['uid' => $uid])) {
|
if (!DBA::exists('profile', ['uid' => $uid])) {
|
||||||
|
|
Loading…
Reference in a new issue