Class Special in namespace setasign\SetaPDF2\Core\DataStructure\Color in 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

Special Special Color

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

Special colors are used in Pattern, Separation, DeviceN and ICCBased colour spaces.

Class hierarchy

AbstractColor
- Special

Implements

\setasign\SetaPDF2\Core\DataStructure\DataStructureInterface

Summary

Properties

$_components

protected \SetaPDF_Core_Type_Array AbstractColor::$_components

The array of color components

Static Methods

createByComponents()

public static AbstractColor::createByComponents (

int|float|string|array|\SetaPDF_Core_Type_Array $components

): \SetaPDF_Core_DataStructure_Color

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

Parameters

$components : int|float|string|array|\SetaPDF_Core_Type_Array

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 Special::writePdfString (

\SetaPDF_Core_WriteInterface $writer,
array|float $components,
bool $stroking = true

): void

Writes a color definition directly to a writer.

Parameters

$writer : \SetaPDF_Core_WriteInterface
$components : array|float
$stroking : bool: Stroking flag

Exceptions

Throws \InvalidArgumentException

writePdfStringByComponents()

public static AbstractColor::writePdfStringByComponents (

\SetaPDF_Core_WriteInterface $writer,
array|int|float|string $components,
bool $stroking = true

): void

Writes a color definition directly to a writer.

Parameters

$writer : \SetaPDF_Core_WriteInterface
$components : array|int|float|string
$stroking : bool

Exceptions

Throws \InvalidArgumentException

Methods

__construct()

public Special::__construct (

float|array|\SetaPDF_Core_Type_Array $components

)

The constructor.

Parameters

$components : float|array|\SetaPDF_Core_Type_Array

Exceptions

Throws \InvalidArgumentException

__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 Special::draw (

\SetaPDF_Core_WriteInterface $writer,
bool $stroking = true

): void

Draw the color on a writer.

Parameters

$writer : \SetaPDF_Core_WriteInterface
$stroking : bool

See

Special::writePdfString()

getValue()

public AbstractColor::getValue (

void

): \SetaPDF_Core_Type_Array

Get the components of the color.

toPhp()

public AbstractColor::toPhp (

void

): array

Get the data as a PHP value.