Conditions | 6 |
Paths | 243 |
Total Lines | 229 |
Code Lines | 177 |
Lines | 0 |
Ratio | 0 % |
Changes | 0 |
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
1 | <?php |
||
184 | public function testBuildWithDifferentImageFormats(): void |
||
185 | { |
||
186 | $reader = new Xlsx(); |
||
187 | $spreadsheet = new Spreadsheet(); |
||
188 | $sheet = $spreadsheet->getActiveSheet(); |
||
189 | |||
190 | // Add png image to comment background |
||
191 | $sheet->setCellValue('A1', '.png'); |
||
192 | $drawing = new Drawing(); |
||
193 | $drawing->setName('Blue Square'); |
||
194 | $drawing->setPath('tests/data/Writer/XLSX/blue_square.png'); |
||
195 | self::assertEquals($drawing->getWidth(), 100); |
||
196 | self::assertEquals($drawing->getHeight(), 100); |
||
197 | $comment = $sheet->getComment('A1'); |
||
198 | $comment->setBackgroundImage($drawing); |
||
199 | $comment->setSizeAsBackgroundImage(); |
||
200 | self::assertEquals($comment->getWidth(), '75pt'); |
||
201 | self::assertEquals($comment->getHeight(), '75pt'); |
||
202 | |||
203 | $comment = $sheet->getComment('A1'); |
||
204 | self::assertTrue($comment->hasBackgroundImage()); |
||
205 | self::assertEquals($comment->getBackgroundImage()->getType(), IMAGETYPE_PNG); |
||
206 | |||
207 | // Add gif image to comment background |
||
208 | $sheet->setCellValue('A2', '.gif'); |
||
209 | $drawing = new Drawing(); |
||
210 | $drawing->setName('Green Square'); |
||
211 | $drawing->setPath('tests/data/Writer/XLSX/green_square.gif'); |
||
212 | self::assertEquals($drawing->getWidth(), 150); |
||
213 | self::assertEquals($drawing->getHeight(), 150); |
||
214 | $comment = $sheet->getComment('A2'); |
||
215 | $comment->setBackgroundImage($drawing); |
||
216 | $comment->setSizeAsBackgroundImage(); |
||
217 | self::assertEquals($comment->getWidth(), '112.5pt'); |
||
218 | self::assertEquals($comment->getHeight(), '112.5pt'); |
||
219 | |||
220 | $comment = $sheet->getComment('A2'); |
||
221 | self::assertTrue($comment->hasBackgroundImage()); |
||
222 | self::assertEquals($comment->getBackgroundImage()->getType(), IMAGETYPE_GIF); |
||
223 | |||
224 | // Add jpeg image to comment background |
||
225 | $sheet->setCellValue('A3', '.jpeg'); |
||
226 | $drawing = new Drawing(); |
||
227 | $drawing->setName('Red Square'); |
||
228 | $drawing->setPath('tests/data/Writer/XLSX/red_square.jpeg'); |
||
229 | self::assertEquals($drawing->getWidth(), 50); |
||
230 | self::assertEquals($drawing->getHeight(), 50); |
||
231 | $comment = $sheet->getComment('A3'); |
||
232 | $comment->setBackgroundImage($drawing); |
||
233 | $comment->setSizeAsBackgroundImage(); |
||
234 | self::assertEquals($comment->getWidth(), '37.5pt'); |
||
235 | self::assertEquals($comment->getHeight(), '37.5pt'); |
||
236 | |||
237 | $comment = $sheet->getComment('A3'); |
||
238 | self::assertTrue($comment->hasBackgroundImage()); |
||
239 | self::assertEquals($comment->getBackgroundImage()->getType(), IMAGETYPE_JPEG); |
||
240 | |||
241 | // Add bmp image to comment background |
||
242 | $sheet->setCellValue('A4', '.bmp 16 colors'); |
||
243 | $drawing = new Drawing(); |
||
244 | $drawing->setName('Yellow Square'); |
||
245 | $drawing->setPath('tests/data/Writer/XLSX/yellow_square_16.bmp'); |
||
246 | self::assertEquals($drawing->getWidth(), 70); |
||
247 | self::assertEquals($drawing->getHeight(), 70); |
||
248 | $comment = $sheet->getComment('A4'); |
||
249 | $comment->setBackgroundImage($drawing); |
||
250 | $comment->setSizeAsBackgroundImage(); |
||
251 | self::assertEquals($comment->getWidth(), '52.5pt'); |
||
252 | self::assertEquals($comment->getHeight(), '52.5pt'); |
||
253 | |||
254 | $comment = $sheet->getComment('A4'); |
||
255 | self::assertTrue($comment->hasBackgroundImage()); |
||
256 | self::assertEquals($comment->getBackgroundImage()->getType(), IMAGETYPE_BMP); |
||
257 | |||
258 | // Add bmp image to comment background |
||
259 | $sheet->setCellValue('A5', '.bmp 256 colors'); |
||
260 | $drawing = new Drawing(); |
||
261 | $drawing->setName('Brown Square'); |
||
262 | $drawing->setPath('tests/data/Writer/XLSX/brown_square_256.bmp'); |
||
263 | self::assertEquals($drawing->getWidth(), 70); |
||
264 | self::assertEquals($drawing->getHeight(), 70); |
||
265 | $comment = $sheet->getComment('A5'); |
||
266 | $comment->setBackgroundImage($drawing); |
||
267 | $comment->setSizeAsBackgroundImage(); |
||
268 | self::assertEquals($comment->getWidth(), '52.5pt'); |
||
269 | self::assertEquals($comment->getHeight(), '52.5pt'); |
||
270 | |||
271 | $comment = $sheet->getComment('A5'); |
||
272 | self::assertTrue($comment->hasBackgroundImage()); |
||
273 | self::assertEquals($comment->getBackgroundImage()->getType(), IMAGETYPE_BMP); |
||
274 | |||
275 | // Add bmp image to comment background |
||
276 | $sheet->setCellValue('A6', '.bmp 24 bit'); |
||
277 | $drawing = new Drawing(); |
||
278 | $drawing->setName('Orange Square'); |
||
279 | $drawing->setPath('tests/data/Writer/XLSX/orange_square_24_bit.bmp'); |
||
280 | self::assertEquals($drawing->getWidth(), 70); |
||
281 | self::assertEquals($drawing->getHeight(), 70); |
||
282 | self::assertSame(IMAGETYPE_PNG, $drawing->getImageTypeForSave()); |
||
283 | $comment = $sheet->getComment('A6'); |
||
284 | $comment->setBackgroundImage($drawing); |
||
285 | $comment->setSizeAsBackgroundImage(); |
||
286 | self::assertEquals($comment->getWidth(), '52.5pt'); |
||
287 | self::assertEquals($comment->getHeight(), '52.5pt'); |
||
288 | |||
289 | $comment = $sheet->getComment('A6'); |
||
290 | self::assertTrue($comment->hasBackgroundImage()); |
||
291 | self::assertEquals($comment->getBackgroundImage()->getType(), IMAGETYPE_BMP); |
||
292 | |||
293 | // Add unsupported tiff image to comment background |
||
294 | $sheet->setCellValue('A7', '.tiff'); |
||
295 | $drawing = new Drawing(); |
||
296 | $drawing->setName('Purple Square'); |
||
297 | $drawing->setPath('tests/data/Writer/XLSX/purple_square.tiff'); |
||
298 | self::assertStringContainsString('purple_square.tiff', $drawing->getFilename()); |
||
299 | self::assertFalse($drawing->getIsUrl()); |
||
300 | $comment = $sheet->getComment('A7'); |
||
301 | self::assertFalse($comment->hasBackgroundImage()); |
||
302 | self::assertEquals($comment->getBackgroundImage()->getType(), IMAGETYPE_UNKNOWN); |
||
303 | |||
304 | try { |
||
305 | $comment->setBackgroundImage($drawing); |
||
306 | self::fail('Should throw exception when attempting to add tiff'); |
||
307 | } catch (PhpSpreadsheetException $e) { |
||
308 | self::assertEquals($e->getMessage(), 'Unsupported image type in comment background. Supported types: PNG, JPEG, BMP, GIF.'); |
||
309 | } |
||
310 | |||
311 | try { |
||
312 | $drawing->getImageTypeForSave(); |
||
313 | self::fail('Should throw exception when attempting to get image type for tiff'); |
||
314 | } catch (PhpSpreadsheetException $e) { |
||
315 | self::assertEquals($e->getMessage(), 'Unsupported image type in comment background. Supported types: PNG, JPEG, BMP, GIF.'); |
||
316 | } |
||
317 | |||
318 | try { |
||
319 | $drawing->getMediaFilename(); |
||
320 | self::fail('Should throw exception when attempting to get media file name for tiff'); |
||
321 | } catch (PhpSpreadsheetException $e) { |
||
322 | self::assertEquals($e->getMessage(), 'Unsupported image type in comment background. Supported types: PNG, JPEG, BMP, GIF.'); |
||
323 | } |
||
324 | |||
325 | try { |
||
326 | $drawing->getImageFileExtensionForSave(); |
||
327 | self::fail('Should throw exception when attempting to get image file extention for tiff'); |
||
328 | } catch (PhpSpreadsheetException $e) { |
||
329 | self::assertEquals($e->getMessage(), 'Unsupported image type in comment background. Supported types: PNG, JPEG, BMP, GIF.'); |
||
330 | } |
||
331 | |||
332 | try { |
||
333 | $drawing->getImageMimeType(); |
||
334 | self::fail('Should throw exception when attempting to get image mime type for tiff'); |
||
335 | } catch (PhpSpreadsheetException $e) { |
||
336 | self::assertEquals($e->getMessage(), 'Unsupported image type in comment background. Supported types: PNG, JPEG, BMP, GIF.'); |
||
337 | } |
||
338 | |||
339 | // Write file |
||
340 | $writer = IOFactory::createWriter($spreadsheet, 'Xlsx'); |
||
341 | $tempFileName = File::sysGetTempDir() . '/drawings_in_comments.xlsx'; |
||
342 | $writer->save($tempFileName); |
||
343 | |||
344 | // Read new file |
||
345 | $reloadedSpreadsheet = $reader->load($tempFileName); |
||
346 | $sheet = $reloadedSpreadsheet->getActiveSheet(); |
||
347 | |||
348 | // Check first image in comment background |
||
349 | $comment = $sheet->getComment('A1'); |
||
350 | self::assertEquals($comment->getWidth(), '75pt'); |
||
351 | self::assertEquals($comment->getHeight(), '75pt'); |
||
352 | self::assertTrue($comment->hasBackgroundImage()); |
||
353 | self::assertEquals($comment->getBackgroundImage()->getWidth(), 100); |
||
354 | self::assertEquals($comment->getBackgroundImage()->getHeight(), 100); |
||
355 | self::assertEquals($comment->getBackgroundImage()->getType(), IMAGETYPE_PNG); |
||
356 | |||
357 | // Check second image in comment background |
||
358 | $comment = $sheet->getComment('A2'); |
||
359 | self::assertEquals($comment->getWidth(), '112.5pt'); |
||
360 | self::assertEquals($comment->getHeight(), '112.5pt'); |
||
361 | self::assertTrue($comment->hasBackgroundImage()); |
||
362 | self::assertEquals($comment->getBackgroundImage()->getWidth(), 150); |
||
363 | self::assertEquals($comment->getBackgroundImage()->getHeight(), 150); |
||
364 | self::assertEquals($comment->getBackgroundImage()->getType(), IMAGETYPE_PNG); |
||
365 | |||
366 | // Check third image in comment background |
||
367 | $comment = $sheet->getComment('A3'); |
||
368 | self::assertEquals($comment->getWidth(), '37.5pt'); |
||
369 | self::assertEquals($comment->getHeight(), '37.5pt'); |
||
370 | self::assertTrue($comment->hasBackgroundImage()); |
||
371 | self::assertEquals($comment->getBackgroundImage()->getWidth(), 50); |
||
372 | self::assertEquals($comment->getBackgroundImage()->getHeight(), 50); |
||
373 | self::assertEquals($comment->getBackgroundImage()->getType(), IMAGETYPE_JPEG); |
||
374 | |||
375 | // Check fourth image in comment background |
||
376 | $comment = $sheet->getComment('A4'); |
||
377 | self::assertEquals($comment->getWidth(), '52.5pt'); |
||
378 | self::assertEquals($comment->getHeight(), '52.5pt'); |
||
379 | self::assertTrue($comment->hasBackgroundImage()); |
||
380 | self::assertEquals($comment->getBackgroundImage()->getWidth(), 70); |
||
381 | self::assertEquals($comment->getBackgroundImage()->getHeight(), 70); |
||
382 | self::assertEquals($comment->getBackgroundImage()->getType(), IMAGETYPE_PNG); |
||
383 | |||
384 | // Check fifth image in comment background |
||
385 | $comment = $sheet->getComment('A5'); |
||
386 | self::assertEquals($comment->getWidth(), '52.5pt'); |
||
387 | self::assertEquals($comment->getHeight(), '52.5pt'); |
||
388 | self::assertTrue($comment->hasBackgroundImage()); |
||
389 | self::assertEquals($comment->getBackgroundImage()->getWidth(), 70); |
||
390 | self::assertEquals($comment->getBackgroundImage()->getHeight(), 70); |
||
391 | self::assertEquals($comment->getBackgroundImage()->getType(), IMAGETYPE_PNG); |
||
392 | |||
393 | // Check sixth image in comment background |
||
394 | $comment = $sheet->getComment('A6'); |
||
395 | self::assertEquals($comment->getWidth(), '52.5pt'); |
||
396 | self::assertEquals($comment->getHeight(), '52.5pt'); |
||
397 | self::assertTrue($comment->hasBackgroundImage()); |
||
398 | self::assertEquals($comment->getBackgroundImage()->getWidth(), 70); |
||
399 | self::assertEquals($comment->getBackgroundImage()->getHeight(), 70); |
||
400 | self::assertEquals($comment->getBackgroundImage()->getType(), IMAGETYPE_PNG); |
||
401 | |||
402 | // Check seventh image in comment background |
||
403 | $comment = $sheet->getComment('A7'); |
||
404 | self::assertFalse($comment->hasBackgroundImage()); |
||
405 | self::assertEquals($comment->getBackgroundImage()->getWidth(), 0); |
||
406 | self::assertEquals($comment->getBackgroundImage()->getHeight(), 0); |
||
407 | self::assertEquals($comment->getBackgroundImage()->getType(), IMAGETYPE_UNKNOWN); |
||
408 | |||
409 | unlink($tempFileName); |
||
410 | |||
411 | $spreadsheet->disconnectWorksheets(); |
||
412 | $reloadedSpreadsheet->disconnectWorksheets(); |
||
413 | } |
||
567 |