AcceptedModel.php

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

namespace Zend\Mvc\Controller\Plugin;

use Zend\Http\Request;
use Zend\Mvc\Controller\Plugin\AbstractPlugin;
use Zend\View\Model\JsonModel;
use Zend\View\Model\FeedModel;
use Zend\View\Model\ModelInterface;
use Zend\View\Model\ViewModel;
use Zend\Mvc\InjectApplicationEventInterface;
use Zend\Mvc\MvcEvent;

/**
 * @category   Zend
 * @package    Zend_Mvc
 * @subpackage Controller
 */
class AcceptedModel extends AbstractPlugin
{
    protected $event;
    protected $request;
    protected $detected;

    /**
     * Default match string to match against. Could be set 'somewhere'
     *
     * @var String
     */
    protected $defaultMatchArray;

    /**
     * Detects an appropriate model for view.
     *
     * @return ModelInterface
     */
    public function __invoke(array $matchAgainst = null, $returnMatchedAcceptTypeOnly = false)
    {
        $this->detected = 'Zend\View\Model\ViewModel';
        $request        = $this->getRequest();
        $headers        = $request->getHeaders();


        if ((!$matchAgainst && !$this->defaultMatchString) || !$headers->has('accept')) {
            return new $this->detected;
        }

        if (!$matchAgainst) {
            $matchAgainst = $this->defaultMatchString;
        }

        $matchAgainstString = '';
        foreach ($matchAgainst as $modelName => $modelStrings) {
            $modelName = str_replace('\\', '|', $modelName);
            foreach ((array) $modelStrings as $modelString) {
                $matchAgainstString .= $modelString
                                    . '; _internalViewModel="' . $modelName . '", ';
            }
        }

        /** @var $accept \Zend\Http\Header\Accept */
        $accept = $headers->get('Accept');
        if (($res = $accept->match($matchAgainstString)) === false) {
            return new $this->detected;
        }

        if ($returnMatchedAcceptTypeOnly) {
            return $res;
        }

        //@todo return actual instance, make sure to preserve \
        $modelName = $res->matchedAgainst->params['_internalViewModel'];
     
        return str_replace('|', '\\', $modelName);
    }

    /**
     * Get the request
     *
     * @return Request
     * @throws Exception\DomainException if unable to find request
     */
    protected function getRequest()
    {
        if ($this->request) {
            return $this->request;
        }

        $event = $this->getEvent();
        $request = $event->getRequest();
        if (!$request instanceof Request) {
            throw new Exception\DomainException('AcceptedModel plugin requires event compose a request');
        }
        $this->request = $request;

        return $this->request;
    }

    /**
     * Get the event
     *
     * @return MvcEvent
     * @throws Exception\DomainException if unable to find event
     */
    protected function getEvent()
    {
        if ($this->event) {
            return $this->event;
        }

        $controller = $this->getController();
        if (!$controller instanceof InjectApplicationEventInterface) {
            throw new Exception\DomainException('AcceptedModel plugin requires a controller that implements InjectApplicationEventInterface');
        }

        $event = $controller->getEvent();
        if (!$event instanceof MvcEvent) {
            $params = $event->getParams();
            $event = new MvcEvent();
            $event->setParams($params);
        }
        $this->event = $event;

        return $this->event;
    }

}