PHPWord/Classes/PHPWord/Section/Header.php

<?php
/**
 * PHPWord
 *
 * Copyright (c) 2011 PHPWord
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * @category   PHPWord
 * @package    PHPWord
 * @copyright  Copyright (c) 010 PHPWord
 * @license    http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt    LGPL
 * @version    Beta 0.6.3, 08.07.2011
 */


/**
 * PHPWord_Section_Header
 *
 * @category   PHPWord
 * @package    PHPWord_Section
 * @copyright  Copyright (c) 2011 PHPWord
 */
class PHPWord_Section_Header {
	
	/**
	 * Header Count
	 * 
	 * @var int
	 */
	private $_headerCount;
	
	/**
	 * Header Relation ID
	 * 
	 * @var int
	 */
	private $_rId;

	/**
	 * Header type
	 *
	 * @var string
	 * @link http://www.schemacentral.com/sc/ooxml/a-w_type-4.html Header or Footer Type
	 */
	private $_type = PHPWord_Section_Header::AUTO;

	/**
	 * Even Numbered Pages Only
	 * @var string
	 * @link http://www.schemacentral.com/sc/ooxml/a-w_type-4.html Header or Footer Type
	 */
	const EVEN  = 'even';

	/**
	 * Default Header or Footer
	 * @var string
	 * @link http://www.schemacentral.com/sc/ooxml/a-w_type-4.html Header or Footer Type
	 */
	const AUTO  = 'default'; // Did not use DEFAULT because it is a PHP keyword

	/**
	 * First Page Only
	 * @var string
	 * @link http://www.schemacentral.com/sc/ooxml/a-w_type-4.html Header or Footer Type
	 */
	const FIRST = 'first';
	
	/**
	 * Header Element Collection
	 * 
	 * @var int
	 */
	private $_elementCollection = array();
	
	/**
	 * Create a new Header
	 */
	public function __construct($sectionCount) {
		$this->_headerCount = $sectionCount;
	}
	
	/**
	 * Add a Text Element
	 * 
	 * @param string $text
	 * @param mixed $styleFont
	 * @param mixed $styleParagraph
	 * @return PHPWord_Section_Text
	 */
	public function addText($text, $styleFont = null, $styleParagraph = null) {
    if(!PHPWord_Shared_String::IsUTF8($text)){
      $text = utf8_encode($text);
    }
		$text = new PHPWord_Section_Text($text, $styleFont, $styleParagraph);
		$this->_elementCollection[] = $text;
		return $text;
	}
	
	/**
	 * Add a TextBreak Element
	 * 
	 * @param int $count
	 */
	public function addTextBreak($count = 1) {
		for($i=1; $i<=$count; $i++) {
			$this->_elementCollection[] = new PHPWord_Section_TextBreak();
		}
	}
	
	/**
	 * Create a new TextRun
	 * 
	 * @return PHPWord_Section_TextRun
	 */
	public function createTextRun($styleParagraph = null) {
		$textRun = new PHPWord_Section_TextRun($styleParagraph);
		$this->_elementCollection[] = $textRun;
		return $textRun;
	}
	
	/**
	 * Add a Table Element
	 * 
	 * @param mixed $style
	 * @return PHPWord_Section_Table
	 */
	public function addTable($style = null) {
		$table = new PHPWord_Section_Table('header', $this->_headerCount, $style);
		$this->_elementCollection[] = $table;
		return $table;
	}
	
	/**
	 * Add a Image Element
	 * 
	 * @param string $src
	 * @param mixed $style
	 * @return PHPWord_Section_Image
	 */
	public function addImage($src, $style = null) {
		$image = new PHPWord_Section_Image($src, $style);
		
		if(!is_null($image->getSource())) {
			$rID = PHPWord_Media::addHeaderMediaElement($this->_headerCount, $src);
			$image->setRelationId($rID);
			
			$this->_elementCollection[] = $image;
			return $image;
		} else {
			trigger_error('Src does not exist or invalid image type.', E_USER_ERROR);
		}
	}
	
	/**
	 * Add a by PHP created Image Element
	 * 
	 * @param string $link
	 * @param mixed $style
	 * @return PHPWord_Section_MemoryImage
	 */
	public function addMemoryImage($link, $style = null) {
		$memoryImage = new PHPWord_Section_MemoryImage($link, $style);
		if(!is_null($memoryImage->getSource())) {
			$rID = PHPWord_Media::addHeaderMediaElement($this->_headerCount, $link, $memoryImage);
			$memoryImage->setRelationId($rID);
			
			$this->_elementCollection[] = $memoryImage;
			return $memoryImage;
		} else {
			trigger_error('Unsupported image type.');
		}
	}
	
	/**
	 * Add a PreserveText Element
	 * 
	 * @param string $text
	 * @param mixed $styleFont
	 * @param mixed $styleParagraph
	 * @return PHPWord_Section_Footer_PreserveText
	 */
	public function addPreserveText($text, $styleFont = null, $styleParagraph = null) {
    if(!PHPWord_Shared_String::IsUTF8($text)){
      $text = utf8_encode($text);
    }
		$ptext = new PHPWord_Section_Footer_PreserveText($text, $styleFont, $styleParagraph);
		$this->_elementCollection[] = $ptext;
		return $ptext;
	}
	
	/**
	 * Add a Watermark Element
	 * 
	 * @param string $src
	 * @param mixed $style
	 * @return PHPWord_Section_Image
	 */
	public function addWatermark($src, $style = null) {
		$image = new PHPWord_Section_Image($src, $style, true);
		
		if(!is_null($image->getSource())) {
			$rID = PHPWord_Media::addHeaderMediaElement($this->_headerCount, $src);
			$image->setRelationId($rID);
			
			$this->_elementCollection[] = $image;
			return $image;
		} else {
			trigger_error('Src does not exist or invalid image type.', E_USER_ERROR);
		}
	}
	
	/**
	 * Get Header Relation ID
	 */
	public function getRelationId() {
		return $this->_rId;
	}
	
	/**
	 * Set Header Relation ID
	 * 
	 * @param int $rId
	 */
	public function setRelationId($rId) {
		$this->_rId = $rId;
	}
	
	/**
	 * Get all Header Elements
	 */
	public function getElements() {
		return $this->_elementCollection;
	}
	
	/**
	 * Get Header Count
	 */
	public function getHeaderCount() {
		return $this->_headerCount;
	}

	/**
	 * Get Header Type
	 */
	public function getType() {
		return $this->_type;
	}

	/**
	 * Reset back to default
	 */
	public function resetType() {
		return $this->_type = PHPWord_Section_Header::AUTO;
	}

	/**
	 * First page only header
	 */
	public function firstPage() {
		return $this->_type = PHPWord_Section_Header::FIRST;
	}

	/**
	 * Even numbered Pages only
	 */
	public function evenPage() {
		return $this->_type = PHPWord_Section_Header::EVEN;
	}

}
?>