WebinoDev\Test\Selenium\ScreenshotTrait

Complexity

Total Complexity

5

Size/Duplication

Total Lines	55
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
	getBrowser()	0	1	?
	getSession()	0	1	?
A	screenshot()	0	8	2
A	takeScreenshot()	0	13	2
A	attachScreenshot()	0	4	1

<?php
/**
 * Webino (http://webino.sk/)
 *
 * @link        https://github.com/webino/WebinoDev/ for the canonical source repository
 * @copyright   Copyright (c) 2014-2016 Webino, s. r. o. (http://webino.sk/)
 * @license     BSD-3-Clause
 */

namespace WebinoDev\Test\Selenium;

use Yandex\Allure\Adapter\Support\AttachmentSupport;

/**
 * Capture test screenshots
 */
trait ScreenshotTrait
{
    use AttachmentSupport;

    /**
     * @return string
     */
    abstract protected function getBrowser();

    /**
     * @return \PHPWebDriver_WebDriverSession|WebDriver\SessionInterface
     */
    abstract protected function getSession();

    /**
     * @return string
     */
    protected function screenshot()
    {
        if ('htmlunit' === $this->getBrowser()) {
            return '';
        }

        return base64_decode($this->getSession()->screenshot());
    }

    /**
     * @param string|null $caption
     * @return $this
     */
    protected function takeScreenshot($caption = null)
    {
        $data = $this->screenshot();
        if (empty($data)) {
            return $this;
        }

        $path = sys_get_temp_dir() . '/' . md5(__METHOD__) . '.png';
        file_put_contents($path, $data);
        $this->addAttachment($path, $caption, 'image/png');

        return $this;
    }

    /**
     * @param string|null $caption
     * @return ScreenshotTrait

The return type ScreenshotTrait is a trait, and thus cannot be used for type-hinting in PHP. Maybe consider adding an interface and use that for type-hinting?

     * @todo remove
     * @deprecated use takeScreenshot()
     */
    protected function attachScreenshot($caption = null)
    {
        return $this->takeScreenshot($caption);
    }
}