Zenstruck\ControllerUtil\View

Complexity

Total Complexity

10

Size/Duplication

Total Lines	109
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

96.55%

Importance

Changes	6
Bugs	2	Features	1

8 Methods

Rating	Name	Duplication	Size	Complexity
A	createCached()	0	4	1
A	getData()	0	4	1
A	getStatusCode()	0	4	1
A	getTemplate()	0	4	1
A	getCache()	0	4	1
A	getHeaders()	0	4	1
A	__construct()	0	13	1
A	getDataAsArray()	0	14	3

<?php

namespace Zenstruck\ControllerUtil;

/**
 * @author Kevin Bond <kevinbond@gmail.com>
 */
class View
{
    const DEFAULT_STATUS_CODE = 200;

    private $data;
    private $statusCode;
    private $template;
    private $cache;
    private $headers;

    /**
     * @param mixed $data
     * @param int   $sharedMaxAge
     * @param int   $statusCode
     *
     * @return static
     */
    public static function createCached($data, $sharedMaxAge, $statusCode = self::DEFAULT_STATUS_CODE)
    {
        return new static($data, $statusCode, null, array('s_maxage' => $sharedMaxAge));
    }

    /**
     * @param mixed|null   $data
     * @param int          $statusCode
     * @param string|array $template
     * @param array        $cache
     * @param array        $headers
     */
    public function __construct(
        $data = null,
        $statusCode = self::DEFAULT_STATUS_CODE,
        $template = null,
        array $cache = array(),
        array $headers = array()
    ) {
        $this->data = $data;
        $this->statusCode = $statusCode;
        $this->template = $template;
        $this->cache = $cache;
        $this->headers = $headers;
    }

    /**
     * @return mixed|null
     */
    public function getData()
    {
        return $this->data;
    }

    /**
     * @param string $key The key to use when creating array if data isn't already an array
     *
     * @return array
     */
    public function getDataAsArray($key = 'data')
    {
        $data = $this->getData();

        if (null === $data) {
            return array();
        }

        if (!is_array($data)) {
            $data = array($key => $data);
        }

        return $data;
    }

    /**
     * @return int
     */
    public function getStatusCode()
    {
        return $this->statusCode;
    }

    /**
     * Either the template name or an array of templates.
     *
     * @return string|array|null
     */
    public function getTemplate()
    {
        return $this->template;
    }

    /**
     * Returns an array of cache options.
     *
     * @see Symfony\Component\HttpFoundation\Response::setCache
     *
     * @return array
     */
    public function getCache()
    {
        return $this->cache;
    }

    /**
     * @return array
     */
    public function getHeaders()
    {
        return $this->headers;
    }
}