DocumentShape::field() should only allow arrays #21

New issue

Closed

opened 2026-08-21 06:58:23 +02:00 by c.fahner · 0 comments

c.fahner commented

2026-08-21 06:58:23 +02:00

Owner

The DocumentShape::field() method currently allows three different input types, but the use case of allowing three variants is unclear.

A string as a shorthand for new FieldPath([ string-here ])
- This saves 4 characters of typing but introduces an unnecessary if-check for all other cases
An array that is passed directly to the constructor
- This avoids having to explicitly import the FieldPath class and typing Q::field() looks more consistent with the builder utility
- This is the primary use case of this method
A FieldPath instance
- Why not use it directly, static analysis can already prove if your variable is a FieldPath already

All cases but the array case should be removed from the method. It essentially is a shorthand for:

use Slendium\Ocd\Common\FieldPath;
// ...
$query = Q::shape([
    'field' => new FieldPath([ 'otherField' ]) // it is more consistent to have a Q::field([ 'otherField' ]) here
]);

The `DocumentShape::field()` method currently allows three different input types, but the use case of allowing three variants is unclear. * A string as a shorthand for `new FieldPath([ string-here ])` * This saves 4 characters of typing but introduces an unnecessary if-check for all other cases * An array that is passed directly to the constructor * This avoids having to explicitly import the `FieldPath` class and typing `Q::field()` looks more consistent with the builder utility * This is the primary use case of this method * A `FieldPath` instance * Why not use it directly, static analysis can already prove if your variable is a `FieldPath` already All cases but the array case should be removed from the method. It essentially is a shorthand for: ```php use Slendium\Ocd\Common\FieldPath; // ... $query = Q::shape([ 'field' => new FieldPath([ 'otherField' ]) // it is more consistent to have a Q::field([ 'otherField' ]) here ]); ```

c.fahner added this to the v0.1 milestone

2026-08-21 06:58:23 +02:00

c.fahner added the

Compat/Breaking

label

2026-08-21 06:58:23 +02:00

c.fahner started working

2026-08-22 09:52:15 +02:00

c.fahner referenced this issue from a pull request that will close it,

2026-08-22 09:55:57 +02:00

DocumentShape::field() should only allow arrays #23

c.fahner stopped working