PHPOffice /
PhpSpreadsheet
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like Content often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Content, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 49 | class Content extends WriterPart |
||
| 50 | { |
||
| 51 | const NUMBER_COLS_REPEATED_MAX = 1024; |
||
| 52 | const NUMBER_ROWS_REPEATED_MAX = 1048576; |
||
| 53 | const CELL_STYLE_PREFIX = 'ce'; |
||
| 54 | |||
| 55 | /** |
||
| 56 | * Write content.xml to XML format. |
||
| 57 | * |
||
| 58 | * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception |
||
| 59 | * |
||
| 60 | * @return string XML Output |
||
| 61 | */ |
||
| 62 | 2 | public function write() |
|
| 131 | |||
| 132 | /** |
||
| 133 | * Write sheets. |
||
| 134 | * |
||
| 135 | * @param XMLWriter $objWriter |
||
| 136 | */ |
||
| 137 | 2 | private function writeSheets(XMLWriter $objWriter) |
|
| 138 | { |
||
| 139 | 2 | $spreadsheet = $this->getParentWriter()->getSpreadsheet(); /* @var $spreadsheet Spreadsheet */ |
|
| 140 | |||
| 141 | 2 | $sheetCount = $spreadsheet->getSheetCount(); |
|
| 142 | 2 | for ($i = 0; $i < $sheetCount; ++$i) { |
|
| 143 | 2 | $objWriter->startElement('table:table'); |
|
| 144 | 2 | $objWriter->writeAttribute('table:name', $spreadsheet->getSheet($i)->getTitle()); |
|
| 145 | 2 | $objWriter->writeElement('office:forms'); |
|
| 146 | 2 | $objWriter->startElement('table:table-column'); |
|
| 147 | 2 | $objWriter->writeAttribute('table:number-columns-repeated', self::NUMBER_COLS_REPEATED_MAX); |
|
| 148 | 2 | $objWriter->endElement(); |
|
| 149 | 2 | $this->writeRows($objWriter, $spreadsheet->getSheet($i)); |
|
| 150 | 2 | $objWriter->endElement(); |
|
| 151 | } |
||
| 152 | 2 | } |
|
| 153 | |||
| 154 | /** |
||
| 155 | * Write rows of the specified sheet. |
||
| 156 | * |
||
| 157 | * @param XMLWriter $objWriter |
||
| 158 | * @param Worksheet $sheet |
||
| 159 | */ |
||
| 160 | 2 | private function writeRows(XMLWriter $objWriter, Worksheet $sheet) |
|
| 161 | { |
||
| 162 | 2 | $numberRowsRepeated = self::NUMBER_ROWS_REPEATED_MAX; |
|
| 163 | 2 | $span_row = 0; |
|
| 164 | 2 | $rows = $sheet->getRowIterator(); |
|
| 165 | 2 | while ($rows->valid()) { |
|
| 166 | 2 | --$numberRowsRepeated; |
|
| 167 | 2 | $row = $rows->current(); |
|
| 168 | 2 | if ($row->getCellIterator()->valid()) { |
|
| 169 | 2 | if ($span_row) { |
|
| 170 | $objWriter->startElement('table:table-row'); |
||
| 171 | if ($span_row > 1) { |
||
| 172 | $objWriter->writeAttribute('table:number-rows-repeated', $span_row); |
||
| 173 | } |
||
| 174 | $objWriter->startElement('table:table-cell'); |
||
| 175 | $objWriter->writeAttribute('table:number-columns-repeated', self::NUMBER_COLS_REPEATED_MAX); |
||
| 176 | $objWriter->endElement(); |
||
| 177 | $objWriter->endElement(); |
||
| 178 | $span_row = 0; |
||
| 179 | } |
||
| 180 | 2 | $objWriter->startElement('table:table-row'); |
|
| 181 | 2 | $this->writeCells($objWriter, $row); |
|
| 182 | 2 | $objWriter->endElement(); |
|
| 183 | } else { |
||
| 184 | ++$span_row; |
||
| 185 | } |
||
| 186 | 2 | $rows->next(); |
|
| 187 | } |
||
| 188 | 2 | } |
|
| 189 | |||
| 190 | /** |
||
| 191 | * Write cells of the specified row. |
||
| 192 | * |
||
| 193 | * @param XMLWriter $objWriter |
||
| 194 | * @param Worksheet\Row $row |
||
| 195 | * |
||
| 196 | * @throws Exception |
||
| 197 | */ |
||
| 198 | 2 | private function writeCells(XMLWriter $objWriter, Worksheet\Row $row) |
|
| 199 | { |
||
| 200 | 2 | $numberColsRepeated = self::NUMBER_COLS_REPEATED_MAX; |
|
| 201 | 2 | $prevColumn = -1; |
|
| 202 | 2 | $cells = $row->getCellIterator(); |
|
| 203 | 2 | while ($cells->valid()) { |
|
| 204 | /** @var Cell $cell */ |
||
| 205 | 2 | $cell = $cells->current(); |
|
| 206 | 2 | $column = Cell::columnIndexFromString($cell->getColumn()) - 1; |
|
| 207 | |||
| 208 | 2 | $this->writeCellSpan($objWriter, $column, $prevColumn); |
|
| 209 | 2 | $objWriter->startElement('table:table-cell'); |
|
| 210 | |||
| 211 | // Style XF |
||
| 212 | 2 | $style = $cell->getXfIndex(); |
|
| 213 | 2 | if ($style !== null) { |
|
| 214 | 2 | $objWriter->writeAttribute('table:style-name', self::CELL_STYLE_PREFIX . $style); |
|
| 215 | } |
||
| 216 | |||
| 217 | 2 | switch ($cell->getDataType()) { |
|
| 218 | 2 | View Code Duplication | case DataType::TYPE_BOOL: |
| 219 | 1 | $objWriter->writeAttribute('office:value-type', 'boolean'); |
|
| 220 | 1 | $objWriter->writeAttribute('office:value', $cell->getValue()); |
|
| 221 | 1 | $objWriter->writeElement('text:p', $cell->getValue()); |
|
| 222 | 1 | break; |
|
| 223 | 2 | case DataType::TYPE_ERROR: |
|
| 224 | throw new Exception('Writing of error not implemented yet.'); |
||
| 225 | break; |
||
| 226 | 2 | case DataType::TYPE_FORMULA: |
|
| 227 | try { |
||
| 228 | 1 | $formulaValue = $cell->getCalculatedValue(); |
|
| 229 | } catch (\Exception $e) { |
||
| 230 | $formulaValue = $cell->getValue(); |
||
| 231 | } |
||
| 232 | 1 | $objWriter->writeAttribute('table:formula', 'of:' . $cell->getValue()); |
|
| 233 | 1 | if (is_numeric($formulaValue)) { |
|
| 234 | $objWriter->writeAttribute('office:value-type', 'float'); |
||
| 235 | } else { |
||
| 236 | 1 | $objWriter->writeAttribute('office:value-type', 'string'); |
|
| 237 | } |
||
| 238 | 1 | $objWriter->writeAttribute('office:value', $formulaValue); |
|
| 239 | 1 | $objWriter->writeElement('text:p', $formulaValue); |
|
| 240 | 1 | break; |
|
| 241 | 2 | case DataType::TYPE_INLINE: |
|
| 242 | throw new Exception('Writing of inline not implemented yet.'); |
||
| 243 | break; |
||
| 244 | 2 | View Code Duplication | case DataType::TYPE_NUMERIC: |
| 245 | 1 | $objWriter->writeAttribute('office:value-type', 'float'); |
|
| 246 | 1 | $objWriter->writeAttribute('office:value', $cell->getValue()); |
|
| 247 | 1 | $objWriter->writeElement('text:p', $cell->getValue()); |
|
| 248 | 1 | break; |
|
| 249 | 2 | case DataType::TYPE_STRING: |
|
| 250 | 1 | $objWriter->writeAttribute('office:value-type', 'string'); |
|
| 251 | 1 | $objWriter->writeElement('text:p', $cell->getValue()); |
|
| 252 | 1 | break; |
|
| 253 | } |
||
| 254 | 2 | Comment::write($objWriter, $cell); |
|
| 255 | 2 | $objWriter->endElement(); |
|
| 256 | 2 | $prevColumn = $column; |
|
| 257 | 2 | $cells->next(); |
|
| 258 | } |
||
| 259 | 2 | $numberColsRepeated = $numberColsRepeated - $prevColumn - 1; |
|
| 260 | 2 | View Code Duplication | if ($numberColsRepeated > 0) { |
| 261 | 2 | if ($numberColsRepeated > 1) { |
|
| 262 | 2 | $objWriter->startElement('table:table-cell'); |
|
| 263 | 2 | $objWriter->writeAttribute('table:number-columns-repeated', $numberColsRepeated); |
|
| 264 | 2 | $objWriter->endElement(); |
|
| 265 | } else { |
||
| 266 | $objWriter->writeElement('table:table-cell'); |
||
| 267 | } |
||
| 268 | } |
||
| 269 | 2 | } |
|
| 270 | |||
| 271 | /** |
||
| 272 | * Write span. |
||
| 273 | * |
||
| 274 | * @param XMLWriter $objWriter |
||
| 275 | * @param int $curColumn |
||
| 276 | * @param int $prevColumn |
||
| 277 | */ |
||
| 278 | 2 | private function writeCellSpan(XMLWriter $objWriter, $curColumn, $prevColumn) |
|
| 289 | |||
| 290 | /** |
||
| 291 | * Write XF cell styles. |
||
| 292 | * |
||
| 293 | * @param XMLWriter $writer |
||
| 294 | * @param Spreadsheet $spreadsheet |
||
| 295 | */ |
||
| 296 | 2 | private function writeXfStyles(XMLWriter $writer, Spreadsheet $spreadsheet) |
|
| 386 | } |
||
| 387 |
Loading history...
This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.
Both the
$myVarassignment in line 1 and the$higherassignment in line 2 are dead. The first because$myVaris never used and the second because$higheris always overwritten for every possible time line.