Abstract Class XObject in namespace setasign\SetaPDF2\Core\XObject in SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Core
  1. XObject
    1. Form
    2. Image
    3. XObject

setasign\SetaPDF2\Core\XObject

XObject Abstract class representing an external object

File: /SetaPDF v2/Core/XObject/XObject.php
Old class name (alias): \SetaPDF_Core_XObject

Class hierarchy

XObject
- Form
- Image

Implements

\setasign\SetaPDF2\Core\Resource\ResourceInterface

Summary

Constants

TYPE_COLOR_SPACE

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_COLOR_SPACE = 'ColorSpace'

Type constant

TYPE_EXT_G_STATE

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_EXT_G_STATE = 'ExtGState'

Type constant

TYPE_FONT

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_FONT = 'Font'

Type constant

TYPE_PATTERN

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_PATTERN = 'Pattern'

Type constant

TYPE_PROC_SET

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_PROC_SET = 'ProcSet'

Type constant

TYPE_PROPERTIES

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_PROPERTIES = 'Properties'

Type constant

TYPE_SHADING

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_SHADING = 'Shading'

Type constant

TYPE_X_OBJECT

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_X_OBJECT = 'XObject'

Type constant

Properties

$_indirectObject

protected \setasign\SetaPDF2\Core\Type\PdfIndirectObject XObject::$_indirectObject

The indirect object of the XObject

Static Methods

freeCache()

public static XObject::freeCache (

\setasign\SetaPDF2\Core\Document $document

): void

Release XObject instances by a document instance.

Parameters

$document : \setasign\SetaPDF2\Core\Document

get()

public static XObject::get (

\setasign\SetaPDF2\Core\Type\IndirectObjectInterface $xObjectReference,
string $subType = null

): Form|Image

Get an external object by an indirect object/reference.

Parameters

$xObjectReference : \setasign\SetaPDF2\Core\Type\IndirectObjectInterface
$subType : string

Exceptions

Throws \setasign\SetaPDF2\NotImplementedException

Methods

__construct()

public XObject::__construct (

\setasign\SetaPDF2\Core\Type\IndirectObjectInterface $indirectObject

)

The constructor.

Parameters

$indirectObject : \setasign\SetaPDF2\Core\Type\IndirectObjectInterface

cleanUp()

public XObject::cleanUp (

void

): void

Release memory and cycled references.

draw()

abstract public XObject::draw (

\setasign\SetaPDF2\Core\Canvas\Canvas $canvas,
int $x = 0,
int $y = 0,
?float $width = null,
?float $height = null

): mixed

Draw the external object on the canvas.

Parameters

$canvas : \setasign\SetaPDF2\Core\Canvas\Canvas
$x : int
$y : int
$width : ?float
$height : ?float

getIndirectObject()

public XObject::getIndirectObject (

?\setasign\SetaPDF2\Core\Document $document = null

): \setasign\SetaPDF2\Core\Type\PdfIndirectObject

Get the indirect object of this XObject.

Parameters

$document : ?\setasign\SetaPDF2\Core\Document

getResourceType()

public XObject::getResourceType (

void

): string

Get the resource type for external objects.

See

\setasign\SetaPDF2\Core\Resource\ResourceInterface::getResourceType()