From 6828a3b28d6872cb24c6a6449a7634c38e3d5d88 Mon Sep 17 00:00:00 2001 From: Carl Schwan Date: Fri, 25 Nov 2022 11:46:18 +0100 Subject: [PATCH] Cleanup contactsinteraction - Add more typing and use PHP 7.4 typed properties Signed-off-by: Carl Schwan --- apps/contactsinteraction/lib/AddressBook.php | 19 ++++++--------- .../lib/BackgroundJob/CleanupJob.php | 4 +--- apps/contactsinteraction/lib/Card.php | 11 +++------ .../lib/Db/CardSearchDao.php | 4 +--- .../lib/Db/RecentContact.php | 24 +++++-------------- .../lib/Db/RecentContactMapper.php | 19 +++------------ .../Listeners/ContactInteractionListener.php | 24 +++++-------------- .../Integration/ExternalAddressBook.php | 11 ++------- 8 files changed, 29 insertions(+), 87 deletions(-) diff --git a/apps/contactsinteraction/lib/AddressBook.php b/apps/contactsinteraction/lib/AddressBook.php index 1a024947362ea..518e39942d953 100644 --- a/apps/contactsinteraction/lib/AddressBook.php +++ b/apps/contactsinteraction/lib/AddressBook.php @@ -40,18 +40,13 @@ use Sabre\DAVACL\IACL; class AddressBook extends ExternalAddressBook implements IACL { - public const URI = 'recent'; - use ACLTrait; - /** @var RecentContactMapper */ - private $mapper; - - /** @var IL10N */ - private $l10n; + public const URI = 'recent'; - /** @var string */ - private $principalUri; + private RecentContactMapper $mapper; + private IL10N $l10n; + private string $principalUri; public function __construct(RecentContactMapper $mapper, IL10N $l10n, @@ -81,7 +76,7 @@ public function createFile($name, $data = null) { * @inheritDoc * @throws NotFound */ - public function getChild($name) { + public function getChild($name): Card { try { return new Card( $this->mapper->find( @@ -115,7 +110,7 @@ function (RecentContact $contact) { /** * @inheritDoc */ - public function childExists($name) { + public function childExists($name): bool { try { $this->mapper->find( $this->getUid(), @@ -160,7 +155,7 @@ public function getOwner(): string { /** * @inheritDoc */ - public function getACL() { + public function getACL(): array { return [ [ 'privilege' => '{DAV:}read', diff --git a/apps/contactsinteraction/lib/BackgroundJob/CleanupJob.php b/apps/contactsinteraction/lib/BackgroundJob/CleanupJob.php index fd370ce60e538..e728342e9b084 100644 --- a/apps/contactsinteraction/lib/BackgroundJob/CleanupJob.php +++ b/apps/contactsinteraction/lib/BackgroundJob/CleanupJob.php @@ -31,9 +31,7 @@ use OCP\BackgroundJob\TimedJob; class CleanupJob extends TimedJob { - - /** @var RecentContactMapper */ - private $mapper; + private RecentContactMapper $mapper; public function __construct(ITimeFactory $time, RecentContactMapper $mapper) { diff --git a/apps/contactsinteraction/lib/Card.php b/apps/contactsinteraction/lib/Card.php index bf4ca1f394f9b..aa73d0e2122b8 100644 --- a/apps/contactsinteraction/lib/Card.php +++ b/apps/contactsinteraction/lib/Card.php @@ -36,14 +36,9 @@ class Card implements ICard, IACL { use ACLTrait; - /** @var RecentContact */ - private $contact; - - /** @var string */ - private $principal; - - /** @var array */ - private $acls; + private RecentContact $contact; + private string $principal; + private array $acls; public function __construct(RecentContact $contact, string $principal, array $acls) { $this->contact = $contact; diff --git a/apps/contactsinteraction/lib/Db/CardSearchDao.php b/apps/contactsinteraction/lib/Db/CardSearchDao.php index 4bf9d9367c4c4..6bd6538257cb0 100644 --- a/apps/contactsinteraction/lib/Db/CardSearchDao.php +++ b/apps/contactsinteraction/lib/Db/CardSearchDao.php @@ -32,9 +32,7 @@ use function stream_get_contents; class CardSearchDao { - - /** @var IDBConnection */ - private $db; + private IDBConnection $db; public function __construct(IDBConnection $db) { $this->db = $db; diff --git a/apps/contactsinteraction/lib/Db/RecentContact.php b/apps/contactsinteraction/lib/Db/RecentContact.php index 306792b434e7f..7160ef1077ba4 100644 --- a/apps/contactsinteraction/lib/Db/RecentContact.php +++ b/apps/contactsinteraction/lib/Db/RecentContact.php @@ -42,24 +42,12 @@ * @method int getLastContact() */ class RecentContact extends Entity { - - /** @var string */ - protected $actorUid; - - /** @var string|null */ - protected $uid; - - /** @var string|null */ - protected $email; - - /** @var string|null */ - protected $federatedCloudId; - - /** @var string */ - protected $card; - - /** @var int */ - protected $lastContact; + protected string $actorUid = ''; + protected ?string $uid = null; + protected ?string $email = null; + protected ?string $federatedCloudId = null; + protected string $card = ''; + protected int $lastContact = -1; public function __construct() { $this->addType('actorUid', 'string'); diff --git a/apps/contactsinteraction/lib/Db/RecentContactMapper.php b/apps/contactsinteraction/lib/Db/RecentContactMapper.php index d606c07152ae6..49a705af570d9 100644 --- a/apps/contactsinteraction/lib/Db/RecentContactMapper.php +++ b/apps/contactsinteraction/lib/Db/RecentContactMapper.php @@ -56,10 +56,6 @@ public function findAll(string $uid): array { } /** - * @param string $uid - * @param int $id - * - * @return RecentContact * @throws DoesNotExistException */ public function find(string $uid, int $id): RecentContact { @@ -75,11 +71,6 @@ public function find(string $uid, int $id): RecentContact { } /** - * @param IUser $user - * @param string|null $uid - * @param string|null $email - * @param string|null $cloudId - * * @return RecentContact[] */ public function findMatch(IUser $user, @@ -108,11 +99,7 @@ public function findMatch(IUser $user, return $this->findEntities($select); } - /** - * @param string $uid - * @return int|null - */ - public function findLastUpdatedForUserId(string $uid):?int { + public function findLastUpdatedForUserId(string $uid): ?int { $qb = $this->db->getQueryBuilder(); $select = $qb @@ -122,7 +109,7 @@ public function findLastUpdatedForUserId(string $uid):?int { ->orderBy('last_contact', 'DESC') ->setMaxResults(1); - $cursor = $select->execute(); + $cursor = $select->executeQuery(); $row = $cursor->fetch(); if ($row === false) { @@ -139,6 +126,6 @@ public function cleanUp(int $olderThan): void { ->delete($this->getTableName()) ->where($qb->expr()->lt('last_contact', $qb->createNamedParameter($olderThan))); - $delete->execute(); + $delete->executeStatement(); } } diff --git a/apps/contactsinteraction/lib/Listeners/ContactInteractionListener.php b/apps/contactsinteraction/lib/Listeners/ContactInteractionListener.php index 333a639392067..0d776bb9fccc8 100644 --- a/apps/contactsinteraction/lib/Listeners/ContactInteractionListener.php +++ b/apps/contactsinteraction/lib/Listeners/ContactInteractionListener.php @@ -41,24 +41,12 @@ use Throwable; class ContactInteractionListener implements IEventListener { - - /** @var RecentContactMapper */ - private $mapper; - - /** @var CardSearchDao */ - private $cardSearchDao; - - /** @var IUserManager */ - private $userManager; - - /** @var ITimeFactory */ - private $timeFactory; - - /** @var IL10N */ - private $l10n; - - /** @var LoggerInterface */ - private $logger; + private RecentContactMapper $mapper; + private CardSearchDao $cardSearchDao; + private IUserManager $userManager; + private ITimeFactory $timeFactory; + private IL10N $l10n; + private LoggerInterface $logger; public function __construct(RecentContactMapper $mapper, CardSearchDao $cardSearchDao, diff --git a/apps/dav/lib/CardDAV/Integration/ExternalAddressBook.php b/apps/dav/lib/CardDAV/Integration/ExternalAddressBook.php index b1deb638f3daf..bd394cb7fb66d 100644 --- a/apps/dav/lib/CardDAV/Integration/ExternalAddressBook.php +++ b/apps/dav/lib/CardDAV/Integration/ExternalAddressBook.php @@ -50,16 +50,9 @@ abstract class ExternalAddressBook implements IAddressBook, DAV\IProperties { */ private const DELIMITER = '--'; - /** @var string */ - private $appId; - - /** @var string */ - private $uri; + private string $appId; + private string $uri; - /** - * @param string $appId - * @param string $uri - */ public function __construct(string $appId, string $uri) { $this->appId = $appId; $this->uri = $uri;