xref: /plugin/combo/vendor/php-webdriver/webdriver/lib/WebDriverTimeouts.php (revision 04fd306c7c155fa133ebb3669986875d65988276)

<?php

namespace Facebook\WebDriver;

use Facebook\WebDriver\Remote\DriverCommand;
use Facebook\WebDriver\Remote\ExecuteMethod;

/**
 * Managing timeout behavior for WebDriver instances.
 */
class WebDriverTimeouts
{
    /**
     * @var ExecuteMethod
     */
    protected $executor;
    /**
     * @var bool
     */
    protected $isW3cCompliant;

    public function __construct(ExecuteMethod $executor, $isW3cCompliant = false)
    {
        $this->executor = $executor;
        $this->isW3cCompliant = $isW3cCompliant;
    }

    /**
     * Specify the amount of time the driver should wait when searching for an element if it is not immediately present.
     *
     * @param int $seconds Wait time in second.
     * @return WebDriverTimeouts The current instance.
     */
    public function implicitlyWait($seconds)
    {
        if ($this->isW3cCompliant) {
            $this->executor->execute(
                DriverCommand::IMPLICITLY_WAIT,
                ['implicit' => $seconds * 1000]
            );

            return $this;
        }

        $this->executor->execute(
            DriverCommand::IMPLICITLY_WAIT,
            ['ms' => $seconds * 1000]
        );

        return $this;
    }

    /**
     * Set the amount of time to wait for an asynchronous script to finish execution before throwing an error.
     *
     * @param int $seconds Wait time in second.
     * @return WebDriverTimeouts The current instance.
     */
    public function setScriptTimeout($seconds)
    {
        if ($this->isW3cCompliant) {
            $this->executor->execute(
                DriverCommand::SET_SCRIPT_TIMEOUT,
                ['script' => $seconds * 1000]
            );

            return $this;
        }

        $this->executor->execute(
            DriverCommand::SET_SCRIPT_TIMEOUT,
            ['ms' => $seconds * 1000]
        );

        return $this;
    }

    /**
     * Set the amount of time to wait for a page load to complete before throwing an error.
     *
     * @param int $seconds Wait time in second.
     * @return WebDriverTimeouts The current instance.
     */
    public function pageLoadTimeout($seconds)
    {
        if ($this->isW3cCompliant) {
            $this->executor->execute(
                DriverCommand::SET_SCRIPT_TIMEOUT,
                ['pageLoad' => $seconds * 1000]
            );

            return $this;
        }

        $this->executor->execute(DriverCommand::SET_TIMEOUT, [
            'type' => 'page load',
            'ms' => $seconds * 1000,
        ]);

        return $this;
    }
}