php-vips

Target extends Connection
in package

This class holds a pointer to a VipsObject (the libvips base class) and manages properties.

Table of Contents

Properties

$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
filename()  : string|null
Get the filename associated with a connection. Return null if there is no associated file.
get()  : mixed
getArgumentDescription()  : string
getBlurb()  : string
getDescription()  : string
getPspec()  : CData|null
getType()  : int
newToDescriptor()  : self
Make a new target to write to a file descriptor. For example:
newToFile()  : self
Make a new target to write to a filename. For example:
newToMemory()  : self
Make a new target to write to a memory buffer. For example:
nick()  : string|null
Make a human-readable name for a connection suitable for error messages.
printAll()  : void
ref()  : void
set()  : void
setString()  : bool
signalConnect()  : void
Connect to a signal on this object.
unref()  : void
unrefOutputs()  : void
getMarshaler()  : Closure|null

Properties

$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

__construct()

public __construct(CData $pointer) : mixed
Parameters
$pointer : CData

__destruct()

public __destruct() : mixed

filename()

Get the filename associated with a connection. Return null if there is no associated file.

public filename() : string|null
Return values
string|null

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

newToDescriptor()

Make a new target to write to a file descriptor. For example:

public static newToDescriptor(int $descriptor) : self 
$target = Target::newToDescriptor(1);

Makes a descriptor attached to stdout. You can pass this target to (for example) @see Image::writeToTarget()

Parameters
$descriptor : int
Tags
throws
Exception
Return values
self

newToFile()

Make a new target to write to a filename. For example:

public static newToFile(string $filename) : self 
$target = Target::newToFile("myfile.jpg");

You can pass this target to (for example) @see Image::writeToTarget()

Parameters
$filename : string
Tags
throws
Exception
Return values
self

newToMemory()

Make a new target to write to a memory buffer. For example:

public static newToMemory() : self 
$target = Target::newToMemory();

You can pass this target to (for example) @see Image::writeToTarget()

Tags
throws
Exception
Return values
self

nick()

Make a human-readable name for a connection suitable for error messages.

public nick() : string|null
Return values
string|null

set()

public set(string $name, mixed $value) : void
Parameters
$name : string
$value : mixed
Tags
throws
Exception

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
throws
Exception

getMarshaler()

private static getMarshaler(string $name, callable $callback) : Closure|null
Parameters
$name : string
$callback : callable
Return values
Closure|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results