Updated API documentation (#1082)

Author: lachiebol

API.php

@@ -409,7 +409,7 @@ public function getContainerTags($idSite, $idContainer, $idContainerVersion)
      *
      * Note: If the current site already has a default container, another default container will be created.
      *
-     * @param int $idSite
+     * @param int $idSite The id of the site that the container will be created for
      * @return string The ID of the created container.
      */
     public function createDefaultContainerForSite($idSite)
@@ -500,6 +500,7 @@ public function createDefaultContainerForSite($idSite)
      * @param null|string $startDate     Optional, a start date to ensure the tag will be only executed after this date. Please provide the date in UTC.
      * @param null|string $endDate       Optional, an end date to ensure the tag will not be executed after this date. Please provide the date in UTC.
      * @param null|string $description   Optional description
+     * @param string $status Optional status to set when creating the tag.
      *
      * @return int The ID of the created tag.
      */
@@ -743,7 +744,7 @@ public function getContainerTriggers($idSite, $idContainer, $idContainerVersion)
      * @param int $idContainerVersion The ID of the container version, a container may have multiple versions and
      *                                the list of triggers will be different per container. Therefore you need to provide
      *                                the ID of the version you are referring to.
-     * @param int $type The type of trigger you want create, for example "AllElements".
+     * @param string $type The type of trigger you want create, for example "AllElements".
      * @param string $name   The name this trigger should have
      * @param array $parameters  A key/value pair to define values for specific parameters. For example array('parameterName' => 'value')
      * @param array[] $conditions An array containing one or multiple conditions to filter when a trigger will be triggered. For example:
@@ -786,6 +787,7 @@ public function addContainerTrigger($idSite, $idContainer, $idContainerVersion,
      *                            array(array('actual' => 'VARIABLENAME', 'comparison' => 'equals', 'expected' => 'expectedValue'))
      *                           To get a list of available comparisons, call {@link TagManager.getAvailableComparisons}
      * @param null|string $description   Optional description
+     * @return null
      */
     public function updateContainerTrigger($idSite, $idContainer, $idContainerVersion, $idTrigger, $name, $parameters = [], $conditions = [], $description = '')
     {
@@ -815,6 +817,7 @@ public function updateContainerTrigger($idSite, $idContainer, $idContainerVersio
      *                                the list of trigger will be different per container. Therefore you need to provide
      *                                the ID of the version you are referring to.
      * @param int $idTrigger The id of the trigger you want to delete.
+     * @return void
      */
     public function deleteContainerTrigger($idSite, $idContainer, $idContainerVersion, $idTrigger)
     {
@@ -953,7 +956,7 @@ public function getAvailableContainerVariables($idSite, $idContainer, $idContain
      * @param string $type        The type of variable you want to create.
      * @param string $name   The name this variable should have
      * @param array $parameters  A key/value pair to define values for specific parameters. For example array('parameterName' => 'value')
-     * @param null|string $defaultValue   Optionally a default value
+     * @param false|null|string $defaultValue Optionally a default value.
      * @param array[] $lookupTable An array containing one or multiple lookup configurations. For example:
      *                             array(array('match_value' => 'inval', 'comparison' => 'equals', 'out_value' => 'outval'))
      *                             For a list of available comparisons see {@link TagManager.getAvailableComparisons}
@@ -1012,6 +1015,7 @@ private function forceDeleteVariable($idSite, $idContainerVersion, $idVariable)
      *                             array(array('match_value' => 'inval', 'comparison' => 'equals', 'out_value' => 'outval'))
      *                             For a list of available comparisons see {@link TagManager.getAvailableComparisons}
      * @param null|string $description   Optional description
+     * @return null
      */
     public function updateContainerVariable($idSite, $idContainer, $idContainerVersion, $idVariable, $name, $parameters = [], $defaultValue = null, $lookupTable = [], $description = '')
     {
@@ -1059,6 +1063,7 @@ public function updateContainerVariable($idSite, $idContainer, $idContainerVersi
      *                                the list of variable will be different per container. Therefore you need to provide
      *                                the ID of the version you are referring to.
      * @param int $idVariable The id of the variable you want to delete.
+     * @return void
      */
     public function deleteContainerVariable($idSite, $idContainer, $idContainerVersion, $idVariable)
     {
@@ -1158,8 +1163,8 @@ public function updateContainer($idSite, $idContainer, $name, $description = '',
      * @param string $idContainer  The id of a container, for example "6OMh6taM"
      * @param string $name   The name this version should have
      * @param string $description Optionally the description this version should have
-     * @param null $idContainerVersion By default a new version based on the current draft version will be created. However,
-     *                                 You can also create a new version from a previously created version.
+     * @param int|null $idContainerVersion By default, a new version based on the current draft version will be created.
+     *                                     You can also create a new version from a previously created version.
      * @return int  The ID of the created version.
      */
     public function createContainerVersion($idSite, $idContainer, $name, $description = '', $idContainerVersion = null)
@@ -1387,7 +1392,6 @@ public function disablePreviewMode($idSite, $idContainer)
      * Updates the debug siteurl cookie
      *
      * @param int $idSite The id of the site the given container belongs to
-     * @param string $idContainer  The id of a container, for example "6OMh6taM"
      * @param string $url  The url to enable debug
      */
     public function changeDebugUrl($idSite, $url)
@@ -1447,7 +1451,7 @@ public function exportContainerVersion($idSite, $idContainer, $idContainerVersio
      * @param string $idContainer  The id of a container, for example "6OMh6taM"
      * @param string $backupName   If specified, a backup of the current draft will be created under this version name.
      * @param bool $_isDraftRestoreCall A boolean parameter to specify, if its a backup restore call to avoid nesting exception if backup version has errors
-     * @return array
+     * @return void
      */
     public function importContainerVersion($exportedContainerVersion, $idSite, $idContainer, $backupName = '', bool $_isDraftRestoreCall = false)
     {

CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Changelog
 
+0.2.7 - 02/03/2026
+
+*  Updated API documentation
+
 0.2.6
 
 * Fix changing name of variable causes removing trigger in a tag

phpstan.neon

@@ -0,0 +1,21 @@
+parameters:
+    level: 1
+    phpVersion: 70200
+    tmpDir: /tmp/phpstan/TagManager/main
+    paths:
+        - .
+    excludePaths:
+        - tests/*
+        - vendor/
+        - github-action-tests/
+    bootstrapFiles:
+        - ../../bootstrap-phpstan.php
+    universalObjectCratesClasses:
+        - Piwik\Config
+        - Piwik\View
+        - Piwik\ViewDataTable\Config
+    scanDirectories:
+        # ../../ does not actually seem to give us anything
+        # that ../plugins/ does not, but including it for
+        # completeness.  It does not seem to slow down performance.
+        - ../../