File size: 4,375 Bytes
1a49063 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 | <?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Plugins\Annotations;
use Piwik\Common;
use Piwik\Db;
/**
* @phpstan-type Annotation array{id:int, idsite:int, date:string, note:string, starred:int, user:string}
*/
class Model
{
private const TABLE_NAME = 'annotations';
private const EDITABLE_COLS = ['note', 'date', 'starred'];
/** @var string */
private $table;
public function __construct()
{
$this->table = Common::prefixTable(self::TABLE_NAME);
}
/**
* @param array<string,mixed> $annotation
*/
public function createAnnotation(array $annotation): int
{
$db = $this->getDb();
$db->insert($this->table, $annotation);
return (int) $db->lastInsertId();
}
/**
* @return Annotation|array{}
*/
public function getAnnotation(int $annotationId, int $idSite): array
{
$db = $this->getDb();
$query = "SELECT * FROM $this->table WHERE id = ? AND idsite = ?";
$bind = [$annotationId, $idSite];
return $db->fetchRow($query, $bind) ?: [];
}
/**
* @return list<Annotation>
*/
public function getAllAnnotationsForSiteInRange(int $idSite, ?string $startDate = null, ?string $endDate = null, ?int $limit = null): array
{
$db = $this->getDb();
$query = "SELECT * FROM $this->table WHERE idsite = ?";
$bind = [
$idSite,
];
if (null !== $startDate) {
$query .= " AND date >= ?";
$bind[] = $startDate;
}
if (null !== $endDate) {
$query .= " AND date <= ?";
$bind[] = $endDate;
}
if (null !== $limit) {
$query .= " LIMIT $limit";
}
return $db->fetchAll($query, $bind);
}
/**
* @return array{int, int}
*/
public function getCountAnnotationsForSiteInRange(int $idSite, string $startDate, string $endDate): array
{
$db = $this->getDb();
$query = "SELECT
SUM(1) AS cnt_total,
SUM(CASE WHEN starred = 1 THEN 1 ELSE 0 END) AS cnt_starred
FROM $this->table
WHERE idsite = ? AND date >= ? AND date < ?";
$bind = [
$idSite,
$startDate,
$endDate,
];
$result = $db->fetchRow($query, $bind);
return [intval($result['cnt_total'] ?? 0), intval($result['cnt_starred'] ?? 0)];
}
/**
* Update existing annotation with provided data
*
* @param int $annotationId id of the annotation being updated
* @param int $idSite the site of the annotation
* @param array<string,string|int|bool> $updatedColumns an associative array containing columns to update,
* only columns matching $this->getEditableColumns() are used.
* @return Annotation the updated annotation
*/
public function updateAnnotation(int $annotationId, int $idSite, array $updatedColumns): array
{
$db = $this->getDb();
$query = "UPDATE $this->table SET";
$bind = [];
foreach (self::EDITABLE_COLS as $columnName) {
if (isset($updatedColumns[$columnName])) {
$query .= " $columnName = ?,";
$bind[] = $updatedColumns[$columnName];
}
}
$query = rtrim($query, ',');
$query .= " WHERE id = ? AND idsite = ?";
$bind[] = $annotationId;
$bind[] = $idSite;
$db->query($query, $bind);
return $this->getAnnotation($annotationId, $idSite);
}
public function deleteAnnotation(int $annotationId, int $idsite): void
{
$db = $this->getDb();
$query = "DELETE FROM $this->table WHERE id = ? AND idsite = ?";
$bind = [$annotationId, $idsite];
$db->query($query, $bind);
}
public function deleteAllAnnotationsForSite(int $idSite): void
{
$db = $this->getDb();
$query = "DELETE FROM $this->table WHERE idsite = ?";
$bind = [$idSite];
$db->query($query, $bind);
}
/**
* @return Db|Db\AdapterInterface|\Zend_Db_Adapter_Abstract
*/
private function getDb()
{
return Db::get();
}
}
|