WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

ModelConfig::validateMediaOrientationAspectRatioCompatibility()

ModelConfig::validateMediaOrientationAspectRatioCompatibility( WordPressAiClientFilesEnumsMediaOrientationEnum $orientation, string $aspectRatio )

In this article

Back to top

Validates that the given media orientation and aspect ratio values do not conflict with each other.

Parameters

$orientationWordPressAiClientFilesEnumsMediaOrientationEnumrequired
The desired media orientation.
$aspectRatiostringrequired
The desired media aspect ratio.

Source

protected function validateMediaOrientationAspectRatioCompatibility(MediaOrientationEnum $orientation, string $aspectRatio): void
{
    $aspectRatioParts = explode(':', $aspectRatio);
    if ($orientation->isSquare() && $aspectRatioParts[0] !== $aspectRatioParts[1]) {
        throw new InvalidArgumentException('The aspect ratio "' . $aspectRatio . '" is not compatible with the square orientation.');
    }
    if ($orientation->isLandscape() && $aspectRatioParts[0] <= $aspectRatioParts[1]) {
        throw new InvalidArgumentException('The aspect ratio "' . $aspectRatio . '" is not compatible with the landscape orientation.');
    }
    if ($orientation->isPortrait() && $aspectRatioParts[0] >= $aspectRatioParts[1]) {
        throw new InvalidArgumentException('The aspect ratio "' . $aspectRatio . '" is not compatible with the portrait orientation.');
    }
}

View all references View on Trac View on GitHub

Used byDescription
ModelConfig::setOutputMediaOrientation()wp-includes/php-ai-client/src/Providers/Models/DTO/ModelConfig.php

Sets the output media orientation.

ModelConfig::setOutputMediaAspectRatio()wp-includes/php-ai-client/src/Providers/Models/DTO/ModelConfig.php

Sets the output media aspect ratio.

Changelog

VersionDescription
0.4.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.