UrlHelper class for generating URLs.
_View
, _defaultConfig
, _helperMap
, fieldset
, helpers
, plugin
, request
, tags
, theme
_config
, _configInitialized
Adds a timestamp to a file based resource based on the value of Asset.timestamp
in Configure. If Asset.timestamp is true and debug is true, or Asset.timestamp === 'force' a timestamp will be added.
_encodeUrl( string $url )
Encodes a URL for use in HTML attributes.
$url
_inflectThemeName( string $name )
Inflect the theme name to its underscored version.
$name
assetTimestamp( string $path , boolean|string $timestamp null )
Adds a timestamp to a file based resource based on the value of Asset.timestamp
in Configure. If Asset.timestamp is true and debug is true, or Asset.timestamp === 'force' a timestamp will be added.
$path
$timestamp
optional null Asset.timestamp
in Configure.assetUrl( string|array $path , array $options [] )
Generates URL for given asset file.
Depending on options passed provides full URL with domain name. Also calls Helper::assetTimestamp()
to add timestamp to local files.
$path
$options
optional [] Options array. Possible keys: fullBase
Return full URL with domain name pathPrefix
Path prefix for relative URLs ext
Asset extension to append plugin
False value will prevent parsing path as a plugin timestamp
Overrides the value of Asset.timestamp
in Configure. Set to false to skip timestamp generation. Set to true to apply timestamps when debug is true. Set to 'force' to always enable timestamping regardless of debug value.
build( string|array|null $url null , array|boolean $options false )
Returns a URL based on provided parameters.
escape
: If false, the URL will be returned unescaped, do only use if it is manually escaped afterwards before being displayed.fullBase
: If true, the full base URL will be prepended to the result$url
optional 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
optional false full
for BC reasons.css( string|array $path , array $options [] )
Generates URL for given CSS file.
Depending on options passed provides full URL with domain name. Also calls Helper::assetTimestamp()
to add timestamp to local files.
$path
$options
optional [] Options array. Possible keys: fullBase
Return full URL with domain name pathPrefix
Path prefix for relative URLs ext
Asset extension to append plugin
False value will prevent parsing path as a plugin timestamp
Overrides the value of Asset.timestamp
in Configure. Set to false to skip timestamp generation. Set to true to apply timestamps when debug is true. Set to 'force' to always enable timestamping regardless of debug value.
image( string|array $path , array $options [] )
Generates URL for given image file.
Depending on options passed provides full URL with domain name. Also calls Helper::assetTimestamp()
to add timestamp to local files.
$path
$options
optional [] Options array. Possible keys: fullBase
Return full URL with domain name pathPrefix
Path prefix for relative URLs plugin
False value will prevent parsing path as a plugin timestamp
Overrides the value of Asset.timestamp
in Configure. Set to false to skip timestamp generation. Set to true to apply timestamps when debug is true. Set to 'force' to always enable timestamping regardless of debug value.
implementedEvents( )
Event listeners.
Cake\View\Helper::implementedEvents()
script( string|array $path , array $options [] )
Generates URL for given javascript file.
Depending on options passed provides full URL with domain name. Also calls Helper::assetTimestamp()
to add timestamp to local files.
$path
$options
optional [] Options array. Possible keys: fullBase
Return full URL with domain name pathPrefix
Path prefix for relative URLs ext
Asset extension to append plugin
False value will prevent parsing path as a plugin timestamp
Overrides the value of Asset.timestamp
in Configure. Set to false to skip timestamp generation. Set to true to apply timestamps when debug is true. Set to 'force' to always enable timestamping regardless of debug value.
webroot( string $file )
Checks if a file exists when theme is used, if no file is found default location is returned
$file
__call( string $method , array $params )
Provide non fatal errors on missing method calls.
$method
$params
__construct( Cake\View\View $View , array $config [] )
Default Constructor
Cake\View\View
$View
$config
optional [] __debugInfo( )
Returns an array that can be used to describe the internal state of this object.
__get( string $name )
Lazy loads helpers.
$name
Cake\View\Helper
|null_confirm( string $message , string $okCode , string $cancelCode '' , array $options [] )
Returns a string to be used as onclick handler for confirm dialogs.
$message
$okCode
$cancelCode
optional '' $options
optional [] addClass( array $options [] , string|null $class null , string $key 'class' )
Adds the given class to the element options
$options
optional [] $class
optional null $key
optional 'class' getView( )
Get the view instance this helper is bound to.
Cake\View\View
initialize( array $config )
Constructor hook method.
Implement this method to avoid having to overwrite the constructor and call parent.
$config
_configDelete( string $key )
Deletes a single config key.
$key
Cake\Core\Exception\Exception
_configRead( string|null $key )
Reads a config key.
$key
_configWrite( string|array $key , mixed $value , boolean|string $merge false )
Writes a config key.
$key
$value
$merge
optional false True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Cake\Core\Exception\Exception
config( string|array|null $key null , mixed|null $value null , boolean $merge true )
Gets/Sets the config.
Reading the whole config:
$this->config();
Reading a specific value:
$this->config('key');
Reading a nested value:
$this->config('some.nested.key');
Setting a specific value:
$this->config('key', $value);
Setting a nested value:
$this->config('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->config(['one' => 'value', 'another' => 'value']);
$key
optional null $value
optional null $merge
optional true Cake\Core\Exception\Exception
configShallow( string|array $key , mixed|null $value null )
Merge provided config with existing config. Unlike config()
which does a recursive merge for nested keys, this method does a simple merge.
Setting a specific value:
$this->configShallow('key', $value);
Setting a nested value:
$this->configShallow('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->configShallow(['one' => 'value', 'another' => 'value']);
$key
$value
optional null getConfig( string|null $key null , mixed $default null )
Returns the config.
Reading the whole config:
$this->getConfig();
Reading a specific value:
$this->getConfig('key');
Reading a nested value:
$this->getConfig('some.nested.key');
Reading with default value:
$this->getConfig('some-key', 'default-value');
$key
optional null $default
optional null setConfig( string|array $key , mixed|null $value null , boolean $merge true )
Sets the config.
Setting a specific value:
$this->setConfig('key', $value);
Setting a nested value:
$this->setConfig('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->setConfig(['one' => 'value', 'another' => 'value']);
$key
$value
optional null $merge
optional true Cake\Core\Exception\Exception
© 2005–2018 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.6/class-Cake.View.Helper.UrlHelper.html