wppaste
WordPress

AbstractOpenAiCompatibleImageGenerationModel::prepareSizeParam( WordPress\AiClient\Files\Enums\MediaOrientationEnum|null $orientation, string|null $aspectRatio ): string

Since
0.1.0
Source
wp-includes/php-ai-client/src/Providers/OpenAiCompatibleImplementation/AbstractOpenAiCompatibleImageGenerationModel.php:163
Prepares the size parameter for the API request.

Compatibility

WordPress
since 0.1.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in 2 of the 5 tracked releases, added in 0.1.0, and compiles on PHP 7.4 through 8.6-dev.

Parameters

$orientationWordPress\AiClient\Files\Enums\MediaOrientationEnum|null
The desired media orientation.
$aspectRatiostring|null
The desired media aspect ratio.

Return value

string
The prepared size parameter.

Performance profile

How much work a call to AbstractOpenAiCompatibleImageGenerationModel::prepareSizeParam() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
6–22

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 38.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What one call costs · 3 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost AbstractOpenAiCompatibleImageGenerationModel::prepareSizeParam() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always6–22none
$aspectRatio === null && $orientation !== null && ->isLandscape()10->isLandscape()
$aspectRatio === null && $orientation !== null && !->isLandscape()13->isLandscape(), ->isPortrait()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev386–2210
8.5386–2210
8.4386–2210
8.3386–2210
8.2386–22101 more instruction than PHP 8.1
8.1376–2110
7.4376–2110

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 1

  • \WordPress\AiClient\Common\Exception\InvalidArgumentException::__construct()

Source code

    protected function prepareSizeParam(?MediaOrientationEnum $orientation, ?string $aspectRatio): string    {        // Use aspect ratio if set, as it is more specific.        if ($aspectRatio !== null) {            switch ($aspectRatio) {                case '1:1':                    return '1024x1024';                case '3:2':                    return '1536x1024';                case '7:4':                    return '1792x1024';                case '2:3':                    return '1024x1536';                case '4:7':                    return '1024x1792';                default:                    throw new InvalidArgumentException('The aspect ratio "' . $aspectRatio . '" is not supported.');            }        }        // This should always have a value, as the method is only called if at least one or the other is set.        if ($orientation !== null) {            if ($orientation->isLandscape()) {                return '1536x1024';            }            if ($orientation->isPortrait()) {                return '1024x1536';            }        }        return '1024x1024';    }

Changelog

Introduced in 0.1.0. Unchanged from 7.0.4 through 7.1.0.

  1. 7.0.4
  2. 7.1.0

Signature, return type and hooks compared across 2 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/php-ai-client/src/Providers/OpenAiCompatibleImplementation/AbstractOpenAiCompatibleImageGenerationModel.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.