2013-12-16 2 views
5

Мне нравятся чистые документы, и phpdoc автоматически ищет тип. При документировании функции контроллера, которая возвращает View :: make, я понятия не имею, какой тип использовать для @return в моей документации.Каков тип возврата View :: make в Laravel?

<?php 

class FooController extends BaseController { 

    /** 
    * Show a view. 
    * 
    * @return ??? description of the view 
    */ 
    public function show(){ 
     return View::make('bar'); 
    } 

} 

Каков тип здесь или есть лучший способ документировать функцию для этой цели?

ответ

7

Возвращаемое значение

Illuminate\View\View 

Я проследил через ServiceProvider, которые привели меня к

Illuminate\View\Environment::make 

Что является линия 113 от поставщика/Laravel/рамочный/SRC/Illuminate/View/окружающей среды. php (не менее 4.1)

/** 
* Get a evaluated view contents for the given view. 
* 
* @param string $view 
* @param array $data 
* @param array $mergeData 
* @return \Illuminate\View\View 
*/ 
public function make($view, $data = array(), $mergeData = array()) 
{ 
    $path = $this->finder->find($view); 

    $data = array_merge($mergeData, $this->parseData($data)); 

    $this->callCreator($view = new View($this, $this->getEngineFromPath($path), $view, $path, $data)); 

    return $view; 
} 
+0

+1 Хорошая находка, хотя ваша документация оставляет желать лучшего. Вы должны документировать больше, чем просто имена типов. –

+0

Моя документация? – ollieread

+0

К сожалению, это не ваш код, не так ли? Laravel [комментарий], тогда! –

Смежные вопросы