HumHub Documentation (unofficial)

UrlNormalizer extends BaseObject
in package

UrlNormalizer normalizes URLs for [[UrlManager]] and [[UrlRule]].

Tags
author

Robert Korulczyk robert@korulczyk.pl

author

Cronfy cronfy@gmail.com

since
2.0.10

Table of Contents

Constants

ACTION_NOT_FOUND  = 404
Represents showing 404 error page during route normalization.
ACTION_REDIRECT_PERMANENT  = 301
Represents permament redirection during route normalization.
ACTION_REDIRECT_TEMPORARY  = 302
Represents temporary redirection during route normalization.

Properties

$action  : int|callable|null
$collapseSlashes  : bool
$normalizeTrailingSlash  : bool

Methods

__call()  : mixed
Calls the named method which is not a class method.
__construct()  : mixed
Constructor.
__get()  : mixed
Returns the value of an object property.
__isset()  : bool
Checks if a property is set, i.e. defined and not null.
__set()  : mixed
Sets value of an object property.
__unset()  : mixed
Sets an object property to null.
canGetProperty()  : bool
Returns a value indicating whether a property can be read.
canSetProperty()  : bool
Returns a value indicating whether a property can be set.
className()  : string
Returns the fully qualified name of this class.
hasMethod()  : bool
Returns a value indicating whether a method is defined.
hasProperty()  : bool
Returns a value indicating whether a property is defined.
init()  : mixed
Initializes the object.
normalizePathInfo()  : string
Normalizes specified pathInfo.
normalizeRoute()  : array<string|int, mixed>
Performs normalization action for the specified $route.
collapseSlashes()  : string
Collapse consecutive slashes in $pathInfo, for example converts `site///index` into `site/index`.
normalizeTrailingSlash()  : string
Adds or removes trailing slashes from $pathInfo depending on whether the $suffix has a trailing slash or not.

Constants

Properties

$action

public int|callable|null $action = self::ACTION_REDIRECT_PERMANENT

action to perform during route normalization. Available options are:

  • null - no special action will be performed

  • 301 - the request should be redirected to the normalized URL using permanent redirection

  • 302 - the request should be redirected to the normalized URL using temporary redirection

  • 404 - [[NotFoundHttpException]] will be thrown

  • callable - custom user callback, for example:

    function ($route, $normalizer) {
    // use custom action for redirections
    $route[1]['oldRoute'] = $route[0];
    $route[0] = 'site/redirect';
    return $route;
}

$collapseSlashes

public bool $collapseSlashes = true

whether slashes should be collapsed, for example site///index will be converted into site/index

$normalizeTrailingSlash

public bool $normalizeTrailingSlash = true

whether trailing slash should be normalized according to the suffix settings of the rule

Methods

__call()

Calls the named method which is not a class method.

public __call(string $name, array<string|int, mixed> $params) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

Parameters
$name : string

the method name

$params : array<string|int, mixed>

method parameters

Tags
throws
UnknownMethodException

when calling unknown method

Return values
mixed —

the method return value

__construct()

Constructor.

public __construct([array<string|int, mixed> $config = [] ]) : mixed

The default implementation does two things:

  • Initializes the object with the given configuration $config.
  • Call [[init()]].

If this method is overridden in a child class, it is recommended that

  • the last parameter of the constructor is a configuration array, like $config here.
  • call the parent implementation at the end of the constructor.
Parameters
$config : array<string|int, mixed> = []

name-value pairs that will be used to initialize the object properties

__get()

Returns the value of an object property.

public __get(string $name) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $object->property;.

Parameters
$name : string

the property name

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is write-only

see
__set()
Return values
mixed —

the property value

__isset()

Checks if a property is set, i.e. defined and not null.

public __isset(string $name) : bool

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($object->property).

Note that if the property is not defined, false will be returned.

Parameters
$name : string

the property name or the event name

Tags
see
https://www.php.net/manual/en/function.isset.php
Return values
bool —

whether the named property is set (not null).

__set()

Sets value of an object property.

public __set(string $name, mixed $value) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $object->property = $value;.

Parameters
$name : string

the property name or the event name

$value : mixed

the property value

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is read-only

see
__get()

__unset()

Sets an object property to null.

public __unset(string $name) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($object->property).

Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.

Parameters
$name : string

the property name

Tags
throws
InvalidCallException

if the property is read only.

see
https://www.php.net/manual/en/function.unset.php

canGetProperty()

Returns a value indicating whether a property can be read.

public canGetProperty(string $name[, bool $checkVars = true ]) : bool

A property is readable if:

  • the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canSetProperty()
Return values
bool —

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.

public canSetProperty(string $name[, bool $checkVars = true ]) : bool

A property is writable if:

  • the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canGetProperty()
Return values
bool —

whether the property can be written

className()

Returns the fully qualified name of this class.

public static className() : string
Tags
deprecated

since 2.0.14. On PHP >=5.5, use ::class instead.

Return values
string —

the fully qualified name of this class.

hasMethod()

Returns a value indicating whether a method is defined.

public hasMethod(string $name) : bool

The default implementation is a call to php function method_exists(). You may override this method when you implemented the php magic method __call().

Parameters
$name : string

the method name

Return values
bool —

whether the method is defined

hasProperty()

Returns a value indicating whether a property is defined.

public hasProperty(string $name[, bool $checkVars = true ]) : bool

A property is defined if:

  • the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canGetProperty()
see
canSetProperty()
Return values
bool —

whether the property is defined

init()

Initializes the object.

public init() : mixed

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

normalizePathInfo()

Normalizes specified pathInfo.

public normalizePathInfo(string $pathInfo, string $suffix[, bool &$normalized = false ]) : string
Parameters
$pathInfo : string

pathInfo for normalization

$suffix : string

current rule suffix

$normalized : bool = false

if specified, this variable will be set to true if $pathInfo was changed during normalization

Return values
string —

normalized pathInfo

normalizeRoute()

Performs normalization action for the specified $route.

public normalizeRoute(array<string|int, mixed> $route) : array<string|int, mixed>
Parameters
$route : array<string|int, mixed>

route for normalization

Tags
throws
InvalidConfigException

if invalid normalization action is used.

throws
UrlNormalizerRedirectException

if normalization requires redirection.

throws
NotFoundHttpException

if normalization suggests action matching route does not exist.

Return values
array<string|int, mixed> —

normalized route

collapseSlashes()

Collapse consecutive slashes in $pathInfo, for example converts `site///index` into `site/index`.

protected collapseSlashes(string $pathInfo) : string
Parameters
$pathInfo : string

raw path info.

Return values
string —

normalized path info.

normalizeTrailingSlash()

Adds or removes trailing slashes from $pathInfo depending on whether the $suffix has a trailing slash or not.

protected normalizeTrailingSlash(string $pathInfo, string $suffix) : string
Parameters
$pathInfo : string

raw path info.

$suffix : string
Return values
string —

normalized path info.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results