diff --git a/generator/src/OperatorGenerator.php b/generator/src/OperatorGenerator.php index ccb1b8a..0b9c607 100644 --- a/generator/src/OperatorGenerator.php +++ b/generator/src/OperatorGenerator.php @@ -95,11 +95,6 @@ final protected function getAcceptedTypes(ArgumentDefinition $arg): stdClass $use = []; foreach ($nativeTypes as $key => $typeName) { - // strings cannot be empty - if ($typeName === 'string') { - $docTypes[$key] = 'non-empty-string'; - } - if (interface_exists($typeName) || class_exists($typeName)) { $use[] = $nativeTypes[$key] = '\\' . $typeName; $docTypes[$key] = $this->splitNamespaceAndClassName($typeName)[1]; diff --git a/src/Builder/Accumulator/AccumulatorAccumulator.php b/src/Builder/Accumulator/AccumulatorAccumulator.php index b4219ce..a12b57c 100644 --- a/src/Builder/Accumulator/AccumulatorAccumulator.php +++ b/src/Builder/Accumulator/AccumulatorAccumulator.php @@ -32,35 +32,35 @@ class AccumulatorAccumulator implements AccumulatorInterface, OperatorInterface { public const ENCODE = Encode::Object; - /** @var Javascript|non-empty-string $init Function used to initialize the state. The init function receives its arguments from the initArgs array expression. You can specify the function definition as either BSON type Code or String. */ + /** @var Javascript|string $init Function used to initialize the state. The init function receives its arguments from the initArgs array expression. You can specify the function definition as either BSON type Code or String. */ public readonly Javascript|string $init; - /** @var Javascript|non-empty-string $accumulate Function used to accumulate documents. The accumulate function receives its arguments from the current state and accumulateArgs array expression. The result of the accumulate function becomes the new state. You can specify the function definition as either BSON type Code or String. */ + /** @var Javascript|string $accumulate Function used to accumulate documents. The accumulate function receives its arguments from the current state and accumulateArgs array expression. The result of the accumulate function becomes the new state. You can specify the function definition as either BSON type Code or String. */ public readonly Javascript|string $accumulate; /** @var BSONArray|PackedArray|ResolvesToArray|array $accumulateArgs Arguments passed to the accumulate function. You can use accumulateArgs to specify what field value(s) to pass to the accumulate function. */ public readonly PackedArray|ResolvesToArray|BSONArray|array $accumulateArgs; - /** @var Javascript|non-empty-string $merge Function used to merge two internal states. merge must be either a String or Code BSON type. merge returns the combined result of the two merged states. For information on when the merge function is called, see Merge Two States with $merge. */ + /** @var Javascript|string $merge Function used to merge two internal states. merge must be either a String or Code BSON type. merge returns the combined result of the two merged states. For information on when the merge function is called, see Merge Two States with $merge. */ public readonly Javascript|string $merge; - /** @var non-empty-string $lang The language used in the $accumulator code. */ + /** @var string $lang The language used in the $accumulator code. */ public readonly string $lang; /** @var Optional|BSONArray|PackedArray|ResolvesToArray|array $initArgs Arguments passed to the init function. */ public readonly Optional|PackedArray|ResolvesToArray|BSONArray|array $initArgs; - /** @var Optional|Javascript|non-empty-string $finalize Function used to update the result of the accumulation. */ + /** @var Optional|Javascript|string $finalize Function used to update the result of the accumulation. */ public readonly Optional|Javascript|string $finalize; /** - * @param Javascript|non-empty-string $init Function used to initialize the state. The init function receives its arguments from the initArgs array expression. You can specify the function definition as either BSON type Code or String. - * @param Javascript|non-empty-string $accumulate Function used to accumulate documents. The accumulate function receives its arguments from the current state and accumulateArgs array expression. The result of the accumulate function becomes the new state. You can specify the function definition as either BSON type Code or String. + * @param Javascript|string $init Function used to initialize the state. The init function receives its arguments from the initArgs array expression. You can specify the function definition as either BSON type Code or String. + * @param Javascript|string $accumulate Function used to accumulate documents. The accumulate function receives its arguments from the current state and accumulateArgs array expression. The result of the accumulate function becomes the new state. You can specify the function definition as either BSON type Code or String. * @param BSONArray|PackedArray|ResolvesToArray|array $accumulateArgs Arguments passed to the accumulate function. You can use accumulateArgs to specify what field value(s) to pass to the accumulate function. - * @param Javascript|non-empty-string $merge Function used to merge two internal states. merge must be either a String or Code BSON type. merge returns the combined result of the two merged states. For information on when the merge function is called, see Merge Two States with $merge. - * @param non-empty-string $lang The language used in the $accumulator code. + * @param Javascript|string $merge Function used to merge two internal states. merge must be either a String or Code BSON type. merge returns the combined result of the two merged states. For information on when the merge function is called, see Merge Two States with $merge. + * @param string $lang The language used in the $accumulator code. * @param Optional|BSONArray|PackedArray|ResolvesToArray|array $initArgs Arguments passed to the init function. - * @param Optional|Javascript|non-empty-string $finalize Function used to update the result of the accumulation. + * @param Optional|Javascript|string $finalize Function used to update the result of the accumulation. */ public function __construct( Javascript|string $init, diff --git a/src/Builder/Accumulator/AddToSetAccumulator.php b/src/Builder/Accumulator/AddToSetAccumulator.php index 02a2029..08bda8c 100644 --- a/src/Builder/Accumulator/AddToSetAccumulator.php +++ b/src/Builder/Accumulator/AddToSetAccumulator.php @@ -26,11 +26,11 @@ class AddToSetAccumulator implements AccumulatorInterface, WindowInterface, Oper { public const ENCODE = Encode::Single; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public function __construct(Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression) { diff --git a/src/Builder/Accumulator/BottomAccumulator.php b/src/Builder/Accumulator/BottomAccumulator.php index b2337de..c8408ba 100644 --- a/src/Builder/Accumulator/BottomAccumulator.php +++ b/src/Builder/Accumulator/BottomAccumulator.php @@ -31,12 +31,12 @@ class BottomAccumulator implements AccumulatorInterface, WindowInterface, Operat /** @var Document|Serializable|array|stdClass $sortBy Specifies the order of results, with syntax similar to $sort. */ public readonly Document|Serializable|stdClass|array $sortBy; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $output Represents the output for each element in the group and can be any expression. */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $output Represents the output for each element in the group and can be any expression. */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $output; /** * @param Document|Serializable|array|stdClass $sortBy Specifies the order of results, with syntax similar to $sort. - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $output Represents the output for each element in the group and can be any expression. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $output Represents the output for each element in the group and can be any expression. */ public function __construct( Document|Serializable|stdClass|array $sortBy, diff --git a/src/Builder/Accumulator/BottomNAccumulator.php b/src/Builder/Accumulator/BottomNAccumulator.php index 004f6a0..47e5185 100644 --- a/src/Builder/Accumulator/BottomNAccumulator.php +++ b/src/Builder/Accumulator/BottomNAccumulator.php @@ -36,13 +36,13 @@ class BottomNAccumulator implements AccumulatorInterface, WindowInterface, Opera /** @var Document|Serializable|array|stdClass $sortBy Specifies the order of results, with syntax similar to $sort. */ public readonly Document|Serializable|stdClass|array $sortBy; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $output Represents the output for each element in the group and can be any expression. */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $output Represents the output for each element in the group and can be any expression. */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $output; /** * @param ResolvesToInt|int $n Limits the number of results per group and has to be a positive integral expression that is either a constant or depends on the _id value for $group. * @param Document|Serializable|array|stdClass $sortBy Specifies the order of results, with syntax similar to $sort. - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $output Represents the output for each element in the group and can be any expression. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $output Represents the output for each element in the group and can be any expression. */ public function __construct( ResolvesToInt|int $n, diff --git a/src/Builder/Accumulator/DerivativeAccumulator.php b/src/Builder/Accumulator/DerivativeAccumulator.php index 4a04119..cd10953 100644 --- a/src/Builder/Accumulator/DerivativeAccumulator.php +++ b/src/Builder/Accumulator/DerivativeAccumulator.php @@ -32,14 +32,14 @@ class DerivativeAccumulator implements WindowInterface, OperatorInterface public readonly Decimal128|Int64|UTCDateTime|ResolvesToDate|ResolvesToNumber|float|int $input; /** - * @var Optional|non-empty-string $unit A string that specifies the time unit. Use one of these strings: "week", "day","hour", "minute", "second", "millisecond". + * @var Optional|string $unit A string that specifies the time unit. Use one of these strings: "week", "day","hour", "minute", "second", "millisecond". * If the sortBy field is not a date, you must omit a unit. If you specify a unit, you must specify a date in the sortBy field. */ public readonly Optional|string $unit; /** * @param Decimal128|Int64|ResolvesToDate|ResolvesToNumber|UTCDateTime|float|int $input - * @param Optional|non-empty-string $unit A string that specifies the time unit. Use one of these strings: "week", "day","hour", "minute", "second", "millisecond". + * @param Optional|string $unit A string that specifies the time unit. Use one of these strings: "week", "day","hour", "minute", "second", "millisecond". * If the sortBy field is not a date, you must omit a unit. If you specify a unit, you must specify a date in the sortBy field. */ public function __construct( diff --git a/src/Builder/Accumulator/FactoryTrait.php b/src/Builder/Accumulator/FactoryTrait.php index af21152..604e3c3 100644 --- a/src/Builder/Accumulator/FactoryTrait.php +++ b/src/Builder/Accumulator/FactoryTrait.php @@ -36,13 +36,13 @@ trait FactoryTrait * New in MongoDB 4.4. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/accumulator/ - * @param Javascript|non-empty-string $init Function used to initialize the state. The init function receives its arguments from the initArgs array expression. You can specify the function definition as either BSON type Code or String. - * @param Javascript|non-empty-string $accumulate Function used to accumulate documents. The accumulate function receives its arguments from the current state and accumulateArgs array expression. The result of the accumulate function becomes the new state. You can specify the function definition as either BSON type Code or String. + * @param Javascript|string $init Function used to initialize the state. The init function receives its arguments from the initArgs array expression. You can specify the function definition as either BSON type Code or String. + * @param Javascript|string $accumulate Function used to accumulate documents. The accumulate function receives its arguments from the current state and accumulateArgs array expression. The result of the accumulate function becomes the new state. You can specify the function definition as either BSON type Code or String. * @param BSONArray|PackedArray|ResolvesToArray|array $accumulateArgs Arguments passed to the accumulate function. You can use accumulateArgs to specify what field value(s) to pass to the accumulate function. - * @param Javascript|non-empty-string $merge Function used to merge two internal states. merge must be either a String or Code BSON type. merge returns the combined result of the two merged states. For information on when the merge function is called, see Merge Two States with $merge. - * @param non-empty-string $lang The language used in the $accumulator code. + * @param Javascript|string $merge Function used to merge two internal states. merge must be either a String or Code BSON type. merge returns the combined result of the two merged states. For information on when the merge function is called, see Merge Two States with $merge. + * @param string $lang The language used in the $accumulator code. * @param Optional|BSONArray|PackedArray|ResolvesToArray|array $initArgs Arguments passed to the init function. - * @param Optional|Javascript|non-empty-string $finalize Function used to update the result of the accumulation. + * @param Optional|Javascript|string $finalize Function used to update the result of the accumulation. */ public static function accumulator( Javascript|string $init, @@ -62,7 +62,7 @@ public static function accumulator( * Changed in MongoDB 5.0: Available in the $setWindowFields stage. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/addToSet/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public static function addToSet( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression, @@ -89,7 +89,7 @@ public static function avg(Decimal128|Int64|ResolvesToNumber|float|int $expressi * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/bottom/ * @param Document|Serializable|array|stdClass $sortBy Specifies the order of results, with syntax similar to $sort. - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $output Represents the output for each element in the group and can be any expression. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $output Represents the output for each element in the group and can be any expression. */ public static function bottom( Document|Serializable|stdClass|array $sortBy, @@ -107,7 +107,7 @@ public static function bottom( * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/bottomN/ * @param ResolvesToInt|int $n Limits the number of results per group and has to be a positive integral expression that is either a constant or depends on the _id value for $group. * @param Document|Serializable|array|stdClass $sortBy Specifies the order of results, with syntax similar to $sort. - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $output Represents the output for each element in the group and can be any expression. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $output Represents the output for each element in the group and can be any expression. */ public static function bottomN( ResolvesToInt|int $n, @@ -179,7 +179,7 @@ public static function denseRank(): DenseRankAccumulator * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/derivative/ * @param Decimal128|Int64|ResolvesToDate|ResolvesToNumber|UTCDateTime|float|int $input - * @param Optional|non-empty-string $unit A string that specifies the time unit. Use one of these strings: "week", "day","hour", "minute", "second", "millisecond". + * @param Optional|string $unit A string that specifies the time unit. Use one of these strings: "week", "day","hour", "minute", "second", "millisecond". * If the sortBy field is not a date, you must omit a unit. If you specify a unit, you must specify a date in the sortBy field. */ public static function derivative( @@ -227,7 +227,7 @@ public static function expMovingAvg( * Changed in MongoDB 5.0: Available in the $setWindowFields stage. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/first/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public static function first( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression, @@ -242,7 +242,7 @@ public static function first( * If the group contains fewer than n elements, $firstN returns all elements in the group. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/firstN/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $input An expression that resolves to the array from which to return n elements. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $input An expression that resolves to the array from which to return n elements. * @param ResolvesToInt|int $n A positive integral expression that is either a constant or depends on the _id value for $group. */ public static function firstN( @@ -258,7 +258,7 @@ public static function firstN( * Changed in MongoDB 5.0: Available in the $setWindowFields stage. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/last/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public static function last( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression, @@ -289,7 +289,7 @@ public static function lastN( * Changed in MongoDB 5.0: Available in the $setWindowFields stage. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/max/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public static function max( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression, @@ -323,7 +323,7 @@ public static function maxN( * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/median/ * @param Decimal128|Int64|ResolvesToNumber|float|int $input $median calculates the 50th percentile value of this data. input must be a field name or an expression that evaluates to a numeric type. If the expression cannot be converted to a numeric type, the $median calculation ignores it. - * @param non-empty-string $method The method that mongod uses to calculate the 50th percentile value. The method must be 'approximate'. + * @param string $method The method that mongod uses to calculate the 50th percentile value. The method must be 'approximate'. */ public static function median( Decimal128|Int64|ResolvesToNumber|float|int $input, @@ -351,7 +351,7 @@ public static function mergeObjects( * Changed in MongoDB 5.0: Available in the $setWindowFields stage. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/min/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public static function min( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression, @@ -390,7 +390,7 @@ public static function minN( * @param Decimal128|Int64|ResolvesToNumber|float|int $input $percentile calculates the percentile values of this data. input must be a field name or an expression that evaluates to a numeric type. If the expression cannot be converted to a numeric type, the $percentile calculation ignores it. * @param BSONArray|PackedArray|ResolvesToArray|array $p $percentile calculates a percentile value for each element in p. The elements represent percentages and must evaluate to numeric values in the range 0.0 to 1.0, inclusive. * $percentile returns results in the same order as the elements in p. - * @param non-empty-string $method The method that mongod uses to calculate the percentile value. The method must be 'approximate'. + * @param string $method The method that mongod uses to calculate the percentile value. The method must be 'approximate'. */ public static function percentile( Decimal128|Int64|ResolvesToNumber|float|int $input, @@ -406,7 +406,7 @@ public static function percentile( * Changed in MongoDB 5.0: Available in the $setWindowFields stage. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/push/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public static function push( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression, @@ -420,13 +420,13 @@ public static function push( * New in MongoDB 5.0. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/shift/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $output Specifies an expression to evaluate and return in the output. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $output Specifies an expression to evaluate and return in the output. * @param int $by Specifies an integer with a numeric document position relative to the current document in the output. * For example: * 1 specifies the document position after the current document. * -1 specifies the document position before the current document. * -2 specifies the document position that is two positions before the current document. - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $default Specifies an optional default expression to evaluate if the document position is outside of the implicit $setWindowFields stage window. The implicit window contains all the documents in the partition. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $default Specifies an optional default expression to evaluate if the document position is outside of the implicit $setWindowFields stage window. The implicit window contains all the documents in the partition. * The default expression must evaluate to a constant value. * If you do not specify a default expression, $shift returns null for documents whose positions are outside of the implicit $setWindowFields stage window. */ @@ -485,7 +485,7 @@ public static function sum(Decimal128|Int64|ResolvesToNumber|float|int $expressi * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/top/ * @param Document|Serializable|array|stdClass $sortBy Specifies the order of results, with syntax similar to $sort. - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $output Represents the output for each element in the group and can be any expression. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $output Represents the output for each element in the group and can be any expression. */ public static function top( Document|Serializable|stdClass|array $sortBy, @@ -504,7 +504,7 @@ public static function top( * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/topN/ * @param ResolvesToInt|int $n limits the number of results per group and has to be a positive integral expression that is either a constant or depends on the _id value for $group. * @param Document|Serializable|array|stdClass $sortBy Specifies the order of results, with syntax similar to $sort. - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $output Represents the output for each element in the group and can be any expression. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $output Represents the output for each element in the group and can be any expression. */ public static function topN( ResolvesToInt|int $n, diff --git a/src/Builder/Accumulator/FirstAccumulator.php b/src/Builder/Accumulator/FirstAccumulator.php index 883b0e0..559305d 100644 --- a/src/Builder/Accumulator/FirstAccumulator.php +++ b/src/Builder/Accumulator/FirstAccumulator.php @@ -26,11 +26,11 @@ class FirstAccumulator implements AccumulatorInterface, WindowInterface, Operato { public const ENCODE = Encode::Single; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public function __construct(Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression) { diff --git a/src/Builder/Accumulator/FirstNAccumulator.php b/src/Builder/Accumulator/FirstNAccumulator.php index ef5b4de..0100f1a 100644 --- a/src/Builder/Accumulator/FirstNAccumulator.php +++ b/src/Builder/Accumulator/FirstNAccumulator.php @@ -28,14 +28,14 @@ class FirstNAccumulator implements AccumulatorInterface, WindowInterface, Operat { public const ENCODE = Encode::Object; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $input An expression that resolves to the array from which to return n elements. */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $input An expression that resolves to the array from which to return n elements. */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $input; /** @var ResolvesToInt|int $n A positive integral expression that is either a constant or depends on the _id value for $group. */ public readonly ResolvesToInt|int $n; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $input An expression that resolves to the array from which to return n elements. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $input An expression that resolves to the array from which to return n elements. * @param ResolvesToInt|int $n A positive integral expression that is either a constant or depends on the _id value for $group. */ public function __construct( diff --git a/src/Builder/Accumulator/LastAccumulator.php b/src/Builder/Accumulator/LastAccumulator.php index 0d142f5..ab01fec 100644 --- a/src/Builder/Accumulator/LastAccumulator.php +++ b/src/Builder/Accumulator/LastAccumulator.php @@ -26,11 +26,11 @@ class LastAccumulator implements AccumulatorInterface, WindowInterface, Operator { public const ENCODE = Encode::Single; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public function __construct(Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression) { diff --git a/src/Builder/Accumulator/MaxAccumulator.php b/src/Builder/Accumulator/MaxAccumulator.php index 517fdd2..0258eb8 100644 --- a/src/Builder/Accumulator/MaxAccumulator.php +++ b/src/Builder/Accumulator/MaxAccumulator.php @@ -26,11 +26,11 @@ class MaxAccumulator implements AccumulatorInterface, WindowInterface, OperatorI { public const ENCODE = Encode::Single; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public function __construct(Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression) { diff --git a/src/Builder/Accumulator/MedianAccumulator.php b/src/Builder/Accumulator/MedianAccumulator.php index 9236c2f..a810707 100644 --- a/src/Builder/Accumulator/MedianAccumulator.php +++ b/src/Builder/Accumulator/MedianAccumulator.php @@ -33,12 +33,12 @@ class MedianAccumulator implements AccumulatorInterface, WindowInterface, Operat /** @var Decimal128|Int64|ResolvesToNumber|float|int $input $median calculates the 50th percentile value of this data. input must be a field name or an expression that evaluates to a numeric type. If the expression cannot be converted to a numeric type, the $median calculation ignores it. */ public readonly Decimal128|Int64|ResolvesToNumber|float|int $input; - /** @var non-empty-string $method The method that mongod uses to calculate the 50th percentile value. The method must be 'approximate'. */ + /** @var string $method The method that mongod uses to calculate the 50th percentile value. The method must be 'approximate'. */ public readonly string $method; /** * @param Decimal128|Int64|ResolvesToNumber|float|int $input $median calculates the 50th percentile value of this data. input must be a field name or an expression that evaluates to a numeric type. If the expression cannot be converted to a numeric type, the $median calculation ignores it. - * @param non-empty-string $method The method that mongod uses to calculate the 50th percentile value. The method must be 'approximate'. + * @param string $method The method that mongod uses to calculate the 50th percentile value. The method must be 'approximate'. */ public function __construct(Decimal128|Int64|ResolvesToNumber|float|int $input, string $method) { diff --git a/src/Builder/Accumulator/MinAccumulator.php b/src/Builder/Accumulator/MinAccumulator.php index 23681a7..9194c88 100644 --- a/src/Builder/Accumulator/MinAccumulator.php +++ b/src/Builder/Accumulator/MinAccumulator.php @@ -26,11 +26,11 @@ class MinAccumulator implements AccumulatorInterface, WindowInterface, OperatorI { public const ENCODE = Encode::Single; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public function __construct(Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression) { diff --git a/src/Builder/Accumulator/PercentileAccumulator.php b/src/Builder/Accumulator/PercentileAccumulator.php index f17f40e..85128f0 100644 --- a/src/Builder/Accumulator/PercentileAccumulator.php +++ b/src/Builder/Accumulator/PercentileAccumulator.php @@ -49,14 +49,14 @@ class PercentileAccumulator implements AccumulatorInterface, WindowInterface, Op */ public readonly PackedArray|ResolvesToArray|BSONArray|array $p; - /** @var non-empty-string $method The method that mongod uses to calculate the percentile value. The method must be 'approximate'. */ + /** @var string $method The method that mongod uses to calculate the percentile value. The method must be 'approximate'. */ public readonly string $method; /** * @param Decimal128|Int64|ResolvesToNumber|float|int $input $percentile calculates the percentile values of this data. input must be a field name or an expression that evaluates to a numeric type. If the expression cannot be converted to a numeric type, the $percentile calculation ignores it. * @param BSONArray|PackedArray|ResolvesToArray|array $p $percentile calculates a percentile value for each element in p. The elements represent percentages and must evaluate to numeric values in the range 0.0 to 1.0, inclusive. * $percentile returns results in the same order as the elements in p. - * @param non-empty-string $method The method that mongod uses to calculate the percentile value. The method must be 'approximate'. + * @param string $method The method that mongod uses to calculate the percentile value. The method must be 'approximate'. */ public function __construct( Decimal128|Int64|ResolvesToNumber|float|int $input, diff --git a/src/Builder/Accumulator/PushAccumulator.php b/src/Builder/Accumulator/PushAccumulator.php index 4368deb..3eb0956 100644 --- a/src/Builder/Accumulator/PushAccumulator.php +++ b/src/Builder/Accumulator/PushAccumulator.php @@ -26,11 +26,11 @@ class PushAccumulator implements AccumulatorInterface, WindowInterface, Operator { public const ENCODE = Encode::Single; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public function __construct(Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression) { diff --git a/src/Builder/Accumulator/ShiftAccumulator.php b/src/Builder/Accumulator/ShiftAccumulator.php index cf1739c..c8533c1 100644 --- a/src/Builder/Accumulator/ShiftAccumulator.php +++ b/src/Builder/Accumulator/ShiftAccumulator.php @@ -25,7 +25,7 @@ class ShiftAccumulator implements WindowInterface, OperatorInterface { public const ENCODE = Encode::Object; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $output Specifies an expression to evaluate and return in the output. */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $output Specifies an expression to evaluate and return in the output. */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $output; /** @@ -38,20 +38,20 @@ class ShiftAccumulator implements WindowInterface, OperatorInterface public readonly int $by; /** - * @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $default Specifies an optional default expression to evaluate if the document position is outside of the implicit $setWindowFields stage window. The implicit window contains all the documents in the partition. + * @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $default Specifies an optional default expression to evaluate if the document position is outside of the implicit $setWindowFields stage window. The implicit window contains all the documents in the partition. * The default expression must evaluate to a constant value. * If you do not specify a default expression, $shift returns null for documents whose positions are outside of the implicit $setWindowFields stage window. */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $default; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $output Specifies an expression to evaluate and return in the output. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $output Specifies an expression to evaluate and return in the output. * @param int $by Specifies an integer with a numeric document position relative to the current document in the output. * For example: * 1 specifies the document position after the current document. * -1 specifies the document position before the current document. * -2 specifies the document position that is two positions before the current document. - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $default Specifies an optional default expression to evaluate if the document position is outside of the implicit $setWindowFields stage window. The implicit window contains all the documents in the partition. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $default Specifies an optional default expression to evaluate if the document position is outside of the implicit $setWindowFields stage window. The implicit window contains all the documents in the partition. * The default expression must evaluate to a constant value. * If you do not specify a default expression, $shift returns null for documents whose positions are outside of the implicit $setWindowFields stage window. */ diff --git a/src/Builder/Accumulator/TopAccumulator.php b/src/Builder/Accumulator/TopAccumulator.php index 11f4cac..135b8eb 100644 --- a/src/Builder/Accumulator/TopAccumulator.php +++ b/src/Builder/Accumulator/TopAccumulator.php @@ -32,12 +32,12 @@ class TopAccumulator implements AccumulatorInterface, OperatorInterface /** @var Document|Serializable|array|stdClass $sortBy Specifies the order of results, with syntax similar to $sort. */ public readonly Document|Serializable|stdClass|array $sortBy; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $output Represents the output for each element in the group and can be any expression. */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $output Represents the output for each element in the group and can be any expression. */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $output; /** * @param Document|Serializable|array|stdClass $sortBy Specifies the order of results, with syntax similar to $sort. - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $output Represents the output for each element in the group and can be any expression. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $output Represents the output for each element in the group and can be any expression. */ public function __construct( Document|Serializable|stdClass|array $sortBy, diff --git a/src/Builder/Accumulator/TopNAccumulator.php b/src/Builder/Accumulator/TopNAccumulator.php index dabec37..ab80091 100644 --- a/src/Builder/Accumulator/TopNAccumulator.php +++ b/src/Builder/Accumulator/TopNAccumulator.php @@ -36,13 +36,13 @@ class TopNAccumulator implements AccumulatorInterface, OperatorInterface /** @var Document|Serializable|array|stdClass $sortBy Specifies the order of results, with syntax similar to $sort. */ public readonly Document|Serializable|stdClass|array $sortBy; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $output Represents the output for each element in the group and can be any expression. */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $output Represents the output for each element in the group and can be any expression. */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $output; /** * @param ResolvesToInt|int $n limits the number of results per group and has to be a positive integral expression that is either a constant or depends on the _id value for $group. * @param Document|Serializable|array|stdClass $sortBy Specifies the order of results, with syntax similar to $sort. - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $output Represents the output for each element in the group and can be any expression. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $output Represents the output for each element in the group and can be any expression. */ public function __construct( ResolvesToInt|int $n, diff --git a/src/Builder/Expression/AndOperator.php b/src/Builder/Expression/AndOperator.php index e576ff7..989a27f 100644 --- a/src/Builder/Expression/AndOperator.php +++ b/src/Builder/Expression/AndOperator.php @@ -28,11 +28,11 @@ class AndOperator implements ResolvesToBool, OperatorInterface { public const ENCODE = Encode::Single; - /** @var list $expression */ + /** @var list $expression */ public readonly array $expression; /** - * @param Decimal128|ExpressionInterface|Int64|ResolvesToBool|ResolvesToNull|ResolvesToNumber|ResolvesToString|Type|array|bool|float|int|non-empty-string|null|stdClass ...$expression + * @param Decimal128|ExpressionInterface|Int64|ResolvesToBool|ResolvesToNull|ResolvesToNumber|ResolvesToString|Type|array|bool|float|int|null|stdClass|string ...$expression * @no-named-arguments */ public function __construct( diff --git a/src/Builder/Expression/BinarySizeOperator.php b/src/Builder/Expression/BinarySizeOperator.php index d4e93f3..28293cc 100644 --- a/src/Builder/Expression/BinarySizeOperator.php +++ b/src/Builder/Expression/BinarySizeOperator.php @@ -21,11 +21,11 @@ class BinarySizeOperator implements ResolvesToInt, OperatorInterface { public const ENCODE = Encode::Single; - /** @var Binary|ResolvesToBinData|ResolvesToNull|ResolvesToString|non-empty-string|null $expression */ + /** @var Binary|ResolvesToBinData|ResolvesToNull|ResolvesToString|null|string $expression */ public readonly Binary|ResolvesToBinData|ResolvesToNull|ResolvesToString|null|string $expression; /** - * @param Binary|ResolvesToBinData|ResolvesToNull|ResolvesToString|non-empty-string|null $expression + * @param Binary|ResolvesToBinData|ResolvesToNull|ResolvesToString|null|string $expression */ public function __construct(Binary|ResolvesToBinData|ResolvesToNull|ResolvesToString|null|string $expression) { diff --git a/src/Builder/Expression/CmpOperator.php b/src/Builder/Expression/CmpOperator.php index c80ba39..78354cb 100644 --- a/src/Builder/Expression/CmpOperator.php +++ b/src/Builder/Expression/CmpOperator.php @@ -23,15 +23,15 @@ class CmpOperator implements ResolvesToInt, OperatorInterface { public const ENCODE = Encode::Array; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression1 */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression1 */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression1; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression2 */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression2 */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression2; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression1 - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression2 + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression1 + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression2 */ public function __construct( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression1, diff --git a/src/Builder/Expression/ConcatOperator.php b/src/Builder/Expression/ConcatOperator.php index 4bfd99c..20bd3e9 100644 --- a/src/Builder/Expression/ConcatOperator.php +++ b/src/Builder/Expression/ConcatOperator.php @@ -23,11 +23,11 @@ class ConcatOperator implements ResolvesToString, OperatorInterface { public const ENCODE = Encode::Single; - /** @var list $expression */ + /** @var list $expression */ public readonly array $expression; /** - * @param ResolvesToString|non-empty-string ...$expression + * @param ResolvesToString|string ...$expression * @no-named-arguments */ public function __construct(ResolvesToString|string ...$expression) diff --git a/src/Builder/Expression/CondOperator.php b/src/Builder/Expression/CondOperator.php index dfd53ba..1d3a44c 100644 --- a/src/Builder/Expression/CondOperator.php +++ b/src/Builder/Expression/CondOperator.php @@ -26,16 +26,16 @@ class CondOperator implements ResolvesToAny, OperatorInterface /** @var ResolvesToBool|bool $if */ public readonly ResolvesToBool|bool $if; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $then */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $then */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $then; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $else */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $else */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $else; /** * @param ResolvesToBool|bool $if - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $then - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $else + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $then + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $else */ public function __construct( ResolvesToBool|bool $if, diff --git a/src/Builder/Expression/ConvertOperator.php b/src/Builder/Expression/ConvertOperator.php index ecfdafe..f8cb521 100644 --- a/src/Builder/Expression/ConvertOperator.php +++ b/src/Builder/Expression/ConvertOperator.php @@ -25,30 +25,30 @@ class ConvertOperator implements ResolvesToAny, OperatorInterface { public const ENCODE = Encode::Object; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $input */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $input */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $input; - /** @var ResolvesToInt|ResolvesToString|int|non-empty-string $to */ + /** @var ResolvesToInt|ResolvesToString|int|string $to */ public readonly ResolvesToInt|ResolvesToString|int|string $to; /** - * @var Optional|ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $onError The value to return on encountering an error during conversion, including unsupported type conversions. The arguments can be any valid expression. + * @var Optional|ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $onError The value to return on encountering an error during conversion, including unsupported type conversions. The arguments can be any valid expression. * If unspecified, the operation throws an error upon encountering an error and stops. */ public readonly Optional|Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $onError; /** - * @var Optional|ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $onNull The value to return if the input is null or missing. The arguments can be any valid expression. + * @var Optional|ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $onNull The value to return if the input is null or missing. The arguments can be any valid expression. * If unspecified, $convert returns null if the input is null or missing. */ public readonly Optional|Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $onNull; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $input - * @param ResolvesToInt|ResolvesToString|int|non-empty-string $to - * @param Optional|ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $onError The value to return on encountering an error during conversion, including unsupported type conversions. The arguments can be any valid expression. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $input + * @param ResolvesToInt|ResolvesToString|int|string $to + * @param Optional|ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $onError The value to return on encountering an error during conversion, including unsupported type conversions. The arguments can be any valid expression. * If unspecified, the operation throws an error upon encountering an error and stops. - * @param Optional|ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $onNull The value to return if the input is null or missing. The arguments can be any valid expression. + * @param Optional|ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $onNull The value to return if the input is null or missing. The arguments can be any valid expression. * If unspecified, $convert returns null if the input is null or missing. */ public function __construct( diff --git a/src/Builder/Expression/DateAddOperator.php b/src/Builder/Expression/DateAddOperator.php index 183d7b4..9d35d3b 100644 --- a/src/Builder/Expression/DateAddOperator.php +++ b/src/Builder/Expression/DateAddOperator.php @@ -28,20 +28,20 @@ class DateAddOperator implements ResolvesToDate, OperatorInterface /** @var ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $startDate The beginning date, in UTC, for the addition operation. The startDate can be any expression that resolves to a Date, a Timestamp, or an ObjectID. */ public readonly ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $startDate; - /** @var ResolvesToString|non-empty-string $unit The unit used to measure the amount of time added to the startDate. */ + /** @var ResolvesToString|string $unit The unit used to measure the amount of time added to the startDate. */ public readonly ResolvesToString|string $unit; /** @var Int64|ResolvesToInt|ResolvesToLong|int $amount */ public readonly Int64|ResolvesToInt|ResolvesToLong|int $amount; - /** @var Optional|ResolvesToString|non-empty-string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ + /** @var Optional|ResolvesToString|string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public readonly Optional|ResolvesToString|string $timezone; /** * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $startDate The beginning date, in UTC, for the addition operation. The startDate can be any expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param ResolvesToString|non-empty-string $unit The unit used to measure the amount of time added to the startDate. + * @param ResolvesToString|string $unit The unit used to measure the amount of time added to the startDate. * @param Int64|ResolvesToInt|ResolvesToLong|int $amount - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public function __construct( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $startDate, diff --git a/src/Builder/Expression/DateDiffOperator.php b/src/Builder/Expression/DateDiffOperator.php index 62cedac..e28d435 100644 --- a/src/Builder/Expression/DateDiffOperator.php +++ b/src/Builder/Expression/DateDiffOperator.php @@ -30,21 +30,21 @@ class DateDiffOperator implements ResolvesToInt, OperatorInterface /** @var ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $endDate The end of the time period. The endDate can be any expression that resolves to a Date, a Timestamp, or an ObjectID. */ public readonly ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $endDate; - /** @var ResolvesToString|non-empty-string $unit The time measurement unit between the startDate and endDate */ + /** @var ResolvesToString|string $unit The time measurement unit between the startDate and endDate */ public readonly ResolvesToString|string $unit; - /** @var Optional|ResolvesToString|non-empty-string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ + /** @var Optional|ResolvesToString|string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public readonly Optional|ResolvesToString|string $timezone; - /** @var Optional|ResolvesToString|non-empty-string $startOfWeek Used when the unit is equal to week. Defaults to Sunday. The startOfWeek parameter is an expression that resolves to a case insensitive string */ + /** @var Optional|ResolvesToString|string $startOfWeek Used when the unit is equal to week. Defaults to Sunday. The startOfWeek parameter is an expression that resolves to a case insensitive string */ public readonly Optional|ResolvesToString|string $startOfWeek; /** * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $startDate The start of the time period. The startDate can be any expression that resolves to a Date, a Timestamp, or an ObjectID. * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $endDate The end of the time period. The endDate can be any expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param ResolvesToString|non-empty-string $unit The time measurement unit between the startDate and endDate - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. - * @param Optional|ResolvesToString|non-empty-string $startOfWeek Used when the unit is equal to week. Defaults to Sunday. The startOfWeek parameter is an expression that resolves to a case insensitive string + * @param ResolvesToString|string $unit The time measurement unit between the startDate and endDate + * @param Optional|ResolvesToString|string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $startOfWeek Used when the unit is equal to week. Defaults to Sunday. The startOfWeek parameter is an expression that resolves to a case insensitive string */ public function __construct( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $startDate, diff --git a/src/Builder/Expression/DateFromPartsOperator.php b/src/Builder/Expression/DateFromPartsOperator.php index 022e029..f8b7ad6 100644 --- a/src/Builder/Expression/DateFromPartsOperator.php +++ b/src/Builder/Expression/DateFromPartsOperator.php @@ -53,7 +53,7 @@ class DateFromPartsOperator implements ResolvesToDate, OperatorInterface /** @var Optional|Decimal128|Int64|ResolvesToNumber|float|int $millisecond Millisecond. Defaults to 0. */ public readonly Optional|Decimal128|Int64|ResolvesToNumber|float|int $millisecond; - /** @var Optional|ResolvesToString|non-empty-string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ + /** @var Optional|ResolvesToString|string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public readonly Optional|ResolvesToString|string $timezone; /** @@ -67,7 +67,7 @@ class DateFromPartsOperator implements ResolvesToDate, OperatorInterface * @param Optional|Decimal128|Int64|ResolvesToNumber|float|int $minute Minute. Defaults to 0. * @param Optional|Decimal128|Int64|ResolvesToNumber|float|int $second Second. Defaults to 0. * @param Optional|Decimal128|Int64|ResolvesToNumber|float|int $millisecond Millisecond. Defaults to 0. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public function __construct( Optional|Decimal128|Int64|ResolvesToNumber|float|int $year = Optional::Undefined, diff --git a/src/Builder/Expression/DateFromStringOperator.php b/src/Builder/Expression/DateFromStringOperator.php index cbda447..5a3f808 100644 --- a/src/Builder/Expression/DateFromStringOperator.php +++ b/src/Builder/Expression/DateFromStringOperator.php @@ -24,38 +24,38 @@ class DateFromStringOperator implements ResolvesToDate, OperatorInterface { public const ENCODE = Encode::Object; - /** @var ResolvesToString|non-empty-string $dateString The date/time string to convert to a date object. */ + /** @var ResolvesToString|string $dateString The date/time string to convert to a date object. */ public readonly ResolvesToString|string $dateString; /** - * @var Optional|ResolvesToString|non-empty-string $format The date format specification of the dateString. The format can be any expression that evaluates to a string literal, containing 0 or more format specifiers. + * @var Optional|ResolvesToString|string $format The date format specification of the dateString. The format can be any expression that evaluates to a string literal, containing 0 or more format specifiers. * If unspecified, $dateFromString uses "%Y-%m-%dT%H:%M:%S.%LZ" as the default format but accepts a variety of formats and attempts to parse the dateString if possible. */ public readonly Optional|ResolvesToString|string $format; - /** @var Optional|ResolvesToString|non-empty-string $timezone The time zone to use to format the date. */ + /** @var Optional|ResolvesToString|string $timezone The time zone to use to format the date. */ public readonly Optional|ResolvesToString|string $timezone; /** - * @var Optional|ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $onError If $dateFromString encounters an error while parsing the given dateString, it outputs the result value of the provided onError expression. This result value can be of any type. + * @var Optional|ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $onError If $dateFromString encounters an error while parsing the given dateString, it outputs the result value of the provided onError expression. This result value can be of any type. * If you do not specify onError, $dateFromString throws an error if it cannot parse dateString. */ public readonly Optional|Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $onError; /** - * @var Optional|ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $onNull If the dateString provided to $dateFromString is null or missing, it outputs the result value of the provided onNull expression. This result value can be of any type. + * @var Optional|ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $onNull If the dateString provided to $dateFromString is null or missing, it outputs the result value of the provided onNull expression. This result value can be of any type. * If you do not specify onNull and dateString is null or missing, then $dateFromString outputs null. */ public readonly Optional|Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $onNull; /** - * @param ResolvesToString|non-empty-string $dateString The date/time string to convert to a date object. - * @param Optional|ResolvesToString|non-empty-string $format The date format specification of the dateString. The format can be any expression that evaluates to a string literal, containing 0 or more format specifiers. + * @param ResolvesToString|string $dateString The date/time string to convert to a date object. + * @param Optional|ResolvesToString|string $format The date format specification of the dateString. The format can be any expression that evaluates to a string literal, containing 0 or more format specifiers. * If unspecified, $dateFromString uses "%Y-%m-%dT%H:%M:%S.%LZ" as the default format but accepts a variety of formats and attempts to parse the dateString if possible. - * @param Optional|ResolvesToString|non-empty-string $timezone The time zone to use to format the date. - * @param Optional|ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $onError If $dateFromString encounters an error while parsing the given dateString, it outputs the result value of the provided onError expression. This result value can be of any type. + * @param Optional|ResolvesToString|string $timezone The time zone to use to format the date. + * @param Optional|ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $onError If $dateFromString encounters an error while parsing the given dateString, it outputs the result value of the provided onError expression. This result value can be of any type. * If you do not specify onError, $dateFromString throws an error if it cannot parse dateString. - * @param Optional|ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $onNull If the dateString provided to $dateFromString is null or missing, it outputs the result value of the provided onNull expression. This result value can be of any type. + * @param Optional|ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $onNull If the dateString provided to $dateFromString is null or missing, it outputs the result value of the provided onNull expression. This result value can be of any type. * If you do not specify onNull and dateString is null or missing, then $dateFromString outputs null. */ public function __construct( diff --git a/src/Builder/Expression/DateSubtractOperator.php b/src/Builder/Expression/DateSubtractOperator.php index 8229a35..e1a5830 100644 --- a/src/Builder/Expression/DateSubtractOperator.php +++ b/src/Builder/Expression/DateSubtractOperator.php @@ -28,20 +28,20 @@ class DateSubtractOperator implements ResolvesToDate, OperatorInterface /** @var ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $startDate The beginning date, in UTC, for the addition operation. The startDate can be any expression that resolves to a Date, a Timestamp, or an ObjectID. */ public readonly ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $startDate; - /** @var ResolvesToString|non-empty-string $unit The unit used to measure the amount of time added to the startDate. */ + /** @var ResolvesToString|string $unit The unit used to measure the amount of time added to the startDate. */ public readonly ResolvesToString|string $unit; /** @var Int64|ResolvesToInt|ResolvesToLong|int $amount */ public readonly Int64|ResolvesToInt|ResolvesToLong|int $amount; - /** @var Optional|ResolvesToString|non-empty-string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ + /** @var Optional|ResolvesToString|string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public readonly Optional|ResolvesToString|string $timezone; /** * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $startDate The beginning date, in UTC, for the addition operation. The startDate can be any expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param ResolvesToString|non-empty-string $unit The unit used to measure the amount of time added to the startDate. + * @param ResolvesToString|string $unit The unit used to measure the amount of time added to the startDate. * @param Int64|ResolvesToInt|ResolvesToLong|int $amount - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public function __construct( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $startDate, diff --git a/src/Builder/Expression/DateToPartsOperator.php b/src/Builder/Expression/DateToPartsOperator.php index 37d7a4c..c0f6372 100644 --- a/src/Builder/Expression/DateToPartsOperator.php +++ b/src/Builder/Expression/DateToPartsOperator.php @@ -27,7 +27,7 @@ class DateToPartsOperator implements ResolvesToObject, OperatorInterface /** @var ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The input date for which to return parts. date can be any expression that resolves to a Date, a Timestamp, or an ObjectID. */ public readonly ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date; - /** @var Optional|ResolvesToString|non-empty-string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ + /** @var Optional|ResolvesToString|string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public readonly Optional|ResolvesToString|string $timezone; /** @var Optional|bool $iso8601 If set to true, modifies the output document to use ISO week date fields. Defaults to false. */ @@ -35,7 +35,7 @@ class DateToPartsOperator implements ResolvesToObject, OperatorInterface /** * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The input date for which to return parts. date can be any expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. * @param Optional|bool $iso8601 If set to true, modifies the output document to use ISO week date fields. Defaults to false. */ public function __construct( diff --git a/src/Builder/Expression/DateToStringOperator.php b/src/Builder/Expression/DateToStringOperator.php index 0180068..e33c519 100644 --- a/src/Builder/Expression/DateToStringOperator.php +++ b/src/Builder/Expression/DateToStringOperator.php @@ -31,26 +31,26 @@ class DateToStringOperator implements ResolvesToString, OperatorInterface public readonly ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date; /** - * @var Optional|ResolvesToString|non-empty-string $format The date format specification of the dateString. The format can be any expression that evaluates to a string literal, containing 0 or more format specifiers. + * @var Optional|ResolvesToString|string $format The date format specification of the dateString. The format can be any expression that evaluates to a string literal, containing 0 or more format specifiers. * If unspecified, $dateFromString uses "%Y-%m-%dT%H:%M:%S.%LZ" as the default format but accepts a variety of formats and attempts to parse the dateString if possible. */ public readonly Optional|ResolvesToString|string $format; - /** @var Optional|ResolvesToString|non-empty-string $timezone The time zone to use to format the date. */ + /** @var Optional|ResolvesToString|string $timezone The time zone to use to format the date. */ public readonly Optional|ResolvesToString|string $timezone; /** - * @var Optional|ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $onNull The value to return if the date is null or missing. + * @var Optional|ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $onNull The value to return if the date is null or missing. * If unspecified, $dateToString returns null if the date is null or missing. */ public readonly Optional|Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $onNull; /** * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to convert to string. Must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param Optional|ResolvesToString|non-empty-string $format The date format specification of the dateString. The format can be any expression that evaluates to a string literal, containing 0 or more format specifiers. + * @param Optional|ResolvesToString|string $format The date format specification of the dateString. The format can be any expression that evaluates to a string literal, containing 0 or more format specifiers. * If unspecified, $dateFromString uses "%Y-%m-%dT%H:%M:%S.%LZ" as the default format but accepts a variety of formats and attempts to parse the dateString if possible. - * @param Optional|ResolvesToString|non-empty-string $timezone The time zone to use to format the date. - * @param Optional|ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $onNull The value to return if the date is null or missing. + * @param Optional|ResolvesToString|string $timezone The time zone to use to format the date. + * @param Optional|ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $onNull The value to return if the date is null or missing. * If unspecified, $dateToString returns null if the date is null or missing. */ public function __construct( diff --git a/src/Builder/Expression/DateTruncOperator.php b/src/Builder/Expression/DateTruncOperator.php index 9464e77..cf56cdf 100644 --- a/src/Builder/Expression/DateTruncOperator.php +++ b/src/Builder/Expression/DateTruncOperator.php @@ -30,7 +30,7 @@ class DateTruncOperator implements ResolvesToDate, OperatorInterface public readonly ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date; /** - * @var ResolvesToString|non-empty-string $unit The unit of time, specified as an expression that must resolve to one of these strings: year, quarter, week, month, day, hour, minute, second. + * @var ResolvesToString|string $unit The unit of time, specified as an expression that must resolve to one of these strings: year, quarter, week, month, day, hour, minute, second. * Together, binSize and unit specify the time period used in the $dateTrunc calculation. */ public readonly ResolvesToString|string $unit; @@ -41,23 +41,23 @@ class DateTruncOperator implements ResolvesToDate, OperatorInterface */ public readonly Optional|Decimal128|Int64|ResolvesToNumber|float|int $binSize; - /** @var Optional|ResolvesToString|non-empty-string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ + /** @var Optional|ResolvesToString|string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public readonly Optional|ResolvesToString|string $timezone; /** - * @var Optional|non-empty-string $startOfWeek The start of the week. Used when + * @var Optional|string $startOfWeek The start of the week. Used when * unit is week. Defaults to Sunday. */ public readonly Optional|string $startOfWeek; /** * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to truncate, specified in UTC. The date can be any expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param ResolvesToString|non-empty-string $unit The unit of time, specified as an expression that must resolve to one of these strings: year, quarter, week, month, day, hour, minute, second. + * @param ResolvesToString|string $unit The unit of time, specified as an expression that must resolve to one of these strings: year, quarter, week, month, day, hour, minute, second. * Together, binSize and unit specify the time period used in the $dateTrunc calculation. * @param Optional|Decimal128|Int64|ResolvesToNumber|float|int $binSize The numeric time value, specified as an expression that must resolve to a positive non-zero number. Defaults to 1. * Together, binSize and unit specify the time period used in the $dateTrunc calculation. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. - * @param Optional|non-empty-string $startOfWeek The start of the week. Used when + * @param Optional|ResolvesToString|string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|string $startOfWeek The start of the week. Used when * unit is week. Defaults to Sunday. */ public function __construct( diff --git a/src/Builder/Expression/DayOfMonthOperator.php b/src/Builder/Expression/DayOfMonthOperator.php index a13e3b9..a1a06db 100644 --- a/src/Builder/Expression/DayOfMonthOperator.php +++ b/src/Builder/Expression/DayOfMonthOperator.php @@ -27,12 +27,12 @@ class DayOfMonthOperator implements ResolvesToInt, OperatorInterface /** @var ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. */ public readonly ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date; - /** @var Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ + /** @var Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public readonly Optional|ResolvesToString|string $timezone; /** * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public function __construct( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date, diff --git a/src/Builder/Expression/DayOfWeekOperator.php b/src/Builder/Expression/DayOfWeekOperator.php index c593600..8b439c0 100644 --- a/src/Builder/Expression/DayOfWeekOperator.php +++ b/src/Builder/Expression/DayOfWeekOperator.php @@ -27,12 +27,12 @@ class DayOfWeekOperator implements ResolvesToInt, OperatorInterface /** @var ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. */ public readonly ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date; - /** @var Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ + /** @var Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public readonly Optional|ResolvesToString|string $timezone; /** * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public function __construct( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date, diff --git a/src/Builder/Expression/DayOfYearOperator.php b/src/Builder/Expression/DayOfYearOperator.php index 3b07626..d97be27 100644 --- a/src/Builder/Expression/DayOfYearOperator.php +++ b/src/Builder/Expression/DayOfYearOperator.php @@ -27,12 +27,12 @@ class DayOfYearOperator implements ResolvesToInt, OperatorInterface /** @var ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. */ public readonly ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date; - /** @var Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ + /** @var Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public readonly Optional|ResolvesToString|string $timezone; /** * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public function __construct( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date, diff --git a/src/Builder/Expression/EqOperator.php b/src/Builder/Expression/EqOperator.php index c607170..5da15a3 100644 --- a/src/Builder/Expression/EqOperator.php +++ b/src/Builder/Expression/EqOperator.php @@ -23,15 +23,15 @@ class EqOperator implements ResolvesToBool, OperatorInterface { public const ENCODE = Encode::Array; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression1 */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression1 */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression1; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression2 */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression2 */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression2; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression1 - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression2 + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression1 + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression2 */ public function __construct( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression1, diff --git a/src/Builder/Expression/FactoryTrait.php b/src/Builder/Expression/FactoryTrait.php index cadcf01..4611c08 100644 --- a/src/Builder/Expression/FactoryTrait.php +++ b/src/Builder/Expression/FactoryTrait.php @@ -99,7 +99,7 @@ public static function allElementsTrue( * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/and/ * @no-named-arguments - * @param Decimal128|ExpressionInterface|Int64|ResolvesToBool|ResolvesToNull|ResolvesToNumber|ResolvesToString|Type|array|bool|float|int|non-empty-string|null|stdClass ...$expression + * @param Decimal128|ExpressionInterface|Int64|ResolvesToBool|ResolvesToNull|ResolvesToNumber|ResolvesToString|Type|array|bool|float|int|null|stdClass|string ...$expression */ public static function and( Decimal128|Int64|Type|ResolvesToBool|ResolvesToNull|ResolvesToNumber|ResolvesToString|ExpressionInterface|stdClass|array|bool|float|int|null|string ...$expression, @@ -233,7 +233,7 @@ public static function avg(Decimal128|Int64|ResolvesToNumber|float|int ...$expre * Returns the size of a given string or binary data value's content in bytes. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/binarySize/ - * @param Binary|ResolvesToBinData|ResolvesToNull|ResolvesToString|non-empty-string|null $expression + * @param Binary|ResolvesToBinData|ResolvesToNull|ResolvesToString|null|string $expression */ public static function binarySize( Binary|ResolvesToBinData|ResolvesToNull|ResolvesToString|null|string $expression, @@ -321,8 +321,8 @@ public static function ceil(Decimal128|Int64|ResolvesToNumber|float|int $express * Returns 0 if the two values are equivalent, 1 if the first value is greater than the second, and -1 if the first value is less than the second. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/cmp/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression1 - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression2 + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression1 + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression2 */ public static function cmp( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression1, @@ -337,7 +337,7 @@ public static function cmp( * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/concat/ * @no-named-arguments - * @param ResolvesToString|non-empty-string ...$expression + * @param ResolvesToString|string ...$expression */ public static function concat(ResolvesToString|string ...$expression): ConcatOperator { @@ -361,8 +361,8 @@ public static function concatArrays(PackedArray|ResolvesToArray|BSONArray|array * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/cond/ * @param ResolvesToBool|bool $if - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $then - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $else + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $then + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $else */ public static function cond( ResolvesToBool|bool $if, @@ -378,11 +378,11 @@ public static function cond( * New in MongoDB 4.0. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/convert/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $input - * @param ResolvesToInt|ResolvesToString|int|non-empty-string $to - * @param Optional|ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $onError The value to return on encountering an error during conversion, including unsupported type conversions. The arguments can be any valid expression. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $input + * @param ResolvesToInt|ResolvesToString|int|string $to + * @param Optional|ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $onError The value to return on encountering an error during conversion, including unsupported type conversions. The arguments can be any valid expression. * If unspecified, the operation throws an error upon encountering an error and stops. - * @param Optional|ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $onNull The value to return if the input is null or missing. The arguments can be any valid expression. + * @param Optional|ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $onNull The value to return if the input is null or missing. The arguments can be any valid expression. * If unspecified, $convert returns null if the input is null or missing. */ public static function convert( @@ -424,9 +424,9 @@ public static function cosh(Decimal128|Int64|ResolvesToNumber|float|int $express * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/dateAdd/ * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $startDate The beginning date, in UTC, for the addition operation. The startDate can be any expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param ResolvesToString|non-empty-string $unit The unit used to measure the amount of time added to the startDate. + * @param ResolvesToString|string $unit The unit used to measure the amount of time added to the startDate. * @param Int64|ResolvesToInt|ResolvesToLong|int $amount - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public static function dateAdd( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $startDate, @@ -444,9 +444,9 @@ public static function dateAdd( * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/dateDiff/ * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $startDate The start of the time period. The startDate can be any expression that resolves to a Date, a Timestamp, or an ObjectID. * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $endDate The end of the time period. The endDate can be any expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param ResolvesToString|non-empty-string $unit The time measurement unit between the startDate and endDate - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. - * @param Optional|ResolvesToString|non-empty-string $startOfWeek Used when the unit is equal to week. Defaults to Sunday. The startOfWeek parameter is an expression that resolves to a case insensitive string + * @param ResolvesToString|string $unit The time measurement unit between the startDate and endDate + * @param Optional|ResolvesToString|string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $startOfWeek Used when the unit is equal to week. Defaults to Sunday. The startOfWeek parameter is an expression that resolves to a case insensitive string */ public static function dateDiff( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $startDate, @@ -473,7 +473,7 @@ public static function dateDiff( * @param Optional|Decimal128|Int64|ResolvesToNumber|float|int $minute Minute. Defaults to 0. * @param Optional|Decimal128|Int64|ResolvesToNumber|float|int $second Second. Defaults to 0. * @param Optional|Decimal128|Int64|ResolvesToNumber|float|int $millisecond Millisecond. Defaults to 0. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public static function dateFromParts( Optional|Decimal128|Int64|ResolvesToNumber|float|int $year = Optional::Undefined, @@ -496,13 +496,13 @@ public static function dateFromParts( * Converts a date/time string to a date object. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/dateFromString/ - * @param ResolvesToString|non-empty-string $dateString The date/time string to convert to a date object. - * @param Optional|ResolvesToString|non-empty-string $format The date format specification of the dateString. The format can be any expression that evaluates to a string literal, containing 0 or more format specifiers. + * @param ResolvesToString|string $dateString The date/time string to convert to a date object. + * @param Optional|ResolvesToString|string $format The date format specification of the dateString. The format can be any expression that evaluates to a string literal, containing 0 or more format specifiers. * If unspecified, $dateFromString uses "%Y-%m-%dT%H:%M:%S.%LZ" as the default format but accepts a variety of formats and attempts to parse the dateString if possible. - * @param Optional|ResolvesToString|non-empty-string $timezone The time zone to use to format the date. - * @param Optional|ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $onError If $dateFromString encounters an error while parsing the given dateString, it outputs the result value of the provided onError expression. This result value can be of any type. + * @param Optional|ResolvesToString|string $timezone The time zone to use to format the date. + * @param Optional|ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $onError If $dateFromString encounters an error while parsing the given dateString, it outputs the result value of the provided onError expression. This result value can be of any type. * If you do not specify onError, $dateFromString throws an error if it cannot parse dateString. - * @param Optional|ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $onNull If the dateString provided to $dateFromString is null or missing, it outputs the result value of the provided onNull expression. This result value can be of any type. + * @param Optional|ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $onNull If the dateString provided to $dateFromString is null or missing, it outputs the result value of the provided onNull expression. This result value can be of any type. * If you do not specify onNull and dateString is null or missing, then $dateFromString outputs null. */ public static function dateFromString( @@ -521,9 +521,9 @@ public static function dateFromString( * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/dateSubtract/ * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $startDate The beginning date, in UTC, for the addition operation. The startDate can be any expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param ResolvesToString|non-empty-string $unit The unit used to measure the amount of time added to the startDate. + * @param ResolvesToString|string $unit The unit used to measure the amount of time added to the startDate. * @param Int64|ResolvesToInt|ResolvesToLong|int $amount - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public static function dateSubtract( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $startDate, @@ -540,7 +540,7 @@ public static function dateSubtract( * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/dateToParts/ * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The input date for which to return parts. date can be any expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. * @param Optional|bool $iso8601 If set to true, modifies the output document to use ISO week date fields. Defaults to false. */ public static function dateToParts( @@ -557,10 +557,10 @@ public static function dateToParts( * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/dateToString/ * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to convert to string. Must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param Optional|ResolvesToString|non-empty-string $format The date format specification of the dateString. The format can be any expression that evaluates to a string literal, containing 0 or more format specifiers. + * @param Optional|ResolvesToString|string $format The date format specification of the dateString. The format can be any expression that evaluates to a string literal, containing 0 or more format specifiers. * If unspecified, $dateFromString uses "%Y-%m-%dT%H:%M:%S.%LZ" as the default format but accepts a variety of formats and attempts to parse the dateString if possible. - * @param Optional|ResolvesToString|non-empty-string $timezone The time zone to use to format the date. - * @param Optional|ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $onNull The value to return if the date is null or missing. + * @param Optional|ResolvesToString|string $timezone The time zone to use to format the date. + * @param Optional|ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $onNull The value to return if the date is null or missing. * If unspecified, $dateToString returns null if the date is null or missing. */ public static function dateToString( @@ -578,12 +578,12 @@ public static function dateToString( * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/dateTrunc/ * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to truncate, specified in UTC. The date can be any expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param ResolvesToString|non-empty-string $unit The unit of time, specified as an expression that must resolve to one of these strings: year, quarter, week, month, day, hour, minute, second. + * @param ResolvesToString|string $unit The unit of time, specified as an expression that must resolve to one of these strings: year, quarter, week, month, day, hour, minute, second. * Together, binSize and unit specify the time period used in the $dateTrunc calculation. * @param Optional|Decimal128|Int64|ResolvesToNumber|float|int $binSize The numeric time value, specified as an expression that must resolve to a positive non-zero number. Defaults to 1. * Together, binSize and unit specify the time period used in the $dateTrunc calculation. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. - * @param Optional|non-empty-string $startOfWeek The start of the week. Used when + * @param Optional|ResolvesToString|string $timezone The timezone to carry out the operation. $timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|string $startOfWeek The start of the week. Used when * unit is week. Defaults to Sunday. */ public static function dateTrunc( @@ -602,7 +602,7 @@ public static function dateTrunc( * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/dayOfMonth/ * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public static function dayOfMonth( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date, @@ -617,7 +617,7 @@ public static function dayOfMonth( * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/dayOfWeek/ * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public static function dayOfWeek( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date, @@ -632,7 +632,7 @@ public static function dayOfWeek( * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/dayOfYear/ * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public static function dayOfYear( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date, @@ -675,8 +675,8 @@ public static function divide( * Returns true if the values are equivalent. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/eq/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression1 - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression2 + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression1 + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression2 */ public static function eq( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression1, @@ -703,7 +703,7 @@ public static function exp(Decimal128|Int64|ResolvesToNumber|float|int $exponent * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/filter/ * @param BSONArray|PackedArray|ResolvesToArray|array $input * @param ResolvesToBool|bool $cond An expression that resolves to a boolean value used to determine if an element should be included in the output array. The expression references each element of the input array individually with the variable name specified in as. - * @param Optional|non-empty-string $as A name for the variable that represents each individual element of the input array. If no name is specified, the variable name defaults to this. + * @param Optional|string $as A name for the variable that represents each individual element of the input array. If no name is specified, the variable name defaults to this. * @param Optional|ResolvesToInt|int $limit A number expression that restricts the number of matching array elements that $filter returns. You cannot specify a limit less than 1. The matching array elements are returned in the order they appear in the input array. * If the specified limit is greater than the number of matching array elements, $filter returns all matching array elements. If the limit is null, $filter returns all matching array elements. */ @@ -759,10 +759,10 @@ public static function floor(Decimal128|Int64|ResolvesToNumber|float|int $expres * New in MongoDB 4.4. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/function/ - * @param Javascript|non-empty-string $body The function definition. You can specify the function definition as either BSON\JavaScript or string. + * @param Javascript|string $body The function definition. You can specify the function definition as either BSON\JavaScript or string. * function(arg1, arg2, ...) { ... } * @param BSONArray|PackedArray|array $args Arguments passed to the function body. If the body function does not take an argument, you can specify an empty array [ ]. - * @param non-empty-string $lang + * @param string $lang */ public static function function( Javascript|string $body, @@ -778,9 +778,9 @@ public static function function( * New in MongoDB 5.0. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/getField/ - * @param ResolvesToString|non-empty-string $field Field in the input object for which you want to return a value. field can be any valid expression that resolves to a string constant. + * @param ResolvesToString|string $field Field in the input object for which you want to return a value. field can be any valid expression that resolves to a string constant. * If field begins with a dollar sign ($), place the field name inside of a $literal expression to return its value. - * @param Optional|ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $input Default: $$CURRENT + * @param Optional|ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $input Default: $$CURRENT * A valid expression that contains the field for which you want to return a value. input must resolve to an object, missing, null, or undefined. If omitted, defaults to the document currently being processed in the pipeline ($$CURRENT). */ public static function getField( @@ -795,8 +795,8 @@ public static function getField( * Returns true if the first value is greater than the second. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/gt/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression1 - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression2 + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression1 + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression2 */ public static function gt( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression1, @@ -810,8 +810,8 @@ public static function gt( * Returns true if the first value is greater than or equal to the second. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/gte/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression1 - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression2 + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression1 + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression2 */ public static function gte( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression1, @@ -826,7 +826,7 @@ public static function gte( * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/hour/ * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public static function hour( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date, @@ -841,7 +841,7 @@ public static function hour( * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/ifNull/ * @no-named-arguments - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass ...$expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string ...$expression */ public static function ifNull( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string ...$expression, @@ -854,7 +854,7 @@ public static function ifNull( * Returns a boolean indicating whether a specified value is in an array. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/in/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression Any valid expression expression. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression Any valid expression expression. * @param BSONArray|PackedArray|ResolvesToArray|array $array Any valid expression that resolves to an array. */ public static function in( @@ -872,7 +872,7 @@ public static function in( * @param BSONArray|PackedArray|ResolvesToArray|array $array Can be any valid expression as long as it resolves to an array. * If the array expression resolves to a value of null or refers to a field that is missing, $indexOfArray returns null. * If the array expression does not resolve to an array or null nor refers to a missing field, $indexOfArray returns an error. - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $search + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $search * @param Optional|ResolvesToInt|int $start An integer, or a number that can be represented as integers (such as 2.0), that specifies the starting index position for the search. Can be any valid expression that resolves to a non-negative integral number. * If unspecified, the starting index position for the search is the beginning of the string. * @param Optional|ResolvesToInt|int $end An integer, or a number that can be represented as integers (such as 2.0), that specifies the ending index position for the search. Can be any valid expression that resolves to a non-negative integral number. If you specify a index value, you should also specify a index value; otherwise, $indexOfArray uses the value as the index value instead of the value. @@ -892,10 +892,10 @@ public static function indexOfArray( * Searches a string for an occurrence of a substring and returns the UTF-8 byte index of the first occurrence. If the substring is not found, returns -1. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/indexOfBytes/ - * @param ResolvesToString|non-empty-string $string Can be any valid expression as long as it resolves to a string. + * @param ResolvesToString|string $string Can be any valid expression as long as it resolves to a string. * If the string expression resolves to a value of null or refers to a field that is missing, $indexOfBytes returns null. * If the string expression does not resolve to a string or null nor refers to a missing field, $indexOfBytes returns an error. - * @param ResolvesToString|non-empty-string $substring Can be any valid expression as long as it resolves to a string. + * @param ResolvesToString|string $substring Can be any valid expression as long as it resolves to a string. * @param Optional|ResolvesToInt|int $start An integer, or a number that can be represented as integers (such as 2.0), that specifies the starting index position for the search. Can be any valid expression that resolves to a non-negative integral number. * If unspecified, the starting index position for the search is the beginning of the string. * @param Optional|ResolvesToInt|int $end An integer, or a number that can be represented as integers (such as 2.0), that specifies the ending index position for the search. Can be any valid expression that resolves to a non-negative integral number. If you specify a index value, you should also specify a index value; otherwise, $indexOfArray uses the value as the index value instead of the value. @@ -915,10 +915,10 @@ public static function indexOfBytes( * Searches a string for an occurrence of a substring and returns the UTF-8 code point index of the first occurrence. If the substring is not found, returns -1 * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/indexOfCP/ - * @param ResolvesToString|non-empty-string $string Can be any valid expression as long as it resolves to a string. + * @param ResolvesToString|string $string Can be any valid expression as long as it resolves to a string. * If the string expression resolves to a value of null or refers to a field that is missing, $indexOfCP returns null. * If the string expression does not resolve to a string or null nor refers to a missing field, $indexOfCP returns an error. - * @param ResolvesToString|non-empty-string $substring Can be any valid expression as long as it resolves to a string. + * @param ResolvesToString|string $substring Can be any valid expression as long as it resolves to a string. * @param Optional|ResolvesToInt|int $start An integer, or a number that can be represented as integers (such as 2.0), that specifies the starting index position for the search. Can be any valid expression that resolves to a non-negative integral number. * If unspecified, the starting index position for the search is the beginning of the string. * @param Optional|ResolvesToInt|int $end An integer, or a number that can be represented as integers (such as 2.0), that specifies the ending index position for the search. Can be any valid expression that resolves to a non-negative integral number. If you specify a index value, you should also specify a index value; otherwise, $indexOfArray uses the value as the index value instead of the value. @@ -940,7 +940,7 @@ public static function indexOfCP( * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/integral/ * @param Decimal128|Int64|ResolvesToDate|ResolvesToNumber|UTCDateTime|float|int $input - * @param Optional|ResolvesToString|non-empty-string $unit A string that specifies the time unit. Use one of these strings: "week", "day","hour", "minute", "second", "millisecond". + * @param Optional|ResolvesToString|string $unit A string that specifies the time unit. Use one of these strings: "week", "day","hour", "minute", "second", "millisecond". * If the sortBy field is not a date, you must omit a unit. If you specify a unit, you must specify a date in the sortBy field. */ public static function integral( @@ -955,7 +955,7 @@ public static function integral( * Determines if the operand is an array. Returns a boolean. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/isArray/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public static function isArray( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression, @@ -970,7 +970,7 @@ public static function isArray( * New in MongoDB 4.4. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/isNumber/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public static function isNumber( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression, @@ -984,7 +984,7 @@ public static function isNumber( * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/isoDayOfWeek/ * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public static function isoDayOfWeek( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date, @@ -999,7 +999,7 @@ public static function isoDayOfWeek( * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/isoWeek/ * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public static function isoWeek( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date, @@ -1014,7 +1014,7 @@ public static function isoWeek( * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/isoWeekYear/ * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public static function isoWeekYear( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date, @@ -1057,7 +1057,7 @@ public static function lastN( * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/let/ * @param Document|Serializable|array|stdClass $vars Assignment block for the variables accessible in the in expression. To assign a variable, specify a string for the variable name and assign a valid expression for the value. * The variable assignments have no meaning outside the in expression, not even within the vars block itself. - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $in The expression to evaluate. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $in The expression to evaluate. */ public static function let( Document|Serializable|stdClass|array $vars, @@ -1084,7 +1084,7 @@ public static function linearFill(Decimal128|Int64|ResolvesToNumber|float|int $e * Return a value without parsing. Use for values that the aggregation pipeline may interpret as an expression. For example, use a $literal expression to a string that starts with a dollar sign ($) to avoid parsing as a field path. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/literal/ - * @param Type|array|bool|float|int|non-empty-string|null|stdClass $value If the value is an expression, $literal does not evaluate the expression but instead returns the unparsed expression. + * @param Type|array|bool|float|int|null|stdClass|string $value If the value is an expression, $literal does not evaluate the expression but instead returns the unparsed expression. */ public static function literal(Type|stdClass|array|bool|float|int|null|string $value): LiteralOperator { @@ -1109,7 +1109,7 @@ public static function ln(Decimal128|Int64|ResolvesToNumber|float|int $number): * New in MongoDB 5.2. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/locf/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public static function locf( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression, @@ -1148,8 +1148,8 @@ public static function log10(Decimal128|Int64|ResolvesToNumber|float|int $number * Returns true if the first value is less than the second. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/lt/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression1 - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression2 + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression1 + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression2 */ public static function lt( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression1, @@ -1163,8 +1163,8 @@ public static function lt( * Returns true if the first value is less than or equal to the second. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/lte/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression1 - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression2 + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression1 + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression2 */ public static function lte( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression1, @@ -1179,8 +1179,8 @@ public static function lte( * New in MongoDB 4.0. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/ltrim/ - * @param ResolvesToString|non-empty-string $input The string to trim. The argument can be any valid expression that resolves to a string. - * @param Optional|ResolvesToString|non-empty-string $chars The character(s) to trim from the beginning of the input. + * @param ResolvesToString|string $input The string to trim. The argument can be any valid expression that resolves to a string. + * @param Optional|ResolvesToString|string $chars The character(s) to trim from the beginning of the input. * The argument can be any valid expression that resolves to a string. The $ltrim operator breaks down the string into individual UTF code point to trim from input. * If unspecified, $ltrim removes whitespace characters, including the null character. */ @@ -1197,8 +1197,8 @@ public static function ltrim( * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/map/ * @param BSONArray|PackedArray|ResolvesToArray|array $input An expression that resolves to an array. - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $in An expression that is applied to each element of the input array. The expression references each element individually with the variable name specified in as. - * @param Optional|ResolvesToString|non-empty-string $as A name for the variable that represents each individual element of the input array. If no name is specified, the variable name defaults to this. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $in An expression that is applied to each element of the input array. The expression references each element individually with the variable name specified in as. + * @param Optional|ResolvesToString|string $as A name for the variable that represents each individual element of the input array. If no name is specified, the variable name defaults to this. */ public static function map( PackedArray|ResolvesToArray|BSONArray|array $input, @@ -1215,7 +1215,7 @@ public static function map( * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/max/ * @no-named-arguments - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass ...$expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string ...$expression */ public static function max( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string ...$expression, @@ -1249,7 +1249,7 @@ public static function maxN( * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/median/ * @param BSONArray|Decimal128|Int64|PackedArray|ResolvesToNumber|array|float|int $input $median calculates the 50th percentile value of this data. input must be a field name or an expression that evaluates to a numeric type. If the expression cannot be converted to a numeric type, the $median calculation ignores it. - * @param non-empty-string $method The method that mongod uses to calculate the 50th percentile value. The method must be 'approximate'. + * @param string $method The method that mongod uses to calculate the 50th percentile value. The method must be 'approximate'. */ public static function median( Decimal128|Int64|PackedArray|ResolvesToNumber|BSONArray|array|float|int $input, @@ -1277,7 +1277,7 @@ public static function mergeObjects( * Access available per-document metadata related to the aggregation operation. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/meta/ - * @param non-empty-string $keyword + * @param string $keyword */ public static function meta(string $keyword): MetaOperator { @@ -1289,7 +1289,7 @@ public static function meta(string $keyword): MetaOperator * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/millisecond/ * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public static function millisecond( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date, @@ -1305,7 +1305,7 @@ public static function millisecond( * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/min/ * @no-named-arguments - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass ...$expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string ...$expression */ public static function min( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string ...$expression, @@ -1334,7 +1334,7 @@ public static function minN( * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/minute/ * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public static function minute( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date, @@ -1364,7 +1364,7 @@ public static function mod( * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/month/ * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public static function month( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date, @@ -1391,8 +1391,8 @@ public static function multiply(Decimal128|Int64|ResolvesToNumber|float|int ...$ * Returns true if the values are not equivalent. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/ne/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression1 - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression2 + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression1 + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression2 */ public static function ne( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression1, @@ -1406,7 +1406,7 @@ public static function ne( * Returns the boolean value that is the opposite of its argument expression. Accepts a single argument expression. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/not/ - * @param ExpressionInterface|ResolvesToBool|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|ResolvesToBool|Type|array|bool|float|int|null|stdClass|string $expression */ public static function not( Type|ResolvesToBool|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression, @@ -1433,7 +1433,7 @@ public static function objectToArray( * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/or/ * @no-named-arguments - * @param ExpressionInterface|ResolvesToBool|Type|array|bool|float|int|non-empty-string|null|stdClass ...$expression + * @param ExpressionInterface|ResolvesToBool|Type|array|bool|float|int|null|stdClass|string ...$expression */ public static function or( Type|ResolvesToBool|ExpressionInterface|stdClass|array|bool|float|int|null|string ...$expression, @@ -1457,7 +1457,7 @@ public static function or( * @param BSONArray|Decimal128|Int64|PackedArray|ResolvesToNumber|array|float|int $input $percentile calculates the percentile values of this data. input must be a field name or an expression that evaluates to a numeric type. If the expression cannot be converted to a numeric type, the $percentile calculation ignores it. * @param BSONArray|PackedArray|ResolvesToArray|array $p $percentile calculates a percentile value for each element in p. The elements represent percentages and must evaluate to numeric values in the range 0.0 to 1.0, inclusive. * $percentile returns results in the same order as the elements in p. - * @param non-empty-string $method The method that mongod uses to calculate the percentile value. The method must be 'approximate'. + * @param string $method The method that mongod uses to calculate the percentile value. The method must be 'approximate'. */ public static function percentile( Decimal128|Int64|PackedArray|ResolvesToNumber|BSONArray|array|float|int $input, @@ -1541,8 +1541,8 @@ public static function rank(): RankOperator * @param BSONArray|PackedArray|ResolvesToArray|array $input Can be any valid expression that resolves to an array. * If the argument resolves to a value of null or refers to a missing field, $reduce returns null. * If the argument does not resolve to an array or null nor refers to a missing field, $reduce returns an error. - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $initialValue The initial cumulative value set before in is applied to the first element of the input array. - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $in A valid expression that $reduce applies to each element in the input array in left-to-right order. Wrap the input value with $reverseArray to yield the equivalent of applying the combining expression from right-to-left. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $initialValue The initial cumulative value set before in is applied to the first element of the input array. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $in A valid expression that $reduce applies to each element in the input array in left-to-right order. Wrap the input value with $reverseArray to yield the equivalent of applying the combining expression from right-to-left. * During evaluation of the in expression, two variables will be available: * - value is the variable that represents the cumulative value of the expression. * - this is the variable that refers to the element being processed. @@ -1561,9 +1561,9 @@ public static function reduce( * New in MongoDB 4.2. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/regexFind/ - * @param ResolvesToString|non-empty-string $input The string on which you wish to apply the regex pattern. Can be a string or any valid expression that resolves to a string. - * @param Regex|ResolvesToString|non-empty-string $regex The regex pattern to apply. Can be any valid expression that resolves to either a string or regex pattern //. When using the regex //, you can also specify the regex options i and m (but not the s or x options) - * @param Optional|non-empty-string $options + * @param ResolvesToString|string $input The string on which you wish to apply the regex pattern. Can be a string or any valid expression that resolves to a string. + * @param Regex|ResolvesToString|string $regex The regex pattern to apply. Can be any valid expression that resolves to either a string or regex pattern //. When using the regex //, you can also specify the regex options i and m (but not the s or x options) + * @param Optional|string $options */ public static function regexFind( ResolvesToString|string $input, @@ -1579,9 +1579,9 @@ public static function regexFind( * New in MongoDB 4.2. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/regexFindAll/ - * @param ResolvesToString|non-empty-string $input The string on which you wish to apply the regex pattern. Can be a string or any valid expression that resolves to a string. - * @param Regex|ResolvesToString|non-empty-string $regex The regex pattern to apply. Can be any valid expression that resolves to either a string or regex pattern //. When using the regex //, you can also specify the regex options i and m (but not the s or x options) - * @param Optional|non-empty-string $options + * @param ResolvesToString|string $input The string on which you wish to apply the regex pattern. Can be a string or any valid expression that resolves to a string. + * @param Regex|ResolvesToString|string $regex The regex pattern to apply. Can be any valid expression that resolves to either a string or regex pattern //. When using the regex //, you can also specify the regex options i and m (but not the s or x options) + * @param Optional|string $options */ public static function regexFindAll( ResolvesToString|string $input, @@ -1597,9 +1597,9 @@ public static function regexFindAll( * New in MongoDB 4.2. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/regexMatch/ - * @param ResolvesToString|non-empty-string $input The string on which you wish to apply the regex pattern. Can be a string or any valid expression that resolves to a string. - * @param Regex|ResolvesToString|non-empty-string $regex The regex pattern to apply. Can be any valid expression that resolves to either a string or regex pattern //. When using the regex //, you can also specify the regex options i and m (but not the s or x options) - * @param Optional|non-empty-string $options + * @param ResolvesToString|string $input The string on which you wish to apply the regex pattern. Can be a string or any valid expression that resolves to a string. + * @param Regex|ResolvesToString|string $regex The regex pattern to apply. Can be any valid expression that resolves to either a string or regex pattern //. When using the regex //, you can also specify the regex options i and m (but not the s or x options) + * @param Optional|string $options */ public static function regexMatch( ResolvesToString|string $input, @@ -1616,9 +1616,9 @@ public static function regexMatch( * New in MongoDB 4.4. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/replaceAll/ - * @param ResolvesToNull|ResolvesToString|non-empty-string|null $input The string on which you wish to apply the find. Can be any valid expression that resolves to a string or a null. If input refers to a field that is missing, $replaceAll returns null. - * @param ResolvesToNull|ResolvesToString|non-empty-string|null $find The string to search for within the given input. Can be any valid expression that resolves to a string or a null. If find refers to a field that is missing, $replaceAll returns null. - * @param ResolvesToNull|ResolvesToString|non-empty-string|null $replacement The string to use to replace all matched instances of find in input. Can be any valid expression that resolves to a string or a null. + * @param ResolvesToNull|ResolvesToString|null|string $input The string on which you wish to apply the find. Can be any valid expression that resolves to a string or a null. If input refers to a field that is missing, $replaceAll returns null. + * @param ResolvesToNull|ResolvesToString|null|string $find The string to search for within the given input. Can be any valid expression that resolves to a string or a null. If find refers to a field that is missing, $replaceAll returns null. + * @param ResolvesToNull|ResolvesToString|null|string $replacement The string to use to replace all matched instances of find in input. Can be any valid expression that resolves to a string or a null. */ public static function replaceAll( ResolvesToNull|ResolvesToString|null|string $input, @@ -1634,9 +1634,9 @@ public static function replaceAll( * New in MongoDB 4.4. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/replaceOne/ - * @param ResolvesToNull|ResolvesToString|non-empty-string|null $input The string on which you wish to apply the find. Can be any valid expression that resolves to a string or a null. If input refers to a field that is missing, $replaceAll returns null. - * @param ResolvesToNull|ResolvesToString|non-empty-string|null $find The string to search for within the given input. Can be any valid expression that resolves to a string or a null. If find refers to a field that is missing, $replaceAll returns null. - * @param ResolvesToNull|ResolvesToString|non-empty-string|null $replacement The string to use to replace all matched instances of find in input. Can be any valid expression that resolves to a string or a null. + * @param ResolvesToNull|ResolvesToString|null|string $input The string on which you wish to apply the find. Can be any valid expression that resolves to a string or a null. If input refers to a field that is missing, $replaceAll returns null. + * @param ResolvesToNull|ResolvesToString|null|string $find The string to search for within the given input. Can be any valid expression that resolves to a string or a null. If find refers to a field that is missing, $replaceAll returns null. + * @param ResolvesToNull|ResolvesToString|null|string $replacement The string to use to replace all matched instances of find in input. Can be any valid expression that resolves to a string or a null. */ public static function replaceOne( ResolvesToNull|ResolvesToString|null|string $input, @@ -1678,8 +1678,8 @@ public static function round( * Removes whitespace characters, including null, or the specified characters from the end of a string. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/rtrim/ - * @param ResolvesToString|non-empty-string $input The string to trim. The argument can be any valid expression that resolves to a string. - * @param Optional|ResolvesToString|non-empty-string $chars The character(s) to trim from the beginning of the input. + * @param ResolvesToString|string $input The string to trim. The argument can be any valid expression that resolves to a string. + * @param Optional|ResolvesToString|string $chars The character(s) to trim from the beginning of the input. * The argument can be any valid expression that resolves to a string. The $ltrim operator breaks down the string into individual UTF code point to trim from input. * If unspecified, $ltrim removes whitespace characters, including the null character. */ @@ -1696,7 +1696,7 @@ public static function rtrim( * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/second/ * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public static function second( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date, @@ -1738,9 +1738,9 @@ public static function setEquals(PackedArray|ResolvesToArray|BSONArray|array ... * New in MongoDB 5.0. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/setField/ - * @param ResolvesToString|non-empty-string $field Field in the input object that you want to add, update, or remove. field can be any valid expression that resolves to a string constant. + * @param ResolvesToString|string $field Field in the input object that you want to add, update, or remove. field can be any valid expression that resolves to a string constant. * @param Document|ResolvesToObject|Serializable|array|stdClass $input Document that contains the field that you want to add or update. input must resolve to an object, missing, null, or undefined. - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $value The value that you want to assign to field. value can be any valid expression. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $value The value that you want to assign to field. value can be any valid expression. * Set to $$REMOVE to remove field from the input document. */ public static function setField( @@ -1870,8 +1870,8 @@ public static function sortArray( * Splits a string into substrings based on a delimiter. Returns an array of substrings. If the delimiter is not found within the string, returns an array containing the original string. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/split/ - * @param ResolvesToString|non-empty-string $string The string to be split. string expression can be any valid expression as long as it resolves to a string. - * @param ResolvesToString|non-empty-string $delimiter The delimiter to use when splitting the string expression. delimiter can be any valid expression as long as it resolves to a string. + * @param ResolvesToString|string $string The string to be split. string expression can be any valid expression as long as it resolves to a string. + * @param ResolvesToString|string $delimiter The delimiter to use when splitting the string expression. delimiter can be any valid expression as long as it resolves to a string. */ public static function split(ResolvesToString|string $string, ResolvesToString|string $delimiter): SplitOperator { @@ -1920,8 +1920,8 @@ public static function stdDevSamp(Decimal128|Int64|ResolvesToNumber|float|int .. * Performs case-insensitive string comparison and returns: 0 if two strings are equivalent, 1 if the first string is greater than the second, and -1 if the first string is less than the second. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/strcasecmp/ - * @param ResolvesToString|non-empty-string $expression1 - * @param ResolvesToString|non-empty-string $expression2 + * @param ResolvesToString|string $expression1 + * @param ResolvesToString|string $expression2 */ public static function strcasecmp( ResolvesToString|string $expression1, @@ -1935,7 +1935,7 @@ public static function strcasecmp( * Returns the number of UTF-8 encoded bytes in a string. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/strLenBytes/ - * @param ResolvesToString|non-empty-string $expression + * @param ResolvesToString|string $expression */ public static function strLenBytes(ResolvesToString|string $expression): StrLenBytesOperator { @@ -1946,7 +1946,7 @@ public static function strLenBytes(ResolvesToString|string $expression): StrLenB * Returns the number of UTF-8 code points in a string. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/strLenCP/ - * @param ResolvesToString|non-empty-string $expression + * @param ResolvesToString|string $expression */ public static function strLenCP(ResolvesToString|string $expression): StrLenCPOperator { @@ -1957,7 +1957,7 @@ public static function strLenCP(ResolvesToString|string $expression): StrLenCPOp * Deprecated. Use $substrBytes or $substrCP. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/substr/ - * @param ResolvesToString|non-empty-string $string + * @param ResolvesToString|string $string * @param ResolvesToInt|int $start If start is a negative number, $substr returns an empty string "". * @param ResolvesToInt|int $length If length is a negative number, $substr returns a substring that starts at the specified index and includes the rest of the string. */ @@ -1974,7 +1974,7 @@ public static function substr( * Returns the substring of a string. Starts with the character at the specified UTF-8 byte index (zero-based) in the string and continues for the specified number of bytes. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/substrBytes/ - * @param ResolvesToString|non-empty-string $string + * @param ResolvesToString|string $string * @param ResolvesToInt|int $start If start is a negative number, $substr returns an empty string "". * @param ResolvesToInt|int $length If length is a negative number, $substr returns a substring that starts at the specified index and includes the rest of the string. */ @@ -1991,7 +1991,7 @@ public static function substrBytes( * Returns the substring of a string. Starts with the character at the specified UTF-8 code point (CP) index (zero-based) in the string and continues for the number of code points specified. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/substrCP/ - * @param ResolvesToString|non-empty-string $string + * @param ResolvesToString|string $string * @param ResolvesToInt|int $start If start is a negative number, $substr returns an empty string "". * @param ResolvesToInt|int $length If length is a negative number, $substr returns a substring that starts at the specified index and includes the rest of the string. */ @@ -2040,7 +2040,7 @@ public static function sum(Decimal128|Int64|ResolvesToNumber|float|int ...$expre * - case Can be any valid expression that resolves to a boolean. If the result is not a boolean, it is coerced to a boolean value. More information about how MongoDB evaluates expressions as either true or false can be found here. * - then Can be any valid expression. * The branches array must contain at least one branch document. - * @param Optional|ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $default The path to take if no branch case expression evaluates to true. + * @param Optional|ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $default The path to take if no branch case expression evaluates to true. * Although optional, if default is unspecified and no branch case evaluates to true, $switch returns an error. */ public static function switch( @@ -2080,7 +2080,7 @@ public static function tanh(Decimal128|Int64|ResolvesToNumber|float|int $express * New in MongoDB 4.0. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/toBool/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public static function toBool( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression, @@ -2094,7 +2094,7 @@ public static function toBool( * New in MongoDB 4.0. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/toDate/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public static function toDate( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression, @@ -2108,7 +2108,7 @@ public static function toDate( * New in MongoDB 4.0. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/toDecimal/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public static function toDecimal( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression, @@ -2122,7 +2122,7 @@ public static function toDecimal( * New in MongoDB 4.0. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/toDouble/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public static function toDouble( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression, @@ -2135,7 +2135,7 @@ public static function toDouble( * Computes and returns the hash value of the input expression using the same hash function that MongoDB uses to create a hashed index. A hash function maps a key or string to a fixed-size numeric value. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/toHashedIndexKey/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $value key or string to hash + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $value key or string to hash */ public static function toHashedIndexKey( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $value, @@ -2149,7 +2149,7 @@ public static function toHashedIndexKey( * New in MongoDB 4.0. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/toInt/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public static function toInt( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression, @@ -2163,7 +2163,7 @@ public static function toInt( * New in MongoDB 4.0. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/toLong/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public static function toLong( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression, @@ -2176,7 +2176,7 @@ public static function toLong( * Converts a string to lowercase. Accepts a single argument expression. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/toLower/ - * @param ResolvesToString|non-empty-string $expression + * @param ResolvesToString|string $expression */ public static function toLower(ResolvesToString|string $expression): ToLowerOperator { @@ -2188,7 +2188,7 @@ public static function toLower(ResolvesToString|string $expression): ToLowerOper * New in MongoDB 4.0. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/toObjectId/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public static function toObjectId( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression, @@ -2202,7 +2202,7 @@ public static function toObjectId( * New in MongoDB 4.0. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/toString/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public static function toString( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression, @@ -2215,7 +2215,7 @@ public static function toString( * Converts a string to uppercase. Accepts a single argument expression. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/toUpper/ - * @param ResolvesToString|non-empty-string $expression + * @param ResolvesToString|string $expression */ public static function toUpper(ResolvesToString|string $expression): ToUpperOperator { @@ -2227,8 +2227,8 @@ public static function toUpper(ResolvesToString|string $expression): ToUpperOper * New in MongoDB 4.0. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/trim/ - * @param ResolvesToString|non-empty-string $input The string to trim. The argument can be any valid expression that resolves to a string. - * @param Optional|ResolvesToString|non-empty-string $chars The character(s) to trim from the beginning of the input. + * @param ResolvesToString|string $input The string to trim. The argument can be any valid expression that resolves to a string. + * @param Optional|ResolvesToString|string $chars The character(s) to trim from the beginning of the input. * The argument can be any valid expression that resolves to a string. The $ltrim operator breaks down the string into individual UTF code point to trim from input. * If unspecified, $ltrim removes whitespace characters, including the null character. */ @@ -2284,7 +2284,7 @@ public static function tsSecond(Timestamp|ResolvesToTimestamp|int $expression): * Return the BSON data type of the field. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/type/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public static function type( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression, @@ -2298,7 +2298,7 @@ public static function type( * $unsetField is an alias for $setField using $$REMOVE to remove fields. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/unsetField/ - * @param ResolvesToString|non-empty-string $field Field in the input object that you want to add, update, or remove. field can be any valid expression that resolves to a string constant. + * @param ResolvesToString|string $field Field in the input object that you want to add, update, or remove. field can be any valid expression that resolves to a string constant. * @param Document|ResolvesToObject|Serializable|array|stdClass $input Document that contains the field that you want to add or update. input must resolve to an object, missing, null, or undefined. */ public static function unsetField( @@ -2314,7 +2314,7 @@ public static function unsetField( * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/week/ * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public static function week( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date, @@ -2329,7 +2329,7 @@ public static function week( * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/year/ * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public static function year( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date, diff --git a/src/Builder/Expression/FilterOperator.php b/src/Builder/Expression/FilterOperator.php index 261332a..6fc372e 100644 --- a/src/Builder/Expression/FilterOperator.php +++ b/src/Builder/Expression/FilterOperator.php @@ -33,7 +33,7 @@ class FilterOperator implements ResolvesToArray, OperatorInterface /** @var ResolvesToBool|bool $cond An expression that resolves to a boolean value used to determine if an element should be included in the output array. The expression references each element of the input array individually with the variable name specified in as. */ public readonly ResolvesToBool|bool $cond; - /** @var Optional|non-empty-string $as A name for the variable that represents each individual element of the input array. If no name is specified, the variable name defaults to this. */ + /** @var Optional|string $as A name for the variable that represents each individual element of the input array. If no name is specified, the variable name defaults to this. */ public readonly Optional|string $as; /** @@ -45,7 +45,7 @@ class FilterOperator implements ResolvesToArray, OperatorInterface /** * @param BSONArray|PackedArray|ResolvesToArray|array $input * @param ResolvesToBool|bool $cond An expression that resolves to a boolean value used to determine if an element should be included in the output array. The expression references each element of the input array individually with the variable name specified in as. - * @param Optional|non-empty-string $as A name for the variable that represents each individual element of the input array. If no name is specified, the variable name defaults to this. + * @param Optional|string $as A name for the variable that represents each individual element of the input array. If no name is specified, the variable name defaults to this. * @param Optional|ResolvesToInt|int $limit A number expression that restricts the number of matching array elements that $filter returns. You cannot specify a limit less than 1. The matching array elements are returned in the order they appear in the input array. * If the specified limit is greater than the number of matching array elements, $filter returns all matching array elements. If the limit is null, $filter returns all matching array elements. */ diff --git a/src/Builder/Expression/FunctionOperator.php b/src/Builder/Expression/FunctionOperator.php index a48d58e..2a59fd6 100644 --- a/src/Builder/Expression/FunctionOperator.php +++ b/src/Builder/Expression/FunctionOperator.php @@ -30,7 +30,7 @@ class FunctionOperator implements ResolvesToAny, OperatorInterface public const ENCODE = Encode::Object; /** - * @var Javascript|non-empty-string $body The function definition. You can specify the function definition as either BSON\JavaScript or string. + * @var Javascript|string $body The function definition. You can specify the function definition as either BSON\JavaScript or string. * function(arg1, arg2, ...) { ... } */ public readonly Javascript|string $body; @@ -38,14 +38,14 @@ class FunctionOperator implements ResolvesToAny, OperatorInterface /** @var BSONArray|PackedArray|array $args Arguments passed to the function body. If the body function does not take an argument, you can specify an empty array [ ]. */ public readonly PackedArray|BSONArray|array $args; - /** @var non-empty-string $lang */ + /** @var string $lang */ public readonly string $lang; /** - * @param Javascript|non-empty-string $body The function definition. You can specify the function definition as either BSON\JavaScript or string. + * @param Javascript|string $body The function definition. You can specify the function definition as either BSON\JavaScript or string. * function(arg1, arg2, ...) { ... } * @param BSONArray|PackedArray|array $args Arguments passed to the function body. If the body function does not take an argument, you can specify an empty array [ ]. - * @param non-empty-string $lang + * @param string $lang */ public function __construct(Javascript|string $body, PackedArray|BSONArray|array $args = [], string $lang = 'js') { diff --git a/src/Builder/Expression/GetFieldOperator.php b/src/Builder/Expression/GetFieldOperator.php index c1b1493..45007b3 100644 --- a/src/Builder/Expression/GetFieldOperator.php +++ b/src/Builder/Expression/GetFieldOperator.php @@ -26,21 +26,21 @@ class GetFieldOperator implements ResolvesToAny, OperatorInterface public const ENCODE = Encode::Object; /** - * @var ResolvesToString|non-empty-string $field Field in the input object for which you want to return a value. field can be any valid expression that resolves to a string constant. + * @var ResolvesToString|string $field Field in the input object for which you want to return a value. field can be any valid expression that resolves to a string constant. * If field begins with a dollar sign ($), place the field name inside of a $literal expression to return its value. */ public readonly ResolvesToString|string $field; /** - * @var Optional|ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $input Default: $$CURRENT + * @var Optional|ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $input Default: $$CURRENT * A valid expression that contains the field for which you want to return a value. input must resolve to an object, missing, null, or undefined. If omitted, defaults to the document currently being processed in the pipeline ($$CURRENT). */ public readonly Optional|Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $input; /** - * @param ResolvesToString|non-empty-string $field Field in the input object for which you want to return a value. field can be any valid expression that resolves to a string constant. + * @param ResolvesToString|string $field Field in the input object for which you want to return a value. field can be any valid expression that resolves to a string constant. * If field begins with a dollar sign ($), place the field name inside of a $literal expression to return its value. - * @param Optional|ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $input Default: $$CURRENT + * @param Optional|ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $input Default: $$CURRENT * A valid expression that contains the field for which you want to return a value. input must resolve to an object, missing, null, or undefined. If omitted, defaults to the document currently being processed in the pipeline ($$CURRENT). */ public function __construct( diff --git a/src/Builder/Expression/GtOperator.php b/src/Builder/Expression/GtOperator.php index 5252fbf..1f4287e 100644 --- a/src/Builder/Expression/GtOperator.php +++ b/src/Builder/Expression/GtOperator.php @@ -23,15 +23,15 @@ class GtOperator implements ResolvesToBool, OperatorInterface { public const ENCODE = Encode::Array; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression1 */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression1 */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression1; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression2 */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression2 */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression2; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression1 - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression2 + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression1 + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression2 */ public function __construct( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression1, diff --git a/src/Builder/Expression/GteOperator.php b/src/Builder/Expression/GteOperator.php index 0df0de9..8ed633a 100644 --- a/src/Builder/Expression/GteOperator.php +++ b/src/Builder/Expression/GteOperator.php @@ -23,15 +23,15 @@ class GteOperator implements ResolvesToBool, OperatorInterface { public const ENCODE = Encode::Array; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression1 */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression1 */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression1; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression2 */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression2 */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression2; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression1 - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression2 + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression1 + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression2 */ public function __construct( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression1, diff --git a/src/Builder/Expression/HourOperator.php b/src/Builder/Expression/HourOperator.php index b53c0ed..2d05985 100644 --- a/src/Builder/Expression/HourOperator.php +++ b/src/Builder/Expression/HourOperator.php @@ -27,12 +27,12 @@ class HourOperator implements ResolvesToInt, OperatorInterface /** @var ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. */ public readonly ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date; - /** @var Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ + /** @var Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public readonly Optional|ResolvesToString|string $timezone; /** * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public function __construct( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date, diff --git a/src/Builder/Expression/IfNullOperator.php b/src/Builder/Expression/IfNullOperator.php index 838b36a..eae888e 100644 --- a/src/Builder/Expression/IfNullOperator.php +++ b/src/Builder/Expression/IfNullOperator.php @@ -26,11 +26,11 @@ class IfNullOperator implements ResolvesToAny, OperatorInterface { public const ENCODE = Encode::Single; - /** @var list $expression */ + /** @var list $expression */ public readonly array $expression; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass ...$expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string ...$expression * @no-named-arguments */ public function __construct(Type|ExpressionInterface|stdClass|array|bool|float|int|null|string ...$expression) diff --git a/src/Builder/Expression/InOperator.php b/src/Builder/Expression/InOperator.php index 62811a1..90ddab2 100644 --- a/src/Builder/Expression/InOperator.php +++ b/src/Builder/Expression/InOperator.php @@ -29,14 +29,14 @@ class InOperator implements ResolvesToBool, OperatorInterface { public const ENCODE = Encode::Array; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression Any valid expression expression. */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression Any valid expression expression. */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression; /** @var BSONArray|PackedArray|ResolvesToArray|array $array Any valid expression that resolves to an array. */ public readonly PackedArray|ResolvesToArray|BSONArray|array $array; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression Any valid expression expression. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression Any valid expression expression. * @param BSONArray|PackedArray|ResolvesToArray|array $array Any valid expression that resolves to an array. */ public function __construct( diff --git a/src/Builder/Expression/IndexOfArrayOperator.php b/src/Builder/Expression/IndexOfArrayOperator.php index 9d48f69..d04497f 100644 --- a/src/Builder/Expression/IndexOfArrayOperator.php +++ b/src/Builder/Expression/IndexOfArrayOperator.php @@ -37,7 +37,7 @@ class IndexOfArrayOperator implements ResolvesToInt, OperatorInterface */ public readonly PackedArray|ResolvesToArray|BSONArray|array $array; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $search */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $search */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $search; /** @@ -56,7 +56,7 @@ class IndexOfArrayOperator implements ResolvesToInt, OperatorInterface * @param BSONArray|PackedArray|ResolvesToArray|array $array Can be any valid expression as long as it resolves to an array. * If the array expression resolves to a value of null or refers to a field that is missing, $indexOfArray returns null. * If the array expression does not resolve to an array or null nor refers to a missing field, $indexOfArray returns an error. - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $search + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $search * @param Optional|ResolvesToInt|int $start An integer, or a number that can be represented as integers (such as 2.0), that specifies the starting index position for the search. Can be any valid expression that resolves to a non-negative integral number. * If unspecified, the starting index position for the search is the beginning of the string. * @param Optional|ResolvesToInt|int $end An integer, or a number that can be represented as integers (such as 2.0), that specifies the ending index position for the search. Can be any valid expression that resolves to a non-negative integral number. If you specify a index value, you should also specify a index value; otherwise, $indexOfArray uses the value as the index value instead of the value. diff --git a/src/Builder/Expression/IndexOfBytesOperator.php b/src/Builder/Expression/IndexOfBytesOperator.php index fe696a5..ce778fa 100644 --- a/src/Builder/Expression/IndexOfBytesOperator.php +++ b/src/Builder/Expression/IndexOfBytesOperator.php @@ -22,13 +22,13 @@ class IndexOfBytesOperator implements ResolvesToInt, OperatorInterface public const ENCODE = Encode::Array; /** - * @var ResolvesToString|non-empty-string $string Can be any valid expression as long as it resolves to a string. + * @var ResolvesToString|string $string Can be any valid expression as long as it resolves to a string. * If the string expression resolves to a value of null or refers to a field that is missing, $indexOfBytes returns null. * If the string expression does not resolve to a string or null nor refers to a missing field, $indexOfBytes returns an error. */ public readonly ResolvesToString|string $string; - /** @var ResolvesToString|non-empty-string $substring Can be any valid expression as long as it resolves to a string. */ + /** @var ResolvesToString|string $substring Can be any valid expression as long as it resolves to a string. */ public readonly ResolvesToString|string $substring; /** @@ -44,10 +44,10 @@ class IndexOfBytesOperator implements ResolvesToInt, OperatorInterface public readonly Optional|ResolvesToInt|int $end; /** - * @param ResolvesToString|non-empty-string $string Can be any valid expression as long as it resolves to a string. + * @param ResolvesToString|string $string Can be any valid expression as long as it resolves to a string. * If the string expression resolves to a value of null or refers to a field that is missing, $indexOfBytes returns null. * If the string expression does not resolve to a string or null nor refers to a missing field, $indexOfBytes returns an error. - * @param ResolvesToString|non-empty-string $substring Can be any valid expression as long as it resolves to a string. + * @param ResolvesToString|string $substring Can be any valid expression as long as it resolves to a string. * @param Optional|ResolvesToInt|int $start An integer, or a number that can be represented as integers (such as 2.0), that specifies the starting index position for the search. Can be any valid expression that resolves to a non-negative integral number. * If unspecified, the starting index position for the search is the beginning of the string. * @param Optional|ResolvesToInt|int $end An integer, or a number that can be represented as integers (such as 2.0), that specifies the ending index position for the search. Can be any valid expression that resolves to a non-negative integral number. If you specify a index value, you should also specify a index value; otherwise, $indexOfArray uses the value as the index value instead of the value. diff --git a/src/Builder/Expression/IndexOfCPOperator.php b/src/Builder/Expression/IndexOfCPOperator.php index e6c5632..c4fd80d 100644 --- a/src/Builder/Expression/IndexOfCPOperator.php +++ b/src/Builder/Expression/IndexOfCPOperator.php @@ -22,13 +22,13 @@ class IndexOfCPOperator implements ResolvesToInt, OperatorInterface public const ENCODE = Encode::Array; /** - * @var ResolvesToString|non-empty-string $string Can be any valid expression as long as it resolves to a string. + * @var ResolvesToString|string $string Can be any valid expression as long as it resolves to a string. * If the string expression resolves to a value of null or refers to a field that is missing, $indexOfCP returns null. * If the string expression does not resolve to a string or null nor refers to a missing field, $indexOfCP returns an error. */ public readonly ResolvesToString|string $string; - /** @var ResolvesToString|non-empty-string $substring Can be any valid expression as long as it resolves to a string. */ + /** @var ResolvesToString|string $substring Can be any valid expression as long as it resolves to a string. */ public readonly ResolvesToString|string $substring; /** @@ -44,10 +44,10 @@ class IndexOfCPOperator implements ResolvesToInt, OperatorInterface public readonly Optional|ResolvesToInt|int $end; /** - * @param ResolvesToString|non-empty-string $string Can be any valid expression as long as it resolves to a string. + * @param ResolvesToString|string $string Can be any valid expression as long as it resolves to a string. * If the string expression resolves to a value of null or refers to a field that is missing, $indexOfCP returns null. * If the string expression does not resolve to a string or null nor refers to a missing field, $indexOfCP returns an error. - * @param ResolvesToString|non-empty-string $substring Can be any valid expression as long as it resolves to a string. + * @param ResolvesToString|string $substring Can be any valid expression as long as it resolves to a string. * @param Optional|ResolvesToInt|int $start An integer, or a number that can be represented as integers (such as 2.0), that specifies the starting index position for the search. Can be any valid expression that resolves to a non-negative integral number. * If unspecified, the starting index position for the search is the beginning of the string. * @param Optional|ResolvesToInt|int $end An integer, or a number that can be represented as integers (such as 2.0), that specifies the ending index position for the search. Can be any valid expression that resolves to a non-negative integral number. If you specify a index value, you should also specify a index value; otherwise, $indexOfArray uses the value as the index value instead of the value. diff --git a/src/Builder/Expression/IntegralOperator.php b/src/Builder/Expression/IntegralOperator.php index 97f4895..2f2c6ef 100644 --- a/src/Builder/Expression/IntegralOperator.php +++ b/src/Builder/Expression/IntegralOperator.php @@ -29,14 +29,14 @@ class IntegralOperator implements ResolvesToDouble, ResolvesToDecimal, OperatorI public readonly Decimal128|Int64|UTCDateTime|ResolvesToDate|ResolvesToNumber|float|int $input; /** - * @var Optional|ResolvesToString|non-empty-string $unit A string that specifies the time unit. Use one of these strings: "week", "day","hour", "minute", "second", "millisecond". + * @var Optional|ResolvesToString|string $unit A string that specifies the time unit. Use one of these strings: "week", "day","hour", "minute", "second", "millisecond". * If the sortBy field is not a date, you must omit a unit. If you specify a unit, you must specify a date in the sortBy field. */ public readonly Optional|ResolvesToString|string $unit; /** * @param Decimal128|Int64|ResolvesToDate|ResolvesToNumber|UTCDateTime|float|int $input - * @param Optional|ResolvesToString|non-empty-string $unit A string that specifies the time unit. Use one of these strings: "week", "day","hour", "minute", "second", "millisecond". + * @param Optional|ResolvesToString|string $unit A string that specifies the time unit. Use one of these strings: "week", "day","hour", "minute", "second", "millisecond". * If the sortBy field is not a date, you must omit a unit. If you specify a unit, you must specify a date in the sortBy field. */ public function __construct( diff --git a/src/Builder/Expression/IsArrayOperator.php b/src/Builder/Expression/IsArrayOperator.php index cf764aa..bb15c01 100644 --- a/src/Builder/Expression/IsArrayOperator.php +++ b/src/Builder/Expression/IsArrayOperator.php @@ -23,11 +23,11 @@ class IsArrayOperator implements ResolvesToBool, OperatorInterface { public const ENCODE = Encode::Array; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public function __construct(Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression) { diff --git a/src/Builder/Expression/IsNumberOperator.php b/src/Builder/Expression/IsNumberOperator.php index 8ccc977..9d778f6 100644 --- a/src/Builder/Expression/IsNumberOperator.php +++ b/src/Builder/Expression/IsNumberOperator.php @@ -25,11 +25,11 @@ class IsNumberOperator implements ResolvesToBool, OperatorInterface { public const ENCODE = Encode::Single; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public function __construct(Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression) { diff --git a/src/Builder/Expression/IsoDayOfWeekOperator.php b/src/Builder/Expression/IsoDayOfWeekOperator.php index 3f9cb49..ac55ea6 100644 --- a/src/Builder/Expression/IsoDayOfWeekOperator.php +++ b/src/Builder/Expression/IsoDayOfWeekOperator.php @@ -27,12 +27,12 @@ class IsoDayOfWeekOperator implements ResolvesToInt, OperatorInterface /** @var ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. */ public readonly ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date; - /** @var Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ + /** @var Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public readonly Optional|ResolvesToString|string $timezone; /** * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public function __construct( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date, diff --git a/src/Builder/Expression/IsoWeekOperator.php b/src/Builder/Expression/IsoWeekOperator.php index 17419af..af6cca4 100644 --- a/src/Builder/Expression/IsoWeekOperator.php +++ b/src/Builder/Expression/IsoWeekOperator.php @@ -27,12 +27,12 @@ class IsoWeekOperator implements ResolvesToInt, OperatorInterface /** @var ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. */ public readonly ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date; - /** @var Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ + /** @var Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public readonly Optional|ResolvesToString|string $timezone; /** * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public function __construct( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date, diff --git a/src/Builder/Expression/IsoWeekYearOperator.php b/src/Builder/Expression/IsoWeekYearOperator.php index d228a33..a23d906 100644 --- a/src/Builder/Expression/IsoWeekYearOperator.php +++ b/src/Builder/Expression/IsoWeekYearOperator.php @@ -27,12 +27,12 @@ class IsoWeekYearOperator implements ResolvesToInt, OperatorInterface /** @var ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. */ public readonly ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date; - /** @var Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ + /** @var Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public readonly Optional|ResolvesToString|string $timezone; /** * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public function __construct( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date, diff --git a/src/Builder/Expression/LetOperator.php b/src/Builder/Expression/LetOperator.php index 82fde5d..541b0b8 100644 --- a/src/Builder/Expression/LetOperator.php +++ b/src/Builder/Expression/LetOperator.php @@ -32,13 +32,13 @@ class LetOperator implements ResolvesToAny, OperatorInterface */ public readonly Document|Serializable|stdClass|array $vars; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $in The expression to evaluate. */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $in The expression to evaluate. */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $in; /** * @param Document|Serializable|array|stdClass $vars Assignment block for the variables accessible in the in expression. To assign a variable, specify a string for the variable name and assign a valid expression for the value. * The variable assignments have no meaning outside the in expression, not even within the vars block itself. - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $in The expression to evaluate. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $in The expression to evaluate. */ public function __construct( Document|Serializable|stdClass|array $vars, diff --git a/src/Builder/Expression/LiteralOperator.php b/src/Builder/Expression/LiteralOperator.php index c8b97a5..95e942b 100644 --- a/src/Builder/Expression/LiteralOperator.php +++ b/src/Builder/Expression/LiteralOperator.php @@ -22,11 +22,11 @@ class LiteralOperator implements ResolvesToAny, OperatorInterface { public const ENCODE = Encode::Single; - /** @var Type|array|bool|float|int|non-empty-string|null|stdClass $value If the value is an expression, $literal does not evaluate the expression but instead returns the unparsed expression. */ + /** @var Type|array|bool|float|int|null|stdClass|string $value If the value is an expression, $literal does not evaluate the expression but instead returns the unparsed expression. */ public readonly Type|stdClass|array|bool|float|int|null|string $value; /** - * @param Type|array|bool|float|int|non-empty-string|null|stdClass $value If the value is an expression, $literal does not evaluate the expression but instead returns the unparsed expression. + * @param Type|array|bool|float|int|null|stdClass|string $value If the value is an expression, $literal does not evaluate the expression but instead returns the unparsed expression. */ public function __construct(Type|stdClass|array|bool|float|int|null|string $value) { diff --git a/src/Builder/Expression/LocfOperator.php b/src/Builder/Expression/LocfOperator.php index bd4feef..64d437a 100644 --- a/src/Builder/Expression/LocfOperator.php +++ b/src/Builder/Expression/LocfOperator.php @@ -25,11 +25,11 @@ class LocfOperator implements ResolvesToAny, OperatorInterface { public const ENCODE = Encode::Single; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public function __construct(Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression) { diff --git a/src/Builder/Expression/LtOperator.php b/src/Builder/Expression/LtOperator.php index 78e4e12..a3cbad9 100644 --- a/src/Builder/Expression/LtOperator.php +++ b/src/Builder/Expression/LtOperator.php @@ -23,15 +23,15 @@ class LtOperator implements ResolvesToBool, OperatorInterface { public const ENCODE = Encode::Array; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression1 */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression1 */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression1; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression2 */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression2 */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression2; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression1 - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression2 + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression1 + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression2 */ public function __construct( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression1, diff --git a/src/Builder/Expression/LteOperator.php b/src/Builder/Expression/LteOperator.php index dd60b84..10e3d29 100644 --- a/src/Builder/Expression/LteOperator.php +++ b/src/Builder/Expression/LteOperator.php @@ -23,15 +23,15 @@ class LteOperator implements ResolvesToBool, OperatorInterface { public const ENCODE = Encode::Array; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression1 */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression1 */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression1; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression2 */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression2 */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression2; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression1 - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression2 + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression1 + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression2 */ public function __construct( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression1, diff --git a/src/Builder/Expression/LtrimOperator.php b/src/Builder/Expression/LtrimOperator.php index 944ced0..a0f4b7a 100644 --- a/src/Builder/Expression/LtrimOperator.php +++ b/src/Builder/Expression/LtrimOperator.php @@ -22,19 +22,19 @@ class LtrimOperator implements ResolvesToString, OperatorInterface { public const ENCODE = Encode::Object; - /** @var ResolvesToString|non-empty-string $input The string to trim. The argument can be any valid expression that resolves to a string. */ + /** @var ResolvesToString|string $input The string to trim. The argument can be any valid expression that resolves to a string. */ public readonly ResolvesToString|string $input; /** - * @var Optional|ResolvesToString|non-empty-string $chars The character(s) to trim from the beginning of the input. + * @var Optional|ResolvesToString|string $chars The character(s) to trim from the beginning of the input. * The argument can be any valid expression that resolves to a string. The $ltrim operator breaks down the string into individual UTF code point to trim from input. * If unspecified, $ltrim removes whitespace characters, including the null character. */ public readonly Optional|ResolvesToString|string $chars; /** - * @param ResolvesToString|non-empty-string $input The string to trim. The argument can be any valid expression that resolves to a string. - * @param Optional|ResolvesToString|non-empty-string $chars The character(s) to trim from the beginning of the input. + * @param ResolvesToString|string $input The string to trim. The argument can be any valid expression that resolves to a string. + * @param Optional|ResolvesToString|string $chars The character(s) to trim from the beginning of the input. * The argument can be any valid expression that resolves to a string. The $ltrim operator breaks down the string into individual UTF code point to trim from input. * If unspecified, $ltrim removes whitespace characters, including the null character. */ diff --git a/src/Builder/Expression/MapOperator.php b/src/Builder/Expression/MapOperator.php index a9b9386..9827439 100644 --- a/src/Builder/Expression/MapOperator.php +++ b/src/Builder/Expression/MapOperator.php @@ -33,16 +33,16 @@ class MapOperator implements ResolvesToArray, OperatorInterface /** @var BSONArray|PackedArray|ResolvesToArray|array $input An expression that resolves to an array. */ public readonly PackedArray|ResolvesToArray|BSONArray|array $input; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $in An expression that is applied to each element of the input array. The expression references each element individually with the variable name specified in as. */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $in An expression that is applied to each element of the input array. The expression references each element individually with the variable name specified in as. */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $in; - /** @var Optional|ResolvesToString|non-empty-string $as A name for the variable that represents each individual element of the input array. If no name is specified, the variable name defaults to this. */ + /** @var Optional|ResolvesToString|string $as A name for the variable that represents each individual element of the input array. If no name is specified, the variable name defaults to this. */ public readonly Optional|ResolvesToString|string $as; /** * @param BSONArray|PackedArray|ResolvesToArray|array $input An expression that resolves to an array. - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $in An expression that is applied to each element of the input array. The expression references each element individually with the variable name specified in as. - * @param Optional|ResolvesToString|non-empty-string $as A name for the variable that represents each individual element of the input array. If no name is specified, the variable name defaults to this. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $in An expression that is applied to each element of the input array. The expression references each element individually with the variable name specified in as. + * @param Optional|ResolvesToString|string $as A name for the variable that represents each individual element of the input array. If no name is specified, the variable name defaults to this. */ public function __construct( PackedArray|ResolvesToArray|BSONArray|array $input, diff --git a/src/Builder/Expression/MaxOperator.php b/src/Builder/Expression/MaxOperator.php index e23940c..ca5a1cf 100644 --- a/src/Builder/Expression/MaxOperator.php +++ b/src/Builder/Expression/MaxOperator.php @@ -27,11 +27,11 @@ class MaxOperator implements ResolvesToAny, OperatorInterface { public const ENCODE = Encode::Single; - /** @var list $expression */ + /** @var list $expression */ public readonly array $expression; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass ...$expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string ...$expression * @no-named-arguments */ public function __construct(Type|ExpressionInterface|stdClass|array|bool|float|int|null|string ...$expression) diff --git a/src/Builder/Expression/MedianOperator.php b/src/Builder/Expression/MedianOperator.php index cc5a2ff..f9c4f45 100644 --- a/src/Builder/Expression/MedianOperator.php +++ b/src/Builder/Expression/MedianOperator.php @@ -36,12 +36,12 @@ class MedianOperator implements ResolvesToDouble, OperatorInterface /** @var BSONArray|Decimal128|Int64|PackedArray|ResolvesToNumber|array|float|int $input $median calculates the 50th percentile value of this data. input must be a field name or an expression that evaluates to a numeric type. If the expression cannot be converted to a numeric type, the $median calculation ignores it. */ public readonly Decimal128|Int64|PackedArray|ResolvesToNumber|BSONArray|array|float|int $input; - /** @var non-empty-string $method The method that mongod uses to calculate the 50th percentile value. The method must be 'approximate'. */ + /** @var string $method The method that mongod uses to calculate the 50th percentile value. The method must be 'approximate'. */ public readonly string $method; /** * @param BSONArray|Decimal128|Int64|PackedArray|ResolvesToNumber|array|float|int $input $median calculates the 50th percentile value of this data. input must be a field name or an expression that evaluates to a numeric type. If the expression cannot be converted to a numeric type, the $median calculation ignores it. - * @param non-empty-string $method The method that mongod uses to calculate the 50th percentile value. The method must be 'approximate'. + * @param string $method The method that mongod uses to calculate the 50th percentile value. The method must be 'approximate'. */ public function __construct( Decimal128|Int64|PackedArray|ResolvesToNumber|BSONArray|array|float|int $input, diff --git a/src/Builder/Expression/MetaOperator.php b/src/Builder/Expression/MetaOperator.php index e8b37e3..a02b54e 100644 --- a/src/Builder/Expression/MetaOperator.php +++ b/src/Builder/Expression/MetaOperator.php @@ -20,11 +20,11 @@ class MetaOperator implements ResolvesToAny, OperatorInterface { public const ENCODE = Encode::Single; - /** @var non-empty-string $keyword */ + /** @var string $keyword */ public readonly string $keyword; /** - * @param non-empty-string $keyword + * @param string $keyword */ public function __construct(string $keyword) { diff --git a/src/Builder/Expression/MillisecondOperator.php b/src/Builder/Expression/MillisecondOperator.php index 9fbd112..63b53b4 100644 --- a/src/Builder/Expression/MillisecondOperator.php +++ b/src/Builder/Expression/MillisecondOperator.php @@ -27,12 +27,12 @@ class MillisecondOperator implements ResolvesToInt, OperatorInterface /** @var ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. */ public readonly ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date; - /** @var Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ + /** @var Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public readonly Optional|ResolvesToString|string $timezone; /** * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public function __construct( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date, diff --git a/src/Builder/Expression/MinOperator.php b/src/Builder/Expression/MinOperator.php index 6d5d89d..3ec303a 100644 --- a/src/Builder/Expression/MinOperator.php +++ b/src/Builder/Expression/MinOperator.php @@ -27,11 +27,11 @@ class MinOperator implements ResolvesToAny, OperatorInterface { public const ENCODE = Encode::Single; - /** @var list $expression */ + /** @var list $expression */ public readonly array $expression; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass ...$expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string ...$expression * @no-named-arguments */ public function __construct(Type|ExpressionInterface|stdClass|array|bool|float|int|null|string ...$expression) diff --git a/src/Builder/Expression/MinuteOperator.php b/src/Builder/Expression/MinuteOperator.php index aa961cf..7ab514e 100644 --- a/src/Builder/Expression/MinuteOperator.php +++ b/src/Builder/Expression/MinuteOperator.php @@ -27,12 +27,12 @@ class MinuteOperator implements ResolvesToInt, OperatorInterface /** @var ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. */ public readonly ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date; - /** @var Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ + /** @var Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public readonly Optional|ResolvesToString|string $timezone; /** * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public function __construct( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date, diff --git a/src/Builder/Expression/MonthOperator.php b/src/Builder/Expression/MonthOperator.php index 9e3ccfd..531bc94 100644 --- a/src/Builder/Expression/MonthOperator.php +++ b/src/Builder/Expression/MonthOperator.php @@ -27,12 +27,12 @@ class MonthOperator implements ResolvesToInt, OperatorInterface /** @var ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. */ public readonly ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date; - /** @var Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ + /** @var Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public readonly Optional|ResolvesToString|string $timezone; /** * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public function __construct( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date, diff --git a/src/Builder/Expression/NeOperator.php b/src/Builder/Expression/NeOperator.php index f2d4d67..7bc3225 100644 --- a/src/Builder/Expression/NeOperator.php +++ b/src/Builder/Expression/NeOperator.php @@ -23,15 +23,15 @@ class NeOperator implements ResolvesToBool, OperatorInterface { public const ENCODE = Encode::Array; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression1 */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression1 */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression1; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression2 */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression2 */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression2; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression1 - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression2 + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression1 + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression2 */ public function __construct( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression1, diff --git a/src/Builder/Expression/NotOperator.php b/src/Builder/Expression/NotOperator.php index 9934c35..170538e 100644 --- a/src/Builder/Expression/NotOperator.php +++ b/src/Builder/Expression/NotOperator.php @@ -23,11 +23,11 @@ class NotOperator implements ResolvesToBool, OperatorInterface { public const ENCODE = Encode::Array; - /** @var ExpressionInterface|ResolvesToBool|Type|array|bool|float|int|non-empty-string|null|stdClass $expression */ + /** @var ExpressionInterface|ResolvesToBool|Type|array|bool|float|int|null|stdClass|string $expression */ public readonly Type|ResolvesToBool|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression; /** - * @param ExpressionInterface|ResolvesToBool|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|ResolvesToBool|Type|array|bool|float|int|null|stdClass|string $expression */ public function __construct( Type|ResolvesToBool|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression, diff --git a/src/Builder/Expression/OrOperator.php b/src/Builder/Expression/OrOperator.php index 16753c6..f544c39 100644 --- a/src/Builder/Expression/OrOperator.php +++ b/src/Builder/Expression/OrOperator.php @@ -26,11 +26,11 @@ class OrOperator implements ResolvesToBool, OperatorInterface { public const ENCODE = Encode::Single; - /** @var list $expression */ + /** @var list $expression */ public readonly array $expression; /** - * @param ExpressionInterface|ResolvesToBool|Type|array|bool|float|int|non-empty-string|null|stdClass ...$expression + * @param ExpressionInterface|ResolvesToBool|Type|array|bool|float|int|null|stdClass|string ...$expression * @no-named-arguments */ public function __construct( diff --git a/src/Builder/Expression/PercentileOperator.php b/src/Builder/Expression/PercentileOperator.php index e4f8929..9817197 100644 --- a/src/Builder/Expression/PercentileOperator.php +++ b/src/Builder/Expression/PercentileOperator.php @@ -45,14 +45,14 @@ class PercentileOperator implements ResolvesToArray, OperatorInterface */ public readonly PackedArray|ResolvesToArray|BSONArray|array $p; - /** @var non-empty-string $method The method that mongod uses to calculate the percentile value. The method must be 'approximate'. */ + /** @var string $method The method that mongod uses to calculate the percentile value. The method must be 'approximate'. */ public readonly string $method; /** * @param BSONArray|Decimal128|Int64|PackedArray|ResolvesToNumber|array|float|int $input $percentile calculates the percentile values of this data. input must be a field name or an expression that evaluates to a numeric type. If the expression cannot be converted to a numeric type, the $percentile calculation ignores it. * @param BSONArray|PackedArray|ResolvesToArray|array $p $percentile calculates a percentile value for each element in p. The elements represent percentages and must evaluate to numeric values in the range 0.0 to 1.0, inclusive. * $percentile returns results in the same order as the elements in p. - * @param non-empty-string $method The method that mongod uses to calculate the percentile value. The method must be 'approximate'. + * @param string $method The method that mongod uses to calculate the percentile value. The method must be 'approximate'. */ public function __construct( Decimal128|Int64|PackedArray|ResolvesToNumber|BSONArray|array|float|int $input, diff --git a/src/Builder/Expression/ReduceOperator.php b/src/Builder/Expression/ReduceOperator.php index dee41f0..f57ef2d 100644 --- a/src/Builder/Expression/ReduceOperator.php +++ b/src/Builder/Expression/ReduceOperator.php @@ -36,11 +36,11 @@ class ReduceOperator implements ResolvesToAny, OperatorInterface */ public readonly PackedArray|ResolvesToArray|BSONArray|array $input; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $initialValue The initial cumulative value set before in is applied to the first element of the input array. */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $initialValue The initial cumulative value set before in is applied to the first element of the input array. */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $initialValue; /** - * @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $in A valid expression that $reduce applies to each element in the input array in left-to-right order. Wrap the input value with $reverseArray to yield the equivalent of applying the combining expression from right-to-left. + * @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $in A valid expression that $reduce applies to each element in the input array in left-to-right order. Wrap the input value with $reverseArray to yield the equivalent of applying the combining expression from right-to-left. * During evaluation of the in expression, two variables will be available: * - value is the variable that represents the cumulative value of the expression. * - this is the variable that refers to the element being processed. @@ -51,8 +51,8 @@ class ReduceOperator implements ResolvesToAny, OperatorInterface * @param BSONArray|PackedArray|ResolvesToArray|array $input Can be any valid expression that resolves to an array. * If the argument resolves to a value of null or refers to a missing field, $reduce returns null. * If the argument does not resolve to an array or null nor refers to a missing field, $reduce returns an error. - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $initialValue The initial cumulative value set before in is applied to the first element of the input array. - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $in A valid expression that $reduce applies to each element in the input array in left-to-right order. Wrap the input value with $reverseArray to yield the equivalent of applying the combining expression from right-to-left. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $initialValue The initial cumulative value set before in is applied to the first element of the input array. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $in A valid expression that $reduce applies to each element in the input array in left-to-right order. Wrap the input value with $reverseArray to yield the equivalent of applying the combining expression from right-to-left. * During evaluation of the in expression, two variables will be available: * - value is the variable that represents the cumulative value of the expression. * - this is the variable that refers to the element being processed. diff --git a/src/Builder/Expression/RegexFindAllOperator.php b/src/Builder/Expression/RegexFindAllOperator.php index c05bb08..e4d2a8d 100644 --- a/src/Builder/Expression/RegexFindAllOperator.php +++ b/src/Builder/Expression/RegexFindAllOperator.php @@ -23,19 +23,19 @@ class RegexFindAllOperator implements ResolvesToArray, OperatorInterface { public const ENCODE = Encode::Object; - /** @var ResolvesToString|non-empty-string $input The string on which you wish to apply the regex pattern. Can be a string or any valid expression that resolves to a string. */ + /** @var ResolvesToString|string $input The string on which you wish to apply the regex pattern. Can be a string or any valid expression that resolves to a string. */ public readonly ResolvesToString|string $input; - /** @var Regex|ResolvesToString|non-empty-string $regex The regex pattern to apply. Can be any valid expression that resolves to either a string or regex pattern //. When using the regex //, you can also specify the regex options i and m (but not the s or x options) */ + /** @var Regex|ResolvesToString|string $regex The regex pattern to apply. Can be any valid expression that resolves to either a string or regex pattern //. When using the regex //, you can also specify the regex options i and m (but not the s or x options) */ public readonly Regex|ResolvesToString|string $regex; - /** @var Optional|non-empty-string $options */ + /** @var Optional|string $options */ public readonly Optional|string $options; /** - * @param ResolvesToString|non-empty-string $input The string on which you wish to apply the regex pattern. Can be a string or any valid expression that resolves to a string. - * @param Regex|ResolvesToString|non-empty-string $regex The regex pattern to apply. Can be any valid expression that resolves to either a string or regex pattern //. When using the regex //, you can also specify the regex options i and m (but not the s or x options) - * @param Optional|non-empty-string $options + * @param ResolvesToString|string $input The string on which you wish to apply the regex pattern. Can be a string or any valid expression that resolves to a string. + * @param Regex|ResolvesToString|string $regex The regex pattern to apply. Can be any valid expression that resolves to either a string or regex pattern //. When using the regex //, you can also specify the regex options i and m (but not the s or x options) + * @param Optional|string $options */ public function __construct( ResolvesToString|string $input, diff --git a/src/Builder/Expression/RegexFindOperator.php b/src/Builder/Expression/RegexFindOperator.php index 315a446..0b5f30f 100644 --- a/src/Builder/Expression/RegexFindOperator.php +++ b/src/Builder/Expression/RegexFindOperator.php @@ -23,19 +23,19 @@ class RegexFindOperator implements ResolvesToObject, OperatorInterface { public const ENCODE = Encode::Object; - /** @var ResolvesToString|non-empty-string $input The string on which you wish to apply the regex pattern. Can be a string or any valid expression that resolves to a string. */ + /** @var ResolvesToString|string $input The string on which you wish to apply the regex pattern. Can be a string or any valid expression that resolves to a string. */ public readonly ResolvesToString|string $input; - /** @var Regex|ResolvesToString|non-empty-string $regex The regex pattern to apply. Can be any valid expression that resolves to either a string or regex pattern //. When using the regex //, you can also specify the regex options i and m (but not the s or x options) */ + /** @var Regex|ResolvesToString|string $regex The regex pattern to apply. Can be any valid expression that resolves to either a string or regex pattern //. When using the regex //, you can also specify the regex options i and m (but not the s or x options) */ public readonly Regex|ResolvesToString|string $regex; - /** @var Optional|non-empty-string $options */ + /** @var Optional|string $options */ public readonly Optional|string $options; /** - * @param ResolvesToString|non-empty-string $input The string on which you wish to apply the regex pattern. Can be a string or any valid expression that resolves to a string. - * @param Regex|ResolvesToString|non-empty-string $regex The regex pattern to apply. Can be any valid expression that resolves to either a string or regex pattern //. When using the regex //, you can also specify the regex options i and m (but not the s or x options) - * @param Optional|non-empty-string $options + * @param ResolvesToString|string $input The string on which you wish to apply the regex pattern. Can be a string or any valid expression that resolves to a string. + * @param Regex|ResolvesToString|string $regex The regex pattern to apply. Can be any valid expression that resolves to either a string or regex pattern //. When using the regex //, you can also specify the regex options i and m (but not the s or x options) + * @param Optional|string $options */ public function __construct( ResolvesToString|string $input, diff --git a/src/Builder/Expression/RegexMatchOperator.php b/src/Builder/Expression/RegexMatchOperator.php index c5acfd6..ed9707b 100644 --- a/src/Builder/Expression/RegexMatchOperator.php +++ b/src/Builder/Expression/RegexMatchOperator.php @@ -23,19 +23,19 @@ class RegexMatchOperator implements ResolvesToBool, OperatorInterface { public const ENCODE = Encode::Object; - /** @var ResolvesToString|non-empty-string $input The string on which you wish to apply the regex pattern. Can be a string or any valid expression that resolves to a string. */ + /** @var ResolvesToString|string $input The string on which you wish to apply the regex pattern. Can be a string or any valid expression that resolves to a string. */ public readonly ResolvesToString|string $input; - /** @var Regex|ResolvesToString|non-empty-string $regex The regex pattern to apply. Can be any valid expression that resolves to either a string or regex pattern //. When using the regex //, you can also specify the regex options i and m (but not the s or x options) */ + /** @var Regex|ResolvesToString|string $regex The regex pattern to apply. Can be any valid expression that resolves to either a string or regex pattern //. When using the regex //, you can also specify the regex options i and m (but not the s or x options) */ public readonly Regex|ResolvesToString|string $regex; - /** @var Optional|non-empty-string $options */ + /** @var Optional|string $options */ public readonly Optional|string $options; /** - * @param ResolvesToString|non-empty-string $input The string on which you wish to apply the regex pattern. Can be a string or any valid expression that resolves to a string. - * @param Regex|ResolvesToString|non-empty-string $regex The regex pattern to apply. Can be any valid expression that resolves to either a string or regex pattern //. When using the regex //, you can also specify the regex options i and m (but not the s or x options) - * @param Optional|non-empty-string $options + * @param ResolvesToString|string $input The string on which you wish to apply the regex pattern. Can be a string or any valid expression that resolves to a string. + * @param Regex|ResolvesToString|string $regex The regex pattern to apply. Can be any valid expression that resolves to either a string or regex pattern //. When using the regex //, you can also specify the regex options i and m (but not the s or x options) + * @param Optional|string $options */ public function __construct( ResolvesToString|string $input, diff --git a/src/Builder/Expression/ReplaceAllOperator.php b/src/Builder/Expression/ReplaceAllOperator.php index f38b4c2..d2fa2a6 100644 --- a/src/Builder/Expression/ReplaceAllOperator.php +++ b/src/Builder/Expression/ReplaceAllOperator.php @@ -22,19 +22,19 @@ class ReplaceAllOperator implements ResolvesToString, OperatorInterface { public const ENCODE = Encode::Object; - /** @var ResolvesToNull|ResolvesToString|non-empty-string|null $input The string on which you wish to apply the find. Can be any valid expression that resolves to a string or a null. If input refers to a field that is missing, $replaceAll returns null. */ + /** @var ResolvesToNull|ResolvesToString|null|string $input The string on which you wish to apply the find. Can be any valid expression that resolves to a string or a null. If input refers to a field that is missing, $replaceAll returns null. */ public readonly ResolvesToNull|ResolvesToString|null|string $input; - /** @var ResolvesToNull|ResolvesToString|non-empty-string|null $find The string to search for within the given input. Can be any valid expression that resolves to a string or a null. If find refers to a field that is missing, $replaceAll returns null. */ + /** @var ResolvesToNull|ResolvesToString|null|string $find The string to search for within the given input. Can be any valid expression that resolves to a string or a null. If find refers to a field that is missing, $replaceAll returns null. */ public readonly ResolvesToNull|ResolvesToString|null|string $find; - /** @var ResolvesToNull|ResolvesToString|non-empty-string|null $replacement The string to use to replace all matched instances of find in input. Can be any valid expression that resolves to a string or a null. */ + /** @var ResolvesToNull|ResolvesToString|null|string $replacement The string to use to replace all matched instances of find in input. Can be any valid expression that resolves to a string or a null. */ public readonly ResolvesToNull|ResolvesToString|null|string $replacement; /** - * @param ResolvesToNull|ResolvesToString|non-empty-string|null $input The string on which you wish to apply the find. Can be any valid expression that resolves to a string or a null. If input refers to a field that is missing, $replaceAll returns null. - * @param ResolvesToNull|ResolvesToString|non-empty-string|null $find The string to search for within the given input. Can be any valid expression that resolves to a string or a null. If find refers to a field that is missing, $replaceAll returns null. - * @param ResolvesToNull|ResolvesToString|non-empty-string|null $replacement The string to use to replace all matched instances of find in input. Can be any valid expression that resolves to a string or a null. + * @param ResolvesToNull|ResolvesToString|null|string $input The string on which you wish to apply the find. Can be any valid expression that resolves to a string or a null. If input refers to a field that is missing, $replaceAll returns null. + * @param ResolvesToNull|ResolvesToString|null|string $find The string to search for within the given input. Can be any valid expression that resolves to a string or a null. If find refers to a field that is missing, $replaceAll returns null. + * @param ResolvesToNull|ResolvesToString|null|string $replacement The string to use to replace all matched instances of find in input. Can be any valid expression that resolves to a string or a null. */ public function __construct( ResolvesToNull|ResolvesToString|null|string $input, diff --git a/src/Builder/Expression/ReplaceOneOperator.php b/src/Builder/Expression/ReplaceOneOperator.php index 8d005ba..609a006 100644 --- a/src/Builder/Expression/ReplaceOneOperator.php +++ b/src/Builder/Expression/ReplaceOneOperator.php @@ -21,19 +21,19 @@ class ReplaceOneOperator implements ResolvesToString, OperatorInterface { public const ENCODE = Encode::Object; - /** @var ResolvesToNull|ResolvesToString|non-empty-string|null $input The string on which you wish to apply the find. Can be any valid expression that resolves to a string or a null. If input refers to a field that is missing, $replaceAll returns null. */ + /** @var ResolvesToNull|ResolvesToString|null|string $input The string on which you wish to apply the find. Can be any valid expression that resolves to a string or a null. If input refers to a field that is missing, $replaceAll returns null. */ public readonly ResolvesToNull|ResolvesToString|null|string $input; - /** @var ResolvesToNull|ResolvesToString|non-empty-string|null $find The string to search for within the given input. Can be any valid expression that resolves to a string or a null. If find refers to a field that is missing, $replaceAll returns null. */ + /** @var ResolvesToNull|ResolvesToString|null|string $find The string to search for within the given input. Can be any valid expression that resolves to a string or a null. If find refers to a field that is missing, $replaceAll returns null. */ public readonly ResolvesToNull|ResolvesToString|null|string $find; - /** @var ResolvesToNull|ResolvesToString|non-empty-string|null $replacement The string to use to replace all matched instances of find in input. Can be any valid expression that resolves to a string or a null. */ + /** @var ResolvesToNull|ResolvesToString|null|string $replacement The string to use to replace all matched instances of find in input. Can be any valid expression that resolves to a string or a null. */ public readonly ResolvesToNull|ResolvesToString|null|string $replacement; /** - * @param ResolvesToNull|ResolvesToString|non-empty-string|null $input The string on which you wish to apply the find. Can be any valid expression that resolves to a string or a null. If input refers to a field that is missing, $replaceAll returns null. - * @param ResolvesToNull|ResolvesToString|non-empty-string|null $find The string to search for within the given input. Can be any valid expression that resolves to a string or a null. If find refers to a field that is missing, $replaceAll returns null. - * @param ResolvesToNull|ResolvesToString|non-empty-string|null $replacement The string to use to replace all matched instances of find in input. Can be any valid expression that resolves to a string or a null. + * @param ResolvesToNull|ResolvesToString|null|string $input The string on which you wish to apply the find. Can be any valid expression that resolves to a string or a null. If input refers to a field that is missing, $replaceAll returns null. + * @param ResolvesToNull|ResolvesToString|null|string $find The string to search for within the given input. Can be any valid expression that resolves to a string or a null. If find refers to a field that is missing, $replaceAll returns null. + * @param ResolvesToNull|ResolvesToString|null|string $replacement The string to use to replace all matched instances of find in input. Can be any valid expression that resolves to a string or a null. */ public function __construct( ResolvesToNull|ResolvesToString|null|string $input, diff --git a/src/Builder/Expression/RtrimOperator.php b/src/Builder/Expression/RtrimOperator.php index 039f791..f9a6bc1 100644 --- a/src/Builder/Expression/RtrimOperator.php +++ b/src/Builder/Expression/RtrimOperator.php @@ -21,19 +21,19 @@ class RtrimOperator implements ResolvesToString, OperatorInterface { public const ENCODE = Encode::Object; - /** @var ResolvesToString|non-empty-string $input The string to trim. The argument can be any valid expression that resolves to a string. */ + /** @var ResolvesToString|string $input The string to trim. The argument can be any valid expression that resolves to a string. */ public readonly ResolvesToString|string $input; /** - * @var Optional|ResolvesToString|non-empty-string $chars The character(s) to trim from the beginning of the input. + * @var Optional|ResolvesToString|string $chars The character(s) to trim from the beginning of the input. * The argument can be any valid expression that resolves to a string. The $ltrim operator breaks down the string into individual UTF code point to trim from input. * If unspecified, $ltrim removes whitespace characters, including the null character. */ public readonly Optional|ResolvesToString|string $chars; /** - * @param ResolvesToString|non-empty-string $input The string to trim. The argument can be any valid expression that resolves to a string. - * @param Optional|ResolvesToString|non-empty-string $chars The character(s) to trim from the beginning of the input. + * @param ResolvesToString|string $input The string to trim. The argument can be any valid expression that resolves to a string. + * @param Optional|ResolvesToString|string $chars The character(s) to trim from the beginning of the input. * The argument can be any valid expression that resolves to a string. The $ltrim operator breaks down the string into individual UTF code point to trim from input. * If unspecified, $ltrim removes whitespace characters, including the null character. */ diff --git a/src/Builder/Expression/SecondOperator.php b/src/Builder/Expression/SecondOperator.php index 08587bb..4c9da6d 100644 --- a/src/Builder/Expression/SecondOperator.php +++ b/src/Builder/Expression/SecondOperator.php @@ -27,12 +27,12 @@ class SecondOperator implements ResolvesToInt, OperatorInterface /** @var ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. */ public readonly ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date; - /** @var Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ + /** @var Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public readonly Optional|ResolvesToString|string $timezone; /** * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public function __construct( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date, diff --git a/src/Builder/Expression/SetFieldOperator.php b/src/Builder/Expression/SetFieldOperator.php index 635d610..f4449de 100644 --- a/src/Builder/Expression/SetFieldOperator.php +++ b/src/Builder/Expression/SetFieldOperator.php @@ -26,22 +26,22 @@ class SetFieldOperator implements ResolvesToObject, OperatorInterface { public const ENCODE = Encode::Object; - /** @var ResolvesToString|non-empty-string $field Field in the input object that you want to add, update, or remove. field can be any valid expression that resolves to a string constant. */ + /** @var ResolvesToString|string $field Field in the input object that you want to add, update, or remove. field can be any valid expression that resolves to a string constant. */ public readonly ResolvesToString|string $field; /** @var Document|ResolvesToObject|Serializable|array|stdClass $input Document that contains the field that you want to add or update. input must resolve to an object, missing, null, or undefined. */ public readonly Document|Serializable|ResolvesToObject|stdClass|array $input; /** - * @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $value The value that you want to assign to field. value can be any valid expression. + * @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $value The value that you want to assign to field. value can be any valid expression. * Set to $$REMOVE to remove field from the input document. */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $value; /** - * @param ResolvesToString|non-empty-string $field Field in the input object that you want to add, update, or remove. field can be any valid expression that resolves to a string constant. + * @param ResolvesToString|string $field Field in the input object that you want to add, update, or remove. field can be any valid expression that resolves to a string constant. * @param Document|ResolvesToObject|Serializable|array|stdClass $input Document that contains the field that you want to add or update. input must resolve to an object, missing, null, or undefined. - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $value The value that you want to assign to field. value can be any valid expression. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $value The value that you want to assign to field. value can be any valid expression. * Set to $$REMOVE to remove field from the input document. */ public function __construct( diff --git a/src/Builder/Expression/SplitOperator.php b/src/Builder/Expression/SplitOperator.php index b5aa192..6453cbf 100644 --- a/src/Builder/Expression/SplitOperator.php +++ b/src/Builder/Expression/SplitOperator.php @@ -20,15 +20,15 @@ class SplitOperator implements ResolvesToArray, OperatorInterface { public const ENCODE = Encode::Array; - /** @var ResolvesToString|non-empty-string $string The string to be split. string expression can be any valid expression as long as it resolves to a string. */ + /** @var ResolvesToString|string $string The string to be split. string expression can be any valid expression as long as it resolves to a string. */ public readonly ResolvesToString|string $string; - /** @var ResolvesToString|non-empty-string $delimiter The delimiter to use when splitting the string expression. delimiter can be any valid expression as long as it resolves to a string. */ + /** @var ResolvesToString|string $delimiter The delimiter to use when splitting the string expression. delimiter can be any valid expression as long as it resolves to a string. */ public readonly ResolvesToString|string $delimiter; /** - * @param ResolvesToString|non-empty-string $string The string to be split. string expression can be any valid expression as long as it resolves to a string. - * @param ResolvesToString|non-empty-string $delimiter The delimiter to use when splitting the string expression. delimiter can be any valid expression as long as it resolves to a string. + * @param ResolvesToString|string $string The string to be split. string expression can be any valid expression as long as it resolves to a string. + * @param ResolvesToString|string $delimiter The delimiter to use when splitting the string expression. delimiter can be any valid expression as long as it resolves to a string. */ public function __construct(ResolvesToString|string $string, ResolvesToString|string $delimiter) { diff --git a/src/Builder/Expression/StrLenBytesOperator.php b/src/Builder/Expression/StrLenBytesOperator.php index e123081..1f859fc 100644 --- a/src/Builder/Expression/StrLenBytesOperator.php +++ b/src/Builder/Expression/StrLenBytesOperator.php @@ -20,11 +20,11 @@ class StrLenBytesOperator implements ResolvesToInt, OperatorInterface { public const ENCODE = Encode::Single; - /** @var ResolvesToString|non-empty-string $expression */ + /** @var ResolvesToString|string $expression */ public readonly ResolvesToString|string $expression; /** - * @param ResolvesToString|non-empty-string $expression + * @param ResolvesToString|string $expression */ public function __construct(ResolvesToString|string $expression) { diff --git a/src/Builder/Expression/StrLenCPOperator.php b/src/Builder/Expression/StrLenCPOperator.php index 6dec4b7..7b63f98 100644 --- a/src/Builder/Expression/StrLenCPOperator.php +++ b/src/Builder/Expression/StrLenCPOperator.php @@ -20,11 +20,11 @@ class StrLenCPOperator implements ResolvesToInt, OperatorInterface { public const ENCODE = Encode::Single; - /** @var ResolvesToString|non-empty-string $expression */ + /** @var ResolvesToString|string $expression */ public readonly ResolvesToString|string $expression; /** - * @param ResolvesToString|non-empty-string $expression + * @param ResolvesToString|string $expression */ public function __construct(ResolvesToString|string $expression) { diff --git a/src/Builder/Expression/StrcasecmpOperator.php b/src/Builder/Expression/StrcasecmpOperator.php index 013f7cb..ff6f544 100644 --- a/src/Builder/Expression/StrcasecmpOperator.php +++ b/src/Builder/Expression/StrcasecmpOperator.php @@ -20,15 +20,15 @@ class StrcasecmpOperator implements ResolvesToInt, OperatorInterface { public const ENCODE = Encode::Array; - /** @var ResolvesToString|non-empty-string $expression1 */ + /** @var ResolvesToString|string $expression1 */ public readonly ResolvesToString|string $expression1; - /** @var ResolvesToString|non-empty-string $expression2 */ + /** @var ResolvesToString|string $expression2 */ public readonly ResolvesToString|string $expression2; /** - * @param ResolvesToString|non-empty-string $expression1 - * @param ResolvesToString|non-empty-string $expression2 + * @param ResolvesToString|string $expression1 + * @param ResolvesToString|string $expression2 */ public function __construct(ResolvesToString|string $expression1, ResolvesToString|string $expression2) { diff --git a/src/Builder/Expression/SubstrBytesOperator.php b/src/Builder/Expression/SubstrBytesOperator.php index 7b8803a..3ff5435 100644 --- a/src/Builder/Expression/SubstrBytesOperator.php +++ b/src/Builder/Expression/SubstrBytesOperator.php @@ -20,7 +20,7 @@ class SubstrBytesOperator implements ResolvesToString, OperatorInterface { public const ENCODE = Encode::Array; - /** @var ResolvesToString|non-empty-string $string */ + /** @var ResolvesToString|string $string */ public readonly ResolvesToString|string $string; /** @var ResolvesToInt|int $start If start is a negative number, $substr returns an empty string "". */ @@ -30,7 +30,7 @@ class SubstrBytesOperator implements ResolvesToString, OperatorInterface public readonly ResolvesToInt|int $length; /** - * @param ResolvesToString|non-empty-string $string + * @param ResolvesToString|string $string * @param ResolvesToInt|int $start If start is a negative number, $substr returns an empty string "". * @param ResolvesToInt|int $length If length is a negative number, $substr returns a substring that starts at the specified index and includes the rest of the string. */ diff --git a/src/Builder/Expression/SubstrCPOperator.php b/src/Builder/Expression/SubstrCPOperator.php index 6f32d3d..85baea9 100644 --- a/src/Builder/Expression/SubstrCPOperator.php +++ b/src/Builder/Expression/SubstrCPOperator.php @@ -20,7 +20,7 @@ class SubstrCPOperator implements ResolvesToString, OperatorInterface { public const ENCODE = Encode::Array; - /** @var ResolvesToString|non-empty-string $string */ + /** @var ResolvesToString|string $string */ public readonly ResolvesToString|string $string; /** @var ResolvesToInt|int $start If start is a negative number, $substr returns an empty string "". */ @@ -30,7 +30,7 @@ class SubstrCPOperator implements ResolvesToString, OperatorInterface public readonly ResolvesToInt|int $length; /** - * @param ResolvesToString|non-empty-string $string + * @param ResolvesToString|string $string * @param ResolvesToInt|int $start If start is a negative number, $substr returns an empty string "". * @param ResolvesToInt|int $length If length is a negative number, $substr returns a substring that starts at the specified index and includes the rest of the string. */ diff --git a/src/Builder/Expression/SubstrOperator.php b/src/Builder/Expression/SubstrOperator.php index c432f4a..9ef1740 100644 --- a/src/Builder/Expression/SubstrOperator.php +++ b/src/Builder/Expression/SubstrOperator.php @@ -20,7 +20,7 @@ class SubstrOperator implements ResolvesToString, OperatorInterface { public const ENCODE = Encode::Array; - /** @var ResolvesToString|non-empty-string $string */ + /** @var ResolvesToString|string $string */ public readonly ResolvesToString|string $string; /** @var ResolvesToInt|int $start If start is a negative number, $substr returns an empty string "". */ @@ -30,7 +30,7 @@ class SubstrOperator implements ResolvesToString, OperatorInterface public readonly ResolvesToInt|int $length; /** - * @param ResolvesToString|non-empty-string $string + * @param ResolvesToString|string $string * @param ResolvesToInt|int $start If start is a negative number, $substr returns an empty string "". * @param ResolvesToInt|int $length If length is a negative number, $substr returns a substring that starts at the specified index and includes the rest of the string. */ diff --git a/src/Builder/Expression/SwitchOperator.php b/src/Builder/Expression/SwitchOperator.php index 93e942d..3545477 100644 --- a/src/Builder/Expression/SwitchOperator.php +++ b/src/Builder/Expression/SwitchOperator.php @@ -39,7 +39,7 @@ class SwitchOperator implements ResolvesToAny, OperatorInterface public readonly PackedArray|BSONArray|array $branches; /** - * @var Optional|ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $default The path to take if no branch case expression evaluates to true. + * @var Optional|ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $default The path to take if no branch case expression evaluates to true. * Although optional, if default is unspecified and no branch case evaluates to true, $switch returns an error. */ public readonly Optional|Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $default; @@ -49,7 +49,7 @@ class SwitchOperator implements ResolvesToAny, OperatorInterface * - case Can be any valid expression that resolves to a boolean. If the result is not a boolean, it is coerced to a boolean value. More information about how MongoDB evaluates expressions as either true or false can be found here. * - then Can be any valid expression. * The branches array must contain at least one branch document. - * @param Optional|ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $default The path to take if no branch case expression evaluates to true. + * @param Optional|ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $default The path to take if no branch case expression evaluates to true. * Although optional, if default is unspecified and no branch case evaluates to true, $switch returns an error. */ public function __construct( diff --git a/src/Builder/Expression/ToBoolOperator.php b/src/Builder/Expression/ToBoolOperator.php index 3aaa708..2986fc8 100644 --- a/src/Builder/Expression/ToBoolOperator.php +++ b/src/Builder/Expression/ToBoolOperator.php @@ -24,11 +24,11 @@ class ToBoolOperator implements ResolvesToBool, OperatorInterface { public const ENCODE = Encode::Single; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public function __construct(Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression) { diff --git a/src/Builder/Expression/ToDateOperator.php b/src/Builder/Expression/ToDateOperator.php index 605f41b..d6ff4b2 100644 --- a/src/Builder/Expression/ToDateOperator.php +++ b/src/Builder/Expression/ToDateOperator.php @@ -24,11 +24,11 @@ class ToDateOperator implements ResolvesToDate, OperatorInterface { public const ENCODE = Encode::Single; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public function __construct(Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression) { diff --git a/src/Builder/Expression/ToDecimalOperator.php b/src/Builder/Expression/ToDecimalOperator.php index 7af799a..d8dd603 100644 --- a/src/Builder/Expression/ToDecimalOperator.php +++ b/src/Builder/Expression/ToDecimalOperator.php @@ -24,11 +24,11 @@ class ToDecimalOperator implements ResolvesToDecimal, OperatorInterface { public const ENCODE = Encode::Single; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public function __construct(Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression) { diff --git a/src/Builder/Expression/ToDoubleOperator.php b/src/Builder/Expression/ToDoubleOperator.php index 2e78b07..a21fe9a 100644 --- a/src/Builder/Expression/ToDoubleOperator.php +++ b/src/Builder/Expression/ToDoubleOperator.php @@ -24,11 +24,11 @@ class ToDoubleOperator implements ResolvesToDouble, OperatorInterface { public const ENCODE = Encode::Single; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public function __construct(Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression) { diff --git a/src/Builder/Expression/ToHashedIndexKeyOperator.php b/src/Builder/Expression/ToHashedIndexKeyOperator.php index 1bc3a5e..e303883 100644 --- a/src/Builder/Expression/ToHashedIndexKeyOperator.php +++ b/src/Builder/Expression/ToHashedIndexKeyOperator.php @@ -23,11 +23,11 @@ class ToHashedIndexKeyOperator implements ResolvesToLong, OperatorInterface { public const ENCODE = Encode::Single; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $value key or string to hash */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $value key or string to hash */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $value; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $value key or string to hash + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $value key or string to hash */ public function __construct(Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $value) { diff --git a/src/Builder/Expression/ToIntOperator.php b/src/Builder/Expression/ToIntOperator.php index d74106a..d039805 100644 --- a/src/Builder/Expression/ToIntOperator.php +++ b/src/Builder/Expression/ToIntOperator.php @@ -24,11 +24,11 @@ class ToIntOperator implements ResolvesToInt, OperatorInterface { public const ENCODE = Encode::Single; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public function __construct(Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression) { diff --git a/src/Builder/Expression/ToLongOperator.php b/src/Builder/Expression/ToLongOperator.php index 5eadcc6..3011132 100644 --- a/src/Builder/Expression/ToLongOperator.php +++ b/src/Builder/Expression/ToLongOperator.php @@ -24,11 +24,11 @@ class ToLongOperator implements ResolvesToLong, OperatorInterface { public const ENCODE = Encode::Single; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public function __construct(Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression) { diff --git a/src/Builder/Expression/ToLowerOperator.php b/src/Builder/Expression/ToLowerOperator.php index 1ab2149..d680f32 100644 --- a/src/Builder/Expression/ToLowerOperator.php +++ b/src/Builder/Expression/ToLowerOperator.php @@ -20,11 +20,11 @@ class ToLowerOperator implements ResolvesToString, OperatorInterface { public const ENCODE = Encode::Single; - /** @var ResolvesToString|non-empty-string $expression */ + /** @var ResolvesToString|string $expression */ public readonly ResolvesToString|string $expression; /** - * @param ResolvesToString|non-empty-string $expression + * @param ResolvesToString|string $expression */ public function __construct(ResolvesToString|string $expression) { diff --git a/src/Builder/Expression/ToObjectIdOperator.php b/src/Builder/Expression/ToObjectIdOperator.php index 57dbae3..8e204f6 100644 --- a/src/Builder/Expression/ToObjectIdOperator.php +++ b/src/Builder/Expression/ToObjectIdOperator.php @@ -24,11 +24,11 @@ class ToObjectIdOperator implements ResolvesToObjectId, OperatorInterface { public const ENCODE = Encode::Single; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public function __construct(Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression) { diff --git a/src/Builder/Expression/ToStringOperator.php b/src/Builder/Expression/ToStringOperator.php index f7ec7c0..c549a6f 100644 --- a/src/Builder/Expression/ToStringOperator.php +++ b/src/Builder/Expression/ToStringOperator.php @@ -24,11 +24,11 @@ class ToStringOperator implements ResolvesToString, OperatorInterface { public const ENCODE = Encode::Single; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public function __construct(Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression) { diff --git a/src/Builder/Expression/ToUpperOperator.php b/src/Builder/Expression/ToUpperOperator.php index e943a61..f57c2cb 100644 --- a/src/Builder/Expression/ToUpperOperator.php +++ b/src/Builder/Expression/ToUpperOperator.php @@ -20,11 +20,11 @@ class ToUpperOperator implements ResolvesToString, OperatorInterface { public const ENCODE = Encode::Single; - /** @var ResolvesToString|non-empty-string $expression */ + /** @var ResolvesToString|string $expression */ public readonly ResolvesToString|string $expression; /** - * @param ResolvesToString|non-empty-string $expression + * @param ResolvesToString|string $expression */ public function __construct(ResolvesToString|string $expression) { diff --git a/src/Builder/Expression/TrimOperator.php b/src/Builder/Expression/TrimOperator.php index 6c6ca57..def9d3a 100644 --- a/src/Builder/Expression/TrimOperator.php +++ b/src/Builder/Expression/TrimOperator.php @@ -22,19 +22,19 @@ class TrimOperator implements ResolvesToString, OperatorInterface { public const ENCODE = Encode::Object; - /** @var ResolvesToString|non-empty-string $input The string to trim. The argument can be any valid expression that resolves to a string. */ + /** @var ResolvesToString|string $input The string to trim. The argument can be any valid expression that resolves to a string. */ public readonly ResolvesToString|string $input; /** - * @var Optional|ResolvesToString|non-empty-string $chars The character(s) to trim from the beginning of the input. + * @var Optional|ResolvesToString|string $chars The character(s) to trim from the beginning of the input. * The argument can be any valid expression that resolves to a string. The $ltrim operator breaks down the string into individual UTF code point to trim from input. * If unspecified, $ltrim removes whitespace characters, including the null character. */ public readonly Optional|ResolvesToString|string $chars; /** - * @param ResolvesToString|non-empty-string $input The string to trim. The argument can be any valid expression that resolves to a string. - * @param Optional|ResolvesToString|non-empty-string $chars The character(s) to trim from the beginning of the input. + * @param ResolvesToString|string $input The string to trim. The argument can be any valid expression that resolves to a string. + * @param Optional|ResolvesToString|string $chars The character(s) to trim from the beginning of the input. * The argument can be any valid expression that resolves to a string. The $ltrim operator breaks down the string into individual UTF code point to trim from input. * If unspecified, $ltrim removes whitespace characters, including the null character. */ diff --git a/src/Builder/Expression/TypeOperator.php b/src/Builder/Expression/TypeOperator.php index d1e134b..a65d1dd 100644 --- a/src/Builder/Expression/TypeOperator.php +++ b/src/Builder/Expression/TypeOperator.php @@ -23,11 +23,11 @@ class TypeOperator implements ResolvesToString, OperatorInterface { public const ENCODE = Encode::Single; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public function __construct(Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression) { diff --git a/src/Builder/Expression/UnsetFieldOperator.php b/src/Builder/Expression/UnsetFieldOperator.php index df1a20d..45e9c41 100644 --- a/src/Builder/Expression/UnsetFieldOperator.php +++ b/src/Builder/Expression/UnsetFieldOperator.php @@ -24,14 +24,14 @@ class UnsetFieldOperator implements ResolvesToObject, OperatorInterface { public const ENCODE = Encode::Object; - /** @var ResolvesToString|non-empty-string $field Field in the input object that you want to add, update, or remove. field can be any valid expression that resolves to a string constant. */ + /** @var ResolvesToString|string $field Field in the input object that you want to add, update, or remove. field can be any valid expression that resolves to a string constant. */ public readonly ResolvesToString|string $field; /** @var Document|ResolvesToObject|Serializable|array|stdClass $input Document that contains the field that you want to add or update. input must resolve to an object, missing, null, or undefined. */ public readonly Document|Serializable|ResolvesToObject|stdClass|array $input; /** - * @param ResolvesToString|non-empty-string $field Field in the input object that you want to add, update, or remove. field can be any valid expression that resolves to a string constant. + * @param ResolvesToString|string $field Field in the input object that you want to add, update, or remove. field can be any valid expression that resolves to a string constant. * @param Document|ResolvesToObject|Serializable|array|stdClass $input Document that contains the field that you want to add or update. input must resolve to an object, missing, null, or undefined. */ public function __construct( diff --git a/src/Builder/Expression/WeekOperator.php b/src/Builder/Expression/WeekOperator.php index 96ba4cc..a24ee93 100644 --- a/src/Builder/Expression/WeekOperator.php +++ b/src/Builder/Expression/WeekOperator.php @@ -27,12 +27,12 @@ class WeekOperator implements ResolvesToInt, OperatorInterface /** @var ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. */ public readonly ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date; - /** @var Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ + /** @var Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public readonly Optional|ResolvesToString|string $timezone; /** * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public function __construct( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date, diff --git a/src/Builder/Expression/YearOperator.php b/src/Builder/Expression/YearOperator.php index 191975c..c2b8692 100644 --- a/src/Builder/Expression/YearOperator.php +++ b/src/Builder/Expression/YearOperator.php @@ -27,12 +27,12 @@ class YearOperator implements ResolvesToInt, OperatorInterface /** @var ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. */ public readonly ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date; - /** @var Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ + /** @var Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public readonly Optional|ResolvesToString|string $timezone; /** * @param ObjectId|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|Timestamp|UTCDateTime|int $date The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID. - * @param Optional|ResolvesToString|non-empty-string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. + * @param Optional|ResolvesToString|string $timezone The timezone of the operation result. timezone must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC. */ public function __construct( ObjectId|Timestamp|UTCDateTime|ResolvesToDate|ResolvesToObjectId|ResolvesToTimestamp|int $date, diff --git a/src/Builder/Projection/FactoryTrait.php b/src/Builder/Projection/FactoryTrait.php index ea87ada..d3f1d23 100644 --- a/src/Builder/Projection/FactoryTrait.php +++ b/src/Builder/Projection/FactoryTrait.php @@ -38,7 +38,7 @@ public static function elemMatch(QueryInterface|array $query): ElemMatchOperator * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/filter/ * @param BSONArray|PackedArray|ResolvesToArray|array $input * @param ResolvesToBool|bool $cond An expression that resolves to a boolean value used to determine if an element should be included in the output array. The expression references each element of the input array individually with the variable name specified in as. - * @param Optional|non-empty-string $as A name for the variable that represents each individual element of the input array. If no name is specified, the variable name defaults to this. + * @param Optional|string $as A name for the variable that represents each individual element of the input array. If no name is specified, the variable name defaults to this. * @param Optional|ResolvesToInt|int $limit A number expression that restricts the number of matching array elements that $filter returns. You cannot specify a limit less than 1. The matching array elements are returned in the order they appear in the input array. * If the specified limit is greater than the number of matching array elements, $filter returns all matching array elements. If the limit is null, $filter returns all matching array elements. */ diff --git a/src/Builder/Projection/FilterOperator.php b/src/Builder/Projection/FilterOperator.php index ee7cbb4..3b29e28 100644 --- a/src/Builder/Projection/FilterOperator.php +++ b/src/Builder/Projection/FilterOperator.php @@ -37,7 +37,7 @@ class FilterOperator implements ProjectionInterface, OperatorInterface /** @var ResolvesToBool|bool $cond An expression that resolves to a boolean value used to determine if an element should be included in the output array. The expression references each element of the input array individually with the variable name specified in as. */ public readonly ResolvesToBool|bool $cond; - /** @var Optional|non-empty-string $as A name for the variable that represents each individual element of the input array. If no name is specified, the variable name defaults to this. */ + /** @var Optional|string $as A name for the variable that represents each individual element of the input array. If no name is specified, the variable name defaults to this. */ public readonly Optional|string $as; /** @@ -49,7 +49,7 @@ class FilterOperator implements ProjectionInterface, OperatorInterface /** * @param BSONArray|PackedArray|ResolvesToArray|array $input * @param ResolvesToBool|bool $cond An expression that resolves to a boolean value used to determine if an element should be included in the output array. The expression references each element of the input array individually with the variable name specified in as. - * @param Optional|non-empty-string $as A name for the variable that represents each individual element of the input array. If no name is specified, the variable name defaults to this. + * @param Optional|string $as A name for the variable that represents each individual element of the input array. If no name is specified, the variable name defaults to this. * @param Optional|ResolvesToInt|int $limit A number expression that restricts the number of matching array elements that $filter returns. You cannot specify a limit less than 1. The matching array elements are returned in the order they appear in the input array. * If the specified limit is greater than the number of matching array elements, $filter returns all matching array elements. If the limit is null, $filter returns all matching array elements. */ diff --git a/src/Builder/Query/AllOperator.php b/src/Builder/Query/AllOperator.php index 537f74f..1b51961 100644 --- a/src/Builder/Query/AllOperator.php +++ b/src/Builder/Query/AllOperator.php @@ -26,11 +26,11 @@ class AllOperator implements FieldQueryInterface, OperatorInterface { public const ENCODE = Encode::Single; - /** @var list $value */ + /** @var list $value */ public readonly array $value; /** - * @param FieldQueryInterface|Type|array|bool|float|int|non-empty-string|null|stdClass ...$value + * @param FieldQueryInterface|Type|array|bool|float|int|null|stdClass|string ...$value * @no-named-arguments */ public function __construct(Type|FieldQueryInterface|stdClass|array|bool|float|int|null|string ...$value) diff --git a/src/Builder/Query/BitsAllClearOperator.php b/src/Builder/Query/BitsAllClearOperator.php index 61221fa..6f056d3 100644 --- a/src/Builder/Query/BitsAllClearOperator.php +++ b/src/Builder/Query/BitsAllClearOperator.php @@ -28,11 +28,11 @@ class BitsAllClearOperator implements FieldQueryInterface, OperatorInterface { public const ENCODE = Encode::Single; - /** @var BSONArray|Binary|PackedArray|array|int|non-empty-string $bitmask */ + /** @var BSONArray|Binary|PackedArray|array|int|string $bitmask */ public readonly Binary|PackedArray|BSONArray|array|int|string $bitmask; /** - * @param BSONArray|Binary|PackedArray|array|int|non-empty-string $bitmask + * @param BSONArray|Binary|PackedArray|array|int|string $bitmask */ public function __construct(Binary|PackedArray|BSONArray|array|int|string $bitmask) { diff --git a/src/Builder/Query/BitsAllSetOperator.php b/src/Builder/Query/BitsAllSetOperator.php index 9d2e1d9..0278b81 100644 --- a/src/Builder/Query/BitsAllSetOperator.php +++ b/src/Builder/Query/BitsAllSetOperator.php @@ -28,11 +28,11 @@ class BitsAllSetOperator implements FieldQueryInterface, OperatorInterface { public const ENCODE = Encode::Single; - /** @var BSONArray|Binary|PackedArray|array|int|non-empty-string $bitmask */ + /** @var BSONArray|Binary|PackedArray|array|int|string $bitmask */ public readonly Binary|PackedArray|BSONArray|array|int|string $bitmask; /** - * @param BSONArray|Binary|PackedArray|array|int|non-empty-string $bitmask + * @param BSONArray|Binary|PackedArray|array|int|string $bitmask */ public function __construct(Binary|PackedArray|BSONArray|array|int|string $bitmask) { diff --git a/src/Builder/Query/BitsAnyClearOperator.php b/src/Builder/Query/BitsAnyClearOperator.php index de3a52a..c2b899e 100644 --- a/src/Builder/Query/BitsAnyClearOperator.php +++ b/src/Builder/Query/BitsAnyClearOperator.php @@ -28,11 +28,11 @@ class BitsAnyClearOperator implements FieldQueryInterface, OperatorInterface { public const ENCODE = Encode::Single; - /** @var BSONArray|Binary|PackedArray|array|int|non-empty-string $bitmask */ + /** @var BSONArray|Binary|PackedArray|array|int|string $bitmask */ public readonly Binary|PackedArray|BSONArray|array|int|string $bitmask; /** - * @param BSONArray|Binary|PackedArray|array|int|non-empty-string $bitmask + * @param BSONArray|Binary|PackedArray|array|int|string $bitmask */ public function __construct(Binary|PackedArray|BSONArray|array|int|string $bitmask) { diff --git a/src/Builder/Query/BitsAnySetOperator.php b/src/Builder/Query/BitsAnySetOperator.php index b5a5b70..4dcf3c3 100644 --- a/src/Builder/Query/BitsAnySetOperator.php +++ b/src/Builder/Query/BitsAnySetOperator.php @@ -28,11 +28,11 @@ class BitsAnySetOperator implements FieldQueryInterface, OperatorInterface { public const ENCODE = Encode::Single; - /** @var BSONArray|Binary|PackedArray|array|int|non-empty-string $bitmask */ + /** @var BSONArray|Binary|PackedArray|array|int|string $bitmask */ public readonly Binary|PackedArray|BSONArray|array|int|string $bitmask; /** - * @param BSONArray|Binary|PackedArray|array|int|non-empty-string $bitmask + * @param BSONArray|Binary|PackedArray|array|int|string $bitmask */ public function __construct(Binary|PackedArray|BSONArray|array|int|string $bitmask) { diff --git a/src/Builder/Query/CommentOperator.php b/src/Builder/Query/CommentOperator.php index c99b096..121c0e3 100644 --- a/src/Builder/Query/CommentOperator.php +++ b/src/Builder/Query/CommentOperator.php @@ -21,11 +21,11 @@ class CommentOperator implements QueryInterface, OperatorInterface { public const ENCODE = Encode::Single; - /** @var non-empty-string $comment */ + /** @var string $comment */ public readonly string $comment; /** - * @param non-empty-string $comment + * @param string $comment */ public function __construct(string $comment) { diff --git a/src/Builder/Query/ElemMatchOperator.php b/src/Builder/Query/ElemMatchOperator.php index 97a02c3..0736198 100644 --- a/src/Builder/Query/ElemMatchOperator.php +++ b/src/Builder/Query/ElemMatchOperator.php @@ -27,11 +27,11 @@ class ElemMatchOperator implements FieldQueryInterface, OperatorInterface { public const ENCODE = Encode::Single; - /** @var FieldQueryInterface|QueryInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $query */ + /** @var FieldQueryInterface|QueryInterface|Type|array|bool|float|int|null|stdClass|string $query */ public readonly Type|FieldQueryInterface|QueryInterface|stdClass|array|bool|float|int|null|string $query; /** - * @param FieldQueryInterface|QueryInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $query + * @param FieldQueryInterface|QueryInterface|Type|array|bool|float|int|null|stdClass|string $query */ public function __construct( Type|FieldQueryInterface|QueryInterface|stdClass|array|bool|float|int|null|string $query, diff --git a/src/Builder/Query/EqOperator.php b/src/Builder/Query/EqOperator.php index 1ed738f..2dcd605 100644 --- a/src/Builder/Query/EqOperator.php +++ b/src/Builder/Query/EqOperator.php @@ -23,11 +23,11 @@ class EqOperator implements FieldQueryInterface, OperatorInterface { public const ENCODE = Encode::Single; - /** @var Type|array|bool|float|int|non-empty-string|null|stdClass $value */ + /** @var Type|array|bool|float|int|null|stdClass|string $value */ public readonly Type|stdClass|array|bool|float|int|null|string $value; /** - * @param Type|array|bool|float|int|non-empty-string|null|stdClass $value + * @param Type|array|bool|float|int|null|stdClass|string $value */ public function __construct(Type|stdClass|array|bool|float|int|null|string $value) { diff --git a/src/Builder/Query/ExprOperator.php b/src/Builder/Query/ExprOperator.php index 98f35a7..a6235cb 100644 --- a/src/Builder/Query/ExprOperator.php +++ b/src/Builder/Query/ExprOperator.php @@ -24,11 +24,11 @@ class ExprOperator implements QueryInterface, OperatorInterface { public const ENCODE = Encode::Single; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public function __construct(Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression) { diff --git a/src/Builder/Query/FactoryTrait.php b/src/Builder/Query/FactoryTrait.php index 6f01589..cc480de 100644 --- a/src/Builder/Query/FactoryTrait.php +++ b/src/Builder/Query/FactoryTrait.php @@ -36,7 +36,7 @@ trait FactoryTrait * * @see https://www.mongodb.com/docs/manual/reference/operator/query/all/ * @no-named-arguments - * @param FieldQueryInterface|Type|array|bool|float|int|non-empty-string|null|stdClass ...$value + * @param FieldQueryInterface|Type|array|bool|float|int|null|stdClass|string ...$value */ public static function all( Type|FieldQueryInterface|stdClass|array|bool|float|int|null|string ...$value, @@ -61,7 +61,7 @@ public static function and(QueryInterface|array ...$queries): AndOperator * Matches numeric or binary values in which a set of bit positions all have a value of 0. * * @see https://www.mongodb.com/docs/manual/reference/operator/query/bitsAllClear/ - * @param BSONArray|Binary|PackedArray|array|int|non-empty-string $bitmask + * @param BSONArray|Binary|PackedArray|array|int|string $bitmask */ public static function bitsAllClear(Binary|PackedArray|BSONArray|array|int|string $bitmask): BitsAllClearOperator { @@ -72,7 +72,7 @@ public static function bitsAllClear(Binary|PackedArray|BSONArray|array|int|strin * Matches numeric or binary values in which a set of bit positions all have a value of 1. * * @see https://www.mongodb.com/docs/manual/reference/operator/query/bitsAllSet/ - * @param BSONArray|Binary|PackedArray|array|int|non-empty-string $bitmask + * @param BSONArray|Binary|PackedArray|array|int|string $bitmask */ public static function bitsAllSet(Binary|PackedArray|BSONArray|array|int|string $bitmask): BitsAllSetOperator { @@ -83,7 +83,7 @@ public static function bitsAllSet(Binary|PackedArray|BSONArray|array|int|string * Matches numeric or binary values in which any bit from a set of bit positions has a value of 0. * * @see https://www.mongodb.com/docs/manual/reference/operator/query/bitsAnyClear/ - * @param BSONArray|Binary|PackedArray|array|int|non-empty-string $bitmask + * @param BSONArray|Binary|PackedArray|array|int|string $bitmask */ public static function bitsAnyClear(Binary|PackedArray|BSONArray|array|int|string $bitmask): BitsAnyClearOperator { @@ -94,7 +94,7 @@ public static function bitsAnyClear(Binary|PackedArray|BSONArray|array|int|strin * Matches numeric or binary values in which any bit from a set of bit positions has a value of 1. * * @see https://www.mongodb.com/docs/manual/reference/operator/query/bitsAnySet/ - * @param BSONArray|Binary|PackedArray|array|int|non-empty-string $bitmask + * @param BSONArray|Binary|PackedArray|array|int|string $bitmask */ public static function bitsAnySet(Binary|PackedArray|BSONArray|array|int|string $bitmask): BitsAnySetOperator { @@ -138,7 +138,7 @@ public static function centerSphere(PackedArray|BSONArray|array $value): CenterS * Adds a comment to a query predicate. * * @see https://www.mongodb.com/docs/manual/reference/operator/query/comment/ - * @param non-empty-string $comment + * @param string $comment */ public static function comment(string $comment): CommentOperator { @@ -149,7 +149,7 @@ public static function comment(string $comment): CommentOperator * The $elemMatch operator matches documents that contain an array field with at least one element that matches all the specified query criteria. * * @see https://www.mongodb.com/docs/manual/reference/operator/query/elemMatch/ - * @param FieldQueryInterface|QueryInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $query + * @param FieldQueryInterface|QueryInterface|Type|array|bool|float|int|null|stdClass|string $query */ public static function elemMatch( Type|FieldQueryInterface|QueryInterface|stdClass|array|bool|float|int|null|string $query, @@ -162,7 +162,7 @@ public static function elemMatch( * Matches values that are equal to a specified value. * * @see https://www.mongodb.com/docs/manual/reference/operator/query/eq/ - * @param Type|array|bool|float|int|non-empty-string|null|stdClass $value + * @param Type|array|bool|float|int|null|stdClass|string $value */ public static function eq(Type|stdClass|array|bool|float|int|null|string $value): EqOperator { @@ -184,7 +184,7 @@ public static function exists(bool $exists): ExistsOperator * Allows use of aggregation expressions within the query language. * * @see https://www.mongodb.com/docs/manual/reference/operator/query/expr/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public static function expr( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression, @@ -210,7 +210,7 @@ public static function geoIntersects( * Specifies a geometry in GeoJSON format to geospatial query operators. * * @see https://www.mongodb.com/docs/manual/reference/operator/query/geometry/ - * @param non-empty-string $type + * @param string $type * @param BSONArray|PackedArray|array $coordinates * @param Optional|Document|Serializable|array|stdClass $crs */ @@ -240,7 +240,7 @@ public static function geoWithin( * Matches values that are greater than a specified value. * * @see https://www.mongodb.com/docs/manual/reference/operator/query/gt/ - * @param Type|array|bool|float|int|non-empty-string|null|stdClass $value + * @param Type|array|bool|float|int|null|stdClass|string $value */ public static function gt(Type|stdClass|array|bool|float|int|null|string $value): GtOperator { @@ -251,7 +251,7 @@ public static function gt(Type|stdClass|array|bool|float|int|null|string $value) * Matches values that are greater than or equal to a specified value. * * @see https://www.mongodb.com/docs/manual/reference/operator/query/gte/ - * @param Type|array|bool|float|int|non-empty-string|null|stdClass $value + * @param Type|array|bool|float|int|null|stdClass|string $value */ public static function gte(Type|stdClass|array|bool|float|int|null|string $value): GteOperator { @@ -284,7 +284,7 @@ public static function jsonSchema(Document|Serializable|stdClass|array $schema): * Matches values that are less than a specified value. * * @see https://www.mongodb.com/docs/manual/reference/operator/query/lt/ - * @param Type|array|bool|float|int|non-empty-string|null|stdClass $value + * @param Type|array|bool|float|int|null|stdClass|string $value */ public static function lt(Type|stdClass|array|bool|float|int|null|string $value): LtOperator { @@ -295,7 +295,7 @@ public static function lt(Type|stdClass|array|bool|float|int|null|string $value) * Matches values that are less than or equal to a specified value. * * @see https://www.mongodb.com/docs/manual/reference/operator/query/lte/ - * @param Type|array|bool|float|int|non-empty-string|null|stdClass $value + * @param Type|array|bool|float|int|null|stdClass|string $value */ public static function lte(Type|stdClass|array|bool|float|int|null|string $value): LteOperator { @@ -353,7 +353,7 @@ public static function natural(): NaturalOperator * Matches all values that are not equal to a specified value. * * @see https://www.mongodb.com/docs/manual/reference/operator/query/ne/ - * @param Type|array|bool|float|int|non-empty-string|null|stdClass $value + * @param Type|array|bool|float|int|null|stdClass|string $value */ public static function ne(Type|stdClass|array|bool|float|int|null|string $value): NeOperator { @@ -421,7 +421,7 @@ public static function nor(QueryInterface|array ...$queries): NorOperator * Inverts the effect of a query expression and returns documents that do not match the query expression. * * @see https://www.mongodb.com/docs/manual/reference/operator/query/not/ - * @param FieldQueryInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param FieldQueryInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public static function not( Type|FieldQueryInterface|stdClass|array|bool|float|int|null|string $expression, @@ -501,8 +501,8 @@ public static function size(int $value): SizeOperator * Performs text search. * * @see https://www.mongodb.com/docs/manual/reference/operator/query/text/ - * @param non-empty-string $search A string of terms that MongoDB parses and uses to query the text index. MongoDB performs a logical OR search of the terms unless specified as a phrase. - * @param Optional|non-empty-string $language The language that determines the list of stop words for the search and the rules for the stemmer and tokenizer. If not specified, the search uses the default language of the index. + * @param string $search A string of terms that MongoDB parses and uses to query the text index. MongoDB performs a logical OR search of the terms unless specified as a phrase. + * @param Optional|string $language The language that determines the list of stop words for the search and the rules for the stemmer and tokenizer. If not specified, the search uses the default language of the index. * If you specify a default_language value of none, then the text index parses through each word in the field, including stop words, and ignores suffix stemming. * @param Optional|bool $caseSensitive A boolean flag to enable or disable case sensitive search. Defaults to false; i.e. the search defers to the case insensitivity of the text index. * @param Optional|bool $diacriticSensitive A boolean flag to enable or disable diacritic sensitive search against version 3 text indexes. Defaults to false; i.e. the search defers to the diacritic insensitivity of the text index. @@ -523,7 +523,7 @@ public static function text( * * @see https://www.mongodb.com/docs/manual/reference/operator/query/type/ * @no-named-arguments - * @param int|non-empty-string ...$type + * @param int|string ...$type */ public static function type(int|string ...$type): TypeOperator { @@ -534,7 +534,7 @@ public static function type(int|string ...$type): TypeOperator * Matches documents that satisfy a JavaScript expression. * * @see https://www.mongodb.com/docs/manual/reference/operator/query/where/ - * @param Javascript|non-empty-string $function + * @param Javascript|string $function */ public static function where(Javascript|string $function): WhereOperator { diff --git a/src/Builder/Query/GeometryOperator.php b/src/Builder/Query/GeometryOperator.php index b9970da..efdd38a 100644 --- a/src/Builder/Query/GeometryOperator.php +++ b/src/Builder/Query/GeometryOperator.php @@ -31,7 +31,7 @@ class GeometryOperator implements GeometryInterface, OperatorInterface { public const ENCODE = Encode::Object; - /** @var non-empty-string $type */ + /** @var string $type */ public readonly string $type; /** @var BSONArray|PackedArray|array $coordinates */ @@ -41,7 +41,7 @@ class GeometryOperator implements GeometryInterface, OperatorInterface public readonly Optional|Document|Serializable|stdClass|array $crs; /** - * @param non-empty-string $type + * @param string $type * @param BSONArray|PackedArray|array $coordinates * @param Optional|Document|Serializable|array|stdClass $crs */ diff --git a/src/Builder/Query/GtOperator.php b/src/Builder/Query/GtOperator.php index 515c0ab..31c03e4 100644 --- a/src/Builder/Query/GtOperator.php +++ b/src/Builder/Query/GtOperator.php @@ -23,11 +23,11 @@ class GtOperator implements FieldQueryInterface, OperatorInterface { public const ENCODE = Encode::Single; - /** @var Type|array|bool|float|int|non-empty-string|null|stdClass $value */ + /** @var Type|array|bool|float|int|null|stdClass|string $value */ public readonly Type|stdClass|array|bool|float|int|null|string $value; /** - * @param Type|array|bool|float|int|non-empty-string|null|stdClass $value + * @param Type|array|bool|float|int|null|stdClass|string $value */ public function __construct(Type|stdClass|array|bool|float|int|null|string $value) { diff --git a/src/Builder/Query/GteOperator.php b/src/Builder/Query/GteOperator.php index b8e06f8..2ef771f 100644 --- a/src/Builder/Query/GteOperator.php +++ b/src/Builder/Query/GteOperator.php @@ -23,11 +23,11 @@ class GteOperator implements FieldQueryInterface, OperatorInterface { public const ENCODE = Encode::Single; - /** @var Type|array|bool|float|int|non-empty-string|null|stdClass $value */ + /** @var Type|array|bool|float|int|null|stdClass|string $value */ public readonly Type|stdClass|array|bool|float|int|null|string $value; /** - * @param Type|array|bool|float|int|non-empty-string|null|stdClass $value + * @param Type|array|bool|float|int|null|stdClass|string $value */ public function __construct(Type|stdClass|array|bool|float|int|null|string $value) { diff --git a/src/Builder/Query/LtOperator.php b/src/Builder/Query/LtOperator.php index aab7dc8..f29c73b 100644 --- a/src/Builder/Query/LtOperator.php +++ b/src/Builder/Query/LtOperator.php @@ -23,11 +23,11 @@ class LtOperator implements FieldQueryInterface, OperatorInterface { public const ENCODE = Encode::Single; - /** @var Type|array|bool|float|int|non-empty-string|null|stdClass $value */ + /** @var Type|array|bool|float|int|null|stdClass|string $value */ public readonly Type|stdClass|array|bool|float|int|null|string $value; /** - * @param Type|array|bool|float|int|non-empty-string|null|stdClass $value + * @param Type|array|bool|float|int|null|stdClass|string $value */ public function __construct(Type|stdClass|array|bool|float|int|null|string $value) { diff --git a/src/Builder/Query/LteOperator.php b/src/Builder/Query/LteOperator.php index 2fc0052..18453cb 100644 --- a/src/Builder/Query/LteOperator.php +++ b/src/Builder/Query/LteOperator.php @@ -23,11 +23,11 @@ class LteOperator implements FieldQueryInterface, OperatorInterface { public const ENCODE = Encode::Single; - /** @var Type|array|bool|float|int|non-empty-string|null|stdClass $value */ + /** @var Type|array|bool|float|int|null|stdClass|string $value */ public readonly Type|stdClass|array|bool|float|int|null|string $value; /** - * @param Type|array|bool|float|int|non-empty-string|null|stdClass $value + * @param Type|array|bool|float|int|null|stdClass|string $value */ public function __construct(Type|stdClass|array|bool|float|int|null|string $value) { diff --git a/src/Builder/Query/NeOperator.php b/src/Builder/Query/NeOperator.php index 71521a7..9c12c85 100644 --- a/src/Builder/Query/NeOperator.php +++ b/src/Builder/Query/NeOperator.php @@ -23,11 +23,11 @@ class NeOperator implements FieldQueryInterface, OperatorInterface { public const ENCODE = Encode::Single; - /** @var Type|array|bool|float|int|non-empty-string|null|stdClass $value */ + /** @var Type|array|bool|float|int|null|stdClass|string $value */ public readonly Type|stdClass|array|bool|float|int|null|string $value; /** - * @param Type|array|bool|float|int|non-empty-string|null|stdClass $value + * @param Type|array|bool|float|int|null|stdClass|string $value */ public function __construct(Type|stdClass|array|bool|float|int|null|string $value) { diff --git a/src/Builder/Query/NotOperator.php b/src/Builder/Query/NotOperator.php index 6c48f93..c6d1354 100644 --- a/src/Builder/Query/NotOperator.php +++ b/src/Builder/Query/NotOperator.php @@ -23,11 +23,11 @@ class NotOperator implements FieldQueryInterface, OperatorInterface { public const ENCODE = Encode::Single; - /** @var FieldQueryInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression */ + /** @var FieldQueryInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public readonly Type|FieldQueryInterface|stdClass|array|bool|float|int|null|string $expression; /** - * @param FieldQueryInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param FieldQueryInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public function __construct(Type|FieldQueryInterface|stdClass|array|bool|float|int|null|string $expression) { diff --git a/src/Builder/Query/TextOperator.php b/src/Builder/Query/TextOperator.php index 1fbdd65..47b88ed 100644 --- a/src/Builder/Query/TextOperator.php +++ b/src/Builder/Query/TextOperator.php @@ -22,11 +22,11 @@ class TextOperator implements QueryInterface, OperatorInterface { public const ENCODE = Encode::DollarObject; - /** @var non-empty-string $search A string of terms that MongoDB parses and uses to query the text index. MongoDB performs a logical OR search of the terms unless specified as a phrase. */ + /** @var string $search A string of terms that MongoDB parses and uses to query the text index. MongoDB performs a logical OR search of the terms unless specified as a phrase. */ public readonly string $search; /** - * @var Optional|non-empty-string $language The language that determines the list of stop words for the search and the rules for the stemmer and tokenizer. If not specified, the search uses the default language of the index. + * @var Optional|string $language The language that determines the list of stop words for the search and the rules for the stemmer and tokenizer. If not specified, the search uses the default language of the index. * If you specify a default_language value of none, then the text index parses through each word in the field, including stop words, and ignores suffix stemming. */ public readonly Optional|string $language; @@ -41,8 +41,8 @@ class TextOperator implements QueryInterface, OperatorInterface public readonly Optional|bool $diacriticSensitive; /** - * @param non-empty-string $search A string of terms that MongoDB parses and uses to query the text index. MongoDB performs a logical OR search of the terms unless specified as a phrase. - * @param Optional|non-empty-string $language The language that determines the list of stop words for the search and the rules for the stemmer and tokenizer. If not specified, the search uses the default language of the index. + * @param string $search A string of terms that MongoDB parses and uses to query the text index. MongoDB performs a logical OR search of the terms unless specified as a phrase. + * @param Optional|string $language The language that determines the list of stop words for the search and the rules for the stemmer and tokenizer. If not specified, the search uses the default language of the index. * If you specify a default_language value of none, then the text index parses through each word in the field, including stop words, and ignores suffix stemming. * @param Optional|bool $caseSensitive A boolean flag to enable or disable case sensitive search. Defaults to false; i.e. the search defers to the case insensitivity of the text index. * @param Optional|bool $diacriticSensitive A boolean flag to enable or disable diacritic sensitive search against version 3 text indexes. Defaults to false; i.e. the search defers to the diacritic insensitivity of the text index. diff --git a/src/Builder/Query/TypeOperator.php b/src/Builder/Query/TypeOperator.php index d59e899..1f839c0 100644 --- a/src/Builder/Query/TypeOperator.php +++ b/src/Builder/Query/TypeOperator.php @@ -24,11 +24,11 @@ class TypeOperator implements FieldQueryInterface, OperatorInterface { public const ENCODE = Encode::Single; - /** @var list $type */ + /** @var list $type */ public readonly array $type; /** - * @param int|non-empty-string ...$type + * @param int|string ...$type * @no-named-arguments */ public function __construct(int|string ...$type) diff --git a/src/Builder/Query/WhereOperator.php b/src/Builder/Query/WhereOperator.php index 8be4a96..5a38eb8 100644 --- a/src/Builder/Query/WhereOperator.php +++ b/src/Builder/Query/WhereOperator.php @@ -24,11 +24,11 @@ class WhereOperator implements QueryInterface, OperatorInterface { public const ENCODE = Encode::Single; - /** @var Javascript|non-empty-string $function */ + /** @var Javascript|string $function */ public readonly Javascript|string $function; /** - * @param Javascript|non-empty-string $function + * @param Javascript|string $function */ public function __construct(Javascript|string $function) { diff --git a/src/Builder/Stage/AddFieldsStage.php b/src/Builder/Stage/AddFieldsStage.php index 02a8440..8e2e346 100644 --- a/src/Builder/Stage/AddFieldsStage.php +++ b/src/Builder/Stage/AddFieldsStage.php @@ -27,11 +27,11 @@ class AddFieldsStage implements StageInterface, OperatorInterface { public const ENCODE = Encode::Single; - /** @var stdClass $expression Specify the name of each field to add and set its value to an aggregation expression or an empty object. */ + /** @var stdClass $expression Specify the name of each field to add and set its value to an aggregation expression or an empty object. */ public readonly stdClass $expression; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass ...$expression Specify the name of each field to add and set its value to an aggregation expression or an empty object. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string ...$expression Specify the name of each field to add and set its value to an aggregation expression or an empty object. */ public function __construct(Type|ExpressionInterface|stdClass|array|bool|float|int|null|string ...$expression) { diff --git a/src/Builder/Stage/BucketAutoStage.php b/src/Builder/Stage/BucketAutoStage.php index 40dd3fd..341421f 100644 --- a/src/Builder/Stage/BucketAutoStage.php +++ b/src/Builder/Stage/BucketAutoStage.php @@ -27,7 +27,7 @@ class BucketAutoStage implements StageInterface, OperatorInterface { public const ENCODE = Encode::Object; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $groupBy An expression to group documents by. To specify a field path, prefix the field name with a dollar sign $ and enclose it in quotes. */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $groupBy An expression to group documents by. To specify a field path, prefix the field name with a dollar sign $ and enclose it in quotes. */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $groupBy; /** @var int $buckets A positive 32-bit integer that specifies the number of buckets into which input documents are grouped. */ @@ -46,7 +46,7 @@ class BucketAutoStage implements StageInterface, OperatorInterface public readonly Optional|Document|Serializable|stdClass|array $granularity; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $groupBy An expression to group documents by. To specify a field path, prefix the field name with a dollar sign $ and enclose it in quotes. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $groupBy An expression to group documents by. To specify a field path, prefix the field name with a dollar sign $ and enclose it in quotes. * @param int $buckets A positive 32-bit integer that specifies the number of buckets into which input documents are grouped. * @param Optional|Document|Serializable|array|stdClass $output A document that specifies the fields to include in the output documents in addition to the _id field. To specify the field to include, you must use accumulator expressions. * The default count field is not included in the output document when output is specified. Explicitly specify the count expression as part of the output document to include it. diff --git a/src/Builder/Stage/BucketStage.php b/src/Builder/Stage/BucketStage.php index 53955c7..47a4971 100644 --- a/src/Builder/Stage/BucketStage.php +++ b/src/Builder/Stage/BucketStage.php @@ -34,7 +34,7 @@ class BucketStage implements StageInterface, OperatorInterface public const ENCODE = Encode::Object; /** - * @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $groupBy An expression to group documents by. To specify a field path, prefix the field name with a dollar sign $ and enclose it in quotes. + * @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $groupBy An expression to group documents by. To specify a field path, prefix the field name with a dollar sign $ and enclose it in quotes. * Unless $bucket includes a default specification, each input document must resolve the groupBy field path or expression to a value that falls within one of the ranges specified by the boundaries. */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $groupBy; @@ -46,7 +46,7 @@ class BucketStage implements StageInterface, OperatorInterface public readonly PackedArray|BSONArray|array $boundaries; /** - * @var Optional|ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $default A literal that specifies the _id of an additional bucket that contains all documents whose groupBy expression result does not fall into a bucket specified by boundaries. + * @var Optional|ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $default A literal that specifies the _id of an additional bucket that contains all documents whose groupBy expression result does not fall into a bucket specified by boundaries. * If unspecified, each input document must resolve the groupBy expression to a value within one of the bucket ranges specified by boundaries or the operation throws an error. * The default value must be less than the lowest boundaries value, or greater than or equal to the highest boundaries value. * The default value can be of a different type than the entries in boundaries. @@ -61,11 +61,11 @@ class BucketStage implements StageInterface, OperatorInterface public readonly Optional|Document|Serializable|stdClass|array $output; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $groupBy An expression to group documents by. To specify a field path, prefix the field name with a dollar sign $ and enclose it in quotes. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $groupBy An expression to group documents by. To specify a field path, prefix the field name with a dollar sign $ and enclose it in quotes. * Unless $bucket includes a default specification, each input document must resolve the groupBy field path or expression to a value that falls within one of the ranges specified by the boundaries. * @param BSONArray|PackedArray|array $boundaries An array of values based on the groupBy expression that specify the boundaries for each bucket. Each adjacent pair of values acts as the inclusive lower boundary and the exclusive upper boundary for the bucket. You must specify at least two boundaries. * The specified values must be in ascending order and all of the same type. The exception is if the values are of mixed numeric types, such as: - * @param Optional|ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $default A literal that specifies the _id of an additional bucket that contains all documents whose groupBy expression result does not fall into a bucket specified by boundaries. + * @param Optional|ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $default A literal that specifies the _id of an additional bucket that contains all documents whose groupBy expression result does not fall into a bucket specified by boundaries. * If unspecified, each input document must resolve the groupBy expression to a value within one of the bucket ranges specified by boundaries or the operation throws an error. * The default value must be less than the lowest boundaries value, or greater than or equal to the highest boundaries value. * The default value can be of a different type than the entries in boundaries. diff --git a/src/Builder/Stage/ChangeStreamStage.php b/src/Builder/Stage/ChangeStreamStage.php index 551842a..184ae96 100644 --- a/src/Builder/Stage/ChangeStreamStage.php +++ b/src/Builder/Stage/ChangeStreamStage.php @@ -29,10 +29,10 @@ class ChangeStreamStage implements StageInterface, OperatorInterface /** @var Optional|bool $allChangesForCluster A flag indicating whether the stream should report all changes that occur on the deployment, aside from those on internal databases or collections. */ public readonly Optional|bool $allChangesForCluster; - /** @var Optional|non-empty-string $fullDocument Specifies whether change notifications include a copy of the full document when modified by update operations. */ + /** @var Optional|string $fullDocument Specifies whether change notifications include a copy of the full document when modified by update operations. */ public readonly Optional|string $fullDocument; - /** @var Optional|non-empty-string $fullDocumentBeforeChange Valid values are "off", "whenAvailable", or "required". If set to "off", the "fullDocumentBeforeChange" field of the output document is always omitted. If set to "whenAvailable", the "fullDocumentBeforeChange" field will be populated with the pre-image of the document modified by the current change event if such a pre-image is available, and will be omitted otherwise. If set to "required", then the "fullDocumentBeforeChange" field is always populated and an exception is thrown if the pre-image is not available. */ + /** @var Optional|string $fullDocumentBeforeChange Valid values are "off", "whenAvailable", or "required". If set to "off", the "fullDocumentBeforeChange" field of the output document is always omitted. If set to "whenAvailable", the "fullDocumentBeforeChange" field will be populated with the pre-image of the document modified by the current change event if such a pre-image is available, and will be omitted otherwise. If set to "required", then the "fullDocumentBeforeChange" field is always populated and an exception is thrown if the pre-image is not available. */ public readonly Optional|string $fullDocumentBeforeChange; /** @var Optional|int $resumeAfter Specifies a resume token as the logical starting point for the change stream. Cannot be used with startAfter or startAtOperationTime fields. */ @@ -52,8 +52,8 @@ class ChangeStreamStage implements StageInterface, OperatorInterface /** * @param Optional|bool $allChangesForCluster A flag indicating whether the stream should report all changes that occur on the deployment, aside from those on internal databases or collections. - * @param Optional|non-empty-string $fullDocument Specifies whether change notifications include a copy of the full document when modified by update operations. - * @param Optional|non-empty-string $fullDocumentBeforeChange Valid values are "off", "whenAvailable", or "required". If set to "off", the "fullDocumentBeforeChange" field of the output document is always omitted. If set to "whenAvailable", the "fullDocumentBeforeChange" field will be populated with the pre-image of the document modified by the current change event if such a pre-image is available, and will be omitted otherwise. If set to "required", then the "fullDocumentBeforeChange" field is always populated and an exception is thrown if the pre-image is not available. + * @param Optional|string $fullDocument Specifies whether change notifications include a copy of the full document when modified by update operations. + * @param Optional|string $fullDocumentBeforeChange Valid values are "off", "whenAvailable", or "required". If set to "off", the "fullDocumentBeforeChange" field of the output document is always omitted. If set to "whenAvailable", the "fullDocumentBeforeChange" field will be populated with the pre-image of the document modified by the current change event if such a pre-image is available, and will be omitted otherwise. If set to "required", then the "fullDocumentBeforeChange" field is always populated and an exception is thrown if the pre-image is not available. * @param Optional|int $resumeAfter Specifies a resume token as the logical starting point for the change stream. Cannot be used with startAfter or startAtOperationTime fields. * @param Optional|bool $showExpandedEvents Specifies whether to include additional change events, such as such as DDL and index operations. * New in MongoDB 6.0. diff --git a/src/Builder/Stage/CountStage.php b/src/Builder/Stage/CountStage.php index fec4a28..3864f00 100644 --- a/src/Builder/Stage/CountStage.php +++ b/src/Builder/Stage/CountStage.php @@ -22,11 +22,11 @@ class CountStage implements StageInterface, OperatorInterface { public const ENCODE = Encode::Single; - /** @var non-empty-string $field Name of the output field which has the count as its value. It must be a non-empty string, must not start with $ and must not contain the . character. */ + /** @var string $field Name of the output field which has the count as its value. It must be a non-empty string, must not start with $ and must not contain the . character. */ public readonly string $field; /** - * @param non-empty-string $field Name of the output field which has the count as its value. It must be a non-empty string, must not start with $ and must not contain the . character. + * @param string $field Name of the output field which has the count as its value. It must be a non-empty string, must not start with $ and must not contain the . character. */ public function __construct(string $field) { diff --git a/src/Builder/Stage/DensifyStage.php b/src/Builder/Stage/DensifyStage.php index cf4fc20..3abfcb3 100644 --- a/src/Builder/Stage/DensifyStage.php +++ b/src/Builder/Stage/DensifyStage.php @@ -32,7 +32,7 @@ class DensifyStage implements StageInterface, OperatorInterface public const ENCODE = Encode::Object; /** - * @var non-empty-string $field The field to densify. The values of the specified field must either be all numeric values or all dates. + * @var string $field The field to densify. The values of the specified field must either be all numeric values or all dates. * Documents that do not contain the specified field continue through the pipeline unmodified. * To specify a in an embedded document or in an array, use dot notation. */ @@ -45,7 +45,7 @@ class DensifyStage implements StageInterface, OperatorInterface public readonly Optional|PackedArray|BSONArray|array $partitionByFields; /** - * @param non-empty-string $field The field to densify. The values of the specified field must either be all numeric values or all dates. + * @param string $field The field to densify. The values of the specified field must either be all numeric values or all dates. * Documents that do not contain the specified field continue through the pipeline unmodified. * To specify a in an embedded document or in an array, use dot notation. * @param Document|Serializable|array|stdClass $range Specification for range based densification. diff --git a/src/Builder/Stage/FactoryTrait.php b/src/Builder/Stage/FactoryTrait.php index 4441381..012fe99 100644 --- a/src/Builder/Stage/FactoryTrait.php +++ b/src/Builder/Stage/FactoryTrait.php @@ -37,7 +37,7 @@ trait FactoryTrait * Adds new fields to documents. Outputs documents that contain all existing fields from the input documents and newly added fields. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/addFields/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass ...$expression Specify the name of each field to add and set its value to an aggregation expression or an empty object. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string ...$expression Specify the name of each field to add and set its value to an aggregation expression or an empty object. */ public static function addFields( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string ...$expression, @@ -50,11 +50,11 @@ public static function addFields( * Categorizes incoming documents into groups, called buckets, based on a specified expression and bucket boundaries. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/bucket/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $groupBy An expression to group documents by. To specify a field path, prefix the field name with a dollar sign $ and enclose it in quotes. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $groupBy An expression to group documents by. To specify a field path, prefix the field name with a dollar sign $ and enclose it in quotes. * Unless $bucket includes a default specification, each input document must resolve the groupBy field path or expression to a value that falls within one of the ranges specified by the boundaries. * @param BSONArray|PackedArray|array $boundaries An array of values based on the groupBy expression that specify the boundaries for each bucket. Each adjacent pair of values acts as the inclusive lower boundary and the exclusive upper boundary for the bucket. You must specify at least two boundaries. * The specified values must be in ascending order and all of the same type. The exception is if the values are of mixed numeric types, such as: - * @param Optional|ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $default A literal that specifies the _id of an additional bucket that contains all documents whose groupBy expression result does not fall into a bucket specified by boundaries. + * @param Optional|ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $default A literal that specifies the _id of an additional bucket that contains all documents whose groupBy expression result does not fall into a bucket specified by boundaries. * If unspecified, each input document must resolve the groupBy expression to a value within one of the bucket ranges specified by boundaries or the operation throws an error. * The default value must be less than the lowest boundaries value, or greater than or equal to the highest boundaries value. * The default value can be of a different type than the entries in boundaries. @@ -76,7 +76,7 @@ public static function bucket( * Categorizes incoming documents into a specific number of groups, called buckets, based on a specified expression. Bucket boundaries are automatically determined in an attempt to evenly distribute the documents into the specified number of buckets. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/bucketAuto/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $groupBy An expression to group documents by. To specify a field path, prefix the field name with a dollar sign $ and enclose it in quotes. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $groupBy An expression to group documents by. To specify a field path, prefix the field name with a dollar sign $ and enclose it in quotes. * @param int $buckets A positive 32-bit integer that specifies the number of buckets into which input documents are grouped. * @param Optional|Document|Serializable|array|stdClass $output A document that specifies the fields to include in the output documents in addition to the _id field. To specify the field to include, you must use accumulator expressions. * The default count field is not included in the output document when output is specified. Explicitly specify the count expression as part of the output document to include it. @@ -98,8 +98,8 @@ public static function bucketAuto( * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/changeStream/ * @param Optional|bool $allChangesForCluster A flag indicating whether the stream should report all changes that occur on the deployment, aside from those on internal databases or collections. - * @param Optional|non-empty-string $fullDocument Specifies whether change notifications include a copy of the full document when modified by update operations. - * @param Optional|non-empty-string $fullDocumentBeforeChange Valid values are "off", "whenAvailable", or "required". If set to "off", the "fullDocumentBeforeChange" field of the output document is always omitted. If set to "whenAvailable", the "fullDocumentBeforeChange" field will be populated with the pre-image of the document modified by the current change event if such a pre-image is available, and will be omitted otherwise. If set to "required", then the "fullDocumentBeforeChange" field is always populated and an exception is thrown if the pre-image is not available. + * @param Optional|string $fullDocument Specifies whether change notifications include a copy of the full document when modified by update operations. + * @param Optional|string $fullDocumentBeforeChange Valid values are "off", "whenAvailable", or "required". If set to "off", the "fullDocumentBeforeChange" field of the output document is always omitted. If set to "whenAvailable", the "fullDocumentBeforeChange" field will be populated with the pre-image of the document modified by the current change event if such a pre-image is available, and will be omitted otherwise. If set to "required", then the "fullDocumentBeforeChange" field is always populated and an exception is thrown if the pre-image is not available. * @param Optional|int $resumeAfter Specifies a resume token as the logical starting point for the change stream. Cannot be used with startAfter or startAtOperationTime fields. * @param Optional|bool $showExpandedEvents Specifies whether to include additional change events, such as such as DDL and index operations. * New in MongoDB 6.0. @@ -146,7 +146,7 @@ public static function collStats(Document|Serializable|stdClass|array $config): * Distinct from the $count aggregation accumulator. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/count/ - * @param non-empty-string $field Name of the output field which has the count as its value. It must be a non-empty string, must not start with $ and must not contain the . character. + * @param string $field Name of the output field which has the count as its value. It must be a non-empty string, must not start with $ and must not contain the . character. */ public static function count(string $field): CountStage { @@ -167,7 +167,7 @@ public static function currentOp(): CurrentOpStage * Creates new documents in a sequence of documents where certain values in a field are missing. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/densify/ - * @param non-empty-string $field The field to densify. The values of the specified field must either be all numeric values or all dates. + * @param string $field The field to densify. The values of the specified field must either be all numeric values or all dates. * Documents that do not contain the specified field continue through the pipeline unmodified. * To specify a in an embedded document or in an array, use dot notation. * @param Document|Serializable|array|stdClass $range Specification for range based densification. @@ -214,7 +214,7 @@ public static function facet(PackedArray|Pipeline|BSONArray|array ...$facet): Fa * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/fill/ * @param Document|Serializable|array|stdClass $output Specifies an object containing each field for which to fill missing values. You can specify multiple fields in the output object. * The object name is the name of the field to fill. The object value specifies how the field is filled. - * @param Optional|Document|Serializable|array|non-empty-string|stdClass $partitionBy Specifies an expression to group the documents. In the $fill stage, a group of documents is known as a partition. + * @param Optional|Document|Serializable|array|stdClass|string $partitionBy Specifies an expression to group the documents. In the $fill stage, a group of documents is known as a partition. * If you omit partitionBy and partitionByFields, $fill uses one partition for the entire collection. * partitionBy and partitionByFields are mutually exclusive. * @param Optional|BSONArray|PackedArray|array $partitionByFields Specifies an array of fields as the compound key to group the documents. In the $fill stage, each group of documents is known as a partition. @@ -236,11 +236,11 @@ public static function fill( * Returns an ordered stream of documents based on the proximity to a geospatial point. Incorporates the functionality of $match, $sort, and $limit for geospatial data. The output documents include an additional distance field and can include a location identifier field. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/geoNear/ - * @param non-empty-string $distanceField The output field that contains the calculated distance. To specify a field within an embedded document, use dot notation. + * @param string $distanceField The output field that contains the calculated distance. To specify a field within an embedded document, use dot notation. * @param Document|Serializable|array|stdClass $near The point for which to find the closest documents. * @param Optional|Decimal128|Int64|float|int $distanceMultiplier The factor to multiply all distances returned by the query. For example, use the distanceMultiplier to convert radians, as returned by a spherical query, to kilometers by multiplying by the radius of the Earth. - * @param Optional|non-empty-string $includeLocs This specifies the output field that identifies the location used to calculate the distance. This option is useful when a location field contains multiple locations. To specify a field within an embedded document, use dot notation. - * @param Optional|non-empty-string $key Specify the geospatial indexed field to use when calculating the distance. + * @param Optional|string $includeLocs This specifies the output field that identifies the location used to calculate the distance. This option is useful when a location field contains multiple locations. To specify a field within an embedded document, use dot notation. + * @param Optional|string $key Specify the geospatial indexed field to use when calculating the distance. * @param Optional|Decimal128|Int64|float|int $maxDistance The maximum distance from the center point that the documents can be. MongoDB limits the results to those documents that fall within the specified distance from the center point. * Specify the distance in meters if the specified point is GeoJSON and in radians if the specified point is legacy coordinate pairs. * @param Optional|Decimal128|Int64|float|int $minDistance The minimum distance from the center point that the documents can be. MongoDB limits the results to those documents that fall outside the specified distance from the center point. @@ -271,14 +271,14 @@ public static function geoNear( * Performs a recursive search on a collection. To each output document, adds a new array field that contains the traversal results of the recursive search for that document. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/graphLookup/ - * @param non-empty-string $from Target collection for the $graphLookup operation to search, recursively matching the connectFromField to the connectToField. The from collection must be in the same database as any other collections used in the operation. + * @param string $from Target collection for the $graphLookup operation to search, recursively matching the connectFromField to the connectToField. The from collection must be in the same database as any other collections used in the operation. * Starting in MongoDB 5.1, the collection specified in the from parameter can be sharded. - * @param BSONArray|ExpressionInterface|PackedArray|Type|array|bool|float|int|non-empty-string|null|stdClass $startWith Expression that specifies the value of the connectFromField with which to start the recursive search. Optionally, startWith may be array of values, each of which is individually followed through the traversal process. - * @param non-empty-string $connectFromField Field name whose value $graphLookup uses to recursively match against the connectToField of other documents in the collection. If the value is an array, each element is individually followed through the traversal process. - * @param non-empty-string $connectToField Field name in other documents against which to match the value of the field specified by the connectFromField parameter. - * @param non-empty-string $as Name of the array field added to each output document. Contains the documents traversed in the $graphLookup stage to reach the document. + * @param BSONArray|ExpressionInterface|PackedArray|Type|array|bool|float|int|null|stdClass|string $startWith Expression that specifies the value of the connectFromField with which to start the recursive search. Optionally, startWith may be array of values, each of which is individually followed through the traversal process. + * @param string $connectFromField Field name whose value $graphLookup uses to recursively match against the connectToField of other documents in the collection. If the value is an array, each element is individually followed through the traversal process. + * @param string $connectToField Field name in other documents against which to match the value of the field specified by the connectFromField parameter. + * @param string $as Name of the array field added to each output document. Contains the documents traversed in the $graphLookup stage to reach the document. * @param Optional|int $maxDepth Non-negative integral number specifying the maximum recursion depth. - * @param Optional|non-empty-string $depthField Name of the field to add to each traversed document in the search path. The value of this field is the recursion depth for the document, represented as a NumberLong. Recursion depth value starts at zero, so the first lookup corresponds to zero depth. + * @param Optional|string $depthField Name of the field to add to each traversed document in the search path. The value of this field is the recursion depth for the document, represented as a NumberLong. Recursion depth value starts at zero, so the first lookup corresponds to zero depth. * @param Optional|QueryInterface|array $restrictSearchWithMatch A document specifying additional conditions for the recursive search. The syntax is identical to query filter syntax. */ public static function graphLookup( @@ -299,7 +299,7 @@ public static function graphLookup( * Groups input documents by a specified identifier expression and applies the accumulator expression(s), if specified, to each group. Consumes all input documents and outputs one document per each distinct group. The output documents only contain the identifier field and, if specified, accumulated fields. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/group/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $_id The _id expression specifies the group key. If you specify an _id value of null, or any other constant value, the $group stage returns a single document that aggregates values across all of the input documents. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $_id The _id expression specifies the group key. If you specify an _id value of null, or any other constant value, the $group stage returns a single document that aggregates values across all of the input documents. * @param AccumulatorInterface|Document|Serializable|array|stdClass ...$field Computed using the accumulator operators. */ public static function group( @@ -350,7 +350,7 @@ public static function listLocalSessions( * Lists sampled queries for all collections or a specific collection. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/listSampledQueries/ - * @param Optional|non-empty-string $namespace + * @param Optional|string $namespace */ public static function listSampledQueries( Optional|string $namespace = Optional::Undefined, @@ -363,8 +363,8 @@ public static function listSampledQueries( * Returns information about existing Atlas Search indexes on a specified collection. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/listSearchIndexes/ - * @param Optional|non-empty-string $id The id of the index to return information about. - * @param Optional|non-empty-string $name The name of the index to return information about. + * @param Optional|string $id The id of the index to return information about. + * @param Optional|string $name The name of the index to return information about. */ public static function listSearchIndexes( Optional|string $id = Optional::Undefined, @@ -393,12 +393,12 @@ public static function listSessions( * Performs a left outer join to another collection in the same database to filter in documents from the "joined" collection for processing. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/lookup/ - * @param non-empty-string $as Specifies the name of the new array field to add to the input documents. The new array field contains the matching documents from the from collection. If the specified name already exists in the input document, the existing field is overwritten. - * @param Optional|non-empty-string $from Specifies the collection in the same database to perform the join with. + * @param string $as Specifies the name of the new array field to add to the input documents. The new array field contains the matching documents from the from collection. If the specified name already exists in the input document, the existing field is overwritten. + * @param Optional|string $from Specifies the collection in the same database to perform the join with. * from is optional, you can use a $documents stage in a $lookup stage instead. For an example, see Use a $documents Stage in a $lookup Stage. * Starting in MongoDB 5.1, the collection specified in the from parameter can be sharded. - * @param Optional|non-empty-string $localField Specifies the field from the documents input to the $lookup stage. $lookup performs an equality match on the localField to the foreignField from the documents of the from collection. If an input document does not contain the localField, the $lookup treats the field as having a value of null for matching purposes. - * @param Optional|non-empty-string $foreignField Specifies the field from the documents in the from collection. $lookup performs an equality match on the foreignField to the localField from the input documents. If a document in the from collection does not contain the foreignField, the $lookup treats the value as null for matching purposes. + * @param Optional|string $localField Specifies the field from the documents input to the $lookup stage. $lookup performs an equality match on the localField to the foreignField from the documents of the from collection. If an input document does not contain the localField, the $lookup treats the field as having a value of null for matching purposes. + * @param Optional|string $foreignField Specifies the field from the documents in the from collection. $lookup performs an equality match on the foreignField to the localField from the input documents. If a document in the from collection does not contain the foreignField, the $lookup treats the value as null for matching purposes. * @param Optional|Document|Serializable|array|stdClass $let Specifies variables to use in the pipeline stages. Use the variable expressions to access the fields from the joined collection's documents that are input to the pipeline. * @param Optional|BSONArray|PackedArray|Pipeline|array $pipeline Specifies the pipeline to run on the joined collection. The pipeline determines the resulting documents from the joined collection. To return all documents, specify an empty pipeline []. * The pipeline cannot include the $out stage or the $merge stage. Starting in v6.0, the pipeline can contain the Atlas Search $search stage as the first stage inside the pipeline. @@ -432,11 +432,11 @@ public static function match(QueryInterface|array $query): MatchStage * New in MongoDB 4.2. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/merge/ - * @param non-empty-string $into The output collection. - * @param Optional|BSONArray|PackedArray|array|non-empty-string $on Field or fields that act as a unique identifier for a document. The identifier determines if a results document matches an existing document in the output collection. + * @param string $into The output collection. + * @param Optional|BSONArray|PackedArray|array|string $on Field or fields that act as a unique identifier for a document. The identifier determines if a results document matches an existing document in the output collection. * @param Optional|Document|Serializable|array|stdClass $let Specifies variables for use in the whenMatched pipeline. - * @param Optional|non-empty-string $whenMatched The behavior of $merge if a result document and an existing document in the collection have the same value for the specified on field(s). - * @param Optional|non-empty-string $whenNotMatched The behavior of $merge if a result document does not match an existing document in the out collection. + * @param Optional|string $whenMatched The behavior of $merge if a result document and an existing document in the collection have the same value for the specified on field(s). + * @param Optional|string $whenNotMatched The behavior of $merge if a result document does not match an existing document in the out collection. */ public static function merge( string $into, @@ -453,8 +453,8 @@ public static function merge( * Writes the resulting documents of the aggregation pipeline to a collection. To use the $out stage, it must be the last stage in the pipeline. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/out/ - * @param non-empty-string $db Target collection name to write documents from $out to. - * @param non-empty-string $coll Target database name to write documents from $out to. + * @param string $db Target collection name to write documents from $out to. + * @param string $coll Target database name to write documents from $out to. * @param Optional|Document|Serializable|array|stdClass $timeseries If set, the aggregation stage will use these options to create or replace a time-series collection in the given namespace. */ public static function out( @@ -480,7 +480,7 @@ public static function planCacheStats(): PlanCacheStatsStage * Reshapes each document in the stream, such as by adding new fields or removing existing fields. For each input document, outputs one document. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/project/ - * @param Document|ExpressionInterface|ProjectionInterface|Serializable|Type|array|bool|float|int|non-empty-string|null|stdClass ...$specification + * @param Document|ExpressionInterface|ProjectionInterface|Serializable|Type|array|bool|float|int|null|stdClass|string ...$specification */ public static function project( Document|Serializable|Type|ExpressionInterface|ProjectionInterface|stdClass|array|bool|float|int|null|string ...$specification, @@ -493,7 +493,7 @@ public static function project( * Reshapes each document in the stream by restricting the content for each document based on information stored in the documents themselves. Incorporates the functionality of $project and $match. Can be used to implement field level redaction. For each input document, outputs either one or zero documents. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/redact/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public static function redact( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression, @@ -569,7 +569,7 @@ public static function searchMeta(Document|Serializable|stdClass|array $meta): S * Alias for $addFields. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/set/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass ...$field + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string ...$field */ public static function set(Type|ExpressionInterface|stdClass|array|bool|float|int|null|string ...$field): SetStage { @@ -584,7 +584,7 @@ public static function set(Type|ExpressionInterface|stdClass|array|bool|float|in * @param Document|Serializable|array|stdClass $sortBy Specifies the field(s) to sort the documents by in the partition. Uses the same syntax as the $sort stage. Default is no sorting. * @param Document|Serializable|array|stdClass $output Specifies the field(s) to append to the documents in the output returned by the $setWindowFields stage. Each field is set to the result returned by the window operator. * A field can contain dots to specify embedded document fields and array fields. The semantics for the embedded document dotted notation in the $setWindowFields stage are the same as the $addFields and $set stages. - * @param Optional|ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $partitionBy Specifies an expression to group the documents. In the $setWindowFields stage, the group of documents is known as a partition. Default is one partition for the entire collection. + * @param Optional|ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $partitionBy Specifies an expression to group the documents. In the $setWindowFields stage, the group of documents is known as a partition. Default is one partition for the entire collection. */ public static function setWindowFields( Document|Serializable|stdClass|array $sortBy, @@ -632,7 +632,7 @@ public static function sort(Document|Serializable|stdClass|array $sort): SortSta * Groups incoming documents based on the value of a specified expression, then computes the count of documents in each distinct group. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/sortByCount/ - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public static function sortByCount( Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression, @@ -646,7 +646,7 @@ public static function sortByCount( * New in MongoDB 4.4. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/unionWith/ - * @param non-empty-string $coll The collection or view whose pipeline results you wish to include in the result set. + * @param string $coll The collection or view whose pipeline results you wish to include in the result set. * @param Optional|BSONArray|PackedArray|Pipeline|array $pipeline An aggregation pipeline to apply to the specified coll. * The pipeline cannot include the $out and $merge stages. Starting in v6.0, the pipeline can contain the Atlas Search $search stage as the first stage inside the pipeline. */ @@ -664,7 +664,7 @@ public static function unionWith( * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/unset/ * @no-named-arguments - * @param FieldPath|non-empty-string ...$field + * @param FieldPath|string ...$field */ public static function unset(FieldPath|string ...$field): UnsetStage { @@ -675,8 +675,8 @@ public static function unset(FieldPath|string ...$field): UnsetStage * Deconstructs an array field from the input documents to output a document for each element. Each output document replaces the array with an element value. For each input document, outputs n documents where n is the number of array elements and can be zero for an empty array. * * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/unwind/ - * @param ArrayFieldPath|non-empty-string $path Field path to an array field. - * @param Optional|non-empty-string $includeArrayIndex The name of a new field to hold the array index of the element. The name cannot start with a dollar sign $. + * @param ArrayFieldPath|string $path Field path to an array field. + * @param Optional|string $includeArrayIndex The name of a new field to hold the array index of the element. The name cannot start with a dollar sign $. * @param Optional|bool $preserveNullAndEmptyArrays If true, if the path is null, missing, or an empty array, $unwind outputs the document. * If false, if path is null, missing, or an empty array, $unwind does not output a document. * The default value is false. diff --git a/src/Builder/Stage/FillStage.php b/src/Builder/Stage/FillStage.php index 00b47ea..634c05b 100644 --- a/src/Builder/Stage/FillStage.php +++ b/src/Builder/Stage/FillStage.php @@ -38,7 +38,7 @@ class FillStage implements StageInterface, OperatorInterface public readonly Document|Serializable|stdClass|array $output; /** - * @var Optional|Document|Serializable|array|non-empty-string|stdClass $partitionBy Specifies an expression to group the documents. In the $fill stage, a group of documents is known as a partition. + * @var Optional|Document|Serializable|array|stdClass|string $partitionBy Specifies an expression to group the documents. In the $fill stage, a group of documents is known as a partition. * If you omit partitionBy and partitionByFields, $fill uses one partition for the entire collection. * partitionBy and partitionByFields are mutually exclusive. */ @@ -57,7 +57,7 @@ class FillStage implements StageInterface, OperatorInterface /** * @param Document|Serializable|array|stdClass $output Specifies an object containing each field for which to fill missing values. You can specify multiple fields in the output object. * The object name is the name of the field to fill. The object value specifies how the field is filled. - * @param Optional|Document|Serializable|array|non-empty-string|stdClass $partitionBy Specifies an expression to group the documents. In the $fill stage, a group of documents is known as a partition. + * @param Optional|Document|Serializable|array|stdClass|string $partitionBy Specifies an expression to group the documents. In the $fill stage, a group of documents is known as a partition. * If you omit partitionBy and partitionByFields, $fill uses one partition for the entire collection. * partitionBy and partitionByFields are mutually exclusive. * @param Optional|BSONArray|PackedArray|array $partitionByFields Specifies an array of fields as the compound key to group the documents. In the $fill stage, each group of documents is known as a partition. diff --git a/src/Builder/Stage/GeoNearStage.php b/src/Builder/Stage/GeoNearStage.php index b7b8ec1..65996e3 100644 --- a/src/Builder/Stage/GeoNearStage.php +++ b/src/Builder/Stage/GeoNearStage.php @@ -31,7 +31,7 @@ class GeoNearStage implements StageInterface, OperatorInterface { public const ENCODE = Encode::Object; - /** @var non-empty-string $distanceField The output field that contains the calculated distance. To specify a field within an embedded document, use dot notation. */ + /** @var string $distanceField The output field that contains the calculated distance. To specify a field within an embedded document, use dot notation. */ public readonly string $distanceField; /** @var Document|Serializable|array|stdClass $near The point for which to find the closest documents. */ @@ -40,10 +40,10 @@ class GeoNearStage implements StageInterface, OperatorInterface /** @var Optional|Decimal128|Int64|float|int $distanceMultiplier The factor to multiply all distances returned by the query. For example, use the distanceMultiplier to convert radians, as returned by a spherical query, to kilometers by multiplying by the radius of the Earth. */ public readonly Optional|Decimal128|Int64|float|int $distanceMultiplier; - /** @var Optional|non-empty-string $includeLocs This specifies the output field that identifies the location used to calculate the distance. This option is useful when a location field contains multiple locations. To specify a field within an embedded document, use dot notation. */ + /** @var Optional|string $includeLocs This specifies the output field that identifies the location used to calculate the distance. This option is useful when a location field contains multiple locations. To specify a field within an embedded document, use dot notation. */ public readonly Optional|string $includeLocs; - /** @var Optional|non-empty-string $key Specify the geospatial indexed field to use when calculating the distance. */ + /** @var Optional|string $key Specify the geospatial indexed field to use when calculating the distance. */ public readonly Optional|string $key; /** @@ -73,11 +73,11 @@ class GeoNearStage implements StageInterface, OperatorInterface public readonly Optional|bool $spherical; /** - * @param non-empty-string $distanceField The output field that contains the calculated distance. To specify a field within an embedded document, use dot notation. + * @param string $distanceField The output field that contains the calculated distance. To specify a field within an embedded document, use dot notation. * @param Document|Serializable|array|stdClass $near The point for which to find the closest documents. * @param Optional|Decimal128|Int64|float|int $distanceMultiplier The factor to multiply all distances returned by the query. For example, use the distanceMultiplier to convert radians, as returned by a spherical query, to kilometers by multiplying by the radius of the Earth. - * @param Optional|non-empty-string $includeLocs This specifies the output field that identifies the location used to calculate the distance. This option is useful when a location field contains multiple locations. To specify a field within an embedded document, use dot notation. - * @param Optional|non-empty-string $key Specify the geospatial indexed field to use when calculating the distance. + * @param Optional|string $includeLocs This specifies the output field that identifies the location used to calculate the distance. This option is useful when a location field contains multiple locations. To specify a field within an embedded document, use dot notation. + * @param Optional|string $key Specify the geospatial indexed field to use when calculating the distance. * @param Optional|Decimal128|Int64|float|int $maxDistance The maximum distance from the center point that the documents can be. MongoDB limits the results to those documents that fall within the specified distance from the center point. * Specify the distance in meters if the specified point is GeoJSON and in radians if the specified point is legacy coordinate pairs. * @param Optional|Decimal128|Int64|float|int $minDistance The minimum distance from the center point that the documents can be. MongoDB limits the results to those documents that fall outside the specified distance from the center point. diff --git a/src/Builder/Stage/GraphLookupStage.php b/src/Builder/Stage/GraphLookupStage.php index 93edd68..ceaa7a4 100644 --- a/src/Builder/Stage/GraphLookupStage.php +++ b/src/Builder/Stage/GraphLookupStage.php @@ -34,41 +34,41 @@ class GraphLookupStage implements StageInterface, OperatorInterface public const ENCODE = Encode::Object; /** - * @var non-empty-string $from Target collection for the $graphLookup operation to search, recursively matching the connectFromField to the connectToField. The from collection must be in the same database as any other collections used in the operation. + * @var string $from Target collection for the $graphLookup operation to search, recursively matching the connectFromField to the connectToField. The from collection must be in the same database as any other collections used in the operation. * Starting in MongoDB 5.1, the collection specified in the from parameter can be sharded. */ public readonly string $from; - /** @var BSONArray|ExpressionInterface|PackedArray|Type|array|bool|float|int|non-empty-string|null|stdClass $startWith Expression that specifies the value of the connectFromField with which to start the recursive search. Optionally, startWith may be array of values, each of which is individually followed through the traversal process. */ + /** @var BSONArray|ExpressionInterface|PackedArray|Type|array|bool|float|int|null|stdClass|string $startWith Expression that specifies the value of the connectFromField with which to start the recursive search. Optionally, startWith may be array of values, each of which is individually followed through the traversal process. */ public readonly PackedArray|Type|ExpressionInterface|BSONArray|stdClass|array|bool|float|int|null|string $startWith; - /** @var non-empty-string $connectFromField Field name whose value $graphLookup uses to recursively match against the connectToField of other documents in the collection. If the value is an array, each element is individually followed through the traversal process. */ + /** @var string $connectFromField Field name whose value $graphLookup uses to recursively match against the connectToField of other documents in the collection. If the value is an array, each element is individually followed through the traversal process. */ public readonly string $connectFromField; - /** @var non-empty-string $connectToField Field name in other documents against which to match the value of the field specified by the connectFromField parameter. */ + /** @var string $connectToField Field name in other documents against which to match the value of the field specified by the connectFromField parameter. */ public readonly string $connectToField; - /** @var non-empty-string $as Name of the array field added to each output document. Contains the documents traversed in the $graphLookup stage to reach the document. */ + /** @var string $as Name of the array field added to each output document. Contains the documents traversed in the $graphLookup stage to reach the document. */ public readonly string $as; /** @var Optional|int $maxDepth Non-negative integral number specifying the maximum recursion depth. */ public readonly Optional|int $maxDepth; - /** @var Optional|non-empty-string $depthField Name of the field to add to each traversed document in the search path. The value of this field is the recursion depth for the document, represented as a NumberLong. Recursion depth value starts at zero, so the first lookup corresponds to zero depth. */ + /** @var Optional|string $depthField Name of the field to add to each traversed document in the search path. The value of this field is the recursion depth for the document, represented as a NumberLong. Recursion depth value starts at zero, so the first lookup corresponds to zero depth. */ public readonly Optional|string $depthField; /** @var Optional|QueryInterface|array $restrictSearchWithMatch A document specifying additional conditions for the recursive search. The syntax is identical to query filter syntax. */ public readonly Optional|QueryInterface|array $restrictSearchWithMatch; /** - * @param non-empty-string $from Target collection for the $graphLookup operation to search, recursively matching the connectFromField to the connectToField. The from collection must be in the same database as any other collections used in the operation. + * @param string $from Target collection for the $graphLookup operation to search, recursively matching the connectFromField to the connectToField. The from collection must be in the same database as any other collections used in the operation. * Starting in MongoDB 5.1, the collection specified in the from parameter can be sharded. - * @param BSONArray|ExpressionInterface|PackedArray|Type|array|bool|float|int|non-empty-string|null|stdClass $startWith Expression that specifies the value of the connectFromField with which to start the recursive search. Optionally, startWith may be array of values, each of which is individually followed through the traversal process. - * @param non-empty-string $connectFromField Field name whose value $graphLookup uses to recursively match against the connectToField of other documents in the collection. If the value is an array, each element is individually followed through the traversal process. - * @param non-empty-string $connectToField Field name in other documents against which to match the value of the field specified by the connectFromField parameter. - * @param non-empty-string $as Name of the array field added to each output document. Contains the documents traversed in the $graphLookup stage to reach the document. + * @param BSONArray|ExpressionInterface|PackedArray|Type|array|bool|float|int|null|stdClass|string $startWith Expression that specifies the value of the connectFromField with which to start the recursive search. Optionally, startWith may be array of values, each of which is individually followed through the traversal process. + * @param string $connectFromField Field name whose value $graphLookup uses to recursively match against the connectToField of other documents in the collection. If the value is an array, each element is individually followed through the traversal process. + * @param string $connectToField Field name in other documents against which to match the value of the field specified by the connectFromField parameter. + * @param string $as Name of the array field added to each output document. Contains the documents traversed in the $graphLookup stage to reach the document. * @param Optional|int $maxDepth Non-negative integral number specifying the maximum recursion depth. - * @param Optional|non-empty-string $depthField Name of the field to add to each traversed document in the search path. The value of this field is the recursion depth for the document, represented as a NumberLong. Recursion depth value starts at zero, so the first lookup corresponds to zero depth. + * @param Optional|string $depthField Name of the field to add to each traversed document in the search path. The value of this field is the recursion depth for the document, represented as a NumberLong. Recursion depth value starts at zero, so the first lookup corresponds to zero depth. * @param Optional|QueryInterface|array $restrictSearchWithMatch A document specifying additional conditions for the recursive search. The syntax is identical to query filter syntax. */ public function __construct( diff --git a/src/Builder/Stage/GroupStage.php b/src/Builder/Stage/GroupStage.php index fc78448..bc14662 100644 --- a/src/Builder/Stage/GroupStage.php +++ b/src/Builder/Stage/GroupStage.php @@ -30,14 +30,14 @@ class GroupStage implements StageInterface, OperatorInterface { public const ENCODE = Encode::Group; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $_id The _id expression specifies the group key. If you specify an _id value of null, or any other constant value, the $group stage returns a single document that aggregates values across all of the input documents. */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $_id The _id expression specifies the group key. If you specify an _id value of null, or any other constant value, the $group stage returns a single document that aggregates values across all of the input documents. */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $_id; /** @var stdClass $field Computed using the accumulator operators. */ public readonly stdClass $field; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $_id The _id expression specifies the group key. If you specify an _id value of null, or any other constant value, the $group stage returns a single document that aggregates values across all of the input documents. + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $_id The _id expression specifies the group key. If you specify an _id value of null, or any other constant value, the $group stage returns a single document that aggregates values across all of the input documents. * @param AccumulatorInterface|Document|Serializable|array|stdClass ...$field Computed using the accumulator operators. */ public function __construct( diff --git a/src/Builder/Stage/ListSampledQueriesStage.php b/src/Builder/Stage/ListSampledQueriesStage.php index 945a21e..8669c0f 100644 --- a/src/Builder/Stage/ListSampledQueriesStage.php +++ b/src/Builder/Stage/ListSampledQueriesStage.php @@ -22,11 +22,11 @@ class ListSampledQueriesStage implements StageInterface, OperatorInterface { public const ENCODE = Encode::Object; - /** @var Optional|non-empty-string $namespace */ + /** @var Optional|string $namespace */ public readonly Optional|string $namespace; /** - * @param Optional|non-empty-string $namespace + * @param Optional|string $namespace */ public function __construct(Optional|string $namespace = Optional::Undefined) { diff --git a/src/Builder/Stage/ListSearchIndexesStage.php b/src/Builder/Stage/ListSearchIndexesStage.php index 053a37a..a2850ea 100644 --- a/src/Builder/Stage/ListSearchIndexesStage.php +++ b/src/Builder/Stage/ListSearchIndexesStage.php @@ -22,15 +22,15 @@ class ListSearchIndexesStage implements StageInterface, OperatorInterface { public const ENCODE = Encode::Object; - /** @var Optional|non-empty-string $id The id of the index to return information about. */ + /** @var Optional|string $id The id of the index to return information about. */ public readonly Optional|string $id; - /** @var Optional|non-empty-string $name The name of the index to return information about. */ + /** @var Optional|string $name The name of the index to return information about. */ public readonly Optional|string $name; /** - * @param Optional|non-empty-string $id The id of the index to return information about. - * @param Optional|non-empty-string $name The name of the index to return information about. + * @param Optional|string $id The id of the index to return information about. + * @param Optional|string $name The name of the index to return information about. */ public function __construct( Optional|string $id = Optional::Undefined, diff --git a/src/Builder/Stage/LookupStage.php b/src/Builder/Stage/LookupStage.php index a3b8961..34f0fb6 100644 --- a/src/Builder/Stage/LookupStage.php +++ b/src/Builder/Stage/LookupStage.php @@ -32,20 +32,20 @@ class LookupStage implements StageInterface, OperatorInterface { public const ENCODE = Encode::Object; - /** @var non-empty-string $as Specifies the name of the new array field to add to the input documents. The new array field contains the matching documents from the from collection. If the specified name already exists in the input document, the existing field is overwritten. */ + /** @var string $as Specifies the name of the new array field to add to the input documents. The new array field contains the matching documents from the from collection. If the specified name already exists in the input document, the existing field is overwritten. */ public readonly string $as; /** - * @var Optional|non-empty-string $from Specifies the collection in the same database to perform the join with. + * @var Optional|string $from Specifies the collection in the same database to perform the join with. * from is optional, you can use a $documents stage in a $lookup stage instead. For an example, see Use a $documents Stage in a $lookup Stage. * Starting in MongoDB 5.1, the collection specified in the from parameter can be sharded. */ public readonly Optional|string $from; - /** @var Optional|non-empty-string $localField Specifies the field from the documents input to the $lookup stage. $lookup performs an equality match on the localField to the foreignField from the documents of the from collection. If an input document does not contain the localField, the $lookup treats the field as having a value of null for matching purposes. */ + /** @var Optional|string $localField Specifies the field from the documents input to the $lookup stage. $lookup performs an equality match on the localField to the foreignField from the documents of the from collection. If an input document does not contain the localField, the $lookup treats the field as having a value of null for matching purposes. */ public readonly Optional|string $localField; - /** @var Optional|non-empty-string $foreignField Specifies the field from the documents in the from collection. $lookup performs an equality match on the foreignField to the localField from the input documents. If a document in the from collection does not contain the foreignField, the $lookup treats the value as null for matching purposes. */ + /** @var Optional|string $foreignField Specifies the field from the documents in the from collection. $lookup performs an equality match on the foreignField to the localField from the input documents. If a document in the from collection does not contain the foreignField, the $lookup treats the value as null for matching purposes. */ public readonly Optional|string $foreignField; /** @var Optional|Document|Serializable|array|stdClass $let Specifies variables to use in the pipeline stages. Use the variable expressions to access the fields from the joined collection's documents that are input to the pipeline. */ @@ -59,12 +59,12 @@ class LookupStage implements StageInterface, OperatorInterface public readonly Optional|PackedArray|Pipeline|BSONArray|array $pipeline; /** - * @param non-empty-string $as Specifies the name of the new array field to add to the input documents. The new array field contains the matching documents from the from collection. If the specified name already exists in the input document, the existing field is overwritten. - * @param Optional|non-empty-string $from Specifies the collection in the same database to perform the join with. + * @param string $as Specifies the name of the new array field to add to the input documents. The new array field contains the matching documents from the from collection. If the specified name already exists in the input document, the existing field is overwritten. + * @param Optional|string $from Specifies the collection in the same database to perform the join with. * from is optional, you can use a $documents stage in a $lookup stage instead. For an example, see Use a $documents Stage in a $lookup Stage. * Starting in MongoDB 5.1, the collection specified in the from parameter can be sharded. - * @param Optional|non-empty-string $localField Specifies the field from the documents input to the $lookup stage. $lookup performs an equality match on the localField to the foreignField from the documents of the from collection. If an input document does not contain the localField, the $lookup treats the field as having a value of null for matching purposes. - * @param Optional|non-empty-string $foreignField Specifies the field from the documents in the from collection. $lookup performs an equality match on the foreignField to the localField from the input documents. If a document in the from collection does not contain the foreignField, the $lookup treats the value as null for matching purposes. + * @param Optional|string $localField Specifies the field from the documents input to the $lookup stage. $lookup performs an equality match on the localField to the foreignField from the documents of the from collection. If an input document does not contain the localField, the $lookup treats the field as having a value of null for matching purposes. + * @param Optional|string $foreignField Specifies the field from the documents in the from collection. $lookup performs an equality match on the foreignField to the localField from the input documents. If a document in the from collection does not contain the foreignField, the $lookup treats the value as null for matching purposes. * @param Optional|Document|Serializable|array|stdClass $let Specifies variables to use in the pipeline stages. Use the variable expressions to access the fields from the joined collection's documents that are input to the pipeline. * @param Optional|BSONArray|PackedArray|Pipeline|array $pipeline Specifies the pipeline to run on the joined collection. The pipeline determines the resulting documents from the joined collection. To return all documents, specify an empty pipeline []. * The pipeline cannot include the $out stage or the $merge stage. Starting in v6.0, the pipeline can contain the Atlas Search $search stage as the first stage inside the pipeline. diff --git a/src/Builder/Stage/MergeStage.php b/src/Builder/Stage/MergeStage.php index 0b2aff1..6af1e28 100644 --- a/src/Builder/Stage/MergeStage.php +++ b/src/Builder/Stage/MergeStage.php @@ -32,27 +32,27 @@ class MergeStage implements StageInterface, OperatorInterface { public const ENCODE = Encode::Object; - /** @var non-empty-string $into The output collection. */ + /** @var string $into The output collection. */ public readonly string $into; - /** @var Optional|BSONArray|PackedArray|array|non-empty-string $on Field or fields that act as a unique identifier for a document. The identifier determines if a results document matches an existing document in the output collection. */ + /** @var Optional|BSONArray|PackedArray|array|string $on Field or fields that act as a unique identifier for a document. The identifier determines if a results document matches an existing document in the output collection. */ public readonly Optional|PackedArray|BSONArray|array|string $on; /** @var Optional|Document|Serializable|array|stdClass $let Specifies variables for use in the whenMatched pipeline. */ public readonly Optional|Document|Serializable|stdClass|array $let; - /** @var Optional|non-empty-string $whenMatched The behavior of $merge if a result document and an existing document in the collection have the same value for the specified on field(s). */ + /** @var Optional|string $whenMatched The behavior of $merge if a result document and an existing document in the collection have the same value for the specified on field(s). */ public readonly Optional|string $whenMatched; - /** @var Optional|non-empty-string $whenNotMatched The behavior of $merge if a result document does not match an existing document in the out collection. */ + /** @var Optional|string $whenNotMatched The behavior of $merge if a result document does not match an existing document in the out collection. */ public readonly Optional|string $whenNotMatched; /** - * @param non-empty-string $into The output collection. - * @param Optional|BSONArray|PackedArray|array|non-empty-string $on Field or fields that act as a unique identifier for a document. The identifier determines if a results document matches an existing document in the output collection. + * @param string $into The output collection. + * @param Optional|BSONArray|PackedArray|array|string $on Field or fields that act as a unique identifier for a document. The identifier determines if a results document matches an existing document in the output collection. * @param Optional|Document|Serializable|array|stdClass $let Specifies variables for use in the whenMatched pipeline. - * @param Optional|non-empty-string $whenMatched The behavior of $merge if a result document and an existing document in the collection have the same value for the specified on field(s). - * @param Optional|non-empty-string $whenNotMatched The behavior of $merge if a result document does not match an existing document in the out collection. + * @param Optional|string $whenMatched The behavior of $merge if a result document and an existing document in the collection have the same value for the specified on field(s). + * @param Optional|string $whenNotMatched The behavior of $merge if a result document does not match an existing document in the out collection. */ public function __construct( string $into, diff --git a/src/Builder/Stage/OutStage.php b/src/Builder/Stage/OutStage.php index 8c48a12..e87a3f8 100644 --- a/src/Builder/Stage/OutStage.php +++ b/src/Builder/Stage/OutStage.php @@ -25,18 +25,18 @@ class OutStage implements StageInterface, OperatorInterface { public const ENCODE = Encode::Object; - /** @var non-empty-string $db Target collection name to write documents from $out to. */ + /** @var string $db Target collection name to write documents from $out to. */ public readonly string $db; - /** @var non-empty-string $coll Target database name to write documents from $out to. */ + /** @var string $coll Target database name to write documents from $out to. */ public readonly string $coll; /** @var Optional|Document|Serializable|array|stdClass $timeseries If set, the aggregation stage will use these options to create or replace a time-series collection in the given namespace. */ public readonly Optional|Document|Serializable|stdClass|array $timeseries; /** - * @param non-empty-string $db Target collection name to write documents from $out to. - * @param non-empty-string $coll Target database name to write documents from $out to. + * @param string $db Target collection name to write documents from $out to. + * @param string $coll Target database name to write documents from $out to. * @param Optional|Document|Serializable|array|stdClass $timeseries If set, the aggregation stage will use these options to create or replace a time-series collection in the given namespace. */ public function __construct( diff --git a/src/Builder/Stage/ProjectStage.php b/src/Builder/Stage/ProjectStage.php index 3c9e579..ab2c16f 100644 --- a/src/Builder/Stage/ProjectStage.php +++ b/src/Builder/Stage/ProjectStage.php @@ -30,11 +30,11 @@ class ProjectStage implements StageInterface, OperatorInterface { public const ENCODE = Encode::Single; - /** @var stdClass $specification */ + /** @var stdClass $specification */ public readonly stdClass $specification; /** - * @param Document|ExpressionInterface|ProjectionInterface|Serializable|Type|array|bool|float|int|non-empty-string|null|stdClass ...$specification + * @param Document|ExpressionInterface|ProjectionInterface|Serializable|Type|array|bool|float|int|null|stdClass|string ...$specification */ public function __construct( Document|Serializable|Type|ExpressionInterface|ProjectionInterface|stdClass|array|bool|float|int|null|string ...$specification, diff --git a/src/Builder/Stage/RedactStage.php b/src/Builder/Stage/RedactStage.php index 28b1bac..96dcab9 100644 --- a/src/Builder/Stage/RedactStage.php +++ b/src/Builder/Stage/RedactStage.php @@ -24,11 +24,11 @@ class RedactStage implements StageInterface, OperatorInterface { public const ENCODE = Encode::Single; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public function __construct(Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression) { diff --git a/src/Builder/Stage/SetStage.php b/src/Builder/Stage/SetStage.php index 2ec1dd1..3814914 100644 --- a/src/Builder/Stage/SetStage.php +++ b/src/Builder/Stage/SetStage.php @@ -28,11 +28,11 @@ class SetStage implements StageInterface, OperatorInterface { public const ENCODE = Encode::Single; - /** @var stdClass $field */ + /** @var stdClass $field */ public readonly stdClass $field; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass ...$field + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string ...$field */ public function __construct(Type|ExpressionInterface|stdClass|array|bool|float|int|null|string ...$field) { diff --git a/src/Builder/Stage/SetWindowFieldsStage.php b/src/Builder/Stage/SetWindowFieldsStage.php index 4537e45..cb1354e 100644 --- a/src/Builder/Stage/SetWindowFieldsStage.php +++ b/src/Builder/Stage/SetWindowFieldsStage.php @@ -37,14 +37,14 @@ class SetWindowFieldsStage implements StageInterface, OperatorInterface */ public readonly Document|Serializable|stdClass|array $output; - /** @var Optional|ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $partitionBy Specifies an expression to group the documents. In the $setWindowFields stage, the group of documents is known as a partition. Default is one partition for the entire collection. */ + /** @var Optional|ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $partitionBy Specifies an expression to group the documents. In the $setWindowFields stage, the group of documents is known as a partition. Default is one partition for the entire collection. */ public readonly Optional|Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $partitionBy; /** * @param Document|Serializable|array|stdClass $sortBy Specifies the field(s) to sort the documents by in the partition. Uses the same syntax as the $sort stage. Default is no sorting. * @param Document|Serializable|array|stdClass $output Specifies the field(s) to append to the documents in the output returned by the $setWindowFields stage. Each field is set to the result returned by the window operator. * A field can contain dots to specify embedded document fields and array fields. The semantics for the embedded document dotted notation in the $setWindowFields stage are the same as the $addFields and $set stages. - * @param Optional|ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $partitionBy Specifies an expression to group the documents. In the $setWindowFields stage, the group of documents is known as a partition. Default is one partition for the entire collection. + * @param Optional|ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $partitionBy Specifies an expression to group the documents. In the $setWindowFields stage, the group of documents is known as a partition. Default is one partition for the entire collection. */ public function __construct( Document|Serializable|stdClass|array $sortBy, diff --git a/src/Builder/Stage/SortByCountStage.php b/src/Builder/Stage/SortByCountStage.php index 0ff9a01..8fda2cb 100644 --- a/src/Builder/Stage/SortByCountStage.php +++ b/src/Builder/Stage/SortByCountStage.php @@ -24,11 +24,11 @@ class SortByCountStage implements StageInterface, OperatorInterface { public const ENCODE = Encode::Object; - /** @var ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression */ + /** @var ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public readonly Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression; /** - * @param ExpressionInterface|Type|array|bool|float|int|non-empty-string|null|stdClass $expression + * @param ExpressionInterface|Type|array|bool|float|int|null|stdClass|string $expression */ public function __construct(Type|ExpressionInterface|stdClass|array|bool|float|int|null|string $expression) { diff --git a/src/Builder/Stage/UnionWithStage.php b/src/Builder/Stage/UnionWithStage.php index f5fc7a1..0882f74 100644 --- a/src/Builder/Stage/UnionWithStage.php +++ b/src/Builder/Stage/UnionWithStage.php @@ -30,7 +30,7 @@ class UnionWithStage implements StageInterface, OperatorInterface { public const ENCODE = Encode::Object; - /** @var non-empty-string $coll The collection or view whose pipeline results you wish to include in the result set. */ + /** @var string $coll The collection or view whose pipeline results you wish to include in the result set. */ public readonly string $coll; /** @@ -40,7 +40,7 @@ class UnionWithStage implements StageInterface, OperatorInterface public readonly Optional|PackedArray|Pipeline|BSONArray|array $pipeline; /** - * @param non-empty-string $coll The collection or view whose pipeline results you wish to include in the result set. + * @param string $coll The collection or view whose pipeline results you wish to include in the result set. * @param Optional|BSONArray|PackedArray|Pipeline|array $pipeline An aggregation pipeline to apply to the specified coll. * The pipeline cannot include the $out and $merge stages. Starting in v6.0, the pipeline can contain the Atlas Search $search stage as the first stage inside the pipeline. */ diff --git a/src/Builder/Stage/UnsetStage.php b/src/Builder/Stage/UnsetStage.php index 83f33e3..7cf9f7b 100644 --- a/src/Builder/Stage/UnsetStage.php +++ b/src/Builder/Stage/UnsetStage.php @@ -26,11 +26,11 @@ class UnsetStage implements StageInterface, OperatorInterface { public const ENCODE = Encode::Single; - /** @var list $field */ + /** @var list $field */ public readonly array $field; /** - * @param FieldPath|non-empty-string ...$field + * @param FieldPath|string ...$field * @no-named-arguments */ public function __construct(FieldPath|string ...$field) diff --git a/src/Builder/Stage/UnwindStage.php b/src/Builder/Stage/UnwindStage.php index bb7dded..09c9f1e 100644 --- a/src/Builder/Stage/UnwindStage.php +++ b/src/Builder/Stage/UnwindStage.php @@ -23,10 +23,10 @@ class UnwindStage implements StageInterface, OperatorInterface { public const ENCODE = Encode::Object; - /** @var ArrayFieldPath|non-empty-string $path Field path to an array field. */ + /** @var ArrayFieldPath|string $path Field path to an array field. */ public readonly ArrayFieldPath|string $path; - /** @var Optional|non-empty-string $includeArrayIndex The name of a new field to hold the array index of the element. The name cannot start with a dollar sign $. */ + /** @var Optional|string $includeArrayIndex The name of a new field to hold the array index of the element. The name cannot start with a dollar sign $. */ public readonly Optional|string $includeArrayIndex; /** @@ -37,8 +37,8 @@ class UnwindStage implements StageInterface, OperatorInterface public readonly Optional|bool $preserveNullAndEmptyArrays; /** - * @param ArrayFieldPath|non-empty-string $path Field path to an array field. - * @param Optional|non-empty-string $includeArrayIndex The name of a new field to hold the array index of the element. The name cannot start with a dollar sign $. + * @param ArrayFieldPath|string $path Field path to an array field. + * @param Optional|string $includeArrayIndex The name of a new field to hold the array index of the element. The name cannot start with a dollar sign $. * @param Optional|bool $preserveNullAndEmptyArrays If true, if the path is null, missing, or an empty array, $unwind outputs the document. * If false, if path is null, missing, or an empty array, $unwind does not output a document. * The default value is false.