TilingPattern
extends PdfStream
in package
Tiling pattern (/Type /Pattern /PatternType 1) — ISO 32000-2 §8.7.3.
A stream whose body is a PDF content stream painting one cell of the pattern. The cell is tiled across the target area using XStep/YStep.
Required entries: PaintType, TilingType, BBox, XStep, YStep, Resources.
Attributes
- #[RequiresPdfVersion]
- \Phpdftk\Pdf\Core\PdfVersion::V1_2
Table of Contents
Constants
- PATTERN_TYPE = 1
- PDF_TYPE = 'Pattern'
Properties
- $bbox : PdfArray
- $data : string
- $dictionary : PdfDictionary
- $generationNumber : int
- $matrix : PdfArray|null
- $objectNumber : int
- $paintType : int
- $resources : Resources|PdfDictionary
- $tilingType : int
- $xStep : float
- $yStep : float
Methods
- __construct() : mixed
- getPatternType() : int
- setFilter() : void
- Set a filter to encode/decode the stream data.
- toIndirectObject() : string
- Wrap the object in an indirect object structure: X Y obj ... endobj
- toPdf() : string
- Returns the stream body: dictionary, stream keyword, data, endstream.
Constants
PATTERN_TYPE
public
mixed
PATTERN_TYPE
= 1
PDF_TYPE
public
mixed
PDF_TYPE
= 'Pattern'
Properties
$bbox
public
PdfArray
$bbox
$data
public
string
$data
= ''
$dictionary
public
PdfDictionary
$dictionary
$generationNumber
public
int
$generationNumber
= 0
$matrix
public
PdfArray|null
$matrix
= null
$objectNumber
public
int
$objectNumber
= 0
$paintType
public
int
$paintType
$resources
public
Resources|PdfDictionary
$resources
$tilingType
public
int
$tilingType
$xStep
public
float
$xStep
$yStep
public
float
$yStep
Methods
__construct()
public
__construct(int $paintType, int $tilingType, PdfArray $bbox, float $xStep, float $yStep, Resources|PdfDictionary $resources[, string $contentStream = '' ]) : mixed
Parameters
- $paintType : int
- $tilingType : int
- $bbox : PdfArray
- $xStep : float
- $yStep : float
- $resources : Resources|PdfDictionary
- $contentStream : string = ''
getPatternType()
public
getPatternType() : int
Return values
intsetFilter()
Set a filter to encode/decode the stream data.
public
setFilter(FilterInterface $filter, string $pdfFilterName) : void
Parameters
- $filter : FilterInterface
-
The filter implementation
- $pdfFilterName : string
-
The PDF filter name (e.g. 'FlateDecode', 'ASCII85Decode')
toIndirectObject()
Wrap the object in an indirect object structure: X Y obj ... endobj
public
toIndirectObject() : string
Return values
stringtoPdf()
Returns the stream body: dictionary, stream keyword, data, endstream.
public
toPdf() : string
/Length is injected into the dictionary at serialization time. If a filter is set, the data is encoded before writing.