wiosna-dev_limesurvey-api-client/src/Exception/CannotProcessDataException.php

<?php

/**
 * (c) Meritoo.pl, http://www.meritoo.pl
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Meritoo\LimeSurvey\ApiClient\Exception;

/**
 * An exception used while raw data returned by the LimeSurvey's API cannot be processed
 *
 * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
 * @copyright Meritoo.pl
 */
class CannotProcessDataException extends \Exception
{
    /**
     * Reason why data cannot be processed, e.g. "Invalid user name or password"
     *
     * @var string
     */
    private $reason;

    /**
     * Class constructor
     *
     * @param string $reason Reason why data cannot be processed, e.g. "Invalid user name or password"
     */
    public function __construct($reason)
    {
        $this->reason = $reason;

        $template = 'Raw data returned by the LimeSurvey\'s API cannot be processed. Reason: \'%s\'.';
        $message = sprintf($template, $this->reason);

        parent::__construct($message);
    }

    /**
     * Returns reason why data cannot be processed, e.g. "Invalid user name or password"
     *
     * @return string
     */
    public function getReason()
    {
        return $this->reason;
    }
}