annotate vendor/behat/mink/src/Exception/ElementException.php @ 19:fa3358dc1485 tip

Add ndrum files

<?php

/*
 * This file is part of the Mink package.
 * (c) Konstantin Kudryashov <[e-mail]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Behat\Mink\Exception;

@trigger_error('The class '.__NAMESPACE__.'\ElementException is deprecated as of Mink 1.6 and will be removed in 2.0', E_USER_DEPRECATED);

use Behat\Mink\Element\Element;

/**
 * A standard way for elements to re-throw exceptions.
 *
 * @deprecated This exception class is not used anymore in Mink 1.6 and will be removed in 2.0
 *
 * @author Chris Worfolk <[e-mail]>
 */
class ElementException extends Exception
{
    private $element;

    /**
     * Initialises exception.
     *
     * @param Element    $element   optional message
     * @param \Exception $exception exception
     */
    public function __construct(Element $element, \Exception $exception)
    {
        $this->element = $element;

        parent::__construct(sprintf("Exception thrown by %s\n%s", $element->getXpath(), $exception->getMessage()));
    }

    /**
     * Override default toString so we don't send a full backtrace in verbose mode.
     *
     * @return string
     */
    public function __toString()
    {
        return $this->getMessage();
    }

    /**
     * Get the element that caused the exception.
     *
     * @return Element
     */
    public function getElement()
    {
        return $this->element;
    }
}