* @param array $fields Array of selected fields, empty for all
* @param array $condition Array of fields for condition
* @param array $params Array of several parameters
- * @return array
+ * @return array|bool
* @throws \Exception
*/
- public static function selectFirst(array $fields = [], array $condition = [], array $params = []): array
+ public static function selectFirst(array $fields = [], array $condition = [], array $params = [])
{
$contact = DBA::selectFirst('contact', $fields, $condition, $params);
* @throws HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
- public static function isFollowerByURL(string $url, uid $uid): bool
+ public static function isFollowerByURL(string $url, int $uid): bool
{
$cid = self::getIdForURL($url, $uid);
* Check if the given contact ID is on the same server
*
* @param string $url The contact link
- *
* @return boolean Is it the same server?
*/
public static function isLocalById(int $cid): bool
*
* @param int $cid Either public contact id or user's contact id
* @param int $uid User ID
- *
* @return array with public and user's contact id
* @throws HTTPException\InternalServerErrorException
* @throws \ImagickException
* @param int $cid A contact ID
* @param int $uid The User ID
* @param array $fields The selected fields for the contact
- *
* @return array The contact details
*
* @throws \Exception
*/
- public static function getContactForUser($cid, $uid, array $fields = [])
+ public static function getContactForUser(int $cid, int $uid, array $fields = []): array
{
$contact = DBA::selectFirst('contact', $fields, ['id' => $cid, 'uid' => $uid]);
* @return bool Operation success
* @throws HTTPException\InternalServerErrorException
*/
- public static function createSelfFromUserId($uid)
+ public static function createSelfFromUserId(int $uid): bool
{
$user = DBA::selectFirst('user', ['uid', 'username', 'nickname', 'pubkey', 'prvkey'],
['uid' => $uid, 'account_expired' => false]);
/**
* Updates the self-contact for the provided user id
*
- * @param int $uid
- * @param boolean $update_avatar Force the avatar update
- * @return bool "true" if updated
+ * @param int $uid
+ * @param bool $update_avatar Force the avatar update
+ * @return bool "true" if updated
* @throws HTTPException\InternalServerErrorException
*/
- public static function updateSelfFromUserID($uid, $update_avatar = false)
+ public static function updateSelfFromUserID(int $uid, bool $update_avatar = false): bool
{
$fields = ['id', 'uri-id', 'name', 'nick', 'location', 'about', 'keywords', 'avatar', 'prvkey', 'pubkey', 'manually-approve',
'xmpp', 'matrix', 'contact-type', 'forum', 'prv', 'avatar-date', 'url', 'nurl', 'unsearchable',
* Marks a contact for removal
*
* @param int $id contact id
+ * @return void
* @throws HTTPException\InternalServerErrorException
*/
- public static function remove($id)
+ public static function remove(int $id)
{
// We want just to make sure that we don't delete our "self" contact
$contact = DBA::selectFirst('contact', ['uri-id', 'photo', 'thumb', 'micro', 'uid'], ['id' => $id, 'self' => false]);
* Unfollow the remote contact
*
* @param array $contact Target user-specific contact (uid != 0) array
+ * @return void
* @throws HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
* The local relationship is updated immediately, the eventual remote server is messaged in the background.
*
* @param array $contact User-specific contact array (uid != 0) to revoke the follow from
+ * @return void
* @throws HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
* Completely severs a relationship with a contact
*
* @param array $contact User-specific contact (uid != 0) array
+ * @return void
* @throws HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
* up or some other transient event and that there's a possibility we could recover from it.
*
* @param array $contact contact to mark for archival
- * @return null
+ * @return void
* @throws HTTPException\InternalServerErrorException
*/
public static function markForArchival(array $contact)
* @see Contact::markForArchival()
*
* @param array $contact contact to be unmarked for archival
- * @return null
+ * @return void
* @throws \Exception
*/
public static function unmarkForArchival(array $contact)
* @throws HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
- public static function photoMenu(array $contact, $uid = 0)
+ public static function photoMenu(array $contact, int $uid = 0): array
{
$pm_url = '';
$status_link = '';
* @throws HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
- public static function getIdForURL($url, $uid = 0, $update = null, $default = [])
+ public static function getIdForURL(string $url = null, int $uid = 0, $update = null, array $default = []): int
{
$contact_id = 0;
- if ($url == '') {
+ if (empty($url)) {
Logger::notice('Empty url, quitting', ['url' => $url, 'user' => $uid, 'default' => $default]);
return 0;
}
$contact = self::getByURL($url, false, ['id', 'network', 'uri-id'], $uid);
if (!empty($contact)) {
- $contact_id = $contact["id"];
+ $contact_id = $contact['id'];
if (empty($update) && (!empty($contact['uri-id']) || is_bool($update))) {
Logger::debug('Contact found', ['url' => $url, 'uid' => $uid, 'update' => $update, 'cid' => $contact_id]);
$data = [];
if (empty($default['network']) || $update) {
- $data = Probe::uri($url, "", $uid);
+ $data = Probe::uri($url, '', $uid);
// Take the default values when probing failed
- if (!empty($default) && !in_array($data["network"], array_merge(Protocol::NATIVE_SUPPORT, [Protocol::PUMPIO]))) {
+ if (!empty($default) && !in_array($data['network'], array_merge(Protocol::NATIVE_SUPPORT, [Protocol::PUMPIO]))) {
$data = array_merge($data, $default);
}
} elseif (!empty($default['network'])) {
* @return boolean Is the contact archived?
* @throws HTTPException\InternalServerErrorException
*/
- public static function isArchived(int $cid)
+ public static function isArchived(int $cid): bool
{
if ($cid == 0) {
return false;
* Checks if the contact is blocked
*
* @param int $cid contact id
- *
* @return boolean Is the contact blocked?
* @throws HTTPException\InternalServerErrorException
*/
- public static function isBlocked($cid)
+ public static function isBlocked(int $cid): bool
{
if ($cid == 0) {
return false;
* Checks if the contact is hidden
*
* @param int $cid contact id
- *
* @return boolean Is the contact hidden?
* @throws \Exception
*/
- public static function isHidden($cid)
+ public static function isHidden(int $cid): bool
{
if ($cid == 0) {
return false;
* @return string posts in HTML
* @throws \Exception
*/
- public static function getPostsFromUrl($contact_url, $thread_mode = false, $update = 0, $parent = 0, bool $only_media = false)
+ public static function getPostsFromUrl(string $contact_url, bool $thread_mode = false, int $update = 0, int $parent = 0, bool $only_media = false): string
{
return self::getPostsFromId(self::getIdForURL($contact_url), $thread_mode, $update, $parent, $only_media);
}
* @return string posts in HTML
* @throws \Exception
*/
- public static function getPostsFromId($cid, $thread_mode = false, $update = 0, $parent = 0, bool $only_media = false)
+ public static function getPostsFromId(int $cid, bool $thread_mode = false, int $update = 0, int $parent = 0, bool $only_media = false): string
{
$contact = DBA::selectFirst('contact', ['contact-type', 'network'], ['id' => $cid]);
if (!DBA::isResult($contact)) {
* @param int $type type of contact or account
* @return string
*/
- public static function getAccountType(int $type)
+ public static function getAccountType(int $type): string
{
switch ($type) {
case self::TYPE_ORGANISATION:
/**
* Blocks a contact
*
- * @param int $cid
- * @return bool
- * @throws \Exception
+ * @param int $cid Contact id to block
+ * @param string $reason Block reason
+ * @return bool Whether it was successful
*/
- public static function block($cid, $reason = null)
+ public static function block(int $cid, string $reason = null): bool
{
$return = self::update(['blocked' => true, 'block_reason' => $reason], ['id' => $cid]);
/**
* Unblocks a contact
*
- * @param int $cid
- * @return bool
- * @throws \Exception
+ * @param int $cid Contact id to unblock
+ * @return bool Whether it was successfull
*/
- public static function unblock($cid)
+ public static function unblock(int $cid): bool
{
$return = self::update(['blocked' => false, 'block_reason' => null], ['id' => $cid]);
/**
* Ensure that cached avatar exist
*
- * @param integer $cid
+ * @param integer $cid Contact id
*/
public static function checkAvatarCache(int $cid)
{
* @param bool $no_update Don't perfom an update if no cached avatar was found
* @return string photo path
*/
- private static function getAvatarPath(array $contact, string $size, $no_update = false)
+ private static function getAvatarPath(array $contact, string $size, bool $no_update = false): string
{
$contact = self::checkAvatarCacheByArray($contact, $no_update);
* @param bool $no_update Don't perfom an update if no cached avatar was found
* @return string photo path
*/
- public static function getPhoto(array $contact, bool $no_update = false)
+ public static function getPhoto(array $contact, bool $no_update = false): string
{
return self::getAvatarPath($contact, Proxy::SIZE_SMALL, $no_update);
}
* @param bool $no_update Don't perfom an update if no cached avatar was found
* @return string photo path
*/
- public static function getThumb(array $contact, bool $no_update = false)
+ public static function getThumb(array $contact, bool $no_update = false): string
{
return self::getAvatarPath($contact, Proxy::SIZE_THUMB, $no_update);
}
* @param bool $no_update Don't perfom an update if no cached avatar was found
* @return string photo path
*/
- public static function getMicro(array $contact, bool $no_update = false)
+ public static function getMicro(array $contact, bool $no_update = false): string
{
return self::getAvatarPath($contact, Proxy::SIZE_MICRO, $no_update);
}
* @param bool $no_update Don't perfom an update if no cached avatar was found
* @return array contact array with avatar cache fields
*/
- private static function checkAvatarCacheByArray(array $contact, bool $no_update = false)
+ private static function checkAvatarCacheByArray(array $contact, bool $no_update = false): array
{
$update = false;
$contact_fields = [];
* @param string $size Size of the avatar picture
* @return string avatar URL
*/
- public static function getDefaultAvatar(array $contact, string $size)
+ public static function getDefaultAvatar(array $contact, string $size): string
{
switch ($size) {
case Proxy::SIZE_MICRO:
* @param string $updated Contact update date
* @return string avatar link
*/
- public static function getAvatarUrlForId(int $cid, string $size = '', string $updated = '', string $guid = ''):string
+ public static function getAvatarUrlForId(int $cid, string $size = '', string $updated = '', string $guid = ''): string
{
// We have to fetch the "updated" variable when it wasn't provided
// The parameter can be provided to improve performance
* @param string $size One of the Proxy::SIZE_* constants
* @return string avatar link
*/
- public static function getAvatarUrlForUrl(string $url, int $uid, string $size = ''):string
+ public static function getAvatarUrlForUrl(string $url, int $uid, string $size = ''): string
{
$condition = ["`nurl` = ? AND ((`uid` = ? AND `network` IN (?, ?)) OR `uid` = ?)",
Strings::normaliseLink($url), $uid, Protocol::FEED, Protocol::MAIL, 0];
* @param string $updated Contact update date
* @return string header link
*/
- public static function getHeaderUrlForId(int $cid, string $size = '', string $updated = '', string $guid = ''):string
+ public static function getHeaderUrlForId(int $cid, string $size = '', string $updated = '', string $guid = ''): string
{
// We have to fetch the "updated" variable when it wasn't provided
// The parameter can be provided to improve performance
}
/**
+ * Updates contact record by provided id and optional network
+ *
* @param integer $id contact id
* @param string $network Optional network we are probing for
* @return boolean
}
/**
+ * Updates contact record by provided id and probed data
+ *
* @param integer $id contact id
* @param array $ret Probed data
* @return boolean
* @throws HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
- private static function updateFromProbeArray(int $id, array $ret)
+ private static function updateFromProbeArray(int $id, array $ret): bool
{
/*
Warning: Never ever fetch the public key via Probe::uri and write it into the contacts.
}
/**
+ * Updates contact record by provided URL
+ *
* @param integer $url contact url
* @return integer Contact id
* @throws HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
- public static function updateFromProbeByURL($url)
+ public static function updateFromProbeByURL(string $url): int
{
$id = self::getIdForURL($url);
* @param string $network Network of that contact
* @return string with protocol
*/
- public static function getProtocol($url, $network)
+ public static function getProtocol(string $url, string $network): string
{
if ($network != Protocol::DFRN) {
return $network;
* Update the local relationship when a local user loses a follower
*
* @param array $contact User-specific contact (uid != 0) array
+ * @return void
* @throws HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
projects / friendica.git / blobdiff