2013-12-16 30 views
5

Ich mag saubere Dokumente und phpdoc wird automatisch den Typ nachschlagen. Wenn ich eine Controller-Funktion dokumentiere, die View :: make zurückgibt, habe ich keine Ahnung, welchen Typ ich für die @ return in meiner Dokumentation verwenden soll.Was ist der Rückgabetyp von View :: make in Laravel?

<?php 

class FooController extends BaseController { 

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

} 

Was ist der Typ hier oder gibt es eine bessere Möglichkeit, die Funktion für diesen Zweck zu dokumentieren?

Antwort

7

Der Rückgabewert ist

Illuminate\View\View 

ich durch den Serviceprovider verfolgt, die mich führen zu

Illuminate\View\Environment::make 

, welche Linie 113 von Verkäufer/Laravel/Rahmen/src/Illuminate/Blick/Umwelt. php (in 4.1 mindestens)

/** 
* 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 Gute finden, obwohl Ihre Dokumentation ist schlecht. Sie sollten mehr dokumentieren als nur Namen eingeben. –

+0

Meine Dokumentation? – ollieread

+0

Hoppla, das ist nicht dein Code, oder? Laravels [Kommentar] -Dokumentation dann! –