SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Core
  1. Document
  2. Document
    1. OptionalContent
      1. Group
      2. Group
      3. Iterator

setasign\SetaPDF2\Core\Document\OptionalContent

Iterator Optional content iterator

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

Class hierarchy

\RecursiveIteratorIterator
- Iterator

Implements

Summary

Methods

__construct()
beginChildren()
beginIteration()
callGetChildren()
callHasChildren()
current()
endChildren()
endIteration()
getDepth()
getInnerIterator()
getMaxDepth()
getSubIterator()
key()
next()
nextElement()
rewind()
setMaxDepth()
valid()

Constants

CATCH_GET_CHILD
CHILD_FIRST
LEAVES_ONLY
SELF_FIRST

Constants

CATCH_GET_CHILD

public const \RecursiveIteratorIterator::CATCH_GET_CHILD = 16

CHILD_FIRST

public const \RecursiveIteratorIterator::CHILD_FIRST = 2

LEAVES_ONLY

public const \RecursiveIteratorIterator::LEAVES_ONLY = 0

SELF_FIRST

public const \RecursiveIteratorIterator::SELF_FIRST = 1

Methods

__construct()

Internal PHP method: RecursiveIteratorIterator::__construct

beginChildren()

Internal PHP method: RecursiveIteratorIterator::beginChildren

beginIteration()

Internal PHP method: RecursiveIteratorIterator::beginIteration

callGetChildren()

Internal PHP method: RecursiveIteratorIterator::callGetChildren

callHasChildren()

Internal PHP method: RecursiveIteratorIterator::callHasChildren

current()

public Iterator::current (

void

): \SetaPDF_Core_Type_AbstractType|\SetaPDF_Core_Document_OptionalContent_Group

Return the current value as an Group object if possible.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

See

\RecursiveIteratorIterator::current()

endChildren()

Internal PHP method: RecursiveIteratorIterator::endChildren

endIteration()

Internal PHP method: RecursiveIteratorIterator::endIteration

getDepth()

Internal PHP method: RecursiveIteratorIterator::getDepth

getInnerIterator()

Internal PHP method: RecursiveIteratorIterator::getInnerIterator

getMaxDepth()

Internal PHP method: RecursiveIteratorIterator::getMaxDepth

getSubIterator()

Internal PHP method: RecursiveIteratorIterator::getSubIterator

key()

Internal PHP method: RecursiveIteratorIterator::key

next()

Internal PHP method: RecursiveIteratorIterator::next

nextElement()

Internal PHP method: RecursiveIteratorIterator::nextElement

rewind()

Internal PHP method: RecursiveIteratorIterator::rewind

setMaxDepth()

Internal PHP method: RecursiveIteratorIterator::setMaxDepth

valid()

Internal PHP method: RecursiveIteratorIterator::valid