Updated AbstractActionController::indexAction return type to reflect real usage

[weierophinney]

• Is this related to quality assurance?

When running static analysis against a simple userland controller like:

class MyController extends AbstractActionController
{
    public function indexAction()
    {
        return ['posts' => ['foo', 'bar']];
    }
}

That do NOT provide the return type, neither with PHP 7.1 return type nor via DocBlock, tools like PHPstan use inherited docs and report:

Method MyController::indexAction() should return Zend\View\Model\ViewModel but returns array.

Of course users should add return types, but it would result in requiring a massive code update without real benefits, since the default behavior of Zend\Mvc framework is to allow:

1. null from \Zend\Mvc\View\Http\CreateViewModelListener::createViewModelFromNull listener
2. array from \Zend\Mvc\View\Http\CreateViewModelListener::createViewModelFromArray listener
3. ViewModel from \Zend\Mvc\View\Http\DefaultRenderingStrategy::render listener
4. ResponseInterface from \Zend\Mvc\SendResponseListener::sendResponse listener

This change only applies to indexAction since I guess its usage is widespread: notFoundAction is untouched as users that override it are, IMHO, already advanced ones.

Ping @Ocramius you type lover ❤️

Reference: https://github.com/Slamdunk/phpstan-zend-framework/issues/5

---

Originally posted by @Slamdunk at zendframework/zend-mvc#312

[weierophinney]

As it seems you've worked on ZF with PHPStan quite a lot, what do you think about this @thomasvargiu?

---

Originally posted by @Slamdunk at zendframework/zend-mvc#312 (comment)

[weierophinney]

@Slamdunk I have the same problem in my projects and right now I’m ignoring that kind of errors.
But yes, even if I don’t like methods that can return 5 or 6 different types, we should fix the phodoc return type.

---

Originally posted by @thomasvargiu at zendframework/zend-mvc#312 (comment)

[weierophinney]

But probably it's better to use only ResponseInterface and ModelInterface, starting deprecating array, null, and void.

---

Originally posted by @thomasvargiu at zendframework/zend-mvc#312 (comment)

[alexmerlin]

Closing issue due to being inactive for more than 1 year.