Index

  1. \SetaPDF
    1. Core
    2. Core
      1. DataStructure
        1. Color
        2. Color
          1. Cmyk
          2. Gray
          3. Rgb
          4. Special

SetaPDF_Core_DataStructure_Color Abstract class for color structures

File: /SetaPDF v2/Core/DataStructure/Color.php

Class hierarchy

Summary

Static Methods

Methods

Properties

Properties

$_components

protected SetaPDF_Core_Type_Array SetaPDF_Core_DataStructure_Color::$_components

The array of color components


Static Methods

createByComponents()

public static SetaPDF_Core_DataStructure_Color::createByComponents (
$components
):

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

Parameters
$components
 
Exceptions

Throws InvalidArgumentException

hexToRgb()

public static SetaPDF_Core_DataStructure_Color::hexToRgb (
$hex
):

Converts a hex encoded string into a component array of red, green and blue values.

Parameters
$hex
 

writePdfString()

public static SetaPDF_Core_DataStructure_Color::writePdfString (
SetaPDF_Core_WriteInterface $writer, $components [, $stroking = true ]
): void

Writes the colors components to a writer.

Parameters
$writer : SetaPDF_Core_WriteInterface
 
$components
 
$stroking
 

writePdfStringByComponents()

public static SetaPDF_Core_DataStructure_Color::writePdfStringByComponents (
SetaPDF_Core_WriteInterface $writer, $components [, $stroking = true ]
): void

Writes a color definition directly to a writer.

Parameters
$writer : SetaPDF_Core_WriteInterface
 
$components
 
$stroking
 
Exceptions

Throws InvalidArgumentException


Methods

__construct()

public SetaPDF_Core_DataStructure_Color::__construct (
$components
)

The constructor.

Parameters
$components
 

__clone()

public SetaPDF_Core_DataStructure_Color::__clone (
void
): void

Implementation of __clone().

adjustAllComponents()

public SetaPDF_Core_DataStructure_Color::adjustAllComponents (
$by
): void

Adjust all color components by a specific value.

Parameters
$by
 

draw()

public SetaPDF_Core_DataStructure_Color::draw (
SetaPDF_Core_WriteInterface $writer [, $stroking = true ]
): void

Write the color as a PDF string to a writer.

Parameters
$writer : SetaPDF_Core_WriteInterface
 
$stroking
 

getValue()

public SetaPDF_Core_DataStructure_Color::getValue (
void
):

Get the components of the color.

toPhp()

public SetaPDF_Core_DataStructure_Color::toPhp (
void
):

Get the data as a PHP value.


© 2022 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)