Bitrix API

UrlManager

FinalYes

Table of Contents

Constants

ABSOLUTE_URL  = true
AJAX_END_POINT  = '/bitrix/services/main/ajax.php'

Methods

create()  : Uri
Creates uri for the action.
createByBitrixComponent()  : Uri
Creates uri for the bitrix component which implements @see \Bitrix\Main\Engine\Contract\Controllerable and it's action.
createByComponentController()  : Uri
Creates uri for the controller in component and it's action.
createByController()  : Uri
Creates uri for the controller and it's action.
getEndPoint()  : Uri
Returns uri for the end point.
getHostUrl()  : string
Returns host url with port and scheme.
getInstance()  : UrlManager

Constants

AJAX_END_POINT

public mixed AJAX_END_POINT = '/bitrix/services/main/ajax.php'

Methods

create()

Creates uri for the action.

public create(string $action[, array<string|int, mixed> $params = [] ][, bool $absolute = false ]) : Uri
Parameters
$action : string

The fully qualified action name.

$params : array<string|int, mixed> = []

Additional parameters for action.

$absolute : bool = false

Generate absolute uri or not.

Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
Return values
Uri

createByBitrixComponent()

Creates uri for the bitrix component which implements @see \Bitrix\Main\Engine\Contract\Controllerable and it's action.

public createByBitrixComponent(CBitrixComponent $component, string $action[, array<string|int, mixed> $params = array() ][, bool $absolute = false ]) : Uri
Parameters
$component : CBitrixComponent
$action : string

Relative action name.

$params : array<string|int, mixed> = array()

Additional parameters for action.

$absolute : bool = false

Generate absolute uri or not.

Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
Return values
Uri

createByComponentController()

Creates uri for the controller in component and it's action.

public createByComponentController(Controller $controller, string $action[, array<string|int, mixed> $params = array() ][, bool $absolute = false ]) : Uri
Parameters
$controller : Controller

Controller.

$action : string

Relative action name.

$params : array<string|int, mixed> = array()

Additional parameters for action.

$absolute : bool = false

Generate absolute uri or not.

Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
throws
ReflectionException
Return values
Uri

createByController()

Creates uri for the controller and it's action.

public createByController(Controller $controller, string $action[, array<string|int, mixed> $params = array() ][, bool $absolute = false ]) : Uri
Parameters
$controller : Controller

Controller.

$action : string

Relative action name.

$params : array<string|int, mixed> = array()

Additional parameters for action.

$absolute : bool = false

Generate absolute uri or not.

Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
Return values
Uri

getEndPoint()

Returns uri for the end point.

public getEndPoint([bool $absolute = false ]) : Uri
Parameters
$absolute : bool = false

Generate absolute uri or not.

Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
Return values
Uri

getHostUrl()

Returns host url with port and scheme.

public getHostUrl() : string
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results