Zend_Pdf_Outline Class Reference

Inheritance diagram for Zend_Pdf_Outline:

Public Member Functions
	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 ()

Static Public Member Functions
static	create ($param1, $param2=null)

Data Fields
	$childOutlines = array()

Protected Attributes
	$_open = false

Detailed Description

Definition at line 34 of file Outline.php.

Member Function Documentation

count()

count

(

)

count()

Returns

int

Definition at line 369 of file Outline.php.

    {
        return count($this->childOutlines);
    }

create()

static create (   $param1,   $param2 = null  )

static

Create new Outline object

It provides two forms of input parameters:

1. Zend_Pdf_Outline::create(string $title[, Zend_Pdf_Target $target])
2. Zend_Pdf_Outline::create(array $options)

Second form allows to provide outline options as an array. The followed options are supported: 'title' - string, outline title, required 'open' - boolean, true if outline entry is open (default value is false) 'color' - Zend_Pdf_Color_Rgb object, true if outline entry is open (default value is null - black) 'italic' - boolean, true if outline entry is displayed in italic (default value is false) 'bold' - boolean, true if outline entry is displayed in bold (default value is false) 'target' - Zend_Pdf_Target object or string, outline item destination

Returns

Zend_Pdf_Outline

Exceptions

Zend_Pdf_Exception

Definition at line 230 of file Outline.php.

    {
        #require_once 'Zend/Pdf/Outline/Created.php';
        if (is_string($param1)) {
            if ($param2 !== null  &&  !($param2 instanceof Zend_Pdf_Target  ||  is_string($param2))) {
                #require_once 'Zend/Pdf/Exception.php';
                throw new Zend_Pdf_Exception('Outline create method takes $title (string) and $target (Zend_Pdf_Target or string) or an array as an input');
            }

            return new Zend_Pdf_Outline_Created(array('title'  => $param1,
                                                      'target' => $param2));
        } else {
            if (!is_array($param1)  ||  $param2 !== null) {
                #require_once 'Zend/Pdf/Exception.php';
                throw new Zend_Pdf_Exception('Outline create method takes $title (string) and $destination (Zend_Pdf_Destination) or an array as an input');
            }

            return new Zend_Pdf_Outline_Created($param1);
        }
    }

current()

current

(

)

Returns the child outline.

Returns

Zend_Pdf_Outline

Definition at line 298 of file Outline.php.

    {
        return current($this->childOutlines);
    }

dumpOutline()

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

abstract

Dump Outline and its child outlines into PDF structures

Returns dictionary indirect object or reference

Parameters

Zend_Pdf_ElementFactory	$factory	object factory for newly created indirect objects
boolean	$updateNavigation	Update navigation flag
Zend_Pdf_Element	$parent	Parent outline dictionary reference
Zend_Pdf_Element	$prev	Previous outline dictionary reference
SplObjectStorage	$processedOutlines	List of already processed outlines

Returns

Zend_Pdf_Element

getChildren()

getChildren

(

)

Returns the child outline.

Returns

Zend_Pdf_Outline|null

Definition at line 344 of file Outline.php.

    {
        return current($this->childOutlines);
    }

getColor()

getColor ( )

abstract

Get outline text color.

Returns

Zend_Pdf_Color_Rgb

getOptions()

getOptions

(

)

Get outline options

Returns

array

Definition at line 156 of file Outline.php.

    {
        return array('title'  => $this->_title,
                     'open'   => $this->_open,
                     'color'  => $this->_color,
                     'italic' => $this->_italic,
                     'bold'   => $this->_bold,
                     'target' => $this->_target);
    }

getTarget()

getTarget ( )

abstract

Get outline target.

Returns

Zend_Pdf_Target

getTitle()

getTitle ( )

abstract

Get outline title.

Returns

string

hasChildren()

hasChildren

(

)

Implements RecursiveIterator interface.

Returns

bool whether container has any pages

Definition at line 354 of file Outline.php.

    {
        return count($this->childOutlines) > 0;
    }

isBold()

isBold ( )

abstract

Returns true if outline item is displayed in bold

Returns

boolean

isItalic()

isItalic ( )

abstract

Returns true if outline item is displayed in italic

Returns

boolean

isOpen()

isOpen

(

)

Returns true if outline item is open by default

Returns

boolean

Definition at line 71 of file Outline.php.

    {
        return $this->_open;
    }

key()

key

(

)

Returns current iterator key

Returns

integer

Definition at line 308 of file Outline.php.

    {
        return key($this->childOutlines);
    }

next()

next

(

)

Go to next child

Definition at line 316 of file Outline.php.

    {
        return next($this->childOutlines);
    }

openOutlinesCount()

openOutlinesCount

(

)

Returns number of the total number of open items at all levels of the outline.

Definition at line 257 of file Outline.php.

    {
        $count = 1; // Include this outline

        if ($this->isOpen()) {
            foreach ($this->childOutlines as $child) {
                $count += $child->openOutlinesCount();
            }
        }

        return $count;
    }

rewind()

rewind

(

)

Rewind children

Definition at line 324 of file Outline.php.

    {
        return reset($this->childOutlines);
    }

setColor()

setColor ( Zend_Pdf_Color_Rgb  $color )

abstract

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

Parameters

Zend_Pdf_Color_Rgb

$color

Returns

Zend_Pdf_Outline

setIsBold()

setIsBold (   $isBold )

abstract

Sets 'isBold' outline flag

Parameters

boolean

$isBold

Returns

Zend_Pdf_Outline

setIsItalic()

setIsItalic (   $isItalic )

abstract

Sets 'isItalic' outline flag

Parameters

boolean

$isItalic

Returns

Zend_Pdf_Outline

setIsOpen()

setIsOpen

(

$isOpen

)

Sets 'isOpen' outline flag

Parameters

boolean

$isOpen

Returns

Zend_Pdf_Outline

Definition at line 82 of file Outline.php.

    {
        $this->_open = $isOpen;
        return $this;
    }

setOptions()

setOptions

(

array

$options

)

Set outline options

Parameters

array

$options

Returns

Zend_Pdf_Action

Exceptions

Zend_Pdf_Exception

Definition at line 173 of file Outline.php.

    {
        foreach ($options as $key => $value) {
            switch ($key) {
                case 'title':
                    $this->setTitle($value);
                    break;

                case 'open':
                    $this->setIsOpen($value);
                    break;

                case 'color':
                    $this->setColor($value);
                    break;
                case 'italic':
                    $this->setIsItalic($value);
                    break;

                case 'bold':
                    $this->setIsBold($value);
                    break;

                case 'target':
                    $this->setTarget($value);
                    break;

                default:
                    #require_once 'Zend/Pdf/Exception.php';
                    throw new Zend_Pdf_Exception("Unknown option name - '$key'.");
                    break;
            }
        }

        return $this;
    }

setTarget()

setTarget (   $target = null )

abstract

Set outline target. Null means no target

Parameters

Zend_Pdf_Target | string

$target

Returns

Zend_Pdf_Outline

setTitle()

setTitle (   $title )

abstract

Set outline title

Parameters

string

$title

Returns

Zend_Pdf_Outline

valid()

valid

(

)

Check if current position is valid

Returns

boolean

Definition at line 334 of file Outline.php.

    {
        return current($this->childOutlines) !== false;
    }

Field Documentation

$_open

$_open = false

protected

Definition at line 41 of file Outline.php.

$childOutlines

$childOutlines = array()

Definition at line 48 of file Outline.php.

---

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

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