UrlGenerator

Get the number of seconds until the given DateTime.

Get the "available at" UNIX timestamp.

If the given value is an interval, convert it to a DateTime instance.

Get the current system time as a UNIX timestamp.

Given a start time, format the total run time for human readability.

Register a custom macro.

Boot-only. Macros persist in a static property for the worker lifetime and apply to every subsequent call on the macroable class.

Mix another object into the class.

Boot-only. Delegates to macro() for each method; registered macros persist in a static property for the worker lifetime.

Check if macro is registered.

Flush the existing macros.

Boot or tests only. Clears worker-wide macros; concurrent coroutines may resolve different methods depending on timing.

Dynamically handle calls to the class.

Dynamically handle calls to the class.

Create a new URL generator instance.

Get the full URL for the current request.

Get the current URL for the request.

Get the URL for the previous request.

Get the previous path info for the request.

Get the previous URL from the session if possible.

Generate an absolute URL to the given path.

Generate an absolute URL with the given query parameters.

Generate a secure, absolute URL to the given path.

Generate the URL to an application asset.

Generate the URL to a secure asset.

Generate the URL to an asset from a custom root domain such as CDN, etc.

Remove the index.php file from a path.

Get the default scheme for a raw URL.

Create a signed route URL for a named route.

Ensure the given signed route parameters are not reserved.

Create a temporary signed route URL for a named route.

Determine if the given request has a valid signature.

Determine if the given request has a valid signature for a relative URL.

Determine if the signature from the given request matches the URL.

Determine if the expires timestamp from the given request is not from the past.

Get the URL to a named route.

Get the URL for a given route instance.

Get the URL to a controller action.

Format the given controller action.

Format the array of URL parameters.

Extract the query string from the given path.

Get the base URL for the request.

Resolve the root URL for the current coroutine.

Format the given URL segments into a single URL.

Determine if the given path is a valid URL.

Get the route URL generator instance.

The RouteUrlGenerator is cached on the instance for its default parameters, but its request is always resolved fresh from the UrlGenerator to ensure coroutine safety in Swoole's long-lived workers.

Register the default route parameter resolver.

Boot-only. The callback persists on the worker-shared URL generator and is evaluated for subsequent route generations across all coroutines.

Set the default named parameters used by the URL generator.

Request-scoped when a request is present: the defaults are stored in coroutine Context and isolated to the current request. Outside a request (boot, queue jobs, scheduled tasks, console), they are stored on the worker-global route URL generator, shared across concurrent coroutines and persisting for the worker lifetime until changed or flushed.

Use useDefaults() for operation-local defaults outside an HTTP request.

Get the effective default named parameters used by the URL generator.

Replace the default route parameters for the current coroutine.

Force the scheme for URLs.

Boot-only. The scheme is stored on the worker-shared URL generator singleton and affects subsequent requests across coroutines; not safe to call per-request.

Get the forced scheme for URLs.

Force the use of the HTTPS scheme for all generated URLs.

Boot-only. The scheme is stored on the worker-shared URL generator singleton and affects subsequent requests across coroutines; not safe to call per-request.

Register the URL origin resolver.

Boot-only. The callback persists on the worker-shared URL generator and is evaluated for subsequent URL generations across all coroutines.

Set the URL origin for the current coroutine.

Stored in coroutine Context so one request, job, or command cannot affect concurrent work.

Set the asset URL origin for the current coroutine.

Stored in coroutine Context so one request, job, or command cannot affect concurrent work.

Set a callback to be used to format the host of generated URLs.

Boot-only. The callback persists on the singleton URL generator and affects every subsequent request.

Set a callback to be used to format the path of generated URLs.

Boot-only. The callback persists on the singleton URL generator and affects every subsequent request.

Get the path formatter being used by the URL generator.

Get the request instance.

In Swoole's long-lived workers, the UrlGenerator is a singleton. The request must be resolved from the coroutine-local RequestContext to avoid one coroutine's request leaking to another.

Set the current request instance.

Tests only. Per-request code should rely on RequestContext (read first by getRequest()); this setter writes the singleton UrlGenerator's fallback request used outside coroutine contexts, plus mutates the shared routeGenerator — runtime use races across coroutines.

Set the route collection.

Boot or tests only. Replacing the collection mutates the singleton URL generator for every subsequent request.

Get the session implementation from the resolver.

Set the session resolver for the generator.

Boot-only. The resolver persists on the singleton URL generator and affects every subsequent request.

Set the encryption key resolver.

Boot-only. The resolver persists on the singleton URL generator and affects every subsequent request.

Clone a new instance of the URL generator with a different encryption key resolver.

Set the callback that should be used to attempt to resolve missing named routes.

Boot-only. The callback persists on the singleton URL generator and affects every subsequent request.

Get the root controller namespace.

Set the root controller namespace.

Boot-only. The namespace persists on the singleton URL generator and affects every subsequent request.

Flush all static state.