Zend_Pdf_Outline_Created Class Reference

Inheritance diagram for Zend_Pdf_Outline_Created:

Public Member Functions
	getTitle ()
	setTitle ($title)
	isItalic ()
	setIsItalic ($isItalic)
	isBold ()
	setIsBold ($isBold)
	getColor ()
	setColor (Zend_Pdf_Color_Rgb $color)
	getTarget ()
	setTarget ($target=null)
	__construct ($options=array())
	dumpOutline (Zend_Pdf_ElementFactory_Interface $factory, $updateNavigation, Zend_Pdf_Element $parent, Zend_Pdf_Element $prev=null, SplObjectStorage $processedOutlines=null)
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
	$_title
	$_color = null
	$_italic = false
	$_bold = false
	$_target = null
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 44 of file Created.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = array()

)

Object constructor

Parameters

array

$options

Exceptions

Zend_Pdf_Exception

Definition at line 222 of file Created.php.

    {
        if (!isset($options['title'])) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Title parameter is required.');
        }

        $this->setOptions($options);
    }

Member Function Documentation

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 246 of file Created.php.

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

        $outlineDictionary = $factory->newObject(new Zend_Pdf_Element_Dictionary());

        $outlineDictionary->Title = new Zend_Pdf_Element_String($this->getTitle());

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

        $color = $this->getColor();
        if ($color !== null) {
            $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]));
            $outlineDictionary->C = new Zend_Pdf_Element_Array($colorComponentElements);
        }

        if ($this->isItalic()  ||  $this->isBold()) {
            $outlineDictionary->F = new Zend_Pdf_Element_Numeric(($this->isItalic()? 1 : 0)  |   // Bit 1 - Italic
                                                                 ($this->isBold()?   2 : 0));    // Bit 2 - Bold
        }


        $outlineDictionary->Parent = $parent;
        $outlineDictionary->Prev   = $prev;

        $lastChild = 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) {
                $lastChild = $childOutline->dumpOutline($factory, true, $outlineDictionary, null, $processedOutlines);
                $outlineDictionary->First = $lastChild;
            } else {
                $childOutlineDictionary = $childOutline->dumpOutline($factory, true, $outlineDictionary, $lastChild, $processedOutlines);
                $lastChild->Next = $childOutlineDictionary;
                $lastChild       = $childOutlineDictionary;
            }
        }
        $outlineDictionary->Last = $lastChild;

        if (count($this->childOutlines) != 0) {
            $outlineDictionary->Count = new Zend_Pdf_Element_Numeric(($this->isOpen()? 1 : -1)*count($this->childOutlines));
        }

        return $outlineDictionary;
    }

getColor()

getColor

(

)

Get outline text color.

Returns

Zend_Pdf_Color_Rgb

Definition at line 162 of file Created.php.

    {
        return $this->_color;
    }

getTarget()

getTarget

(

)

Get outline target.

Returns

Zend_Pdf_Target

Definition at line 185 of file Created.php.

    {
        return $this->_target;
    }

getTitle()

getTitle

(

)

Get outline title.

Returns

string

Definition at line 95 of file Created.php.

    {
        return $this->_title;
    }

isBold()

isBold

(

)

Returns true if outline item is displayed in bold

Returns

boolean

Definition at line 139 of file Created.php.

    {
        return $this->_bold;
    }

isItalic()

isItalic

(

)

Returns true if outline item is displayed in italic

Returns

boolean

Definition at line 117 of file Created.php.

    {
        return $this->_italic;
    }

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 174 of file Created.php.

    {
        $this->_color = $color;
        return $this;
    }

setIsBold()

setIsBold

(

$isBold

)

Sets 'isBold' outline flag

Parameters

boolean

$isBold

Returns

Zend_Pdf_Outline

Definition at line 150 of file Created.php.

    {
        $this->_bold = $isBold;
        return $this;
    }

setIsItalic()

setIsItalic

(

$isItalic

)

Sets 'isItalic' outline flag

Parameters

boolean

$isItalic

Returns

Zend_Pdf_Outline

Definition at line 128 of file Created.php.

    {
        $this->_italic = $isItalic;
        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 198 of file Created.php.

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

        if ($target === null  ||  $target instanceof Zend_Pdf_Target) {
            $this->_target = $target;
        } 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 106 of file Created.php.

    {
        $this->_title = $title;
        return $this;
    }

Field Documentation

$_bold

$_bold = false

protected

Definition at line 77 of file Created.php.

$_color

$_color = null

protected

Definition at line 61 of file Created.php.

$_italic

$_italic = false

protected

Definition at line 69 of file Created.php.

$_target

$_target = null

protected

Definition at line 87 of file Created.php.

$_title

$_title

protected

Definition at line 51 of file Created.php.

---

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

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