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
- $introspect : Introspect
- Introspection data for this operation.
- __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
Methods
__clone()
public
__clone() : mixed
Return values
mixed —__construct()
public
__construct(CData $pointer) : mixed
Parameters
- $pointer : CData
Return values
mixed —__destruct()
public
__destruct() : mixed
Return values
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
Return values
mixed —getArgumentDescription()
public
getArgumentDescription(string $name) : string
Parameters
- $name : string
Return values
string —getBlurb()
public
getBlurb(string $name) : string
Parameters
- $name : string
Return values
string —getDescription()
public
getDescription() : string
Return values
string —getPspec()
public
getPspec(string $name) : CData|null
Parameters
- $name : string
Return values
CData|null —getType()
public
getType(string $name) : int
Parameters
- $name : string
Return values
int —newFromName()
public
static newFromName(mixed $name) : VipsOperation
Parameters
- $name : mixed
Tags
Return values
VipsOperation —printAll()
public
static printAll() : void
Return values
void —ref()
public
ref() : void
Return values
void —set()
public
set(string $name, mixed $value) : void
Parameters
- $name : string
- $value : mixed
Tags
Return values
void —setMatch()
public
setMatch(mixed $name, mixed $match_image, mixed $value) : void
Parameters
- $name : mixed
- $match_image : mixed
- $value : mixed
Return values
void —setString()
public
setString(string $string_options) : bool
Parameters
- $string_options : string
Return values
bool —signalConnect()
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
Return values
void —unref()
public
unref() : void
Return values
void —unrefOutputs()
public
unrefOutputs() : void
Return values
void —findInside()
private
static findInside(mixed $predicate, mixed $x) : mixed
Parameters
- $predicate : mixed
- $x : mixed
Return values
mixed —getMarshaler()
private
static getMarshaler(string $name, callable $callback) : Closure|null
Parameters
- $name : string
- $callback : callable
Return values
Closure|null —introspect()
private
static introspect(mixed $name) : Introspect
Parameters
- $name : mixed