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
Summary
Properties
Static Methods
createByComponents()
public static AbstractColor::createByComponents (
int|float|string|array|\setasign\SetaPDF2\Core\Type\PdfArray $components
): AbstractColorCreate an instance by a PDF array object, PHP array or a hexadecimal string of an RGB value.
Parameters
- $components : int|float|string|array|\setasign\SetaPDF2\Core\Type\PdfArray
Exceptions
Throws \InvalidArgumentException
hexToRgb()
WARNING: This method is marked as deprecated!
Use Rgb::hexToRgb() instead.
Converts a hex encoded string (3 or 6 characters) into a component array of red, green and blue values.
Parameters
- $hex : string
writePdfString()
Writes the colors components to a writer.
Parameters
- $writer : \setasign\SetaPDF2\Core\Writer\WriteInterface
- $components : array
- $stroking : ?bool
writePdfStringByComponents()
public static AbstractColor::writePdfStringByComponents (
\setasign\SetaPDF2\Core\Writer\WriteInterface $writer,
array|int|float|string $components,
bool $stroking = true
): voidarray|int|float|string $components,
bool $stroking = true
Writes a color definition directly to a writer.
Parameters
- $writer : \setasign\SetaPDF2\Core\Writer\WriteInterface
- $components : array|int|float|string
- $stroking : bool
Exceptions
Throws \InvalidArgumentException
Methods
__construct()
draw()
Write the color as a PDF string to a writer.
Parameters
- $writer : \setasign\SetaPDF2\Core\Writer\WriteInterface
- $stroking : bool