nextcloud / circles

lib/Service/SharingFrameService.php

Doc Comments +2 added lines, -2 removed lines

@@ -181,7 +181,7 @@ 
 	 *
 	 * @param SharingFrame $frame
 	 * @param DeprecatedCircle $circle
-	 * @param $broadcast
+	 * @param string|null $broadcast
 	 */
 	private function generateHeaders(SharingFrame $frame, DeprecatedCircle $circle, $broadcast) {
 
@@ -220,7 +220,7 @@ 
 	 * Please use getFrameFromCircle();
 	 *
 	 * @param string $circleUniqueId
-	 * @param $viewerId
+	 * @param string $viewerId
 	 *
 	 * @return SharingFrame[]
 	 * @throws CircleDoesNotExistException

lib/Service/CirclesService.php

Spacing +5 added lines, -5 removed lines

@@ -569,24 +569,24 @@
 		switch ($type) {
 			case DeprecatedCircle::CIRCLES_PERSONAL:
 				return $urlGen->getAbsoluteURL(
-					$urlGen->imagePath(Application::APP_ID, 'personal' . $ext)
+					$urlGen->imagePath(Application::APP_ID, 'personal'.$ext)
 				);
 			case DeprecatedCircle::CIRCLES_CLOSED:
 				return $urlGen->getAbsoluteURL(
-					$urlGen->imagePath(Application::APP_ID, 'closed' . $ext)
+					$urlGen->imagePath(Application::APP_ID, 'closed'.$ext)
 				);
 			case DeprecatedCircle::CIRCLES_SECRET:
 				return $urlGen->getAbsoluteURL(
-					$urlGen->imagePath(Application::APP_ID, 'secret' . $ext)
+					$urlGen->imagePath(Application::APP_ID, 'secret'.$ext)
 				);
 			case DeprecatedCircle::CIRCLES_PUBLIC:
 				return $urlGen->getAbsoluteURL(
-					$urlGen->imagePath(Application::APP_ID, 'black_circle' . $ext)
+					$urlGen->imagePath(Application::APP_ID, 'black_circle'.$ext)
 				);
 		}
 
 		return $urlGen->getAbsoluteURL(
-			$urlGen->imagePath(Application::APP_ID, 'black_circle' . $ext)
+			$urlGen->imagePath(Application::APP_ID, 'black_circle'.$ext)
 		);
 	}
 

lib/Model/BaseCircle.php

Doc Comments +4 added lines, -4 removed lines

@@ -467,7 +467,7 @@ 
 	}
 
 	/**
-	 * @return string
+	 * @return integer
 	 */
 	public function getType() {
 		return $this->type;
@@ -521,7 +521,7 @@ 
 	}
 
 	/**
-	 * @return array
+	 * @return DeprecatedMember[]
 	 */
 	public function getGroups() {
 		return $this->groups;
@@ -539,7 +539,7 @@ 
 	}
 
 	/**
-	 * @return array
+	 * @return FederatedLink[]
 	 */
 	public function getLinks() {
 		return $this->links;
@@ -575,7 +575,7 @@ 
 //	}
 
 	/**
-	 * @param integer|string $type
+	 * @param string $type
 	 *
 	 * @return integer
 	 */

lib/Model/DeprecatedCircle.php

Doc Comments +1 added lines, -1 removed lines

@@ -178,7 +178,7 @@
 
 	/**
 	 * @param array $arr
-	 * @param $key
+	 * @param string $key
 	 * @param int $type
 	 *
 	 * @return null|DeprecatedMember

Spacing +1 added lines, -1 removed lines

@@ -292,7 +292,7 @@
 	 * @return int
 	 */
 	public static function convertTypeToConfig(int $type): int {
-		switch($type) {
+		switch ($type) {
 			case DeprecatedCircle::CIRCLES_PERSONAL:
 				return 2;
 			case DeprecatedCircle::CIRCLES_SECRET:

lib/Model/DeprecatedMember.php

Doc Comments +3 added lines

@@ -41,6 +41,9 @@
 class DeprecatedMember extends BaseMember {
 
 
+	/**
+	 * @param integer $circleType
+	 */
 	public function inviteToCircle($circleType) {
 
 		if ($circleType === 0) {

lib/Service/GroupsService.php

Doc Comments +6 added lines, -6 removed lines

@@ -109,7 +109,7 @@ 
 	 * @param string $circleUniqueId
 	 * @param string $groupId
 	 *
-	 * @return array
+	 * @return DeprecatedMember[]
 	 * @throws \Exception
 	 */
 	public function linkGroup($circleUniqueId, $groupId) {
@@ -165,8 +165,8 @@ 
 	/**
 	 * Check if a fresh member can be generated (by linkGroup)
 	 *
-	 * @param $circleId
-	 * @param $groupId
+	 * @param string $circleId
+	 * @param string $groupId
 	 *
 	 * @return null|DeprecatedMember
 	 * @throws MemberAlreadyExistsException
@@ -202,7 +202,7 @@ 
 	 * @param string $groupId
 	 * @param int $level
 	 *
-	 * @return array
+	 * @return DeprecatedMember[]
 	 * @throws \Exception
 	 */
 	public function levelGroup($circleUniqueId, $groupId, $level) {
@@ -243,7 +243,7 @@ 
 	/**
 	 * @param DeprecatedCircle $circle
 	 * @param DeprecatedMember $group
-	 * @param $level
+	 * @param integer $level
 	 *
 	 * @throws \Exception
 	 */
@@ -270,7 +270,7 @@ 
 	 * @param string $circleUniqueId
 	 * @param string $groupId
 	 *
-	 * @return array
+	 * @return DeprecatedMember[]
 	 * @throws \Exception
 	 */
 	public function unlinkGroup($circleUniqueId, $groupId) {

lib/Service/MembersService.php

Doc Comments +7 added lines, -7 removed lines

@@ -349,8 +349,8 @@ 
 	/**
 	 * Verify if a local account is valid.
 	 *
-	 * @param $ident
-	 * @param $type
+	 * @param string $ident
+	 * @param integer $type
 	 *
 	 * @param string $instance
 	 *
@@ -401,8 +401,8 @@ 
 	/**
 	 * Verify if a contact exist in current user address books.
 	 *
-	 * @param $ident
-	 * @param $type
+	 * @param string $ident
+	 * @param integer $type
 	 *
 	 * @throws NoUserException
 	 * @throws EmailAccountInvalidFormatException
@@ -494,8 +494,8 @@ 
 	 * Will return any data of a user related to a circle (as a Member). User can be a 'non-member'
 	 * Viewer needs to be at least Member of the Circle
 	 *
-	 * @param $circleId
-	 * @param $userId
+	 * @param string $circleId
+	 * @param string $userId
 	 * @param $type
 	 * @param bool $forceAll
 	 *
@@ -551,7 +551,7 @@ 
 	 * @param int $level
 	 * @param bool $force
 	 *
-	 * @return array
+	 * @return DeprecatedMember[]
 	 * @throws CircleDoesNotExistException
 	 * @throws CircleTypeNotValidException
 	 * @throws ConfigNoCircleAvailableException

lib/Service/DavService.php

Spacing +38 added lines, -38 removed lines

@@ -164,7 +164,7 @@ 
 	public function onDeleteCard(GenericEvent $event) {
 		$davCard = $this->generateDavCard($event, true);
 
-		$this->miscService->log('Deleting Card: ' . json_encode($davCard), 1);
+		$this->miscService->log('Deleting Card: '.json_encode($davCard), 1);
 		$this->membersRequest->removeMembersByContactId($davCard->getUniqueId(), DeprecatedMember::TYPE_USER);
 		$this->manageDeprecatedCircles($davCard->getAddressBookId());
 		$this->manageDeprecatedMembers($davCard);
@@ -205,7 +205,7 @@ 
 	 */
 	private function generateDavCardFromCard(int $bookId, array $card): DavCard {
 		$this->miscService->log(
-			'generating DavCard Model from book=' . $bookId . ' from ' . json_encode($card), 0
+			'generating DavCard Model from book='.$bookId.' from '.json_encode($card), 0
 		);
 
 		$davCard = new DavCard();
@@ -215,7 +215,7 @@ 
 		$davCard->setOwner($this->getOwnerFromAddressBook($bookId));
 		$davCard->importFromDav($card['carddata']);
 
-		$this->miscService->log('generated DavCard Model: ' . json_encode($davCard), 0);
+		$this->miscService->log('generated DavCard Model: '.json_encode($davCard), 0);
 
 		return $davCard;
 	}
@@ -226,7 +226,7 @@ 
 	 *
 	 */
 	private function manageDavCard(DavCard $davCard) {
-		$this->miscService->log('Updating Card: ' . json_encode($davCard), 1);
+		$this->miscService->log('Updating Card: '.json_encode($davCard), 1);
 		$this->manageCircles($davCard);
 		$this->manageContact($davCard);
 	}
@@ -260,7 +260,7 @@ 
 	 */
 	private function manageDeprecatedMembers(DavCard $davCard) {
 		$this->miscService->log(
-			'Managing deprecated circles memberships from DavCard Model: ' . json_encode($davCard), 0
+			'Managing deprecated circles memberships from DavCard Model: '.json_encode($davCard), 0
 		);
 
 		$circles = array_map(
@@ -271,13 +271,13 @@ 
 
 		$members = $this->membersRequest->getMembersByContactId($davCard->getUniqueId());
 		$this->miscService->log(
-			'Found ' . sizeof($members) . ' memberships with contactId=' . $davCard->getUniqueId(), 0
+			'Found '.sizeof($members).' memberships with contactId='.$davCard->getUniqueId(), 0
 		);
 
 		foreach ($members as $member) {
 			if (!in_array($member->getCircleId(), $circles)) {
 				$this->miscService->log(
-					'Removing membership ' . $member->getMemberId() . ' from ' . $member->getCircleId(), 0
+					'Removing membership '.$member->getMemberId().' from '.$member->getCircleId(), 0
 				);
 				$this->membersRequest->removeMember($member);
 			}
@@ -357,7 +357,7 @@ 
 			}
 		}
 
-		$davCard->setUserId($davCard->getOwner() . ':' . $davCard->getContactId());
+		$davCard->setUserId($davCard->getOwner().':'.$davCard->getContactId());
 
 		return DavCard::TYPE_CONTACT;
 	}
@@ -402,7 +402,7 @@ 
 		);
 
 		$this->miscService->log(
-			'manage Circles from DavCard: ' . json_encode($fromCard) . ' - current: ' . json_encode($current)
+			'manage Circles from DavCard: '.json_encode($fromCard).' - current: '.json_encode($current)
 		);
 
 		$this->manageNewCircles($davCard, $fromCard, $current);
@@ -425,7 +425,7 @@ 
 
 			$user = $this->userManager->get($davCard->getOwner());
 			$circle = new DeprecatedCircle(
-				$this->configService->contactsBackendType(), $group . ' - ' . $user->getDisplayName()
+				$this->configService->contactsBackendType(), $group.' - '.$user->getDisplayName()
 			);
 			$circle->setAltName($group);
 			$circle->generateUniqueId();
@@ -433,7 +433,7 @@ 
 			$circle->setContactGroupName($group);
 
 			$this->miscService->log(
-				'creating new Circle: ' . json_encode($circle) . ', with owner=' . $davCard->getOwner(), 0
+				'creating new Circle: '.json_encode($circle).', with owner='.$davCard->getOwner(), 0
 			);
 			try {
 				$this->circlesRequest->createCircle($circle);
@@ -442,7 +442,7 @@ 
 				$owner->setStatus(DeprecatedMember::STATUS_MEMBER);
 				$this->membersService->updateCachedName($owner);
 
-				$this->miscService->log('creating new Member: ' . json_encode($owner), 0);
+				$this->miscService->log('creating new Member: '.json_encode($owner), 0);
 				try {
 					$this->membersRequest->createMember($owner);
 				} catch (MemberAlreadyExistsException $e) {
@@ -457,7 +457,7 @@ 
 	 * @param DavCard $davCard
 	 */
 	private function assignCirclesToCard(DavCard $davCard) {
-		$this->miscService->log('assigning Circles to DavCard Model: ' . json_encode($davCard), 0);
+		$this->miscService->log('assigning Circles to DavCard Model: '.json_encode($davCard), 0);
 		foreach ($davCard->getGroups() as $group) {
 			try {
 				$davCard->addCircle(
@@ -467,7 +467,7 @@ 
 			}
 		}
 
-		$this->miscService->log('assigned Circles to DavCard Model: ' . json_encode($davCard), 0);
+		$this->miscService->log('assigned Circles to DavCard Model: '.json_encode($davCard), 0);
 	}
 
 
@@ -512,12 +512,12 @@ 
 	 * @return string
 	 */
 	public function getOwnerFromAddressBook(int $bookId): string {
-		$this->miscService->log('Retrieving Owner from book:' . $bookId, 0);
+		$this->miscService->log('Retrieving Owner from book:'.$bookId, 0);
 		$data = $this->cardDavBackend->getAddressBookById($bookId);
 
 		// let's assume the format is principals/users/OWNER
 		$owner = substr($data['principaluri'], 17);
-		$this->miscService->log('Retrieved Owner:' . $owner, 0);
+		$this->miscService->log('Retrieved Owner:'.$owner, 0);
 
 		return $owner;
 	}
@@ -534,12 +534,12 @@ 
 		$this->manageDeprecatedContacts();
 		$this->manageDeprecatedCircles();
 		$users = $this->userManager->search('');
-		$this->miscService->log('initiating migration for ' . sizeof($users) . ' users', 0);
+		$this->miscService->log('initiating migration for '.sizeof($users).' users', 0);
 		foreach ($users as $user) {
-			$this->miscService->log('retrieving books for user=' . $user->getUID(), 0);
-			$books = $this->cardDavBackend->getAddressBooksForUser('principals/users/' . $user->getUID());
+			$this->miscService->log('retrieving books for user='.$user->getUID(), 0);
+			$books = $this->cardDavBackend->getAddressBooksForUser('principals/users/'.$user->getUID());
 
-			$this->miscService->log('initiating migration for user=' . $user->getUID(), 0);
+			$this->miscService->log('initiating migration for user='.$user->getUID(), 0);
 			foreach ($books as $book) {
 				$this->migrateBook($book['id']);
 			}
@@ -552,16 +552,16 @@ 
 	private function manageDeprecatedContacts() {
 		$contacts = $this->membersRequest->getMembersByContactId();
 		$this->miscService->log(
-			'Managing Deprecated Contacts, checking ' . sizeof($contacts) . ' known contacts in database', 0
+			'Managing Deprecated Contacts, checking '.sizeof($contacts).' known contacts in database', 0
 		);
 
 		foreach ($contacts as $contact) {
 			try {
 				$this->getDavCardFromMember($contact);
-				$this->miscService->log('Contact is not deprecated: ' . json_encode($contact));
+				$this->miscService->log('Contact is not deprecated: '.json_encode($contact));
 			} catch (MemberDoesNotExistException $e) {
 				$this->miscService->log(
-					'Contact is deprecated and will be removed: ' . json_encode($contact)
+					'Contact is deprecated and will be removed: '.json_encode($contact)
 				);
 				$this->membersRequest->removeMember($contact);
 			}
@@ -576,12 +576,12 @@ 
 	 */
 	private function manageDeprecatedCircles(int $bookId = 0) {
 		$knownBooks = [$bookId];
-		$this->miscService->log('Managing Deprecated Circles, using bookId: ' . $bookId, 0);
+		$this->miscService->log('Managing Deprecated Circles, using bookId: '.$bookId, 0);
 
 		if ($bookId > 0) {
 			$knownBooks = [];
 			$contacts = $this->membersRequest->getMembersByContactId();
-			$this->miscService->log(sizeof($contacts) . ' known members as contacts in Circles DB', 0);
+			$this->miscService->log(sizeof($contacts).' known members as contacts in Circles DB', 0);
 
 			foreach ($contacts as $contact) {
 				list($bookId,) = explode('/', $contact->getContactId(), 2);
@@ -593,17 +593,17 @@ 
 			}
 		}
 
-		$this->miscService->log('Known books: ' . json_encode($knownBooks), 0);
+		$this->miscService->log('Known books: '.json_encode($knownBooks), 0);
 		foreach ($knownBooks as $bookId) {
-			$this->miscService->log('retrieving local Circles data for bookId=' . $bookId, 0);
+			$this->miscService->log('retrieving local Circles data for bookId='.$bookId, 0);
 			$circles = $this->circlesRequest->getFromContactBook($bookId);
 			$this->miscService->log(
-				'Known circles for bookId=' . $bookId . ': ' . json_encode($circles), 0
+				'Known circles for bookId='.$bookId.': '.json_encode($circles), 0
 			);
 
 			$fromBook = $this->getExistingCirclesFromBook($bookId);
 			$this->miscService->log(
-				'Generated circles from bookId=' . $bookId . ': ' . json_encode($fromBook), 0
+				'Generated circles from bookId='.$bookId.': '.json_encode($fromBook), 0
 			);
 
 			foreach ($circles as $circle) {
@@ -612,7 +612,7 @@ 
 				}
 
 				$this->miscService->log(
-					$circle->getUniqueId() . ' is a deprecated Circle and will be destroyed', 0
+					$circle->getUniqueId().' is a deprecated Circle and will be destroyed', 0
 				);
 
 				$this->membersRequest->removeAllFromCircle($circle->getUniqueId());
@@ -634,7 +634,7 @@ 
 		$cards = $this->cardDavBackend->getCards($bookId);
 
 		$this->miscService->log(
-			'retrieving existing circles from bookId=' . $bookId . ' in ' . sizeof($cards) . ' cards', 0
+			'retrieving existing circles from bookId='.$bookId.' in '.sizeof($cards).' cards', 0
 		);
 		foreach ($cards as $card) {
 			$davCard = $this->generateDavCardFromCard($bookId, $card);
@@ -642,7 +642,7 @@ 
 			$circles = array_merge($circles, $davCard->getCircles());
 		}
 
-		$this->miscService->log('Found ' . sizeof($circles) . ' Circles from book=' . $bookId, 0);
+		$this->miscService->log('Found '.sizeof($circles).' Circles from book='.$bookId, 0);
 		$existing = array_unique(
 			array_map(
 				function(DeprecatedCircle $circle) {
@@ -652,7 +652,7 @@ 
 		);
 
 		$this->miscService->log(
-			'retrieved existing circles from book=' . $bookId . ': ' . json_encode($existing), 0
+			'retrieved existing circles from book='.$bookId.': '.json_encode($existing), 0
 		);
 
 		return $existing;
@@ -667,14 +667,14 @@ 
 	 */
 	public function getDavCardFromMember(DeprecatedMember $contact): DavCard {
 		list($bookId, $cardUri) = explode('/', $contact->getContactId(), 2);
-		$this->miscService->log('Retrieving DavCard from book:' . $bookId . ', uri:' . $cardUri, 0);
+		$this->miscService->log('Retrieving DavCard from book:'.$bookId.', uri:'.$cardUri, 0);
 
 		$cards = $this->cardDavBackend->getCards($bookId);
-		$this->miscService->log('Book contains ' . sizeof($cards) . ' cards', 0);
+		$this->miscService->log('Book contains '.sizeof($cards).' cards', 0);
 		foreach ($cards as $card) {
 			if ($card['uri'] === $cardUri) {
 				$davCard = $this->generateDavCardFromCard($bookId, $card);
-				$this->miscService->log('Retrieved DavCard: ' . json_encode($card));
+				$this->miscService->log('Retrieved DavCard: '.json_encode($card));
 
 				return $davCard;
 			}
@@ -692,11 +692,11 @@ 
 			return;
 		}
 
-		$this->miscService->log('migrating book: ' . $bookId, 0);
+		$this->miscService->log('migrating book: '.$bookId, 0);
 		$owner = $this->getOwnerFromAddressBook($bookId);
 
 		$cards = $this->cardDavBackend->getCards($bookId);
-		$this->miscService->log('found ' . sizeof($cards) . 'cards from book=' . $bookId, 0);
+		$this->miscService->log('found '.sizeof($cards).'cards from book='.$bookId, 0);
 
 		foreach ($cards as $card) {
 			$davCard = new DavCard();

lib/Migration/ImportOwncloudCustomGroups.php

Spacing +1 added lines, -1 removed lines

@@ -148,7 +148,7 @@
 				continue;
 			}
 
-			$level = (int) $row['role'] === 1 ? DeprecatedMember::LEVEL_OWNER : DeprecatedMember::LEVEL_MEMBER;
+			$level = (int)$row['role'] === 1 ? DeprecatedMember::LEVEL_OWNER : DeprecatedMember::LEVEL_MEMBER;
 
 			if ($level === DeprecatedMember::LEVEL_OWNER) {
 				if (isset($this->circleHasAdmin[$this->circlesById[$row['group_id']]])) {