SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Core
  1. DataStructure
    1. Color
      1. AbstractColor
      2. Cmyk
      3. Gray
      4. Rgb
      5. Special

setasign\SetaPDF2\Core\DataStructure\Color

AbstractColor Abstract class for color structures

File: /SetaPDF v2/Core/DataStructure/Color/AbstractColor.php
Old class name (alias): \SetaPDF_Core_DataStructure_Color

Class hierarchy

AbstractColor

Summary

Static Methods

createByComponents()
hexToRgb()
writePdfString()
writePdfStringByComponents()

Methods

__construct()
__clone()
adjustAllComponents()
draw()
getValue()
toPhp()

Properties

$_components

Properties

$_components

protected \setasign\SetaPDF2\Core\Type\PdfArray AbstractColor::$_components

The array of color components

Static Methods

createByComponents()

public static AbstractColor::createByComponents (

string|float|array{0: float, 1?: float, 2?: float, 3?: float}|\setasign\SetaPDF2\Core\Type\PdfArray $components

): AbstractColor

Create an instance by a PDF array object, PHP array or a hexadecimal string of an RGB value.

Parameters

$components: string|float|array{0: float, 1?: float, 2?: float, 3?: float}|\setasign\SetaPDF2\Core\Type\PdfArray

Exceptions

Throws \InvalidArgumentException

hexToRgb()

WARNING: This method is marked as deprecated!

Use Rgb ::hexToRgb() instead.

public static AbstractColor::hexToRgb (

string $hex

): array

Converts a hex encoded string (3 or 6 characters) into a component array of red, green and blue values.

Parameters

$hex: string

writePdfString()

public static AbstractColor::writePdfString (

\setasign\SetaPDF2\Core\Writer\WriteInterface $writer,
float[] $components,
?bool $stroking = true

): void

Writes the colors components to a writer.

Parameters

$writer: \setasign\SetaPDF2\Core\Writer\WriteInterface
$components: float[]
$stroking: ?bool

writePdfStringByComponents()

public static AbstractColor::writePdfStringByComponents (

\setasign\SetaPDF2\Core\Writer\WriteInterface $writer,
int|float|string|array{0: float, 1?: float, 2?: float, 3?: float} $components,
bool $stroking = true

): void

Writes a color definition directly to a writer.

Parameters

$writer: \setasign\SetaPDF2\Core\Writer\WriteInterface
$components: int|float|string|array{0: float, 1?: float, 2?: float, 3?: float}
$stroking: bool

Exceptions

Throws \InvalidArgumentException

Methods

__construct()

public AbstractColor::__construct (

\setasign\SetaPDF2\Core\Type\PdfArray|float|float[] $components

)

The constructor.

Parameters

$components: \setasign\SetaPDF2\Core\Type\PdfArray|float|float[]

__clone()

public AbstractColor::__clone (

void

): void

Implementation of __clone().

adjustAllComponents()

public AbstractColor::adjustAllComponents (

int|float $by

): void

Adjust all color components by a specific value.

Parameters

$by: int|float

draw()

public AbstractColor::draw (

\setasign\SetaPDF2\Core\Writer\WriteInterface $writer,
bool $stroking = true

): void

Write the color as a PDF string to a writer.

Parameters

$writer: \setasign\SetaPDF2\Core\Writer\WriteInterface
$stroking: bool

getValue()

public AbstractColor::getValue (

void

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

Get the components of the color.

toPhp()

public AbstractColor::toPhp (

void

): float[]

Get the data as a PHP value.