3 * @copyright Copyright (C) 2010-2021, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Contact\Introduction\Depository;
24 use Friendica\BaseDepository;
25 use Friendica\Contact\Introduction\Exception\IntroductionNotFoundException;
26 use Friendica\Contact\Introduction\Exception\IntroductionPersistenceException;
27 use Friendica\Contact\Introduction\Collection;
28 use Friendica\Contact\Introduction\Entity;
29 use Friendica\Contact\Introduction\Factory;
30 use Friendica\Database\Database;
31 use Friendica\Network\HTTPException\NotFoundException;
32 use Friendica\Util\DateTimeFormat;
33 use Psr\Log\LoggerInterface;
35 class Introduction extends BaseDepository
37 /** @var Factory\Introduction */
40 protected static $table_name = 'intro';
42 public function __construct(Database $database, LoggerInterface $logger, Factory\Introduction $factory)
44 parent::__construct($database, $logger, $factory);
48 * @param array $condition
49 * @param array $params
51 * @return Entity\Introduction
53 * @throws NotFoundException the underlying exception if there's no Introduction with the given conditions
55 private function selectOne(array $condition, array $params = []): Entity\Introduction
57 return parent::_selectOne($condition, $params);
61 * Converts a given Introduction into a DB compatible row array
63 * @param Entity\Introduction $introduction
67 protected function convertToTableRow(Entity\Introduction $introduction): array
70 'uid' => $introduction->uid,
71 'contact-id' => $introduction->cid,
72 'suggest-cid' => $introduction->sid,
73 'knowyou' => $introduction->knowyou ? 1 : 0,
74 'duplex' => $introduction->duplex ? 1 : 0,
75 'note' => $introduction->note,
76 'hash' => $introduction->hash,
77 'ignore' => $introduction->ignore ? 1 : 0,
78 'datetime' => $introduction->datetime->format(DateTimeFormat::MYSQL),
86 * @return Entity\Introduction
88 * @throws IntroductionNotFoundException in case there is no Introduction with this id
90 public function selectOneById(int $id, int $uid): Entity\Introduction
93 return $this->selectOne(['id' => $id, 'uid' => $uid]);
94 } catch (NotFoundException $exception) {
95 throw new IntroductionNotFoundException(sprintf('There is no Introduction with the ID %d for the user %d', $id, $uid), $exception);
100 * Selects introductions for a given user
103 * @param int|null $min_id
104 * @param int|null $max_id
107 * @return Collection\Introductions
109 public function selectForUser(int $uid, int $min_id = null, int $max_id = null, int $limit = self::LIMIT): Collection\Introductions
112 $BaseCollection = parent::_selectByBoundaries(
113 ['`uid = ?` AND NOT `ignore`',$uid],
114 ['order' => ['id' => 'DESC']],
115 $min_id, $max_id, $limit);
116 } catch (\Exception $e) {
117 throw new IntroductionPersistenceException(sprintf('Cannot select Introductions for used %d', $uid), $e);
120 return new Collection\Introductions($BaseCollection->getArrayCopy(), $BaseCollection->getTotalCount());
124 * Selects the introduction for a given contact
128 * @return Entity\Introduction
130 * @throws IntroductionNotFoundException in case there is not Introduction for this contact
132 public function selectForContact(int $cid): Entity\Introduction
135 return $this->selectOne(['contact-id' => $cid]);
136 } catch (NotFoundException $exception) {
137 throw new IntroductionNotFoundException(sprintf('There is no Introduction for the contact %d', $cid), $exception);
141 public function countActiveForUser($uid, array $params = []): int
144 return $this->count(['ignore' => false, 'uid' => $uid], $params);
145 } catch (\Exception $e) {
146 throw new IntroductionPersistenceException(sprintf('Cannot count Introductions for used %d', $uid), $e);
150 public function existsForContact(int $cid, int $uid): bool
153 return $this->exists(['uid' => $uid, 'suggest-cid' => $cid]);
154 } catch (\Exception $e) {
155 throw new IntroductionPersistenceException(sprintf('Cannot check Introductions for contact %d and user %d', $cid, $uid), $e);
160 * @param Entity\Introduction $introduction
164 * @throws IntroductionPersistenceException in case the underlying storage cannot delete the Introduction
166 public function delete(Entity\Introduction $introduction): bool
168 if (!$introduction->id) {
173 return $this->db->delete(self::$table_name, ['id' => $introduction->id]);
174 } catch (\Exception $e) {
175 throw new IntroductionPersistenceException(sprintf('Cannot delete Introduction with id %d', $introduction->id), $e);
180 * @param Entity\Introduction $introduction
182 * @return Entity\Introduction
184 * @throws IntroductionPersistenceException In case the underlying storage cannot save the Introduction
186 public function save(Entity\Introduction $introduction): Entity\Introduction
189 $fields = $this->convertToTableRow($introduction);
191 if ($introduction->id) {
192 $this->db->update(self::$table_name, $fields, ['id' => $introduction->id]);
193 return $this->factory->createFromTableRow($fields);
195 $this->db->insert(self::$table_name, $fields);
196 return $this->selectOneById($this->db->lastInsertId(), $introduction->uid);
198 } catch (\Exception $exception) {
199 throw new IntroductionPersistenceException(sprintf('Cannot insert/update the Introduction %d for user %d', $introduction->id, $introduction->uid), $exception);