1. Documentation
  2. API
  3. Library
  4. Router
  5. UrlGenerator

October\Rain\Router\UrlGenerator

Source: ~/vendor/october/rain/src/Router/UrlGenerator.php

Extends:

  • Illuminate\Routing\UrlGenerator

Implements:

  • Illuminate\Contracts\Routing\UrlGenerator

Protected properties

There are no protected properties in the class.

Show inherited protected properties

Inherited protected properties

  • protected Illuminate\Routing\RouteCollection $routes - defined in Illuminate\Routing\UrlGenerator. The route collection.
  • protected Illuminate\Http\Request $request - defined in Illuminate\Routing\UrlGenerator. The request instance.
  • protected string $forcedRoot - defined in Illuminate\Routing\UrlGenerator. The forced URL root.
  • protected string $forceScheme - defined in Illuminate\Routing\UrlGenerator. The forced schema for URLs.
  • protected string|null $cachedRoot - defined in Illuminate\Routing\UrlGenerator. A cached copy of the URL root for the current request.
  • protected string|null $cachedSchema - defined in Illuminate\Routing\UrlGenerator. A cached copy of the URL schema for the current request.
  • protected string $rootNamespace - defined in Illuminate\Routing\UrlGenerator. The root namespace being applied to controller actions.
  • protected callable $sessionResolver - defined in Illuminate\Routing\UrlGenerator. The session resolver callable.
  • protected Closure $formatHostUsing - defined in Illuminate\Routing\UrlGenerator. The callback to use to format hosts.
  • protected Closure $formatPathUsing - defined in Illuminate\Routing\UrlGenerator. The callback to use to format paths.
  • protected Illuminate\Routing\RouteUrlGenerator|null $routeGenerator - defined in Illuminate\Routing\UrlGenerator. The route URL generator instance.
  • protected static array $macros - defined in Illuminate\Routing\UrlGenerator. The registered string macros.

Public methods

public static string buildUrl(array $url, array $replace=array(), mixed $flags=1, array &$newUrl=array())

Build a URL from an array returned from a parse_url call.

This function serves as a counterpart to the parse_url method available in PHP, and a userland implementation of the http_build_query method provided by the PECL HTTP module. This allows a developer to parse a URL to an array and make adjustments to the URL parts before combining them into a valid URL reference string.

Based off of the implentation at https://github.com/jakeasmith/http_build_url/blob/master/src/http_build_url.php.

Parameters
  • array $url - The URL parts, as an array. Must match the structure returned from a parse_url call.
  • array $replace - The URL replacement parts. Allows a developer to replace certain sections of the URL with a different value.
  • mixed $flags - A bitmask of binary or'ed HTTP_URL constants. By default, this is set to HTTP_URL_REPLACE.
  • array &$newUrl - If set, this will be filled with the array parts of the composed URL, similar to the return value of parse_url.

Show inherited public methods

Inherited public methods

  • public mixed __call(string $method, array $parameters) - defined in Illuminate\Routing\UrlGenerator. Dynamically handle calls to the class.
  • public static mixed __callStatic(string $method, array $parameters) - defined in Illuminate\Routing\UrlGenerator. Dynamically handle calls to the class.
  • public void __construct(Illuminate\Routing\RouteCollection $routes, Illuminate\Http\Request $request) - defined in Illuminate\Routing\UrlGenerator. Create a new URL Generator instance.
  • public string action(string $action, mixed $parameters=array(), bool $absolute=true) - defined in Illuminate\Routing\UrlGenerator. Get the URL to a controller action.
  • public string asset(string $path, bool|null $secure=NULL) - defined in Illuminate\Routing\UrlGenerator. Generate the URL to an application asset.
  • public string assetFrom(string $root, string $path, bool|null $secure=NULL) - defined in Illuminate\Routing\UrlGenerator. Generate the URL to an asset from a custom root domain such as CDN, etc.
  • public string current() - defined in Illuminate\Routing\UrlGenerator. Get the current URL for the request.
  • public void defaults(array $defaults) - defined in Illuminate\Routing\UrlGenerator. Set the default named parameters used by the URL generator.
  • public void forceRootUrl(string $root) - defined in Illuminate\Routing\UrlGenerator. Set the forced root URL.
  • public void forceScheme(string $schema) - defined in Illuminate\Routing\UrlGenerator. Force the scheme for URLs.
  • public string format(string $root, string $path) - defined in Illuminate\Routing\UrlGenerator. Format the given URL segments into a single URL.
  • public $this formatHostUsing(Closure $callback) - defined in Illuminate\Routing\UrlGenerator. Set a callback to be used to format the host of generated URLs.
  • public array formatParameters(mixed|array $parameters) - defined in Illuminate\Routing\UrlGenerator. Format the array of URL parameters.
  • public $this formatPathUsing(Closure $callback) - defined in Illuminate\Routing\UrlGenerator. Set a callback to be used to format the path of generated URLs.
  • public string formatRoot(string $scheme, string $root=NULL) - defined in Illuminate\Routing\UrlGenerator. Get the base URL for the request.
  • public string formatScheme(bool|null $secure) - defined in Illuminate\Routing\UrlGenerator. Get the default scheme for a raw URL.
  • public string full() - defined in Illuminate\Routing\UrlGenerator. Get the full URL for the current request.
  • public array getDefaultParameters() - defined in Illuminate\Routing\UrlGenerator. Get the default named parameters used by the URL generator.
  • public Illuminate\Http\Request getRequest() - defined in Illuminate\Routing\UrlGenerator. Get the request instance.
  • public static bool hasMacro(string $name) - defined in Illuminate\Routing\UrlGenerator. Checks if macro is registered.
  • public bool isValidUrl(string $path) - defined in Illuminate\Routing\UrlGenerator. Determine if the given path is a valid URL.
  • public static void macro(string $name, object|callable $macro) - defined in Illuminate\Routing\UrlGenerator. Register a custom macro.
  • public static void mixin(object $mixin) - defined in Illuminate\Routing\UrlGenerator. Mix another object into the class.
  • public Closure pathFormatter() - defined in Illuminate\Routing\UrlGenerator. Get the path formatter being used by the URL generator.
  • public string previous(mixed $fallback=false) - defined in Illuminate\Routing\UrlGenerator. Get the URL for the previous request.
  • public string route(string $name, mixed $parameters=array(), bool $absolute=true) - defined in Illuminate\Routing\UrlGenerator. Get the URL to a named route.
  • public string secure(string $path, array $parameters=array()) - defined in Illuminate\Routing\UrlGenerator. Generate a secure, absolute URL to the given path.
  • public string secureAsset(string $path) - defined in Illuminate\Routing\UrlGenerator. Generate the URL to a secure asset.
  • public void setRequest(Illuminate\Http\Request $request) - defined in Illuminate\Routing\UrlGenerator. Set the current request instance.
  • public $this setRootControllerNamespace(string $rootNamespace) - defined in Illuminate\Routing\UrlGenerator. Set the root controller namespace.
  • public $this setRoutes(Illuminate\Routing\RouteCollection $routes) - defined in Illuminate\Routing\UrlGenerator. Set the route collection.
  • public $this setSessionResolver(callable $sessionResolver) - defined in Illuminate\Routing\UrlGenerator. Set the session resolver for the generator.
  • public string to(string $path, mixed $extra=array(), bool|null $secure=NULL) - defined in Illuminate\Routing\UrlGenerator. Generate an absolute URL to the given path.

Protected methods

Show inherited protected methods

Inherited protected methods

  • protected array extractQueryString(string $path) - defined in Illuminate\Routing\UrlGenerator. Extract the query string from the given path.
  • protected string formatAction(string $action) - defined in Illuminate\Routing\UrlGenerator. Format the given controller action.
  • protected string|null getPreviousUrlFromSession() - defined in Illuminate\Routing\UrlGenerator. Get the previous URL from the session if possible.
  • protected Illuminate\Session\Store|null getSession() - defined in Illuminate\Routing\UrlGenerator. Get the session implementation from the resolver.
  • protected string removeIndex(string $root) - defined in Illuminate\Routing\UrlGenerator. Remove the index.php file from a path.
  • protected Illuminate\Routing\RouteUrlGenerator routeUrl() - defined in Illuminate\Routing\UrlGenerator. Get the Route URL generator instance.
  • protected string toRoute(Illuminate\Routing\Route $route, mixed $parameters, bool $absolute) - defined in Illuminate\Routing\UrlGenerator. Get the URL for a given route instance.