api/laravel/Routing/RouteUrlGenerator.yaml

name: RouteUrlGenerator
class_comment: null
dependencies:
- name: UrlGenerationException
  type: class
  source: Illuminate\Routing\Exceptions\UrlGenerationException
- name: Arr
  type: class
  source: Illuminate\Support\Arr
properties:
- name: url
  visibility: protected
  comment: '# * The URL generator instance.

    # *

    # * @var \Illuminate\Routing\UrlGenerator'
- name: request
  visibility: protected
  comment: '# * The request instance.

    # *

    # * @var \Illuminate\Http\Request'
- name: defaultParameters
  visibility: public
  comment: '# * The named parameter defaults.

    # *

    # * @var array'
- name: dontEncode
  visibility: public
  comment: '# * Characters that should not be URL encoded.

    # *

    # * @var array'
methods:
- name: __construct
  visibility: public
  parameters:
  - name: url
  - name: request
  comment: "# * The URL generator instance.\n# *\n# * @var \\Illuminate\\Routing\\\
    UrlGenerator\n# */\n# protected $url;\n# \n# /**\n# * The request instance.\n\
    # *\n# * @var \\Illuminate\\Http\\Request\n# */\n# protected $request;\n# \n#\
    \ /**\n# * The named parameter defaults.\n# *\n# * @var array\n# */\n# public\
    \ $defaultParameters = [];\n# \n# /**\n# * Characters that should not be URL encoded.\n\
    # *\n# * @var array\n# */\n# public $dontEncode = [\n# '%2F' => '/',\n# '%40'\
    \ => '@',\n# '%3A' => ':',\n# '%3B' => ';',\n# '%2C' => ',',\n# '%3D' => '=',\n\
    # '%2B' => '+',\n# '%21' => '!',\n# '%2A' => '*',\n# '%7C' => '|',\n# '%3F' =>\
    \ '?',\n# '%26' => '&',\n# '%23' => '#',\n# '%25' => '%',\n# ];\n# \n# /**\n#\
    \ * Create a new Route URL generator.\n# *\n# * @param  \\Illuminate\\Routing\\\
    UrlGenerator  $url\n# * @param  \\Illuminate\\Http\\Request  $request\n# * @return\
    \ void"
- name: to
  visibility: public
  parameters:
  - name: route
  - name: parameters
    default: '[]'
  - name: absolute
    default: 'false'
  comment: '# * Generate a URL for the given route.

    # *

    # * @param  \Illuminate\Routing\Route  $route

    # * @param  array  $parameters

    # * @param  bool  $absolute

    # * @return string

    # *

    # * @throws \Illuminate\Routing\Exceptions\UrlGenerationException'
- name: getRouteDomain
  visibility: protected
  parameters:
  - name: route
  - name: '&$parameters'
  comment: '# * Get the formatted domain for a given route.

    # *

    # * @param  \Illuminate\Routing\Route  $route

    # * @param  array  $parameters

    # * @return string'
- name: formatDomain
  visibility: protected
  parameters:
  - name: route
  - name: '&$parameters'
  comment: '# * Format the domain and port for the route and request.

    # *

    # * @param  \Illuminate\Routing\Route  $route

    # * @param  array  $parameters

    # * @return string'
- name: getRouteScheme
  visibility: protected
  parameters:
  - name: route
  comment: '# * Get the scheme for the given route.

    # *

    # * @param  \Illuminate\Routing\Route  $route

    # * @return string'
- name: addPortToDomain
  visibility: protected
  parameters:
  - name: domain
  comment: '# * Add the port to the domain if necessary.

    # *

    # * @param  string  $domain

    # * @return string'
- name: replaceRootParameters
  visibility: protected
  parameters:
  - name: route
  - name: domain
  - name: '&$parameters'
  comment: '# * Replace the parameters on the root path.

    # *

    # * @param  \Illuminate\Routing\Route  $route

    # * @param  string  $domain

    # * @param  array  $parameters

    # * @return string'
- name: replaceRouteParameters
  visibility: protected
  parameters:
  - name: path
  - name: '&$parameters'
  comment: '# * Replace all of the wildcard parameters for a route path.

    # *

    # * @param  string  $path

    # * @param  array  $parameters

    # * @return string'
- name: replaceNamedParameters
  visibility: protected
  parameters:
  - name: path
  - name: '&$parameters'
  comment: '# * Replace all of the named parameters in the path.

    # *

    # * @param  string  $path

    # * @param  array  $parameters

    # * @return string'
- name: addQueryString
  visibility: protected
  parameters:
  - name: uri
  - name: parameters
  comment: '# * Add a query string to the URI.

    # *

    # * @param  string  $uri

    # * @param  array  $parameters

    # * @return mixed|string'
- name: getRouteQueryString
  visibility: protected
  parameters:
  - name: parameters
  comment: '# * Get the query string for a given route.

    # *

    # * @param  array  $parameters

    # * @return string'
- name: getStringParameters
  visibility: protected
  parameters:
  - name: parameters
  comment: '# * Get the string parameters from a given list.

    # *

    # * @param  array  $parameters

    # * @return array'
- name: getNumericParameters
  visibility: protected
  parameters:
  - name: parameters
  comment: '# * Get the numeric parameters from a given list.

    # *

    # * @param  array  $parameters

    # * @return array'
- name: defaults
  visibility: public
  parameters:
  - name: defaults
  comment: '# * Set the default named parameters used by the URL generator.

    # *

    # * @param  array  $defaults

    # * @return void'
traits:
- Illuminate\Routing\Exceptions\UrlGenerationException
- Illuminate\Support\Arr
interfaces: []