IBX-9840: Implemented service fetching content fields from expression and validating if field is within expression

[barw4]

🎫 Issue	IBX-9840

Description:

The parser will parse the following expressions:

expr         ::= (<group> '/')? <content_type> '/' <field> 
group        ::= id | '{' <id> (',' <id>)* '}'
content_type ::= id | '{' <id> (',' <id>)* '}' | '*'
field        ::= id | '{' <id> (',' <id>)* '}' 

and fetch asked field definitions, then provide an output in the form of a list that consists of field definition ids.

Example of usage:

$extractedFieldIds = $this->contentTypeFieldsExtractor->extractFieldsFromExpression('{Media,Content}/*/name');

will result in:

.array:2 [
  0 => 8
  1 => 9
]

There is also a possibility to check whether a FieldDefinition is within a given expression. The API reference is as follows:

ContentTypeFieldsByExpressionServiceInterface service:

interface ContentTypeFieldsByExpressionServiceInterface
{
    /**
     * @return list<\Ibexa\Contracts\Core\Repository\Values\ContentType\FieldDefinition>
     *
     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\NotFoundException
     */
    public function getFieldsFromExpression(string $expression): array;

    /**
     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\NotFoundException
     */
    public function isFieldIncludedInExpression(FieldDefinition $fieldDefinition, string $expression): bool;
}

For QA:

Documentation:

[sonarqubecloud]

Quality Gate passed

Issues
10 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[mikadamczyk]

Do we need to expose a method to validate an expression? Will it be possible to edit it by hand?

[mikadamczyk]

WDYT about throwing a dedicated exception, like SyntaxError/Exception? And what about catching it, should it be in service or by client code? T_SLASH or "/" like here https://github.com/ibexa/admin-ui/pull/1500/files#diff-74127d24456a18e891c75260b495952ea2359a27853f3bea40933252aa41f3ffR133?

[barw4]

I've added the Ibexa\AdminUi\Exception\FieldTypeExpressionParserException and imo it should be catched by client code to throw 4xx (when there is one)

[mikadamczyk]

Instead of fetching by indexes, is it worth creating a structure for metadata?

[barw4]

Do you mean by that that public function parseExpression(string $expression): array should give us some kind of structured object instead?

[mikadamczyk]

yes, like ExpresionMetadata or sth

[barw4]

please see a5bbca7

[sonarqubecloud]

Quality Gate passed

Issues
2 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud