Question

我已经开始了解Laravel如何使用docs以及教程和SO。但是当我尝试使用他们的API/class reference时，我一直遇到同样的问题。

例如，我已经能够使用这样的URL类：

URL::to('string')

我从教程中学到了什么。但是，如果我查看Illuminate\Support\Facades\URL的文档，则不会列出to()方法。

相反，如果我查看Illuminate\Filesystem\Filesystem的文档，我会尝试像这样调用get()方法：

$file = new Filesystem;
$file->get('lorem.txt');

我收到以下错误

Class 'Filesystem' not found

我的问题：

我如何知道我可以使用哪些类以及可以调用哪些方法？
我在哪里可以找到这些信息？
或者我只是错过了一些关于Laravel如何运作的内容？

Answer 1

Laravel使用名为Facade的设计模式，它基本上是实例化对象的别名，因此您可以这样使用它：

URL::to('string');

而不是

$url = new URL;
$url->to('string');

看看你的app / config / app.php，你会看到指向Facade的URL别名：

'URL' => 'Illuminate\Support\Facades\URL',

如果您查看Facade，您将在IoC容器中看到它的真实“内部”名称（'url'）：

protected static function getFacadeAccessor() { return 'url'; }

这个'url'对象由某个服务提供者实例化，这个对象绑定到Illuminate\Routing\RoutingServiceProvider中的IoC容器：

/**
 * Register the URL generator service.
 *
 * @return void
 */
protected function registerUrlGenerator()
{
    $this->app['url'] = $this->app->share(function($app)
    {
        // The URL generator needs the route collection that exists on the router.
        // Keep in mind this is an object, so we're passing by references here
        // and all the registered routes will be available to the generator.
        $routes = $app['router']->getRoutes();

        return new UrlGenerator($routes, $app->rebinding('request', function($app, $request)
        {
            $app['url']->setRequest($request);
        }));
    });
}

在那里你可以看到'url'实际上是UrlGenerator ->(http://laravel.com/api/4.1/Illuminate/Routing/UrlGenerator.html)。

以下是to()方法：

/**
 * Generate a absolute URL to the given path.
 *
 * @param  string  $path
 * @param  mixed  $extra
 * @param  bool  $secure
 * @return string
 */
public function to($path, $extra = array(), $secure = null)
{
    // First we will check if the URL is already a valid URL. If it is we will not
    // try to generate a new one but will simply return the URL as is, which is
    // convenient since developers do not always have to check if it's valid.
    if ($this->isValidUrl($path)) return $path;

    $scheme = $this->getScheme($secure);

    $tail = implode('/', (array) $extra);

    // Once we have the scheme we will compile the "tail" by collapsing the values
    // into a single string delimited by slashes. This just makes it convenient
    // for passing the array of parameters to this URL as a list of segments.
    $root = $this->getRootUrl($scheme);

    return $this->trimUrl($root, $path, $tail);
}

一开始有点混乱，但你必须记住：

1）找到别名。

2）找到Facade并获得真实的内部名称。

3）找到ServiceProvider以找到真正的类。

Answer 2

当您调用类似URL::to('string')之类的内容时，您通过检查外观命名空间找到了正在使用的Facade。 facade类本身只是将请求指向它应该使用的类，在本例中为url，此类绑定到方法Illuminate\Routing\RoutingServiceProvider中registerUrlGenerator()中的Laravel IoC容器。

通过研究绑定，您可以看到当您使用URL外观时，您实际上正在使用类Illuminate\Routing\UrlGenerator。

在Laravel这样的框架中，API文档实际上并不实用，其中Facade通过IoC容器提供对类的访问，从而从调用代码中抽象出实现。这使得实际找到您实际使用的类的位置非常困难。我求助于在供应商目录上运行搜索。如果外观返回url。我搜索将找到绑定的$this->app['url']，然后我可以跟踪实际使用的类。如果没有进行此搜索，我将仅在供应商目录中搜索('url。

关于第二个问题，如果要实例化一个名为namespace的类，则必须使用该命名空间。

$filesystem = new Illuminate\Filesystem\Filesystem();

您实际上不需要这样做，因为此类使用别名files绑定到IoC容器，通过外观File可以通过静态调用完全访问该类。

或者，如果您需要自己的Filesystem类副本，最好使用IoC容器来获取它。

$filesystem = App::make('files');

Answer 3

对于您想要的文档http://laravel.com/docs，documentation和api列表是两个独立的内容。

话虽这么说，这是Laravel 4的一个方便的小作弊表：http://cheats.jesse-obrien.ca/

Laravel 4.1文档如何工作？

3 个答案: