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 PhpExcelWrapper 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 PhpExcelWrapper, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 16 | class PhpExcelWrapper |
||
| 17 | { |
||
| 18 | private $__phpexcel; |
||
| 19 | private $__sheet = []; |
||
| 20 | private $__deleteSheetList = []; |
||
| 21 | private static $__borderType = [ |
||
| 22 | 'none' => PHPExcel_Style_Border::BORDER_NONE, |
||
| 23 | 'thin' => PHPExcel_Style_Border::BORDER_THIN, |
||
| 24 | 'medium' => PHPExcel_Style_Border::BORDER_MEDIUM, |
||
| 25 | 'dashed' => PHPExcel_Style_Border::BORDER_DASHED, |
||
| 26 | 'dotted' => PHPExcel_Style_Border::BORDER_DOTTED, |
||
| 27 | 'thick' => PHPExcel_Style_Border::BORDER_THICK, |
||
| 28 | 'double' => PHPExcel_Style_Border::BORDER_DOUBLE, |
||
| 29 | 'hair' => PHPExcel_Style_Border::BORDER_HAIR, |
||
| 30 | 'mediumdashed' => PHPExcel_Style_Border::BORDER_MEDIUMDASHED, |
||
| 31 | 'dashdot' => PHPExcel_Style_Border::BORDER_DASHDOT, |
||
| 32 | 'mediumdashdot' => PHPExcel_Style_Border::BORDER_MEDIUMDASHDOT, |
||
| 33 | 'dashdotdot' => PHPExcel_Style_Border::BORDER_DASHDOTDOT, |
||
| 34 | 'mediumdashdotdot' => PHPExcel_Style_Border::BORDER_MEDIUMDASHDOTDOT, |
||
| 35 | 'slantdashdot' => PHPExcel_Style_Border::BORDER_SLANTDASHDOT, |
||
| 36 | ]; |
||
| 37 | |||
| 38 | private static $__alignHolizonalType = [ |
||
| 39 | 'general' => PHPExcel_Style_Alignment::HORIZONTAL_GENERAL, |
||
| 40 | 'center' => PHPExcel_Style_Alignment::HORIZONTAL_CENTER, |
||
| 41 | 'left' => PHPExcel_Style_Alignment::HORIZONTAL_LEFT, |
||
| 42 | 'right' => PHPExcel_Style_Alignment::HORIZONTAL_RIGHT, |
||
| 43 | 'justify' => PHPExcel_Style_Alignment::HORIZONTAL_JUSTIFY, |
||
| 44 | 'countinuous' => PHPExcel_Style_Alignment::HORIZONTAL_CENTER_CONTINUOUS, |
||
| 45 | ]; |
||
| 46 | |||
| 47 | private static $__alignVerticalType = [ |
||
| 48 | 'bottom' => PHPExcel_Style_Alignment::VERTICAL_BOTTOM, |
||
| 49 | 'center' => PHPExcel_Style_Alignment::VERTICAL_CENTER, |
||
| 50 | 'justify' => PHPExcel_Style_Alignment::VERTICAL_JUSTIFY, |
||
| 51 | 'top' => PHPExcel_Style_Alignment::VERTICAL_TOP, |
||
| 52 | ]; |
||
| 53 | |||
| 54 | private static $__fillType = [ |
||
| 55 | 'linear' => PHPExcel_Style_Fill::FILL_GRADIENT_LINEAR, |
||
| 56 | 'path' => PHPExcel_Style_Fill::FILL_GRADIENT_PATH, |
||
| 57 | 'none' => PHPExcel_Style_Fill::FILL_NONE, |
||
| 58 | 'darkdown' => PHPExcel_Style_Fill::FILL_PATTERN_DARKDOWN, |
||
| 59 | 'darkgray' => PHPExcel_Style_Fill::FILL_PATTERN_DARKGRAY, |
||
| 60 | 'darkgrid' => PHPExcel_Style_Fill::FILL_PATTERN_DARKGRID, |
||
| 61 | 'darkhorizontal' => PHPExcel_Style_Fill::FILL_PATTERN_DARKHORIZONTAL, |
||
| 62 | 'darktrellis' => PHPExcel_Style_Fill::FILL_PATTERN_DARKTRELLIS, |
||
| 63 | 'darkup' => PHPExcel_Style_Fill::FILL_PATTERN_DARKUP, |
||
| 64 | 'darkvertical' => PHPExcel_Style_Fill::FILL_PATTERN_DARKVERTICAL, |
||
| 65 | 'gray0625' => PHPExcel_Style_Fill::FILL_PATTERN_GRAY0625, |
||
| 66 | 'gray125' => PHPExcel_Style_Fill::FILL_PATTERN_GRAY125, |
||
| 67 | 'lightdown' => PHPExcel_Style_Fill::FILL_PATTERN_LIGHTDOWN, |
||
| 68 | 'lightgray' => PHPExcel_Style_Fill::FILL_PATTERN_LIGHTGRAY, |
||
| 69 | 'lightgrid' => PHPExcel_Style_Fill::FILL_PATTERN_LIGHTGRID, |
||
| 70 | 'lighthorizontal' => PHPExcel_Style_Fill::FILL_PATTERN_LIGHTHORIZONTAL, |
||
| 71 | 'lighttrellis' => PHPExcel_Style_Fill::FILL_PATTERN_LIGHTTRELLIS, |
||
| 72 | 'lightup' => PHPExcel_Style_Fill::FILL_PATTERN_LIGHTUP, |
||
| 73 | 'lightvertical' => PHPExcel_Style_Fill::FILL_PATTERN_LIGHTVERTICAL, |
||
| 74 | 'mediumgray' => PHPExcel_Style_Fill::FILL_PATTERN_MEDIUMGRAY, |
||
| 75 | 'solid' => PHPExcel_Style_Fill::FILL_SOLID, |
||
| 76 | ]; |
||
| 77 | |||
| 78 | /** |
||
| 79 | * __construct |
||
| 80 | * |
||
| 81 | * @param string $template テンプレートファイルのパス |
||
| 82 | * @author hagiwara |
||
| 83 | */ |
||
| 84 | public function __construct($template = null, $type = 'Excel2007') |
||
| 95 | |||
| 96 | /** |
||
| 97 | * setVal |
||
| 98 | * 値のセット |
||
| 99 | * @param string $value 値 |
||
| 100 | * @param integer $col 行 |
||
| 101 | * @param integer $row 列 |
||
| 102 | * @param integer $sheetNo シート番号 |
||
| 103 | * @param integer $refCol 参照セル行 |
||
| 104 | * @param integer $refRow 参照セル列 |
||
| 105 | * @param integer $refSheet 参照シート |
||
| 106 | * @author hagiwara |
||
| 107 | */ |
||
| 108 | public function setVal($value, $col, $row, $sheetNo = 0, $refCol = null, $refRow = null, $refSheet = 0) |
||
| 119 | |||
| 120 | /** |
||
| 121 | * setImage |
||
| 122 | * 画像のセット |
||
| 123 | * @param string $img 画像のファイルパス |
||
| 124 | * @param integer $col 行 |
||
| 125 | * @param integer $row 列 |
||
| 126 | * @param integer $sheetNo シート番号 |
||
| 127 | * @param integer $height 画像の縦幅 |
||
| 128 | * @param integer $width 画像の横幅 |
||
| 129 | * @param boolean $proportial 縦横比を維持するか |
||
| 130 | * @param integer $offsetx セルから何ピクセルずらすか(X軸) |
||
| 131 | * @param integer $offsety セルから何ピクセルずらすか(Y軸) |
||
| 132 | * @author hagiwara |
||
| 133 | */ |
||
| 134 | public function setImage($img, $col, $row, $sheetNo = 0, $height = null, $width = null, $proportial = false, $offsetx = null, $offsety = null) |
||
| 135 | { |
||
| 136 | $cellInfo = $this->cellInfo($col, $row); |
||
| 137 | |||
| 138 | $objDrawing = new PHPExcel_Worksheet_Drawing();//画像用のオプジェクト作成 |
||
| 139 | $objDrawing->setPath($img);//貼り付ける画像のパスを指定 |
||
| 140 | $objDrawing->setCoordinates($cellInfo);//位置 |
||
| 141 | if (!is_null($height)) { |
||
| 142 | $objDrawing->setHeight($height);//画像の高さを指定 |
||
| 143 | } |
||
| 144 | if (!is_null($width)) { |
||
| 145 | $objDrawing->setWidth($width);//画像の高さを指定 |
||
| 146 | } |
||
| 147 | if (!is_null($proportial)) { |
||
| 148 | $objDrawing->setResizeProportional($proportial);//縦横比の変更なし |
||
| 149 | } |
||
| 150 | if (!is_null($offsetx)) { |
||
| 151 | $objDrawing->setOffsetX($offsetx);//指定した位置からどれだけ横方向にずらすか。 |
||
| 152 | } |
||
| 153 | if (!is_null($offsety)) { |
||
| 154 | $objDrawing->setOffsetY($offsety);//指定した位置からどれだけ縦方向にずらすか。 |
||
| 155 | } |
||
| 156 | $objDrawing->setWorksheet($this->getSheet($sheetNo)); |
||
| 157 | } |
||
| 158 | |||
| 159 | /** |
||
| 160 | * cellMerge |
||
| 161 | * セルのマージ |
||
| 162 | * @param integer $col1 行 |
||
| 163 | * @param integer $row1 列 |
||
| 164 | * @param integer $col2 行 |
||
| 165 | * @param integer $row2 列 |
||
| 166 | * @param integer $sheetNo シート番号 |
||
| 167 | * @author hagiwara |
||
| 168 | */ |
||
| 169 | public function cellMerge($col1, $row1, $col2, $row2, $sheetNo) |
||
| 176 | |||
| 177 | |||
| 178 | /** |
||
| 179 | * styleCopy |
||
| 180 | * セルの書式コピー |
||
| 181 | * @param integer $col 行 |
||
| 182 | * @param integer $row 列 |
||
| 183 | * @param integer $sheetNo シート番号 |
||
| 184 | * @param integer $refCol 参照セル行 |
||
| 185 | * @param integer $refRow 参照セル列 |
||
| 186 | * @param integer $refSheet 参照シート |
||
| 187 | * @author hagiwara |
||
| 188 | */ |
||
| 189 | public function styleCopy($col, $row, $sheetNo, $refCol, $refRow, $refSheet) |
||
| 197 | |||
| 198 | /** |
||
| 199 | * setStyle |
||
| 200 | * 書式のセット(まとめて) |
||
| 201 | * @param integer $col 行 |
||
| 202 | * @param integer $row 列 |
||
| 203 | * @param integer $sheetNo シート番号 |
||
| 204 | * @param array $style スタイル情報 |
||
| 205 | * @author hagiwara |
||
| 206 | */ |
||
| 207 | public function setStyle($col, $row, $sheetNo, $style) |
||
| 234 | |||
| 235 | /** |
||
| 236 | * setFontName |
||
| 237 | * フォントのセット |
||
| 238 | * @param integer $col 行 |
||
| 239 | * @param integer $row 列 |
||
| 240 | * @param integer $sheetNo シート番号 |
||
| 241 | * @param string $fontName フォント名 |
||
| 242 | * @author hagiwara |
||
| 243 | */ |
||
| 244 | View Code Duplication | public function setFontName($col, $row, $sheetNo, $fontName) |
|
| 252 | |||
| 253 | /** |
||
| 254 | * setUnderline |
||
| 255 | * 下線のセット |
||
| 256 | * @param integer $col 行 |
||
| 257 | * @param integer $row 列 |
||
| 258 | * @param integer $sheetNo シート番号 |
||
| 259 | * @param boolean $underline 下線を引くか |
||
| 260 | * @author hagiwara |
||
| 261 | */ |
||
| 262 | View Code Duplication | public function setUnderline($col, $row, $sheetNo, $underline) |
|
| 270 | |||
| 271 | /** |
||
| 272 | * setFontBold |
||
| 273 | * 太字のセット |
||
| 274 | * @param integer $col 行 |
||
| 275 | * @param integer $row 列 |
||
| 276 | * @param integer $sheetNo シート番号 |
||
| 277 | * @param boolean $bold 太字を引くか |
||
| 278 | * @author hagiwara |
||
| 279 | */ |
||
| 280 | View Code Duplication | public function setFontBold($col, $row, $sheetNo, $bold) |
|
| 288 | |||
| 289 | /** |
||
| 290 | * setItalic |
||
| 291 | * イタリックのセット |
||
| 292 | * @param integer $col 行 |
||
| 293 | * @param integer $row 列 |
||
| 294 | * @param integer $sheetNo シート番号 |
||
| 295 | * @param boolean $italic イタリックにするか |
||
| 296 | * @author hagiwara |
||
| 297 | */ |
||
| 298 | View Code Duplication | public function setItalic($col, $row, $sheetNo, $italic) |
|
| 306 | |||
| 307 | /** |
||
| 308 | * setStrikethrough |
||
| 309 | * 打ち消し線のセット |
||
| 310 | * @param integer $col 行 |
||
| 311 | * @param integer $row 列 |
||
| 312 | * @param integer $sheetNo シート番号 |
||
| 313 | * @param boolean $strikethrough 打ち消し線をつけるか |
||
| 314 | * @author hagiwara |
||
| 315 | */ |
||
| 316 | View Code Duplication | public function setStrikethrough($col, $row, $sheetNo, $strikethrough) |
|
| 324 | |||
| 325 | /** |
||
| 326 | * setColor |
||
| 327 | * 文字の色 |
||
| 328 | * @param integer $col 行 |
||
| 329 | * @param integer $row 列 |
||
| 330 | * @param integer $sheetNo シート番号 |
||
| 331 | * @param string $color 色(ARGB) |
||
| 332 | * @author hagiwara |
||
| 333 | */ |
||
| 334 | View Code Duplication | public function setColor($col, $row, $sheetNo, $color) |
|
| 342 | |||
| 343 | /** |
||
| 344 | * setSize |
||
| 345 | * 文字サイズ |
||
| 346 | * @param integer $col 行 |
||
| 347 | * @param integer $row 列 |
||
| 348 | * @param integer $sheetNo シート番号 |
||
| 349 | * @param integer $size |
||
| 350 | * @author hagiwara |
||
| 351 | */ |
||
| 352 | View Code Duplication | public function setSize($col, $row, $sheetNo, $size) |
|
| 360 | |||
| 361 | /** |
||
| 362 | * setAlignHolizonal |
||
| 363 | * 水平方向のalign |
||
| 364 | * @param integer $col 行 |
||
| 365 | * @param integer $row 列 |
||
| 366 | * @param integer $sheetNo シート番号 |
||
| 367 | * @param string $type |
||
| 368 | * typeはgetAlignHolizonalType参照 |
||
| 369 | * @author hagiwara |
||
| 370 | */ |
||
| 371 | View Code Duplication | public function setAlignHolizonal($col, $row, $sheetNo, $type) |
|
| 379 | |||
| 380 | /** |
||
| 381 | * setAlignVertical |
||
| 382 | * 垂直方法のalign |
||
| 383 | * @param integer $col 行 |
||
| 384 | * @param integer $row 列 |
||
| 385 | * @param integer $sheetNo シート番号 |
||
| 386 | * @param string $type |
||
| 387 | * typeはgetAlignVerticalType参照 |
||
| 388 | * @author hagiwara |
||
| 389 | */ |
||
| 390 | View Code Duplication | public function setAlignVertical($col, $row, $sheetNo, $type) |
|
| 398 | |||
| 399 | /** |
||
| 400 | * setBorder |
||
| 401 | * 罫線の設定 |
||
| 402 | * @param integer $col 行 |
||
| 403 | * @param integer $row 列 |
||
| 404 | * @param integer $sheetNo シート番号 |
||
| 405 | * @param array $border |
||
| 406 | * borderの内部はgetBorderType参照 |
||
| 407 | * @author hagiwara |
||
| 408 | */ |
||
| 409 | public function setBorder($col, $row, $sheetNo, $border) |
||
| 437 | |||
| 438 | /** |
||
| 439 | * setBackgroundColor |
||
| 440 | * 背景色の設定 |
||
| 441 | * @param integer $col 行 |
||
| 442 | * @param integer $row 列 |
||
| 443 | * @param integer $sheetNo シート番号 |
||
| 444 | * @param string $color 色 |
||
| 445 | * @param string $fillType 塗りつぶし方(デフォルトsolid) |
||
| 446 | * fillTypeの内部はgetFillType参照 |
||
| 447 | * @author hagiwara |
||
| 448 | */ |
||
| 449 | public function setBackgroundColor($col, $row, $sheetNo, $color, $fillType = 'solid') |
||
| 455 | |||
| 456 | /** |
||
| 457 | * getBorderType |
||
| 458 | * 罫線の種類の設定 |
||
| 459 | * @param string $type |
||
| 460 | * @author hagiwara |
||
| 461 | */ |
||
| 462 | private function getBorderType($type) |
||
| 470 | |||
| 471 | /** |
||
| 472 | * getAlignHolizonalType |
||
| 473 | * 水平方向のAlignの設定 |
||
| 474 | * @param string $type |
||
| 475 | * @author hagiwara |
||
| 476 | */ |
||
| 477 | private function getAlignHolizonalType($type) |
||
| 485 | |||
| 486 | /** |
||
| 487 | * getAlignVerticalType |
||
| 488 | * 垂直方向のAlignの設定 |
||
| 489 | * @param string $type |
||
| 490 | * @author hagiwara |
||
| 491 | */ |
||
| 492 | private function getAlignVerticalType($type) |
||
| 500 | |||
| 501 | /** |
||
| 502 | * getFillType |
||
| 503 | * 塗りつぶしの設定 |
||
| 504 | * @param string $type |
||
| 505 | * @author hagiwara |
||
| 506 | */ |
||
| 507 | private function getFillType($type) |
||
| 515 | |||
| 516 | /** |
||
| 517 | * createSheet |
||
| 518 | * シートの作成 |
||
| 519 | * @param string $name |
||
| 520 | * @author hagiwara |
||
| 521 | */ |
||
| 522 | public function createSheet($name = null) |
||
| 532 | |||
| 533 | /** |
||
| 534 | * deleteSheet |
||
| 535 | * シートの削除 |
||
| 536 | * @param integer $sheetNo |
||
| 537 | * @author hagiwara |
||
| 538 | */ |
||
| 539 | public function deleteSheet($sheetNo) |
||
| 544 | |||
| 545 | /** |
||
| 546 | * copySheet |
||
| 547 | * シートのコピー |
||
| 548 | * @param integer $sheetNo |
||
| 549 | * @param integer $position |
||
| 550 | * @param string $name |
||
| 551 | * @author hagiwara |
||
| 552 | */ |
||
| 553 | public function copySheet($sheetNo, $position = null, $name = null) |
||
| 564 | |||
| 565 | /** |
||
| 566 | * renameSheet |
||
| 567 | * シート名の変更 |
||
| 568 | * @param integer $sheetNo |
||
| 569 | * @param string $name |
||
| 570 | * @author hagiwara |
||
| 571 | */ |
||
| 572 | public function renameSheet($sheetNo, $name) |
||
| 576 | |||
| 577 | /** |
||
| 578 | * write |
||
| 579 | * xlsxファイルの書き込み |
||
| 580 | * @param string $file 書き込み先のファイルパス |
||
| 581 | * @author hagiwara |
||
| 582 | */ |
||
| 583 | public function write($file, $type = 'Excel2007') |
||
| 592 | |||
| 593 | /** |
||
| 594 | * getReader |
||
| 595 | * readerを返す(※直接PHPExcelの関数を実行できるように) |
||
| 596 | * @author hagiwara |
||
| 597 | */ |
||
| 598 | public function getReader() |
||
| 602 | |||
| 603 | /** |
||
| 604 | * getSheet |
||
| 605 | * シート情報の読み込み |
||
| 606 | * @param integer $sheetNo シート番号 |
||
| 607 | * @author hagiwara |
||
| 608 | * @return null|\PHPExcel_Worksheet |
||
| 609 | */ |
||
| 610 | private function getSheet($sheetNo) |
||
| 617 | |||
| 618 | /** |
||
| 619 | * cellInfo |
||
| 620 | * R1C1参照をA1参照に変換して返す |
||
| 621 | * @param integer $col 行 |
||
| 622 | * @param integer $row 列 |
||
| 623 | * @author hagiwara |
||
| 624 | */ |
||
| 625 | private function cellInfo($col, $row) |
||
| 630 | |||
| 631 | /** |
||
| 632 | * cellInfo |
||
| 633 | * http://qiita.com/Hiraku/items/036080976884fad1e450 |
||
| 634 | * @param string $str |
||
| 635 | */ |
||
| 636 | private function camelize($str) |
||
| 641 | } |
||
| 642 |
It seems like the type of the argument is not accepted by the function/method which you are calling.
In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.
We suggest to add an explicit type cast like in the following example: