VipsOperation
extends VipsObject
in package
This class holds a pointer to a VipsOperation (the libvips operation base class) and manages argument introspection and operation call.
Tags
Table of Contents
Properties
- $introspect : Introspect
- Introspection data for this operation.
- $check_max_stack_size : bool
- libvips executes FFI callbacks off the main thread and this confuses the stack limit checks available since PHP 8.3.0. We need to check if `zend.max_allowed_stack_size` is set to `-1`.
Methods
- __clone() : mixed
- __construct() : mixed
- __destruct() : mixed
- call() : mixed
- Call any vips operation, with an explicit set of options. This is more convenient than callBase() if you have a set of known options.
- callBase() : mixed
- Call any vips operation. The final element of $arguments can be (but doesn't have to be) an array of options to pass to the operation.
- get() : mixed
- getArgumentDescription() : string
- getBlurb() : string
- getDescription() : string
- getPspec() : CData|null
- getType() : int
- newFromName() : VipsOperation
- printAll() : void
- ref() : void
- set() : void
- setMatch() : void
- setString() : bool
- signalConnect() : void
- Connect to a signal on this object.
- unref() : void
- unrefOutputs() : void
- findInside() : mixed
- getMarshaler() : Closure|null
- introspect() : Introspect
Properties
$introspect
Introspection data for this operation.
public
Introspect
$introspect
$check_max_stack_size
libvips executes FFI callbacks off the main thread and this confuses the stack limit checks available since PHP 8.3.0. We need to check if `zend.max_allowed_stack_size` is set to `-1`.
private
static bool
$check_max_stack_size
= true
See: https://github.com/libvips/php-vips/pull/237.
Methods
__clone()
public
__clone() : mixed
__construct()
public
__construct(CData $pointer) : mixed
Parameters
- $pointer : CData
__destruct()
public
__destruct() : mixed
call()
Call any vips operation, with an explicit set of options. This is more convenient than callBase() if you have a set of known options.
public
static call(string $name, Image|null $instance, array<string|int, mixed> $arguments[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $name : string
-
The operation name.
- $instance : Image|null
-
The instance this operation is being invoked from.
- $arguments : array<string|int, mixed>
-
An array of arguments to pass to the operation.
- $options : array<string|int, mixed> = []
-
An array of optional arguments to pass to the operation.
Tags
Return values
mixed —The result(s) of the operation.
callBase()
Call any vips operation. The final element of $arguments can be (but doesn't have to be) an array of options to pass to the operation.
public
static callBase(string $operation_name, Image|null $instance, array<string|int, mixed> $arguments) : mixed
We can't have a separate arg for the options since this will be run from __call(), which cannot know which args are required and which are optional. See call() below for a version with the options broken out.
Parameters
- $operation_name : string
-
The operation name.
- $instance : Image|null
-
The instance this operation is being invoked from.
- $arguments : array<string|int, mixed>
-
An array of arguments to pass to the operation.
Tags
Return values
mixed —The result(s) of the operation.
get()
public
get(string $name) : mixed
Parameters
- $name : string
Tags
getArgumentDescription()
public
getArgumentDescription(string $name) : string
Parameters
- $name : string
Return values
stringgetBlurb()
public
getBlurb(string $name) : string
Parameters
- $name : string
Return values
stringgetDescription()
public
getDescription() : string
Return values
stringgetPspec()
public
getPspec(string $name) : CData|null
Parameters
- $name : string
Return values
CData|nullgetType()
public
getType(string $name) : int
Parameters
- $name : string
Return values
intnewFromName()
public
static newFromName(mixed $name) : VipsOperation
Parameters
- $name : mixed
Tags
Return values
VipsOperationprintAll()
public
static printAll() : void
ref()
public
ref() : void
set()
public
set(string $name, mixed $value) : void
Parameters
- $name : string
- $value : mixed
Tags
setMatch()
public
setMatch(mixed $name, mixed $match_image, mixed $value) : void
Parameters
- $name : mixed
- $match_image : mixed
- $value : mixed
setString()
public
setString(string $string_options) : bool
Parameters
- $string_options : string
Return values
boolsignalConnect()
Connect to a signal on this object.
public
signalConnect(string $name, callable $callback) : void
The callback will be triggered every time this signal is issued on this instance.
Parameters
- $name : string
- $callback : callable
Tags
unref()
public
unref() : void
unrefOutputs()
public
unrefOutputs() : void
findInside()
private
static findInside(mixed $predicate, mixed $x) : mixed
Parameters
- $predicate : mixed
- $x : mixed
getMarshaler()
private
static getMarshaler(string $name, callable $callback) : Closure|null
Parameters
- $name : string
- $callback : callable
Return values
Closure|nullintrospect()
private
static introspect(mixed $name) : Introspect
Parameters
- $name : mixed