<?php
/**
 * Indicates a missing value when reading or writing a Kolab Format object.
 *
 * PHP version 5
 *
 * @category Kolab
 * @package  Kolab_Format
 * @author   Gunnar Wrobel <wrobel@pardus.de>
 * @license  http://www.horde.org/licenses/lgpl21 LGPL 2.1
 * @link     http://www.horde.org/libraries/Horde_Kolab_Format
 */

/**
 * Indicates a missing value when reading or writing a Kolab Format object.
 *
 * Copyright 2011-2016 Horde LLC (http://www.horde.org/)
 *
 * See the enclosed file COPYING for license information (LGPL). If you
 * did not receive this file, see http://www.horde.org/licenses/lgpl21.
 *
 * @category Kolab
 * @package  Kolab_Format
 * @author   Gunnar Wrobel <wrobel@pardus.de>
 * @license  http://www.horde.org/licenses/lgpl21 LGPL 2.1
 * @link     http://www.horde.org/libraries/Horde_Kolab_Format
 */
class Horde_Kolab_Format_Exception_MissingValue
extends Horde_Kolab_Format_Exception
{
    /**
     * The name of the value that was missing.
     *
     * @var string
     */
    private $_value;

    /**
     * Constructor.
     *
     * @param string $value The value that was missing.
     */
    public function __construct($value)
    {
        $this->_value = $value;
        parent::__construct(
            sprintf(
                "Data value for \"%s\" is empty in the Kolab XML object!",
                $value
            )
        );
    }

    /**
     * Return the name of the missing value.
     *
     * @return string The name
     */
    public function getValue()
    {
        return $this->_value;
    }
}