Class Group in namespace setasign\SetaPDF2\Core\Document\OptionalContent in SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Core
  1. Document
  2. Document
    1. OptionalContent
      1. Group
      2. Group
        
        Usage

setasign\SetaPDF2\Core\Document\OptionalContent

Group An optional content group

File: /SetaPDF v2/Core/Document/OptionalContent/Group.php
Old class name (alias): \SetaPDF_Core_Document_OptionalContent_Group

Class hierarchy

Group

Implements

\setasign\SetaPDF2\Core\Resource\ResourceInterface

Summary

Constants

TYPE_COLOR_SPACE

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_COLOR_SPACE = 'ColorSpace'

Type constant

TYPE_EXT_G_STATE

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_EXT_G_STATE = 'ExtGState'

Type constant

TYPE_FONT

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_FONT = 'Font'

Type constant

TYPE_PATTERN

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_PATTERN = 'Pattern'

Type constant

TYPE_PROC_SET

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_PROC_SET = 'ProcSet'

Type constant

TYPE_PROPERTIES

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_PROPERTIES = 'Properties'

Type constant

TYPE_SHADING

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_SHADING = 'Shading'

Type constant

TYPE_X_OBJECT

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_X_OBJECT = 'XObject'

Type constant

Properties

$_dictionary

protected \SetaPDF_Core_Type_Dictionary Group::$_dictionary

The optional content group dictionary

$_indirectObject

protected \SetaPDF_Core_Type_IndirectObjectInterface Group::$_indirectObject

The indirect object of this group

$_usage

protected \SetaPDF_Core_Document_OptionalContent_Group_Usage Group::$_usage

A usage helper class

Static Methods

createOCGDictionary()

public static Group::createOCGDictionary (

string $name,
string $encoding = 'UTF-8'

): \SetaPDF_Core_Type_Dictionary

Creates an optional content group dictionary.

Parameters

$name : string
$encoding : string

Methods

__construct()

public Group::__construct (

\SetaPDF_Core_Type_IndirectObjectInterface|\SetaPDF_Core_Type_Dictionary|string $ocgDictionary

)

The constructor.

Parameters

$ocgDictionary : \SetaPDF_Core_Type_IndirectObjectInterface|\SetaPDF_Core_Type_Dictionary|string

Exceptions

Throws \InvalidArgumentException

Throws \setasign\SetaPDF2\Core\Type\Exception

See

Group::createOCGDictionary()

cleanUp()

public Group::cleanUp (

void

): void

Release memory / cycled references.

getDictionary()

public Group::getDictionary (

void

): \SetaPDF_Core_Type_Dictionary

Get the dictionary of the optional content group.

getIndirectObject()

public Group::getIndirectObject (

?\SetaPDF_Core_Document $document = null

): \SetaPDF_Core_Type_IndirectObjectInterface

Get an indirect object for this optional content group.

Parameters

$document : ?\SetaPDF_Core_Document

Exceptions

Throws \InvalidArgumentException

See

\setasign\SetaPDF2\Core\Resource\ResourceInterface::getIndirectObject()

getName()

public Group::getName (

string $encoding = 'UTF-8'

): string

Get the name of the optional content group.

Parameters

$encoding : string

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getResourceType()

public Group::getResourceType (

void

): string

Get the resource type for optional content groups.

See

\setasign\SetaPDF2\Core\Resource\ResourceInterface::getResourceType()

setName()

public Group::setName (

string $name,
string $encoding = 'UTF-8'

): void

Set the name of the optional content group.

Parameters

$name : string
$encoding : string

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

usage()

public Group::usage (

void

): \SetaPDF_Core_Document_OptionalContent_Group_Usage

Gets the usage helper class.