SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Extractor
  1. ContentStreamCleaner
  2. Exception
  3. Extractor
  4. Filter
  5. Result
  6. Sorter
  7. Storage
  8. Strategy
  9. TextItem

setasign\SetaPDF2\Extractor

ContentStreamCleaner Helper class to clean up content streams.

File: /SetaPDF v2/Extractor/ContentStreamCleaner.php
Old class name (alias): \SetaPDF_Extractor_ContentStreamCleaner

Class hierarchy

ContentStreamCleaner

Summary

Static Methods

_strposa()
clean()
splitStream()

Constants

REGEX_COLORS
REGEX_PATHOPERATORS
TYPE_ALL
TYPE_INLINE_IMAGE
TYPE_NONE
TYPE_OPERATOR
TYPE_STRING

Constants

REGEX_COLORS

public const string ContentStreamCleaner::REGEX_COLORS = '/(?<=[}\\]\\x00\\x09\\x0A\\x0C\\x0D\\x20]|^)([\\d\\.\\-]+[\\x00\\x09\\x0A\\x0C\\x0D\\x20]+){1,4}(k|K|SC|sc|SCN|scn|rg|RG|g|G)(?=[\\x00\\x09\\x0A\\x0C\\x0D\\x20{\\[\\/]|$)/S'

Constant defining a regex for color operators.

REGEX_PATHOPERATORS

public const string ContentStreamCleaner::REGEX_PATHOPERATORS = '/(?<=[}\\]\\x00\\x09\\x0A\\x0C\\x0D\\x20]|^)([\\d\\.\\-]+[\\x00\\x09\\x0A\\x0C\\x0D\\x20]+){0,6}(m|l|c|v|y|re|h|S|s|f|F|f\\*|B|B\\*|b|b\\*|n|W|W\\*)(?=[\\x00\\x09\\x0A\\x0C\\x0D\\x20{\\[\\/]|$)/S'

Constant defining a regex for path operators.

TYPE_ALL

public const int ContentStreamCleaner::TYPE_ALL = 7

Constant defining all content types.

TYPE_INLINE_IMAGE

public const int ContentStreamCleaner::TYPE_INLINE_IMAGE = 4

Constant defining a content type.

TYPE_NONE

public const int ContentStreamCleaner::TYPE_NONE = 0

Constant defining a content type.

TYPE_OPERATOR

public const int ContentStreamCleaner::TYPE_OPERATOR = 2

Constant defining a content type.

TYPE_STRING

public const int ContentStreamCleaner::TYPE_STRING = 1

Constant defining a content type.

Static Methods

_strposa()

private static ContentStreamCleaner::_strposa (

string $haystack,
array $needles,
int $offset = 0

): bool|int

Searches for the closest needle in the string.

If there is no needle in the string, it will return false.

Parameters

$haystack : string
$needles : array
$offset : int

clean()

public static ContentStreamCleaner::clean (

string|array $data,
array $regexes,
int $target = ContentStreamCleaner ::TYPE_OPERATOR

): string

Cleans a content stream string by using regexes on the chosen targets.

The regexes will NOT affect literal string objects.

Parameters

$data : string|array
$regexes : array
$target : int

splitStream()

public static ContentStreamCleaner::splitStream (

string $string,
int $ignore = ContentStreamCleaner ::TYPE_INLINE_IMAGE

): array

Splits a content stream string into literal strings, inline images and operators (all left).

The pieces offer information about their type.

Parameters

$string : string
$ignore : int