ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
Public Member Functions
PHPExcel_Writer_Excel2007_StringTable Class Reference
+ Inheritance diagram for PHPExcel_Writer_Excel2007_StringTable:
+ Collaboration diagram for PHPExcel_Writer_Excel2007_StringTable:

Public Member Functions

 createStringTable ($pSheet=null, $pExistingTable=null)
 Create worksheet stringtable. More...
 
 writeStringTable ($pStringTable=null)
 Write string table to XML format. More...
 
 writeRichText (PHPExcel_Shared_XMLWriter $objWriter=null, PHPExcel_RichText $pRichText=null, $prefix=NULL)
 Write Rich Text. More...
 
 writeRichTextForCharts (PHPExcel_Shared_XMLWriter $objWriter=null, $pRichText=null, $prefix=NULL)
 Write Rich Text. More...
 
 flipStringTable ($stringTable=array())
 Flip string table (for index searching) More...
 
- Public Member Functions inherited from PHPExcel_Writer_Excel2007_WriterPart
 setParentWriter (PHPExcel_Writer_IWriter $pWriter=null)
 Set parent IWriter object. More...
 
 getParentWriter ()
 Get parent IWriter object. More...
 
 __construct (PHPExcel_Writer_IWriter $pWriter=null)
 Set parent IWriter object. More...
 

Detailed Description

Definition at line 36 of file StringTable.php.

Member Function Documentation

◆ createStringTable()

PHPExcel_Writer_Excel2007_StringTable::createStringTable (   $pSheet = null,
  $pExistingTable = null 
)

Create worksheet stringtable.

Parameters
PHPExcel_Worksheet$pSheetWorksheet
string[]$pExistingTableExisting table to eventually merge with
Returns
string[] String table for worksheet
Exceptions
PHPExcel_Writer_Exception

Definition at line 46 of file StringTable.php.

47 {
48 if ($pSheet !== NULL) {
49 // Create string lookup table
50 $aStringTable = array();
51 $cellCollection = null;
52 $aFlippedStringTable = null; // For faster lookup
53
54 // Is an existing table given?
55 if (($pExistingTable !== NULL) && is_array($pExistingTable)) {
56 $aStringTable = $pExistingTable;
57 }
58
59 // Fill index array
60 $aFlippedStringTable = $this->flipStringTable($aStringTable);
61
62 // Loop through cells
63 foreach ($pSheet->getCellCollection() as $cellID) {
64 $cell = $pSheet->getCell($cellID);
65 $cellValue = $cell->getValue();
66 if (!is_object($cellValue) &&
67 ($cellValue !== NULL) &&
68 $cellValue !== '' &&
69 !isset($aFlippedStringTable[$cellValue]) &&
70 ($cell->getDataType() == PHPExcel_Cell_DataType::TYPE_STRING || $cell->getDataType() == PHPExcel_Cell_DataType::TYPE_STRING2 || $cell->getDataType() == PHPExcel_Cell_DataType::TYPE_NULL)) {
71 $aStringTable[] = $cellValue;
72 $aFlippedStringTable[$cellValue] = true;
73 } elseif ($cellValue instanceof PHPExcel_RichText &&
74 ($cellValue !== NULL) &&
75 !isset($aFlippedStringTable[$cellValue->getHashCode()])) {
76 $aStringTable[] = $cellValue;
77 $aFlippedStringTable[$cellValue->getHashCode()] = true;
78 }
79 }
80
81 // Return
82 return $aStringTable;
83 } else {
84 throw new PHPExcel_Writer_Exception("Invalid PHPExcel_Worksheet object passed.");
85 }
86 }
PHPExcel_Cell_DataType\TYPE_STRING2
const TYPE_STRING2
Definition: DataType.php:39
PHPExcel_Cell_DataType\TYPE_NULL
const TYPE_NULL
Definition: DataType.php:44
PHPExcel_Cell_DataType\TYPE_STRING
const TYPE_STRING
Definition: DataType.php:40
PHPExcel_Writer_Excel2007_StringTable\flipStringTable
flipStringTable($stringTable=array())
Flip string table (for index searching)
Definition: StringTable.php:303
PHPExcel_Writer_Exception
Definition: Exception.php:36
PHPExcel_RichText

References flipStringTable(), PHPExcel_Cell_DataType\TYPE_NULL, PHPExcel_Cell_DataType\TYPE_STRING, and PHPExcel_Cell_DataType\TYPE_STRING2.

+ Here is the call graph for this function:

◆ flipStringTable()

PHPExcel_Writer_Excel2007_StringTable::flipStringTable (   $stringTable = array())

Flip string table (for index searching)

Parameters
array$stringTableStringtable
Returns
array

Definition at line 303 of file StringTable.php.

303 {
304 // Return value
305 $returnValue = array();
306
307 // Loop through stringtable and add flipped items to $returnValue
308 foreach ($stringTable as $key => $value) {
309 if (! $value instanceof PHPExcel_RichText) {
310 $returnValue[$value] = $key;
311 } else if ($value instanceof PHPExcel_RichText) {
312 $returnValue[$value->getHashCode()] = $key;
313 }
314 }
315
316 // Return
317 return $returnValue;
318 }
$key
$key
Definition: croninfo.php:18

References $key.

Referenced by createStringTable().

+ Here is the caller graph for this function:

◆ writeRichText()

PHPExcel_Writer_Excel2007_StringTable::writeRichText ( PHPExcel_Shared_XMLWriter  $objWriter = null,
PHPExcel_RichText  $pRichText = null,
  $prefix = NULL 
)

Write Rich Text.

Parameters
PHPExcel_Shared_XMLWriter$objWriterXML Writer
PHPExcel_RichText$pRichTextRich text
string$prefixOptional Namespace prefix
Exceptions
PHPExcel_Writer_Exception

Definition at line 150 of file StringTable.php.

151 {
152 if ($prefix !== NULL)
153 $prefix .= ':';
154 // Loop through rich text elements
155 $elements = $pRichText->getRichTextElements();
156 foreach ($elements as $element) {
157 // r
158 $objWriter->startElement($prefix.'r');
159
160 // rPr
161 if ($element instanceof PHPExcel_RichText_Run) {
162 // rPr
163 $objWriter->startElement($prefix.'rPr');
164
165 // rFont
166 $objWriter->startElement($prefix.'rFont');
167 $objWriter->writeAttribute('val', $element->getFont()->getName());
168 $objWriter->endElement();
169
170 // Bold
171 $objWriter->startElement($prefix.'b');
172 $objWriter->writeAttribute('val', ($element->getFont()->getBold() ? 'true' : 'false'));
173 $objWriter->endElement();
174
175 // Italic
176 $objWriter->startElement($prefix.'i');
177 $objWriter->writeAttribute('val', ($element->getFont()->getItalic() ? 'true' : 'false'));
178 $objWriter->endElement();
179
180 // Superscript / subscript
181 if ($element->getFont()->getSuperScript() || $element->getFont()->getSubScript()) {
182 $objWriter->startElement($prefix.'vertAlign');
183 if ($element->getFont()->getSuperScript()) {
184 $objWriter->writeAttribute('val', 'superscript');
185 } else if ($element->getFont()->getSubScript()) {
186 $objWriter->writeAttribute('val', 'subscript');
187 }
188 $objWriter->endElement();
189 }
190
191 // Strikethrough
192 $objWriter->startElement($prefix.'strike');
193 $objWriter->writeAttribute('val', ($element->getFont()->getStrikethrough() ? 'true' : 'false'));
194 $objWriter->endElement();
195
196 // Color
197 $objWriter->startElement($prefix.'color');
198 $objWriter->writeAttribute('rgb', $element->getFont()->getColor()->getARGB());
199 $objWriter->endElement();
200
201 // Size
202 $objWriter->startElement($prefix.'sz');
203 $objWriter->writeAttribute('val', $element->getFont()->getSize());
204 $objWriter->endElement();
205
206 // Underline
207 $objWriter->startElement($prefix.'u');
208 $objWriter->writeAttribute('val', $element->getFont()->getUnderline());
209 $objWriter->endElement();
210
211 $objWriter->endElement();
212 }
213
214 // t
215 $objWriter->startElement($prefix.'t');
216 $objWriter->writeAttribute('xml:space', 'preserve');
217 $objWriter->writeRawData(PHPExcel_Shared_String::ControlCharacterPHP2OOXML( $element->getText() ));
218 $objWriter->endElement();
219
220 $objWriter->endElement();
221 }
222 }
$objWriter
$objWriter
Definition: 01pharSimple.php:81
PHPExcel_RichText_Run
Definition: Run.php:35
PHPExcel_RichText\getRichTextElements
getRichTextElements()
Get Rich Text elements.
Definition: RichText.php:145
PHPExcel_Shared_String\ControlCharacterPHP2OOXML
static ControlCharacterPHP2OOXML($value='')
Convert from PHP control character to OpenXML escaped control character.
Definition: String.php:373

References $objWriter, and PHPExcel_Shared_String\ControlCharacterPHP2OOXML().

Referenced by writeStringTable().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ writeRichTextForCharts()

PHPExcel_Writer_Excel2007_StringTable::writeRichTextForCharts ( PHPExcel_Shared_XMLWriter  $objWriter = null,
  $pRichText = null,
  $prefix = NULL 
)

Write Rich Text.

Parameters
PHPExcel_Shared_XMLWriter$objWriterXML Writer
string | PHPExcel_RichText$pRichTexttext string or Rich text
string$prefixOptional Namespace prefix
Exceptions
PHPExcel_Writer_Exception

Definition at line 232 of file StringTable.php.

233 {
234 if (!$pRichText instanceof PHPExcel_RichText) {
235 $textRun = $pRichText;
236 $pRichText = new PHPExcel_RichText();
237 $pRichText->createTextRun($textRun);
238 }
239
240 if ($prefix !== NULL)
241 $prefix .= ':';
242 // Loop through rich text elements
243 $elements = $pRichText->getRichTextElements();
244 foreach ($elements as $element) {
245 // r
246 $objWriter->startElement($prefix.'r');
247
248 // rPr
249 $objWriter->startElement($prefix.'rPr');
250
251 // Bold
252 $objWriter->writeAttribute('b', ($element->getFont()->getBold() ? 1 : 0));
253 // Italic
254 $objWriter->writeAttribute('i', ($element->getFont()->getItalic() ? 1 : 0));
255 // Underline
256 $underlineType = $element->getFont()->getUnderline();
257 switch($underlineType) {
258 case 'single' :
259 $underlineType = 'sng';
260 break;
261 case 'double' :
262 $underlineType = 'dbl';
263 break;
264 }
265 $objWriter->writeAttribute('u', $underlineType);
266 // Strikethrough
267 $objWriter->writeAttribute('strike', ($element->getFont()->getStrikethrough() ? 'sngStrike' : 'noStrike'));
268
269 // rFont
270 $objWriter->startElement($prefix.'latin');
271 $objWriter->writeAttribute('typeface', $element->getFont()->getName());
272 $objWriter->endElement();
273
274 // Superscript / subscript
275// if ($element->getFont()->getSuperScript() || $element->getFont()->getSubScript()) {
276// $objWriter->startElement($prefix.'vertAlign');
277// if ($element->getFont()->getSuperScript()) {
278// $objWriter->writeAttribute('val', 'superscript');
279// } else if ($element->getFont()->getSubScript()) {
280// $objWriter->writeAttribute('val', 'subscript');
281// }
282// $objWriter->endElement();
283// }
284//
285 $objWriter->endElement();
286
287 // t
288 $objWriter->startElement($prefix.'t');
289// $objWriter->writeAttribute('xml:space', 'preserve'); // Excel2010 accepts, Excel2007 complains
290 $objWriter->writeRawData(PHPExcel_Shared_String::ControlCharacterPHP2OOXML( $element->getText() ));
291 $objWriter->endElement();
292
293 $objWriter->endElement();
294 }
295 }

References $objWriter, and PHPExcel_Shared_String\ControlCharacterPHP2OOXML().

+ Here is the call graph for this function:

◆ writeStringTable()

PHPExcel_Writer_Excel2007_StringTable::writeStringTable (   $pStringTable = null)

Write string table to XML format.

Parameters
string[]$pStringTable
Returns
string XML Output
Exceptions
PHPExcel_Writer_Exception

Definition at line 95 of file StringTable.php.

96 {
97 if ($pStringTable !== NULL) {
98 // Create XML writer
99 $objWriter = null;
100 if ($this->getParentWriter()->getUseDiskCaching()) {
101 $objWriter = new PHPExcel_Shared_XMLWriter(PHPExcel_Shared_XMLWriter::STORAGE_DISK, $this->getParentWriter()->getDiskCachingDirectory());
102 } else {
103 $objWriter = new PHPExcel_Shared_XMLWriter(PHPExcel_Shared_XMLWriter::STORAGE_MEMORY);
104 }
105
106 // XML header
107 $objWriter->startDocument('1.0','UTF-8','yes');
108
109 // String table
110 $objWriter->startElement('sst');
111 $objWriter->writeAttribute('xmlns', 'http://schemas.openxmlformats.org/spreadsheetml/2006/main');
112 $objWriter->writeAttribute('uniqueCount', count($pStringTable));
113
114 // Loop through string table
115 foreach ($pStringTable as $textElement) {
116 $objWriter->startElement('si');
117
118 if (! $textElement instanceof PHPExcel_RichText) {
119 $textToWrite = PHPExcel_Shared_String::ControlCharacterPHP2OOXML( $textElement );
120 $objWriter->startElement('t');
121 if ($textToWrite !== trim($textToWrite)) {
122 $objWriter->writeAttribute('xml:space', 'preserve');
123 }
124 $objWriter->writeRawData($textToWrite);
125 $objWriter->endElement();
126 } else if ($textElement instanceof PHPExcel_RichText) {
127 $this->writeRichText($objWriter, $textElement);
128 }
129
130 $objWriter->endElement();
131 }
132
133 $objWriter->endElement();
134
135 // Return
136 return $objWriter->getData();
137 } else {
138 throw new PHPExcel_Writer_Exception("Invalid string table array passed.");
139 }
140 }
PHPExcel_Shared_XMLWriter
Definition: XMLWriter.php:44
PHPExcel_Shared_XMLWriter\STORAGE_DISK
const STORAGE_DISK
Definition: XMLWriter.php:47
PHPExcel_Shared_XMLWriter\STORAGE_MEMORY
const STORAGE_MEMORY
Temporary storage method.
Definition: XMLWriter.php:46
PHPExcel_Writer_Excel2007_StringTable\writeRichText
writeRichText(PHPExcel_Shared_XMLWriter $objWriter=null, PHPExcel_RichText $pRichText=null, $prefix=NULL)
Write Rich Text.
Definition: StringTable.php:150
PHPExcel_Writer_Excel2007_WriterPart\getParentWriter
getParentWriter()
Get parent IWriter object.
Definition: WriterPart.php:61

References $objWriter, PHPExcel_Shared_String\ControlCharacterPHP2OOXML(), PHPExcel_Writer_Excel2007_WriterPart\getParentWriter(), PHPExcel_Shared_XMLWriter\STORAGE_DISK, PHPExcel_Shared_XMLWriter\STORAGE_MEMORY, and writeRichText().

+ Here is the call graph for this function:
The documentation for this class was generated from the following file: