Class Rectangle in namespace setasign\SetaPDF2\Core\DataStructure in SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Core
  1. DataStructure
    1. Color
    2. DataStructureInterface
    3. Date
    4. Rectangle
    5. Tree

setasign\SetaPDF2\Core\DataStructure

Rectangle Data structure class for rect objects

File: /SetaPDF v2/Core/DataStructure/Rectangle.php
Old class name (alias): \SetaPDF_Core_DataStructure_Rectangle

Class hierarchy

Rectangle

Implements

DataStructureInterface

Summary

Properties

$_array

protected \setasign\SetaPDF2\Core\Type\PdfArray Rectangle::$_array

An array representing a rectangle [llx lly urx ury]

Static Methods

byArray()

public static Rectangle::byArray (

array $phpArray,
bool $getValue = false

): \setasign\SetaPDF2\Core\Type\PdfArray|Rectangle

Create a rect object or array from a php array.

Parameters

$phpArray: array
$getValue: bool

Exceptions

Throws \InvalidArgumentException

byRectangle()

public static Rectangle::byRectangle (

\setasign\SetaPDF2\Core\Geometry\Rectangle|Rectangle $rectangle

): Rectangle

Create an instance by another rectangle instance.

Parameters

$rectangle: \setasign\SetaPDF2\Core\Geometry\Rectangle|Rectangle

create()

public static Rectangle::create (

array|\setasign\SetaPDF2\Core\Geometry\Rectangle|Rectangle $rectangle

): Rectangle

Create a rectangle by a specific argument.

Parameters

$rectangle: array|\setasign\SetaPDF2\Core\Geometry\Rectangle|Rectangle

Exceptions

Throws \InvalidArgumentException

Methods

__construct()

public Rectangle::__construct (

?\setasign\SetaPDF2\Core\Type\PdfArray $array = null

)

The constructor.

Parameters

$array: ?\setasign\SetaPDF2\Core\Type\PdfArray

Exceptions

Throws \InvalidArgumentException

__clone()

public Rectangle::__clone (

void

): void

Implementation of clone.

__get()

public Rectangle::__get (

string $name

): float|int

Get handler.

Parameters

$name: string

Exceptions

Throws \InvalidArgumentException

__set()

public Rectangle::__set (

string $name,
float|int $value

): void

Set handler.

Parameters

$name: string
$value: float|int

Exceptions

Throws \InvalidArgumentException

Throws \setasign\SetaPDF2\Core\Type\Exception

contains()

public Rectangle::contains (

\setasign\SetaPDF2\Core\Geometry\Rectangle|Rectangle $otherRect

): bool

Checks whether this rectangle contains another rectangle.

Parameters

$otherRect: \setasign\SetaPDF2\Core\Geometry\Rectangle|Rectangle

Exceptions

Throws \InvalidArgumentException

getHeight()

public Rectangle::getHeight (

void

): int|float

Get the height of the rect.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getLlx()

public Rectangle::getLlx (

void

): int|float

Get the lower left x-coordinate.

getLly()

public Rectangle::getLly (

void

): int|float

Get the lower left y-coordinate.

getRectangle()

public Rectangle::getRectangle (

void

): \setasign\SetaPDF2\Core\Geometry\Rectangle

Return this rectangle as a \setasign\SetaPDF2\Core\Geometry\Rectangle instance.

getUrx()

public Rectangle::getUrx (

void

): int|float

Get the upper right x-coordinate.

getUry()

public Rectangle::getUry (

void

): int|float

Get the upper right y-coordinate.

getValue()

public Rectangle::getValue (

void

): \setasign\SetaPDF2\Core\Type\PdfArray

Get the PDF value object.

See

DataStructureInterface::getValue()

getWidth()

public Rectangle::getWidth (

void

): int|float

Get the width of the rect.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

intersect()

public Rectangle::intersect (

\setasign\SetaPDF2\Core\Geometry\Rectangle|Rectangle $otherRect

): bool

Checks whether this rectangle intersects another rectangle.

Parameters

$otherRect: \setasign\SetaPDF2\Core\Geometry\Rectangle|Rectangle

Exceptions

Throws \InvalidArgumentException

setAll()

public Rectangle::setAll (

float|int $llx,
float|int $lly,
float|int $urx,
float|int $ury

): void

Set all coordinates.

Parameters

$llx: float|int: Lower left x value
$lly: float|int: Lower left y value
$urx: float|int: Upper right x value
$ury: float|int: Upper right y value

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setLlx()

public Rectangle::setLlx (

int|float $llx

): void

Set the lower left x-coordinate.

Parameters

$llx: int|float

setLly()

public Rectangle::setLly (

int|float $lly

): void

Set the lower left y-coordinate.

Parameters

$lly: int|float

setUrx()

public Rectangle::setUrx (

int|float $urx

): void

Set the upper right x-coordinate.

Parameters

$urx: int|float

setUry()

public Rectangle::setUry (

int|float $ury

): void

Set the upper right y-coordinate.

Parameters

$ury: int|float

toPhp()

public Rectangle::toPhp (

void

): array

Get the data as a PHP value.