IBX-6620: Added image criterions rest input parsers

[ciastektk]

⚠️ Remove dev dependency!

Question	Answer
JIRA issue	IBX-6620
Type	feature
Target version	v4.6
BC breaks	no
Tests pass	yes/no
Doc needed	yes

This PR adds new criteria parsers that allows to search images by REST.

Examples:

FileSize criterion:

Criterion to filter by image size.

min - Optional, minimum file size in MB
max - Optional maximum file size in MB

"ImageFileSizeCriterion": {
    "fieldDefIdentifier": "<field_definition_identifier>",
    "size": {
        "min": 0 
        "max": 2
    }
}

MimeType criterion:

Criterion to filter by image mime type.

type - string or array

"ImageMimeTypeCriterion": {
    "fieldDefIdentifier": "<field_definition_identifier>",
    "type": "image/jpeg"
}

OR

"ImageMimeTypeCriterion": {
    "fieldDefIdentifier": "<field_definition_identifier>",
    "type": [
        "image/jpeg",
        "image/png"
    ]
}

Orientation criterion:

Criterion to filter by image orientation.

orientation - string or array. Allowed orientation types: portrait, landscape, square.

"ImageMimeTypeCriterion": {
    "fieldDefIdentifier": "<field_definition_identifier>",
    "orientation": "portrait"
}

OR

"ImageMimeTypeCriterion": {
    "fieldDefIdentifier": "<field_definition_identifier>",
    "orientation": [
        "portrait",
        "landscape"
    ]
}

Dimensions criterion:

Composite criterion to filter by image dimensions.

Allowed criteria width, height. All criteria are optional.

min - Optional, minimum value in pixel
max - Optional, maximum value in pixel

"ImageDimensionsCriterion": {
    "fieldDefIdentifier": "<field_definition_identifier>",
    "width": {
        "min": 100
        "max": 1000
    },
    "height": {
        "min": 500
        "max": 1500
    }
}

Image criterion:

Composite criterion to filter by image attributes.

Allowed criteria mimeTypes, size,width, height,orientation. All criteria are optional.

min - Optional, minimum value in pixel or MB
max - Optional, maximum value in pixel or MB

"ImageCriterion": {
    "fieldDefIdentifier": "<field_definition_identifier>",
    "mimeTypes": [
        "image/png",
        "image/jpeg"
    ],
    "size": {
        "min": 0,
        "max": 2
    },
    "width": {
        "min": 100,
        "max": 1000
    },
    "height": {
        "min": 500,
        "max": 1500
    },
    "orientation": [
        "portrait",
        "landscape"
    ]
}

OR

"ImageCriterion": {
    "fieldDefIdentifier": "<field_definition_identifier>",
    "mimeTypes": "image/png",
    "size": {
        "min": 0,
        "max": 2
    },
    "width": {
        "min": 100,
        "max": 1000
    },
    "height": {
        "min": 500,
        "max": 1500
    },
    "orientation": "portrait"
}

TODO:

• Implement tests.
• Fix new code according to Coding Standards ($ composer fix-cs).
• Ask for Code Review.

[Steveb-p]

There are no associated tests. Can we get integration tests for those, on specific service level at least - with validation failures especially?

[Steveb-p]

Note

Optional.

You can use @phpstan-assert to inform static analysis about the expected shape of data after validation.

See https://phpstan.org/writing-php-code/narrowing-types#custom-type-checking-functions-and-methods for details.

[ciastektk]

As we discussed with the dev team, tests coverage will be added later.

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication