cs

matomo-org · Sep 4, 2024 · ad894e4 · ad894e4
1 parent 9a929aa
commit ad894e4
Showing 1 changed file with 6 additions and 6 deletions.
diff --git a/plugins/Annotations/API.php b/plugins/Annotations/API.php
@@ -70,11 +70,11 @@ public function add(int $idSite, string $date, string $note, bool $starred = fal
      *    created the note
      *
      * @param int $idSite The site ID to add the annotation to.
-     * @param string $idNote The ID of the note.
+     * @param int $idNote The ID of the note.
      * @param string|null $date The date the annotation is attached to. If null, the annotation's
      *                          date is not modified.
-     * @param string|null $note The text of the annotation. If null, the annotation's text
-     *                          is not modified.
+     * @param string|null $note The text of the annotation (max 255 chars).
+     *                          If null, the annotation's text is not modified.
      * @param bool|null $starred Whether the annotation should be starred.
      *                           If null, the annotation is not starred/un-starred, so the current state won't change.
      * @return array Returns an array of two elements. The first element (indexed by
@@ -172,7 +172,7 @@ public function get(int $idSite, int $idNote): array
      * The date range is specified by a date, the period type (day/week/month/year)
      * and an optional number of N periods in the past to include.
      *
-     * @param string $idSite The site ID to add the annotation to. Can be one ID or
+     * @param string $idSite The site ID to get annotations for. Can be one ID or
      *                       a list of site IDs.
      * @param null|string $date The date of the period.
      * @param string $period The period type.
@@ -240,7 +240,7 @@ public function getAnnotationCountForDates(
         }
 
         // create list of dates
-        $dates = array();
+        $dates = [];
         for (; $startDate->getTimestamp() <= $endDate->getTimestamp(); $startDate = $startDate->addPeriod(1, $period)) {
             $dates[] = $startDate;
         }
@@ -251,7 +251,7 @@ public function getAnnotationCountForDates(
         $annotations = new AnnotationList($idSite);
 
         // create result w/ 0-counts
-        $result = array();
+        $result = [];
         for ($i = 0; $i != count($dates) - 1; ++$i) {
             $date = $dates[$i];
             $nextDate = $dates[$i + 1];