X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FModel%2FGroup.php;h=eb4008184f943d1242ba30663352e1896f75acf3;hb=459f28776d015f44e9a449363b190f8a0dada5d5;hp=da77335f12ed944a515bf26d74be052aadde0644;hpb=9c6f6bcb95213186a364ba00672c1f3c9556b85d;p=friendica.git

diff --git a/src/Model/Group.php b/src/Model/Group.php
index da77335f12..eb4008184f 100644
--- a/src/Model/Group.php
+++ b/src/Model/Group.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * @copyright Copyright (C) 2010-2022, the Friendica project
+ * @copyright Copyright (C) 2010-2023, the Friendica project
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -39,7 +39,14 @@ class Group
 	const FOLLOWERS = '~';
 	const MUTUALS = '&';
 
-	public static function getByUserId($uid, $includesDeleted = false)
+	/**
+	 * Fetches group record by user id and maybe includes deleted groups as well
+	 *
+	 * @param int  $uid User id to fetch group(s) for
+	 * @param bool $includesDeleted Whether deleted groups should be included
+	 * @return array|bool Array on success, bool on error
+	 */
+	public static function getByUserId(int $uid, bool $includesDeleted = false)
 	{
 		$conditions = ['uid' => $uid, 'cid' => null];
 
@@ -51,15 +58,18 @@ class Group
 	}
 
 	/**
-	 * @param int $group_id
+	 * Checks whether given group id is found in database
+	 *
+	 * @param int $group_id Groupd it
+	 * @param int $uid Optional user id
 	 * @return bool
 	 * @throws \Exception
 	 */
-	public static function exists($group_id, $uid = null)
+	public static function exists(int $group_id, int $uid = null): bool
 	{
 		$condition = ['id' => $group_id, 'deleted' => false];
 
-		if (isset($uid)) {
+		if (!is_null($uid)) {
 			$condition = [
 				'uid' => $uid
 			];
@@ -73,12 +83,12 @@ class Group
 	 *
 	 * Note: If we found a deleted group with the same name, we restore it
 	 *
-	 * @param int    $uid
-	 * @param string $name
-	 * @return boolean
+	 * @param int    $uid User id to create group for
+	 * @param string $name Name of group
+	 * @return int|boolean Id of newly created group or false on error
 	 * @throws \Exception
 	 */
-	public static function create($uid, $name)
+	public static function create(int $uid, string $name)
 	{
 		$return = false;
 		if (!empty($uid) && !empty($name)) {
@@ -92,7 +102,7 @@ class Group
 				$group = DBA::selectFirst('group', ['deleted'], ['id' => $gid]);
 				if (DBA::isResult($group) && $group['deleted']) {
 					DBA::update('group', ['deleted' => 0], ['id' => $gid]);
-					notice(DI::l10n()->t('A deleted group with this name was revived. Existing item permissions <strong>may</strong> apply to this group and any future members. If this is not what you intended, please create another group with a different name.'));
+					DI::sysmsg()->addNotice(DI::l10n()->t('A deleted group with this name was revived. Existing item permissions <strong>may</strong> apply to this group and any future members. If this is not what you intended, please create another group with a different name.'));
 				}
 				return true;
 			}
@@ -114,7 +124,7 @@ class Group
 	 * @return bool Was the update successful?
 	 * @throws \Exception
 	 */
-	public static function update($id, $name)
+	public static function update(int $id, string $name): bool
 	{
 		return DBA::update('group', ['name' => $name], ['id' => $id]);
 	}
@@ -122,31 +132,35 @@ class Group
 	/**
 	 * Get a list of group ids a contact belongs to
 	 *
-	 * @param int $cid
-	 * @return array
+	 * @param int $cid Contact id
+	 * @return array Group ids
 	 * @throws \Exception
 	 */
-	public static function getIdsByContactId($cid)
+	public static function getIdsByContactId(int $cid): array
 	{
-		$return = [];
+		$contact = Contact::getById($cid, ['rel']);
+		if (!$contact) {
+			return [];
+		}
+
+		$groupIds = [];
 
 		$stmt = DBA::select('group_member', ['gid'], ['contact-id' => $cid]);
 		while ($group = DBA::fetch($stmt)) {
-			$return[] = $group['gid'];
+			$groupIds[] = $group['gid'];
 		}
 		DBA::close($stmt);
 
 		// Meta-groups
-		$contact = Contact::getById($cid, ['rel']);
 		if ($contact['rel'] == Contact::FOLLOWER || $contact['rel'] == Contact::FRIEND) {
-			$return[] = self::FOLLOWERS;
+			$groupIds[] = self::FOLLOWERS;
 		}
 
 		if ($contact['rel'] == Contact::FRIEND) {
-			$return[] = self::MUTUALS;
+			$groupIds[] = self::MUTUALS;
 		}
 
-		return $return;
+		return $groupIds;
 	}
 
 	/**
@@ -173,8 +187,8 @@ class Group
 					) AS `count`
 				FROM `group`
 				WHERE `group`.`uid` = ?;",
-			local_user(),
-			local_user()
+			DI::userSession()->getLocalUserId(),
+			DI::userSession()->getLocalUserId()
 		);
 
 		return DBA::toArray($stmt);
@@ -185,12 +199,12 @@ class Group
 	 *
 	 * Returns false if no group has been found.
 	 *
-	 * @param int    $uid
-	 * @param string $name
-	 * @return int|boolean
+	 * @param int    $uid User id
+	 * @param string $name Group name
+	 * @return int|boolean Groups' id number or false on error
 	 * @throws \Exception
 	 */
-	public static function getIdByName($uid, $name)
+	public static function getIdByName(int $uid, string $name)
 	{
 		if (!$uid || !strlen($name)) {
 			return false;
@@ -211,7 +225,7 @@ class Group
 	 * @return boolean
 	 * @throws \Exception
 	 */
-	public static function remove($gid)
+	public static function remove(int $gid): bool
 	{
 		if (!$gid) {
 			return false;
@@ -314,13 +328,14 @@ class Group
 	 * Adds contacts to a group
 	 *
 	 * @param int $gid
-	 * @param array $contacts
+	 * @param array $contacts Array with contact ids
+	 * @return void
 	 * @throws \Exception
 	 */
 	public static function addMembers(int $gid, array $contacts)
 	{
 		if (!$gid || !$contacts) {
-			return false;
+			return;
 		}
 
 		// @TODO Backward compatibility with user contacts, remove by version 2022.03
@@ -342,8 +357,9 @@ class Group
 	/**
 	 * Removes contacts from a group
 	 *
-	 * @param int $gid
-	 * @param array $contacts
+	 * @param int $gid Group id
+	 * @param array $contacts Contact ids
+	 * @return bool
 	 * @throws \Exception
 	 */
 	public static function removeMembers(int $gid, array $contacts)
@@ -358,26 +374,31 @@ class Group
 			throw new HTTPException\NotFoundException('Group not found.');
 		}
 
+		$contactIds = [];
+
 		foreach ($contacts as $cid) {
 			$cdata = Contact::getPublicAndUserContactID($cid, $group['uid']);
 			if (empty($cdata['user'])) {
 				throw new HTTPException\NotFoundException('Invalid contact.');
 			}
 
-			DBA::delete('group_member', ['gid' => $gid, 'contact-id' => $cdata['user']]);
+			$contactIds[] = $cdata['user'];
 		}
+
+		// Return status of deletion
+		return DBA::delete('group_member', ['gid' => $gid, 'contact-id' => $contactIds]);
 	}
 
 	/**
 	 * Returns the combined list of contact ids from a group id list
 	 *
-	 * @param int     $uid
-	 * @param array   $group_ids
-	 * @param boolean $check_dead
+	 * @param int     $uid User id
+	 * @param array   $group_ids Groups ids
+	 * @param boolean $check_dead Whether check "dead" records (?)
 	 * @return array
 	 * @throws \Exception
 	 */
-	public static function expand($uid, array $group_ids, $check_dead = false)
+	public static function expand(int $uid, array $group_ids, bool $check_dead = false): array
 	{
 		if (!is_array($group_ids) || !count($group_ids)) {
 			return [];
@@ -450,13 +471,13 @@ class Group
 	/**
 	 * Returns a templated group selection list
 	 *
-	 * @param int    $uid
+	 * @param int    $uid User id
 	 * @param int    $gid   An optional pre-selected group
 	 * @param string $label An optional label of the list
 	 * @return string
 	 * @throws \Exception
 	 */
-	public static function displayGroupSelection($uid, $gid = 0, $label = '')
+	public static function displayGroupSelection(int $uid, int $gid = 0, string $label = ''): string
 	{
 		$display_groups = [
 			[
@@ -498,14 +519,14 @@ class Group
 	 *    'standard' => include link 'Edit groups'
 	 *    'extended' => include link 'Create new group'
 	 *    'full' => include link 'Create new group' and provide for each group a link to edit this group
-	 * @param string $group_id
-	 * @param int    $cid
-	 * @return string
+	 * @param string|int $group_id Distinct group id or 'everyone'
+	 * @param int    $cid Contact id
+	 * @return string Sidebar widget HTML code
 	 * @throws \Exception
 	 */
-	public static function sidebarWidget($every = 'contact', $each = 'group', $editmode = 'standard', $group_id = '', $cid = 0)
+	public static function sidebarWidget(string $every = 'contact', string $each = 'group', string $editmode = 'standard', $group_id = '', int $cid = 0)
 	{
-		if (!local_user()) {
+		if (!DI::userSession()->getLocalUserId()) {
 			return '';
 		}
 
@@ -523,7 +544,7 @@ class Group
 			$member_of = self::getIdsByContactId($cid);
 		}
 
-		$stmt = DBA::select('group', [], ['deleted' => false, 'uid' => local_user(), 'cid' => null], ['order' => ['name']]);
+		$stmt = DBA::select('group', [], ['deleted' => false, 'uid' => DI::userSession()->getLocalUserId(), 'cid' => null], ['order' => ['name']]);
 		while ($group = DBA::fetch($stmt)) {
 			$selected = (($group_id == $group['id']) ? ' group-selected' : '');
 
@@ -585,7 +606,7 @@ class Group
 	 * @param integer $id Contact ID
 	 * @return integer Group IO
 	 */
-	public static function getIdForForum(int $id)
+	public static function getIdForForum(int $id): int
 	{
 		Logger::info('Get id for forum id', ['id' => $id]);
 		$contact = Contact::getById($id, ['uid', 'name', 'contact-type', 'manually-approve']);
@@ -613,6 +634,7 @@ class Group
 	 * Fetch the followers of a given contact id and store them as group members
 	 *
 	 * @param integer $id Contact ID
+	 * @return void
 	 */
 	public static function updateMembersForForum(int $id)
 	{