Skip to content

Commit

Permalink
updated plugins API documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Piwik Docs committed Oct 18, 2024
1 parent 9fd7779 commit 6849e7f
Show file tree
Hide file tree
Showing 15 changed files with 27 additions and 27 deletions.
8 changes: 4 additions & 4 deletions docs/5.x/generated/Piwik/Archive/ArchiveInvalidator.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,13 @@ core:archive is run, they will be processed.
- It accepts the following parameter(s):
- `$idSites`

- `$plugin` (`string`) —
- `$plugin` (`string`|`null`) —

- `$report` (`string`) —
- `$report` (`string`|`null`) —

- `$startDate` ([`Date`](../../Piwik/Date.md)) —
- `$startDate` ([`Date`](../../Piwik/Date.md)|`null`) —

- `$segment` ([`Segment`](../../Piwik/Segment.md)) —
- `$segment` ([`Segment`](../../Piwik/Segment.md)|`null`) —

- It does not return anything or a mixed result.
- It throws one of the following exceptions:
Expand Down
2 changes: 1 addition & 1 deletion docs/5.x/generated/Piwik/Columns/DimensionMetricFactory.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Generates a new dimension metric factory.

- `$documentation`

- `$semanticType` (`string`) —
- `$semanticType` (`string`|`null`) —

- It returns a `Piwik\Plugin\ArchivedMetric` value.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Creates a segment based on the dimension properties
#### Signature

- It accepts the following parameter(s):
- `$segment` ([`Segment`](../../Piwik/Plugin/Segment.md)) —
- `$segment` ([`Segment`](../../Piwik/Plugin/Segment.md)|`null`) —
optional Segment to enrich with dimension data (if properties not already set)
- It returns a [`Segment`](../../Piwik/Plugin/Segment.md) value.
- It throws one of the following exceptions:
Expand Down
4 changes: 2 additions & 2 deletions docs/5.x/generated/Piwik/DI.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ The class defines the following methods:
#### Signature

- It accepts the following parameter(s):
- `$className` (`string`) —
- `$className` (`string`|`null`) —

- It returns a `DI\Definition\Helper\CreateDefinitionHelper` value.

Expand All @@ -57,7 +57,7 @@ The class defines the following methods:
#### Signature

- It accepts the following parameter(s):
- `$className` (`string`) —
- `$className` (`string`|`null`) —

- It returns a `DI\Definition\Helper\AutowireDefinitionHelper` value.

Expand Down
2 changes: 1 addition & 1 deletion docs/5.x/generated/Piwik/Filesystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Recursively deletes a directory.
Path of the directory to delete.
- `$deleteRootToo` (`boolean`) —
If true, `$dir` is deleted, otherwise just its contents.
- `$beforeUnlink` ([`Closure`](http://php.net/class.Closure)) —
- `$beforeUnlink` ([`Closure`](http://php.net/class.Closure)|`null`) —
An optional closure to execute on a file path before unlinking.
- It does not return anything or a mixed result.

Expand Down
2 changes: 1 addition & 1 deletion docs/5.x/generated/Piwik/Metrics/Formatter.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ are found through report metadata and DataTable metadata.
- It accepts the following parameter(s):
- `$dataTable` ([`DataTable`](../../Piwik/DataTable.md)) —
The table to format metrics for.
- `$report` ([`Report`](../../Piwik/Plugin/Report.md)) —
- `$report` ([`Report`](../../Piwik/Plugin/Report.md)|`null`) —
The report the table belongs to.
- `$metricsToFormat` (`string[]`|`null`) —
Allow a list of names of metrics to format.
Expand Down
2 changes: 1 addition & 1 deletion docs/5.x/generated/Piwik/Metrics/Formatter/Html.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ are found through report metadata and DataTable metadata.
- It accepts the following parameter(s):
- `$dataTable` ([`DataTable`](../../../Piwik/DataTable.md)) —
The table to format metrics for.
- `$report` ([`Report`](../../../Piwik/Plugin/Report.md)) —
- `$report` ([`Report`](../../../Piwik/Plugin/Report.md)|`null`) —
The report the table belongs to.
- `$metricsToFormat` (`string[]`|`null`) —
Allow a list of names of metrics to format.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -685,7 +685,7 @@ campaign information for the current action is different from the last.
The current tracker request information.
- `$visitor` (`Piwik\Tracker\Visitor`) —
The information for the currently recognized visitor.
- `$action` (`Piwik\Tracker\Action`) —
- `$action` (`Piwik\Tracker\Action`|`null`) —
The current action information (if any).

- *Returns:* `bool` —
Expand Down
4 changes: 2 additions & 2 deletions docs/5.x/generated/Piwik/Plugin/Report.md
Original file line number Diff line number Diff line change
Expand Up @@ -645,7 +645,7 @@ Includes ProcessedMetrics and Metrics.
- It accepts the following parameter(s):
- `$dataTable` ([`DataTable`](../../Piwik/DataTable.md)) —

- `$report` ([`Report`](../../Piwik/Plugin/Report.md)) —
- `$report` ([`Report`](../../Piwik/Plugin/Report.md)|`null`) —

- `$baseType` (`string`) —
The base type each metric class needs to be of.
Expand All @@ -664,7 +664,7 @@ as well as the DataTable metadata.
- It accepts the following parameter(s):
- `$dataTable` ([`DataTable`](../../Piwik/DataTable.md)) —

- `$report` ([`Report`](../../Piwik/Plugin/Report.md)) —
- `$report` ([`Report`](../../Piwik/Plugin/Report.md)|`null`) —

- It returns a [`ProcessedMetric[]`](../../Piwik/Plugin/ProcessedMetric.md) value.

Expand Down
10 changes: 5 additions & 5 deletions docs/5.x/generated/Piwik/Plugin/Tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Schedule the given tasks/method to run once every hour.

- `$priority`

- `$ttlInSeconds` (`int`) —
- `$ttlInSeconds` (`int`|`null`) —

- It returns a [`Schedule`](../../Piwik/Scheduler/Schedule/Schedule.md) value.

Expand All @@ -56,7 +56,7 @@ See [hourly()](/api-reference/Piwik/Plugin/Tasks#hourly)

- `$priority`

- `$ttlInSeconds` (`int`) —
- `$ttlInSeconds` (`int`|`null`) —

- It does not return anything or a mixed result.

Expand All @@ -77,7 +77,7 @@ See [hourly()](/api-reference/Piwik/Plugin/Tasks#hourly)

- `$priority`

- `$ttlInSeconds` (`int`) —
- `$ttlInSeconds` (`int`|`null`) —

- It does not return anything or a mixed result.

Expand All @@ -98,7 +98,7 @@ See [hourly()](/api-reference/Piwik/Plugin/Tasks#hourly)

- `$priority`

- `$ttlInSeconds` (`int`) —
- `$ttlInSeconds` (`int`|`null`) —

- It does not return anything or a mixed result.

Expand All @@ -123,7 +123,7 @@ either an instance of a class or a class name. For more information about these

- `$priority`

- `$ttlInSeconds` (`int`) —
- `$ttlInSeconds` (`int`|`null`) —

- It returns a [`Schedule`](../../Piwik/Scheduler/Schedule/Schedule.md) value.
- It throws one of the following exceptions:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ are found through report metadata and DataTable metadata.
- It accepts the following parameter(s):
- `$dataTable` ([`DataTable`](../../../../../Piwik/DataTable.md)) —
The table to format metrics for.
- `$report` ([`Report`](../../../../../Piwik/Plugin/Report.md)) —
- `$report` ([`Report`](../../../../../Piwik/Plugin/Report.md)|`null`) —
The report the table belongs to.
- `$metricsToFormat` (`string[]`|`null`) —
Allow a list of names of metrics to format.
Expand Down
2 changes: 1 addition & 1 deletion docs/5.x/generated/Piwik/Scheduler/Task.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The class defines the following methods:
A Schedule instance that describes when the method should be executed and how long before the next execution.
- `$priority` (`int`) —
The priority of the task. Tasks with a higher priority will be executed first. Tasks with low priority will be executed last.
- `$ttlInSeconds` (`int`) —
- `$ttlInSeconds` (`int`|`null`) —
TTL to use for this task. Defauts to 3600. See self::$ttlInSeconds
- It throws one of the following exceptions:
- [`Exception`](http://php.net/class.Exception)
Expand Down
4 changes: 2 additions & 2 deletions docs/5.x/generated/Piwik/Segment.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,9 @@ joins the according tables, but trigger a php warning as results might be incorr
The segment condition, eg, `'browserCode=ff;countryCode=CA'`.
- `$idSites` (`array`) —
The list of sites the segment will be used with. Some segments are dependent on the site, such as goal segments.
- `$startDate` ([`Date`](../Piwik/Date.md)) —
- `$startDate` ([`Date`](../Piwik/Date.md)|`null`) —
start date used to limit subqueries
- `$endDate` ([`Date`](../Piwik/Date.md)) —
- `$endDate` ([`Date`](../Piwik/Date.md)|`null`) —
end date used to limit subqueries
- It throws one of the following exceptions:
- ``
Expand Down
6 changes: 3 additions & 3 deletions docs/5.x/generated/Piwik/Translation/Translator.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The class defines the following methods:
- It accepts the following parameter(s):
- `$loader` (`Piwik\Translation\Loader\LoaderInterface`) —

- `$directories` (`array`) —
- `$directories` (`array`|`null`) —


<a name="clean" id="clean"></a>
Expand Down Expand Up @@ -80,7 +80,7 @@ Converts the given list of items into a listing (e.g. One, Two, and Three)
- It accepts the following parameter(s):
- `$items` (`array`) &mdash;

- `$language` (`string`) &mdash;
- `$language` (`string`|`null`) &mdash;

- It returns a `string` value.

Expand All @@ -95,7 +95,7 @@ Converts the given list of items into a or listing (e.g. One, Two, or Three)
- It accepts the following parameter(s):
- `$items` (`array`) &mdash;

- `$language` (`string`) &mdash;
- `$language` (`string`|`null`) &mdash;

- It returns a `string` value.

Expand Down
2 changes: 1 addition & 1 deletion docs/5.x/generated/renderer.index

Large diffs are not rendered by default.

0 comments on commit 6849e7f

Please sign in to comment.