1: <?php
  2: /**
  3:  * PHPWord
  4:  *
  5:  * Copyright (c) 2013 PHPWord
  6:  *
  7:  * This library is free software; you can redistribute it and/or
  8:  * modify it under the terms of the GNU Lesser General Public
  9:  * License as published by the Free Software Foundation; either
 10:  * version 2.1 of the License, or (at your option) any later version.
 11:  *
 12:  * This library is distributed in the hope that it will be useful,
 13:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
 14:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 15:  * Lesser General Public License for more details.
 16:  *
 17:  * You should have received a copy of the GNU Lesser General Public
 18:  * License along with this library; if not, write to the Free Software
 19:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 20:  *
 21:  * @category   PHPWord
 22:  * @package    PHPWord
 23:  * @copyright  Copyright (c) 2013 PHPWord
 24:  * @license    http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt    LGPL
 25:  * @version    0.7.0
 26:  */
 27: 
 28: /**
 29:  * PHPWord_Section_Footer
 30:  */
 31: class PHPWord_Section_Footer
 32: {
 33: 
 34:     /**
 35:      * Footer Count
 36:      *
 37:      * @var int
 38:      */
 39:     private $_footerCount;
 40: 
 41:     /**
 42:      * Footer Relation ID
 43:      *
 44:      * @var int
 45:      */
 46:     private $_rId;
 47: 
 48:     /**
 49:      * Footer Element Collection
 50:      *
 51:      * @var int
 52:      */
 53:     private $_elementCollection = array();
 54: 
 55:     /**
 56:      * Create a new Footer
 57:      */
 58:     public function __construct($sectionCount)
 59:     {
 60:         $this->_footerCount = $sectionCount;
 61:     }
 62: 
 63:     /**
 64:      * Add a Text Element
 65:      *
 66:      * @param string $text
 67:      * @param mixed $styleFont
 68:      * @param mixed $styleParagraph
 69:      * @return PHPWord_Section_Text
 70:      */
 71:     public function addText($text, $styleFont = null, $styleParagraph = null)
 72:     {
 73:         if (!PHPWord_Shared_String::IsUTF8($text)) {
 74:             $text = utf8_encode($text);
 75:         }
 76:         $text = new PHPWord_Section_Text($text, $styleFont, $styleParagraph);
 77:         $this->_elementCollection[] = $text;
 78:         return $text;
 79:     }
 80: 
 81:     /**
 82:      * Add a TextBreak Element
 83:      *
 84:      * @param int $count
 85:      */
 86:     public function addTextBreak($count = 1)
 87:     {
 88:         for ($i = 1; $i <= $count; $i++) {
 89:             $this->_elementCollection[] = new PHPWord_Section_TextBreak();
 90:         }
 91:     }
 92: 
 93:     /**
 94:      * Create a new TextRun
 95:      *
 96:      * @return PHPWord_Section_TextRun
 97:      */
 98:     public function createTextRun($styleParagraph = null)
 99:     {
100:         $textRun = new PHPWord_Section_TextRun($styleParagraph);
101:         $this->_elementCollection[] = $textRun;
102:         return $textRun;
103:     }
104: 
105:     /**
106:      * Add a Table Element
107:      *
108:      * @param mixed $style
109:      * @return PHPWord_Section_Table
110:      */
111:     public function addTable($style = null)
112:     {
113:         $table = new PHPWord_Section_Table('footer', $this->_footerCount, $style);
114:         $this->_elementCollection[] = $table;
115:         return $table;
116:     }
117: 
118:     /**
119:      * Add a Image Element
120:      *
121:      * @param string $src
122:      * @param mixed $style
123:      * @return PHPWord_Section_Image
124:      */
125:     public function addImage($src, $style = null)
126:     {
127:         $image = new PHPWord_Section_Image($src, $style);
128: 
129:         if (!is_null($image->getSource())) {
130:             $rID = PHPWord_Media::addFooterMediaElement($this->_footerCount, $src);
131:             $image->setRelationId($rID);
132: 
133:             $this->_elementCollection[] = $image;
134:             return $image;
135:         } else {
136:             trigger_error('Src does not exist or invalid image type.', E_USER_ERROR);
137:         }
138:     }
139: 
140:     /**
141:      * Add a by PHP created Image Element
142:      *
143:      * @param string $link
144:      * @param mixed $style
145:      * @return PHPWord_Section_MemoryImage
146:      */
147:     public function addMemoryImage($link, $style = null)
148:     {
149:         $memoryImage = new PHPWord_Section_MemoryImage($link, $style);
150:         if (!is_null($memoryImage->getSource())) {
151:             $rID = PHPWord_Media::addFooterMediaElement($this->_footerCount, $link, $memoryImage);
152:             $memoryImage->setRelationId($rID);
153: 
154:             $this->_elementCollection[] = $memoryImage;
155:             return $memoryImage;
156:         } else {
157:             trigger_error('Unsupported image type.');
158:         }
159:     }
160: 
161:     /**
162:      * Add a PreserveText Element
163:      *
164:      * @param string $text
165:      * @param mixed $styleFont
166:      * @param mixed $styleParagraph
167:      * @return PHPWord_Section_Footer_PreserveText
168:      */
169:     public function addPreserveText($text, $styleFont = null, $styleParagraph = null)
170:     {
171:         if (!PHPWord_Shared_String::IsUTF8($text)) {
172:             $text = utf8_encode($text);
173:         }
174:         $ptext = new PHPWord_Section_Footer_PreserveText($text, $styleFont, $styleParagraph);
175:         $this->_elementCollection[] = $ptext;
176:         return $ptext;
177:     }
178: 
179:     /**
180:      * Get Footer Relation ID
181:      */
182:     public function getRelationId()
183:     {
184:         return $this->_rId;
185:     }
186: 
187:     /**
188:      * Set Footer Relation ID
189:      *
190:      * @param int $rId
191:      */
192:     public function setRelationId($rId)
193:     {
194:         $this->_rId = $rId;
195:     }
196: 
197:     /**
198:      * Get all Footer Elements
199:      */
200:     public function getElements()
201:     {
202:         return $this->_elementCollection;
203:     }
204: 
205:     /**
206:      * Get Footer Count
207:      */
208:     public function getFooterCount()
209:     {
210:         return $this->_footerCount;
211:     }
212: }