• Home
• Illuminate
• Routing
• UrlGenerator

PHP Class Illuminate\Routing\UrlGenerator

ファイルを表示 Open project: illuminate/routing Class Usage Examples

Protected Properties

Property	Type	Description
$cachedRoot	string | null	A cached copy of the URL root for the current request.
$cachedSchema	string | null	A cached copy of the URL schema for the current request.
$dontEncode	array	Characters that should not be URL encoded.
$forceSchema	string	The forced schema for URLs.
$forcedRoot	string	The forced URL root.
$formatHostUsing	Closure	The callback to use to format hosts.
$formatPathUsing	Closure	The callback to use to format paths.
$request	Illuminate\Http\Request	The request instance.
$rootNamespace	string	The root namespace being applied to controller actions.
$routes	Illuminate\Routing\RouteCollection	The route collection.
$sessionResolver	callable	The session resolver callable.

Public Methods

Method	Description
__construct ( RouteCollection $routes, Illuminate\Http\Request $request ) : void	Create a new URL Generator instance.
action ( string $action, mixed $parameters = [], boolean $absolute = true ) : string	Get the URL to a controller action.
asset ( string $path, boolean | null $secure = null ) : string	Generate the URL to an application asset.
assetFrom ( string $root, string $path, boolean | null $secure = null ) : string	Generate the URL to an asset from a custom root domain such as CDN, etc.
current ( ) : string	Get the current URL for the request.
forceRootUrl ( string $root ) : void	Set the forced root URL.
forceSchema ( string $schema ) : void	Force the schema for URLs.
formatHostUsing ( Closur\Closure $callback )	Set a callback to be used to format the host of generated URLs.
formatPathUsing ( Closur\Closure $callback )	Set a callback to be used to format the path of generated URLs.
full ( ) : string	Get the full URL for the current request.
getRequest ( ) : Illuminate\Http\Request	Get the request instance.
isValidUrl ( string $path ) : boolean	Determine if the given path is a valid URL.
pathFormatter ( ) : Closure	Get the path formatter being used by the URL generator.
previous ( mixed $fallback = false ) : string	Get the URL for the previous request.
route ( string $name, mixed $parameters = [], boolean $absolute = true ) : string	Get the URL to a named route.
secure ( string $path, array $parameters = [] ) : string	Generate a secure, absolute URL to the given path.
secureAsset ( string $path ) : string	Generate the URL to a secure asset.
setRequest ( Illuminate\Http\Request $request ) : void	Set the current request instance.
setRootControllerNamespace ( string $rootNamespace )	Set the root controller namespace.
setRoutes ( RouteCollection $routes )	Set the route collection.
setSessionResolver ( callable $sessionResolver )	Set the session resolver for the generator.
to ( string $path, mixed $extra = [], boolean | null $secure = null ) : string	Generate an absolute URL to the given path.

Protected Methods

Method	Description
addPortToDomain ( string $domain ) : string	Add the port to the domain if necessary.
addQueryString ( string $uri, array $parameters ) : mixed | string	Add a query string to the URI.
buildCompleteUrl ( string $root, string $path, string $tail = '' ) : string	Format the given URL segments into a single URL.
formatDomain ( Illuminate\Routing\Route $route, array &$parameters ) : string	Format the domain and port for the route and request.
formatParameters ( mixed | array $parameters ) : array	Format the array of URL parameters.
getDomainAndScheme ( Illuminate\Routing\Route $route ) : string	Get the domain and scheme for the route.
getNumericParameters ( array $parameters ) : array	Get the numeric parameters from a given list.
getPreviousUrlFromSession ( ) : string | null	Get the previous URL from the session if possible.
getRootUrl ( string $scheme, string $root = null ) : string	Get the base URL for the request.
getRouteDomain ( Illuminate\Routing\Route $route, array &$parameters ) : string	Get the formatted domain for a given route.
getRouteQueryString ( array $parameters ) : string	Get the query string for a given route.
getRouteRoot ( Illuminate\Routing\Route $route, string $domain ) : string	Get the root of the route URL.
getRouteScheme ( Illuminate\Routing\Route $route ) : string	Get the scheme for the given route.
getScheme ( boolean | null $secure ) : string	Get the scheme for a raw URL.
getSession ( ) : Illuminate\Session\Store | null	Get the session implementation from the resolver.
getStringParameters ( array $parameters ) : array	Get the string parameters from a given list.
removeIndex ( string $root ) : string	Remove the index.php file from a path.
replaceNamedParameters ( string $path, array &$parameters ) : string	Replace all of the named parameters in the path.
replaceRoot ( Illuminate\Routing\Route $route, string $domain, array &$parameters ) : string	Replace the parameters on the root path.
replaceRoutableParameters ( array $parameters = [] ) : array	Replace UrlRoutable parameters with their route parameter.
replaceRouteParameters ( string $path, array &$parameters ) : string	Replace all of the wildcard parameters for a route path.
toRoute ( Illuminate\Routing\Route $route, mixed $parameters, boolean $absolute ) : string	Get the URL for a given route instance.

Method Details

Property Details