Zend_Pdf_Outline_Loaded Class Reference

Inheritance diagram for Zend_Pdf_Outline_Loaded:

Public Member Functions
	getTitle ()
	setTitle ($title)
	setIsOpen ($isOpen)
	isItalic ()
	setIsItalic ($isItalic)
	isBold ()
	setIsBold ($isBold)
	getColor ()
	setColor (Zend_Pdf_Color_Rgb $color)
	getTarget ()
	setTarget ($target=null)
	setOptions (array $options)
	__construct (Zend_Pdf_Element $dictionary, SplObjectStorage $processedDictionaries=null)
	dumpOutline (Zend_Pdf_ElementFactory_Interface $factory, $updateNavigation, Zend_Pdf_Element $parent, Zend_Pdf_Element $prev=null, SplObjectStorage $processedOutlines=null)
	dump ($level=0)
Public Member Functions inherited from Zend_Pdf_Outline
	getTitle ()
	setTitle ($title)
	isOpen ()
	setIsOpen ($isOpen)
	isItalic ()
	setIsItalic ($isItalic)
	isBold ()
	setIsBold ($isBold)
	getColor ()
	setColor (Zend_Pdf_Color_Rgb $color)
	getTarget ()
	setTarget ($target=null)
	getOptions ()
	setOptions (array $options)
	openOutlinesCount ()
	dumpOutline (Zend_Pdf_ElementFactory_Interface $factory, $updateNavigation, Zend_Pdf_Element $parent, Zend_Pdf_Element $prev=null, SplObjectStorage $processedOutlines=null)
	current ()
	key ()
	next ()
	rewind ()
	valid ()
	getChildren ()
	hasChildren ()
	count ()

Protected Attributes
	$_outlineDictionary
	$_originalChildOutlines = array()
Protected Attributes inherited from Zend_Pdf_Outline
	$_open = false

Additional Inherited Members
Static Public Member Functions inherited from Zend_Pdf_Outline
static	create ($param1, $param2=null)
Data Fields inherited from Zend_Pdf_Outline
	$childOutlines = array()

Detailed Description

Definition at line 45 of file Loaded.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Zend_Pdf_Element	$dictionary,
		SplObjectStorage	$processedDictionaries = null
	)

Create PDF outline object using specified dictionary

Definition at line 311 of file Loaded.php.

    {
        if ($dictionary->getType() != Zend_Pdf_Element::TYPE_DICTIONARY) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('$dictionary mast be an indirect dictionary object.');
        }

        if ($processedDictionaries === null) {
            $processedDictionaries = new SplObjectStorage();
        }
        $processedDictionaries->attach($dictionary);

        $this->_outlineDictionary = $dictionary;

        if ($dictionary->Count !== null) {
            if ($dictionary->Count->getType() != Zend_Pdf_Element::TYPE_NUMERIC) {
                #require_once 'Zend/Pdf/Exception.php';
                throw new Zend_Pdf_Exception('Outline dictionary Count entry must be a numeric element.');
            }

            $childOutlinesCount = $dictionary->Count->value;
            if ($childOutlinesCount > 0) {
                $this->_open = true;
            }
            $childOutlinesCount = abs($childOutlinesCount);

            $childDictionary = $dictionary->First;

            $children = new SplObjectStorage();
            while ($childDictionary !== null) {
                // Check children structure for cyclic references
                if ($children->contains($childDictionary)) {
                    #require_once 'Zend/Pdf/Exception.php';
                    throw new Zend_Pdf_Exception('Outline childs load error.');
                }

                if (!$processedDictionaries->contains($childDictionary)) {
                    $this->childOutlines[] = new Zend_Pdf_Outline_Loaded($childDictionary, $processedDictionaries);
                }

                $childDictionary = $childDictionary->Next;
            }

            $this->_originalChildOutlines = $this->childOutlines;
        }
    }

Member Function Documentation

dump()

dump

(

$level = 0

)

Definition at line 450 of file Loaded.php.

    {
        printf(":%3d:%s:%s:%s%s  :\n", count($this->childOutlines),$this->isItalic()? 'i':' ', $this->isBold()? 'b':' ', str_pad('', 4*$level), $this->getTitle());

        if ($this->isOpen()  ||  true) {
            foreach ($this->childOutlines as $child) {
                $child->dump($level + 1);
            }
        }
    }

dumpOutline()

dumpOutline	(	Zend_Pdf_ElementFactory_Interface	$factory,
			$updateNavigation,
		Zend_Pdf_Element	$parent,
		Zend_Pdf_Element	$prev = null,
		SplObjectStorage	$processedOutlines = null
	)

Dump Outline and its child outlines into PDF structures

Returns dictionary indirect object or reference

Definition at line 372 of file Loaded.php.

    {
        if ($processedOutlines === null) {
            $processedOutlines = new SplObjectStorage();
        }
        $processedOutlines->attach($this);

        if ($updateNavigation) {
            $this->_outlineDictionary->touch();

            $this->_outlineDictionary->Parent = $parent;
            $this->_outlineDictionary->Prev   = $prev;
            $this->_outlineDictionary->Next   = null;
        }

        $updateChildNavigation = false;
        if (count($this->_originalChildOutlines) != count($this->childOutlines)) {
            // If original and current children arrays have different size then children list was updated
            $updateChildNavigation = true;
        } else if ( !(array_keys($this->_originalChildOutlines) === array_keys($this->childOutlines)) ) {
            // If original and current children arrays have different keys (with a glance to an order) then children list was updated
            $updateChildNavigation = true;
        } else {
            foreach ($this->childOutlines as $key => $childOutline) {
                if ($this->_originalChildOutlines[$key] !== $childOutline) {
                    $updateChildNavigation = true;
                    break;
                }
            }
        }

        $lastChild = null;
        if ($updateChildNavigation) {
            $this->_outlineDictionary->touch();
            $this->_outlineDictionary->First = null;

            foreach ($this->childOutlines as $childOutline) {
                if ($processedOutlines->contains($childOutline)) {
                    #require_once 'Zend/Pdf/Exception.php';
                    throw new Zend_Pdf_Exception('Outlines cyclyc reference is detected.');
                }

                if ($lastChild === null) {
                    // First pass. Update Outlines dictionary First entry using corresponding value
                    $lastChild = $childOutline->dumpOutline($factory, $updateChildNavigation, $this->_outlineDictionary, null, $processedOutlines);
                    $this->_outlineDictionary->First = $lastChild;
                } else {
                    // Update previous outline dictionary Next entry (Prev is updated within dumpOutline() method)
                    $childOutlineDictionary = $childOutline->dumpOutline($factory, $updateChildNavigation, $this->_outlineDictionary, $lastChild, $processedOutlines);
                    $lastChild->Next = $childOutlineDictionary;
                    $lastChild       = $childOutlineDictionary;
                }
            }

            $this->_outlineDictionary->Last  = $lastChild;

            if (count($this->childOutlines) != 0) {
                $this->_outlineDictionary->Count = new Zend_Pdf_Element_Numeric(($this->isOpen()? 1 : -1)*count($this->childOutlines));
            } else {
                $this->_outlineDictionary->Count = null;
            }
        } else {
            foreach ($this->childOutlines as $childOutline) {
                if ($processedOutlines->contains($childOutline)) {
                    #require_once 'Zend/Pdf/Exception.php';
                    throw new Zend_Pdf_Exception('Outlines cyclyc reference is detected.');
                }
                $lastChild = $childOutline->dumpOutline($factory, $updateChildNavigation, $this->_outlineDictionary, $lastChild, $processedOutlines);
            }
        }

        return $this->_outlineDictionary;
    }

getColor()

getColor

(

)

Get outline text color.

Returns

Zend_Pdf_Color_Rgb

Definition at line 190 of file Loaded.php.

    {
        if ($this->_outlineDictionary->C === null) {
            return null;
        }

        $components = $this->_outlineDictionary->C->items;

        #require_once 'Zend/Pdf/Color/Rgb.php';
        return new Zend_Pdf_Color_Rgb($components[0], $components[1], $components[2]);
    }

getTarget()

getTarget

(

)

Get outline target.

Returns

Zend_Pdf_Target

Exceptions

Zend_Pdf_Exception

Definition at line 232 of file Loaded.php.

    {
        if ($this->_outlineDictionary->Dest !== null) {
            if ($this->_outlineDictionary->A !== null) {
                #require_once 'Zend/Pdf/Exception.php';
                throw new Zend_Pdf_Exception('Outline dictionary may contain Dest or A entry, but not both.');
            }

            #require_once 'Zend/Pdf/Destination.php';
            return Zend_Pdf_Destination::load($this->_outlineDictionary->Dest);
        } else if ($this->_outlineDictionary->A !== null) {
            #require_once 'Zend/Pdf/Action.php';
            return Zend_Pdf_Action::load($this->_outlineDictionary->A);
        }

        return null;
    }

getTitle()

getTitle

(

)

Get outline title.

Returns

string

Exceptions

Zend_Pdf_Exception

Definition at line 67 of file Loaded.php.

    {
        if ($this->_outlineDictionary->Title === null) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Outline dictionary Title entry is required.');
        }
        return $this->_outlineDictionary->Title->value;
    }

isBold()

isBold

(

)

Returns true if outline item is displayed in bold

Returns

boolean

Definition at line 154 of file Loaded.php.

    {
        if ($this->_outlineDictionary->F === null) {
            return false;
        }
        return $this->_outlineDictionary->F->value & 2;
    }

isItalic()

isItalic

(

)

Returns true if outline item is displayed in italic

Returns

boolean

Definition at line 119 of file Loaded.php.

    {
        if ($this->_outlineDictionary->F === null) {
            return false;
        }
        return $this->_outlineDictionary->F->value & 1;
    }

setColor()

setColor

(

Zend_Pdf_Color_Rgb

$color

)

Set outline text color. (null means default color which is black)

Parameters

Zend_Pdf_Color_Rgb

$color

Returns

Zend_Pdf_Outline

Definition at line 209 of file Loaded.php.

    {
        $this->_outlineDictionary->touch();

        if ($color === null) {
            $this->_outlineDictionary->C = null;
        } else {
            $components = $color->getComponents();
            $colorComponentElements = array(new Zend_Pdf_Element_Numeric($components[0]),
                                            new Zend_Pdf_Element_Numeric($components[1]),
                                            new Zend_Pdf_Element_Numeric($components[2]));
            $this->_outlineDictionary->C = new Zend_Pdf_Element_Array($colorComponentElements);
        }

        return $this;
    }

setIsBold()

setIsBold

(

$isBold

)

Sets 'isBold' outline flag

Parameters

boolean

$isBold

Returns

Zend_Pdf_Outline

Definition at line 168 of file Loaded.php.

    {
        if ($this->_outlineDictionary->F === null) {
            $this->_outlineDictionary->touch();
            $this->_outlineDictionary->F = new Zend_Pdf_Element_Numeric($isBold? 2 : 0);
        } else {
            $this->_outlineDictionary->F->touch();
            if ($isBold) {
                $this->_outlineDictionary->F->value = $this->_outlineDictionary->F->value | 2;
            } else {
                $this->_outlineDictionary->F->value = $this->_outlineDictionary->F->value | ~2;
            }
        }
        return $this;
    }

setIsItalic()

setIsItalic

(

$isItalic

)

Sets 'isItalic' outline flag

Parameters

boolean

$isItalic

Returns

Zend_Pdf_Outline

Definition at line 133 of file Loaded.php.

    {
        if ($this->_outlineDictionary->F === null) {
            $this->_outlineDictionary->touch();
            $this->_outlineDictionary->F = new Zend_Pdf_Element_Numeric($isItalic? 1 : 0);
        } else {
            $this->_outlineDictionary->F->touch();
            if ($isItalic) {
                $this->_outlineDictionary->F->value = $this->_outlineDictionary->F->value | 1;
            } else {
                $this->_outlineDictionary->F->value = $this->_outlineDictionary->F->value | ~1;
            }
        }
        return $this;
    }

setIsOpen()

setIsOpen

(

$isOpen

)

Sets 'isOpen' outline flag

Parameters

boolean

$isOpen

Returns

Zend_Pdf_Outline

Definition at line 95 of file Loaded.php.

    {
        parent::setIsOpen($isOpen);

        if ($this->_outlineDictionary->Count === null) {
            // Do Nothing.
            return this;
        }

        $childrenCount = $this->_outlineDictionary->Count->value;
        $isOpenCurrentState = ($childrenCount > 0);
        if ($isOpen != $isOpenCurrentState) {
            $this->_outlineDictionary->Count->touch();
            $this->_outlineDictionary->Count->value = ($isOpen? 1 : -1)*abs($childrenCount);
        }

        return $this;
    }

setOptions()

setOptions

(

array

$options

)

Set outline options

Parameters

array

$options

Returns

Zend_Pdf_Actions_Traceable

Exceptions

Zend_Pdf_Exception

Definition at line 291 of file Loaded.php.

    {
        parent::setOptions($options);

        return $this;
    }

setTarget()

setTarget

(

$target = null

)

Set outline target. Null means no target

Parameters

Zend_Pdf_Target | string

$target

Returns

Zend_Pdf_Outline

Exceptions

Zend_Pdf_Exception

Definition at line 258 of file Loaded.php.

    {
        $this->_outlineDictionary->touch();

        if (is_string($target)) {
            #require_once 'Zend/Pdf/Destination/Named.php';
            $target = Zend_Pdf_Destination_Named::create($target);
        }

        if ($target === null) {
            $this->_outlineDictionary->Dest = null;
            $this->_outlineDictionary->A    = null;
        } else if ($target instanceof Zend_Pdf_Destination) {
            $this->_outlineDictionary->Dest = $target->getResource();
            $this->_outlineDictionary->A    = null;
        } else if ($target instanceof Zend_Pdf_Action) {
            $this->_outlineDictionary->Dest = null;
            $this->_outlineDictionary->A    = $target->getResource();
        } else {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Outline target has to be Zend_Pdf_Destination or Zend_Pdf_Action object or string');
        }

        return $this;
    }

setTitle()

setTitle

(

$title

)

Set outline title

Parameters

string

$title

Returns

Zend_Pdf_Outline

Definition at line 82 of file Loaded.php.

    {
        $this->_outlineDictionary->Title->touch();
        $this->_outlineDictionary->Title = new Zend_Pdf_Element_String($title);
        return $this;
    }

Field Documentation

$_originalChildOutlines

$_originalChildOutlines = array()

protected

Definition at line 59 of file Loaded.php.

$_outlineDictionary

$_outlineDictionary

protected

Definition at line 52 of file Loaded.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Pdf/Outline/Loaded.php