Accumulator
in package
uses
FactoryTrait
FinalYes
Factories for Aggregation Pipeline Accumulator and Window Operators
Tags
Table of Contents
Methods
- outputWindow() : OutputWindow
- __construct() : mixed
Methods
outputWindow()
public
static outputWindow(Document|Serializable|WindowInterface|array<string, mixed>|stdClass $operator[, Optional|array{string|int, string|int} $documents = Optional::Undefined ][, Optional|array{string|(numeric), string|(numeric)} $range = Optional::Undefined ][, Optional|non-empty-string $unit = Optional::Undefined ]) : OutputWindow
Parameters
- $operator : Document|Serializable|WindowInterface|array<string, mixed>|stdClass
-
Window operator to use in the $setWindowFields stage.
- $documents : Optional|array{string|int, string|int} = Optional::Undefined
-
A window where the lower and upper boundaries are specified relative to the position of the current document read from the collection.
- $range : Optional|array{string|(numeric), string|(numeric)} = Optional::Undefined
-
Arguments passed to the init function.
- $unit : Optional|non-empty-string = Optional::Undefined
-
Specifies the units for time range window boundaries. If omitted, default numeric range window boundaries are used.
Return values
OutputWindow__construct()
private
__construct() : mixed