ElementObject.php

Go to the documentation of this file.

<?php
namespace Magento\FunctionalTestingFramework\Page\Objects;

use Magento\FunctionalTestingFramework\Exceptions\XmlException;

class ElementObject
{
    const DEFAULT_TIMEOUT_SYMBOL = '-';

    private $name;

    private $type;

    private $selector;

    private $locatorFunction;

    private $timeout;

    private $parameterized;

    public function __construct($name, $type, $selector, $locatorFunction, $timeout, $parameterized)
    {
        if ($selector != null && $locatorFunction != null) {
            throw new XmlException("Element '{$name}' cannot have both a selector and a locatorFunction.");
        } elseif ($selector == null && $locatorFunction == null) {
            throw new XmlException("Element '{$name}' must have either a selector or a locatorFunction.'");
        }

        $this->name = $name;
        $this->type = $type;
        $this->selector = $selector;
        $this->locatorFunction = $locatorFunction;
        if (strpos($locatorFunction, "Locator::") === false) {
            $this->locatorFunction = "Locator::" . $locatorFunction;
        }
        $this->timeout = $timeout;
        $this->parameterized = $parameterized;
    }

    public function getName()
    {
        return $this->name;
    }

    public function getType()
    {
        return $this->type;
    }

    public function getSelector()
    {
        return $this->selector;
    }

    public function getLocatorFunction()
    {
        return $this->locatorFunction;
    }

    public function getPrioritizedSelector()
    {
        return $this->selector ?: $this->locatorFunction;
    }

    public function getTimeout()
    {
        if ($this->timeout == ElementObject::DEFAULT_TIMEOUT_SYMBOL) {
            return null;
        }

        return (int)$this->timeout;
    }

    public function isParameterized()
    {
        return $this->parameterized;
    }
}