2013-12-16 5 views
5

Mi piacciono i documenti puliti e phpdoc cercherà automagicamente il tipo. Quando si documenta una funzione del controller che restituisce View :: make, non ho idea del tipo da utilizzare per @return nella mia documentazione.Qual è il tipo di reso di View :: make in Laravel?

<?php 

class FooController extends BaseController { 

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

} 

Qual è il tipo qui o c'è un modo migliore per documentare la funzione per questo scopo?

risposta

7

Il valore di ritorno è

Illuminate\View\View 

ho tracciato attraverso il ServiceProvider che mi portano a

Illuminate\View\Environment::make 

Quale è la linea 113 di vendor/laravel/quadro/src/Illuminate/Vista/Ambiente. php (almeno in 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 Buona ricerca, anche se la documentazione è scarsa. Dovresti documentare più di un semplice tipo di nome. –

+0

La mia documentazione? – ollieread

+0

Oops, non è il tuo codice, vero? La documentazione [di commento] di Laravel, quindi! –