Introduction to the method of modifying the url() function in Laravel to generate the root address of the URL

This article mainly introduces you to the relevant information on how to modify the url() function in Laravel to generate the URL root address. The article introduces it in detail through the example code. It has certain reference learning value for everyone to learn or use laravel. Friends who need it, please follow the editor to learn together.

Preface

This article mainly introduces you to the relevant content of modifying the root address of the URL generated by the url() function in Laravel. I believe everyone is familiar with it. I know that there is a url() in Larevel's helper function, which can generate a complete URL from the given directory. It is a very convenient function:

// return: https://skin.dev/user/profile
url('user/profile')

But this thing The part to be completed in the generated URL is automatically determined by the framework based on the Request, and what is automatically determined may sometimes be wrong (for example, when a layer of reverse proxy is used).

The document does not mention how we can customize the root address and protocol header part (http(s)) in the URL it generates, which is very frustrating. So what should we do?

First let's take a look at the location where url() is defined:

# File: src/Illuminate/Foundation/helpers.php

/**
 * Generate a url for the application.
 *
 * @param string $path
 * @param mixed $parameters
 * @param bool $secure
 * @return Illuminate\Contracts\Routing\UrlGenerator|string
 */
function url($path = null, $parameters = [], $secure = null)
{
 if (is_null($path)) {
  return app(UrlGenerator::class);
 }

 return app(UrlGenerator::class)->to($path, $parameters, $secure);
}

As you can see, it is from Laravel's service An Illuminate\Contracts\Routing\UrlGenerator is parsed out in the container, and the parameters are passed to the to method of this object.

The UrlGenerator class is bound to the service container in the service provider src/Illuminate/Routing/RoutingServiceProvider.php:

/**
 * Register the URL generator service.
 *
 * @return void
 */
protected function registerUrlGenerator()
{
 $this->app['url'] = $this->app->share(function ($app) {
  // 略

  $url = new UrlGenerator(
   $routes, $app->rebinding(
    'request', $this->requestRebinder()
   )
  );

  return $url;
 });
}

This also means that we can access the UrlGenerator in the service container through the url abstract at any time and modify it.

And it does expose the methods we need: forceSchema and forceRootUrl.

The code to modify the root address in the URL generated by the url() function is as follows:

// 用它提供的方法检测 URL 是否有效
if (app('url')->isValidUrl($rootUrl)) {
 app('url')->forceRootUrl($rootUrl);
}

// 强制生成使用 HTTPS 协议的 URL
app('url')->forceSchema('https');

It is recommended that the above codes be placed Customized ServiceProvider, so that all links generated by the url() function will use the root address and protocol defined above.

So, to truly master Laravel’s things, just reading the documentation is not enough. Moreover, Laravel's source code documentation is very good, it is very clear to read, and you can learn a lot.

The above is the detailed content of Introduction to the method of modifying the url() function in Laravel to generate the root address of the URL. For more information, please follow other related articles on the PHP Chinese website!