Outline.php

Go to the documentation of this file.

<?php
abstract class Zend_Pdf_Outline implements RecursiveIterator, Countable
{
    protected $_open = false;

    public $childOutlines = array();


    abstract public function getTitle();

    abstract public function setTitle($title);

    public function isOpen()
    {
        return $this->_open;
    }

    public function setIsOpen($isOpen)
    {
        $this->_open = $isOpen;
        return $this;
    }

    abstract public function isItalic();

    abstract public function setIsItalic($isItalic);

    abstract public function isBold();

    abstract public function setIsBold($isBold);


    abstract public function getColor();

    abstract public function setColor(Zend_Pdf_Color_Rgb $color);

    abstract public function getTarget();

    abstract public function setTarget($target = null);

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

    public function setOptions(array $options)
    {
        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;
    }

    public static function create($param1, $param2 = null)
    {
        #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);
        }
    }

    public function openOutlinesCount()
    {
        $count = 1; // Include this outline

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

        return $count;
    }

    abstract public function dumpOutline(Zend_Pdf_ElementFactory_Interface $factory,
                                                                           $updateNavigation,
                                                          Zend_Pdf_Element $parent,
                                                          Zend_Pdf_Element $prev = null,
                                                          SplObjectStorage $processedOutlines = null);


    //  RecursiveIterator interface methods

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

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

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

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

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

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

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


    //  Countable interface methods

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