PHP Class Tools\Controller\Component\UrlComponent

Author: Mark Scherer

Inheritance: extends Shim\Controller\Component\Component

Public Methods

Method	Description
build ( string \| array \| null $url = null, array $options = [] ) : string	Returns a URL based on provided parameters.
buildComplete ( string \| array \| null $url = null, boolean $full = false ) : string	Returns a URL based on provided parameters.
buildReset ( string \| array \| null $url = null, boolean $full = false ) : string	Creates a reset URL.
completeArray ( array $url ) : array
defaults ( ) : array
resetArray ( array $url ) : array

Method	Description
addQueryStrings ( array $url ) : array

protected addQueryStrings ( array $url ) : array
$url	array
return	array

### Options: - fullBase: If true, the full base URL will be prepended to the result

public build ( string \| array \| null $url = null, array $options = [] ) : string
$url	string \| array \| null	Either a relative string url like `/products/view/23` or an array of URL parameters. Using an array for URLs will allow you to leverage the reverse routing features of CakePHP.
$options	array	Array of options
return	string	Full translated URL with base path.

Can only add query strings for array URLs.

public buildComplete ( string \| array \| null $url = null, boolean $full = false ) : string
$url	string \| array \| null	URL.
$full	boolean	If true, the full base URL will be prepended to the result
return	string	Full translated URL with base path.

The prefix and plugin params are resetting to default false. Can only add defaults for array URLs.

public buildReset ( string \| array \| null $url = null, boolean $full = false ) : string
$url	string \| array \| null	URL.
$full	boolean	If true, the full base URL will be prepended to the result
return	string	Full translated URL with base path.

public completeArray ( array $url ) : array
$url	array
return	array

public defaults ( ) : array
return	array

public resetArray ( array $url ) : array
$url	array
return	array