SetaPDF v2 API Reference

Copies an item.

This method internally removes all relations to its parents or neighboring items.

Parameters

$document : SetaPDF_Core_Document: The document instance in which context the item will be copied
$item : SetaPDF_Core_Document_OutlinesItem: The item to copy

Exceptions

create()

public static SetaPDF_Core_Document_OutlinesItem::create (

SetaPDF_Core_Document $document, string|array $titleOrConfig [, array $config = array ( ) ]

Creates an outline item.

The configuration array could hold keyed values:

copy

$config = array(
    SetaPDF_Core_Document_OutlinesItem::TITLE => string,
    SetaPDF_Core_Document_OutlinesItem::DEST => SetaPDF_Core_Document_Destination|SetaPDF_Core_Type_Array|string,
    SetaPDF_Core_Document_OutlinesItem::ACTION => SetaPDF_Core_Document_Action|SetaPDF_Core_Type_Dictionary,
    SetaPDF_Core_Document_OutlinesItem::COLOR => SetaPDF_Core_DataStructure_Color_Rgb|array
    SetaPDF_Core_Document_OutlinesItem::BOLD => boolean,
    SetaPDF_Core_Document_OutlinesItem::ITALIC => boolean,
);

Parameters

$document : SetaPDF_Core_Document: The document instance in which context the item will be used
$titleOrConfig : string|array: The title or a configuration array
$config : array: A configuration array

Exceptions

Methods

__construct()

public SetaPDF_Core_Document_OutlinesItem::__construct (

SetaPDF_Core_Type_IndirectObjectInterface $indirectReference

)

The constructor.

Parameters

$indirectReference : SetaPDF_Core_Type_IndirectObjectInterface

Exceptions

__clone()

public SetaPDF_Core_Document_OutlinesItem::__clone (

void

): void

Omit cloning.

Exceptions

Throws BadMethodCallException

_isFlagSet()

protected SetaPDF_Core_Document_OutlinesItem::_isFlagSet (

int $flag

): bool

Checks whether a flag in the F entry is set or not.

Parameters

$flag : int

_setFlag()

protected SetaPDF_Core_Document_OutlinesItem::_setFlag (

boolean $value, int $flag

): $this|void

Set or unset a flag in the F entry.

Parameters

$value : boolean
$flag : int

_updateParentCount()

protected SetaPDF_Core_Document_OutlinesItem::_updateParentCount (

SetaPDF_Core_Type_Dictionary|false $parentPdfDict

): void

Increases or decreases the count value in the parent items.

Parameters

$parentPdfDict : SetaPDF_Core_Type_Dictionary|false

Exceptions

append()

public SetaPDF_Core_Document_OutlinesItem::append (

SetaPDF_Core_Document_OutlinesItem $item [, SetaPDF_Core_Document $document = null [, string $mode = null ]]

Append another item to this item.

The $mode parameter can be used to specify the way the item will be appended: moved or copied.

Parameters

$item : SetaPDF_Core_Document_OutlinesItem: The item to append
$document : SetaPDF_Core_Document: The document instance in which context the item will be used
$mode : string: The append mode. See SetaPDF_Core_Document_OutlinesItem::APPEND_MODE_XXX constants for details.

Return Values

Returns the SetaPDF_Core_Document_OutlinesItem object for method chaining.

Exceptions

Throws LogicException

appendChild()

public SetaPDF_Core_Document_OutlinesItem::appendChild (

SetaPDF_Core_Document_OutlinesItem $item [, SetaPDF_Core_Document $document = null [, string $mode = null ]]

Append another item as a child of this item.

The $mode parameter can be used to specify the way the item will be appended: moved or copied.

Parameters

$item : SetaPDF_Core_Document_OutlinesItem: The item to append
$document : SetaPDF_Core_Document: The document instance in which context the item will be used
$mode : string: The append mode. See SetaPDF_Core_Document_OutlinesItem::APPEND_MODE_XXX constants for details.

Return Values

Returns the SetaPDF_Core_Document_OutlinesItem object for method chaining.

Exceptions

appendChildCopy()

public SetaPDF_Core_Document_OutlinesItem::appendChildCopy (

SetaPDF_Core_Document_Catalog_Outlines|SetaPDF_Core_Document_OutlinesItem $originalItem, SetaPDF_Core_Document $document

): null|SetaPDF_Core_Document_OutlinesItem

Appends a copy of another item or outline as a child to this item.

Parameters

$originalItem : SetaPDF_Core_Document_Catalog_Outlines|SetaPDF_Core_Document_OutlinesItem
$document : SetaPDF_Core_Document: The document instance in which context the item will be used

Exceptions

appendCopy()

public SetaPDF_Core_Document_OutlinesItem::appendCopy (

SetaPDF_Core_Document_OutlinesItem $originalItem, SetaPDF_Core_Document $document

Appends a copy of another item to this item.

Parameters

$originalItem : SetaPDF_Core_Document_OutlinesItem: The original item
$document : SetaPDF_Core_Document: The document instance in which context the item will be used

Return Values

Returns the SetaPDF_Core_Document_OutlinesItem object for method chaining.

Exceptions

close()

public SetaPDF_Core_Document_OutlinesItem::close (

void

Close the item.

Alias for SetaPDF_Core_Document_OutlinesItem::setOpen() with false as its argument.

Return Values

Returns the SetaPDF_Core_Document_OutlinesItem object for method chaining.

Exceptions

contains()

public SetaPDF_Core_Document_OutlinesItem::contains (

SetaPDF_Core_Document_OutlinesItem $item [, boolean $checkAgainstThis = true ]

): boolean

Checks if an item is specified in any descendants of this item.

Parameters

$item : SetaPDF_Core_Document_OutlinesItem: The item to check for
$checkAgainstThis : boolean: True to check this instance against the item

Return Values

Whether the item is specified in any descendants of this item.

Exceptions

current()

public SetaPDF_Core_Document_OutlinesItem::current (

void

Get the current item.

See

RecursiveIterator::current()

getAction()

public SetaPDF_Core_Document_OutlinesItem::getAction (

void

): bool|SetaPDF_Core_Document_Action

Get the action of the item.

Return Values

The action instance or false if no action is defined.

Exceptions

getChildren()

public SetaPDF_Core_Document_OutlinesItem::getChildren (

void

): SetaPDF_Core_Document_OutlinesItem|false

Get the first descendant item.

Exceptions

See

RecursiveIterator::getChildren()

getColor()

public SetaPDF_Core_Document_OutlinesItem::getColor (

void

): false|SetaPDF_Core_DataStructure_Color

Get the color of the item.

Return Values

A color object or false if no color is defined.

getCount()

public SetaPDF_Core_Document_OutlinesItem::getCount (

void

): int

Get the number of visible outline items (value of the Count key).

Total number of visible outline items at all levels of the outline.

getDestination()

public SetaPDF_Core_Document_OutlinesItem::getDestination (

[ SetaPDF_Core_Document $document = null ]

): SetaPDF_Core_Document_Destination|false

Get the destination of the item.

Parameters

$document : SetaPDF_Core_Document: The main document is needed to automatically resolve the destination

Return Values

A destination instance or false if none was defined.

Exceptions

): SetaPDF_Core_Type_Dictionary

getDictionary()

public SetaPDF_Core_Document_OutlinesItem::getDictionary (

void

Get the dictionary.

getFirstItem()

public SetaPDF_Core_Document_OutlinesItem::getFirstItem (

void

Get an item instance of the item referenced in the First key.

Exceptions

getLastItem()

public SetaPDF_Core_Document_OutlinesItem::getLastItem (

void

): bool|SetaPDF_Core_Document_OutlinesItem

Get an item instance of the item referenced in the 'Last' key.

Exceptions

getNext()

public SetaPDF_Core_Document_OutlinesItem::getNext (

void

Get an item instance of the item referenced in the Next key.

Exceptions

getParent()

public SetaPDF_Core_Document_OutlinesItem::getParent (

void

Get an item instance of the item referenced in the Parent key.

Exceptions

getPrevious()

public SetaPDF_Core_Document_OutlinesItem::getPrevious (

void

Get an item instance of the item referenced in the Prev key.

Exceptions

): SetaPDF_Core_Type_IndirectObjectInterface

getReferenceTo()

public SetaPDF_Core_Document_OutlinesItem::getReferenceTo (

void

Get the reference to this item.

getTitle()

public SetaPDF_Core_Document_OutlinesItem::getTitle (

[ string $encoding = 'UTF-8' ]

): string

Get the item title.

Parameters

$encoding : string: The output encoding

Exceptions

hasChildren()

public SetaPDF_Core_Document_OutlinesItem::hasChildren (

void

): void

Checks if this item has descendants.

See

RecursiveIterator::hasChildren()

hasFirstItem()

public SetaPDF_Core_Document_OutlinesItem::hasFirstItem (

void

): bool

Checks if this item has a 'First' value set.

The first item is the first item structured under this item. With this method you can check if the item has child items.

Return Values

True if a child item exists - false otherwise.

isBold()

public SetaPDF_Core_Document_OutlinesItem::isBold (

void

): boolean

Checks if the item should be displayed bold.

isItalic()

public SetaPDF_Core_Document_OutlinesItem::isItalic (

void

): boolean

Checks if the item should be displayed italic.

isOpen()

public SetaPDF_Core_Document_OutlinesItem::isOpen (

void

): null|boolean

Checks whether the item is open or not or if the item does not holds any descendants.

Return Values

Returns true if the item is open, false if it is closed or null if the item does not holds any descendants.

key()

public SetaPDF_Core_Document_OutlinesItem::key (

void

): int

Get the iterator key.

See

RecursiveIterator::key()

move()

public SetaPDF_Core_Document_OutlinesItem::move (

SetaPDF_Core_Document_Catalog_Outlines|SetaPDF_Core_Document_OutlinesItem $target, SetaPDF_Core_Document $document [, string $mode = 'appendChild' ]

Move this item to another item or root outline.

The $mode parameter can be used to specify how the item will be moved.

Parameters

$target : SetaPDF_Core_Document_Catalog_Outlines|SetaPDF_Core_Document_OutlinesItem: The target item
$document : SetaPDF_Core_Document: The document instance in which context the item will be used
$mode : string: The move mode. See SetaPDF_Core_Document_OutlinesItem::MOVE_MODE_XXX constants for details.

Return Values

Returns the SetaPDF_Core_Document_OutlinesItem object for method chaining.

Exceptions

next()

public SetaPDF_Core_Document_OutlinesItem::next (

void

): void

Get the next item.

See

RecursiveIterator::next()

offsetExists()

public SetaPDF_Core_Document_OutlinesItem::offsetExists (

string|integer $offset

): bool

Checks if an item exists at a specific position.

Parameters

$offset : string|integer: The index being checked

See

ArrayAccess::offsetExists()

offsetGet()

public SetaPDF_Core_Document_OutlinesItem::offsetGet (

string|integer $offset

Get an item by a specific position.

Parameters

$offset : string|integer: The index with the value

Return Values

The value at the specified index.

Exceptions

Throws InvalidArgumentException if no item is at the offset.

See

ArrayAccess::offsetGet()

offsetSet()

public SetaPDF_Core_Document_OutlinesItem::offsetSet (

null|string|integer $offset, mixed $value

): void

Set an item at a specific position.

Parameters

$offset : null|string|integer: The index being set
$value : mixed: The new value for the index

Exceptions

See

offsetUnset()

public SetaPDF_Core_Document_OutlinesItem::offsetUnset (

string|integer $offset

Removes an item at a specific position.

Parameters

$offset : string|integer: The index being unset

Exceptions

See

ArrayAccess::offsetUnset()

open()

public SetaPDF_Core_Document_OutlinesItem::open (

void

Open the item.

Return Values

Returns the SetaPDF_Core_Document_OutlinesItem object for method chaining.

Exceptions

prepend()

public SetaPDF_Core_Document_OutlinesItem::prepend (

SetaPDF_Core_Document_OutlinesItem $item [, SetaPDF_Core_Document $document = null [, string $mode = null ]]

Prepend another item to this item.

The $mode parameter can be used to specify the way the item will be prepended: moved or copied.

Parameters

$item : SetaPDF_Core_Document_OutlinesItem: The item to prepend
$document : SetaPDF_Core_Document: The document instance in which context the item will be used
$mode : string: The append mode. See SetaPDF_Core_Document_OutlinesItem::APPEND_MODE_XXX constants for details.

Return Values

Returns the passed item or the last node in the item structure.

Exceptions

Throws LogicException

prependCopy()

public SetaPDF_Core_Document_OutlinesItem::prependCopy (

SetaPDF_Core_Document_OutlinesItem $originalItem, SetaPDF_Core_Document $document

Prepends a copy of another item to this item.

Parameters

$originalItem : SetaPDF_Core_Document_OutlinesItem: The original item
$document : SetaPDF_Core_Document: The document instance in which context the item will be used

Return Values

Returns the SetaPDF_Core_Document_OutlinesItem object for method chaining.

Exceptions

remove()

public SetaPDF_Core_Document_OutlinesItem::remove (

void

Remove the item from the outline.

Return Values

The removed item

Exceptions

rewind()

public SetaPDF_Core_Document_OutlinesItem::rewind (

void

): void

Reset the iterator.

See

RecursiveIterator::rewind()

setAction()

public SetaPDF_Core_Document_OutlinesItem::setAction (

SetaPDF_Core_Document_Action|SetaPDF_Core_Type_IndirectObject|SetaPDF_Core_Type_IndirectReference|SetaPDF_Core_Type_Dictionary|null $action

Set the action of the item.

The action could be an instance of SetaPDF_Core_Document_Action, a dictionary or a reference to a dictionary representing the action.

Parameters

$action : SetaPDF_Core_Document_Action|SetaPDF_Core_Type_IndirectObject|SetaPDF_Core_Type_IndirectReference|SetaPDF_Core_Type_Dictionary|null: The action to execute

Return Values

Returns the SetaPDF_Core_Document_OutlinesItem object for method chaining.

Exceptions

setBold()

public SetaPDF_Core_Document_OutlinesItem::setBold (

[ boolean $bold = true ]

Sets whether the item should be displayed bold or not.

Parameters

$bold : boolean: True to display the item bold

Return Values

Returns the SetaPDF_Core_Document_OutlinesItem object for method chaining.

setColor()

public SetaPDF_Core_Document_OutlinesItem::setColor (

array|SetaPDF_Core_DataStructure_Color_Rgb|float $colorOrR [, float $g = null [, float $b = null ]]

Set the color of the item.

Parameters

$colorOrR : array|SetaPDF_Core_DataStructure_Color_Rgb|float: An array of 3 integer values representing the rgb components (between 0 and 1), an instance of SetaPDF_Core_DataStructure_Color_Rgb or the red component value (between 0 and 1).
$g : float: The green component value (between 0 and 1)
$b : float: The blue component value (between 0 and 1)

Return Values

Returns the SetaPDF_Core_Document_OutlinesItem object for method chaining.

setDestination()

public SetaPDF_Core_Document_OutlinesItem::setDestination (

Set the destination of the item.

Parameters

$destination : SetaPDF_Core_Type_IndirectObjectInterface|SetaPDF_Core_Document_Destination|SetaPDF_Core_Type_Array|SetaPDF_Core_Type_StringValue|SetaPDF_Core_Type_Name|string|null: The destination

Return Values

Returns the SetaPDF_Core_Document_OutlinesItem object for method chaining.

Exceptions

setItalic()

public SetaPDF_Core_Document_OutlinesItem::setItalic (

[ boolean $italic = true ]

Sets whether the item should be displayed italic or not.

Parameters

$italic : boolean: True to display the item italic

Return Values

Returns the SetaPDF_Core_Document_OutlinesItem object for method chaining.

setOpen()

public SetaPDF_Core_Document_OutlinesItem::setOpen (

[ boolean $open = true ]

Open or close the item.

Parameters

$open : boolean: A boolean value specifying if the item is opened or not

Return Values

Returns the SetaPDF_Core_Document_OutlinesItem object for method chaining.

Exceptions

setTitle()

public SetaPDF_Core_Document_OutlinesItem::setTitle (

string $title [, string $encoding = 'UTF-8' ]