<?php
/**
 * Zend Framework (http://framework.zend.com/)
 *
 * @link      http://github.com/zendframework/zf2 for the canonical source repository
 * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
 * @license   http://framework.zend.com/license/new-bsd New BSD License
 */

namespace Zend\Http\Header;

/**
 * Connection Header
 *
 * @link       http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.10
 */
class Connection implements HeaderInterface
{
    const CONNECTION_CLOSE      = 'close';
    const CONNECTION_KEEP_ALIVE = 'keep-alive';

    /**
     * Value of this header
     *
     * @var string
     */
    protected $value = self::CONNECTION_KEEP_ALIVE;

    /**
     * @param $headerLine
     * @return Connection
     * @throws Exception\InvalidArgumentException
     */
    public static function fromString($headerLine)
    {
        $header = new static();

        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);

        // check to ensure proper header type for this factory
        if (strtolower($name) !== 'connection') {
            throw new Exception\InvalidArgumentException('Invalid header line for Connection string: "' . $name . '"');
        }

        $header->setValue(trim($value));

        return $header;
    }

    /**
     * Set Connection header to define persistent connection
     *
     * @param  bool $flag
     * @return Connection
     */
    public function setPersistent($flag)
    {
        if ((bool) $flag === true) {
            $this->value = self::CONNECTION_KEEP_ALIVE;
        } else {
            $this->value = self::CONNECTION_CLOSE;
        }
        return $this;
    }

    /**
     * Get whether this connection is persistent
     *
     * @return bool
     */
    public function isPersistent()
    {
        return ($this->value === self::CONNECTION_KEEP_ALIVE);
    }

    /**
     * Set arbitrary header value
     * RFC allows any token as value, 'close' and 'keep-alive' are commonly used
     *
     * @param string $value
     * @return Connection
     */
    public function setValue($value)
    {
        $this->value = strtolower($value);
        return $this;
    }

    /**
     * Connection header name
     *
     * @return string
     */
    public function getFieldName()
    {
        return 'Connection';
    }

    /**
     * Connection header value
     *
     * @return string
     */
    public function getFieldValue()
    {
        return $this->value;
    }

    /**
     * Return header line
     *
     * @return string
     */
    public function toString()
    {
        return 'Connection: ' . $this->getFieldValue();
    }
}
