Phpxforms documentation

AdminNavigation
in package

Administration - navigation inside administration

Tags
author

DaVee

version
0.87dev
license

Lesser General Public License 2.1 or later; see http://www.gnu.org/licenses/lgpl-2.1.html

Table of Contents

Properties

$appDir  : string
$order  : array<string|int, string>
$csrf  : string|null
$current  : string
$dir  : string
$extra  : array<string, mixed>
$langId  : string|null
$moduleId  : string|null
$path  : array<string, string|int>
$sessionInUrl  : bool

Methods

__construct()  : mixed
getLangId()  : string|null
getModuleId()  : string
getParams()  : array<string, string|int>
getUrl()  : string
Returns url
getUrlCurrent()  : string
Returns url on current page
getUrlExtra()  : string
Returns url with set-up extra parameters
getUrlFull()  : string
setExtra()  : void
setLangId()  : void
urlDecode()  : string
Convert url into module name
urlEncode()  : string
Convert module name into url
rUnionArrays()  : array<string|int, mixed>|string|int|null
Join arrays and remove empty(null) items

Properties

$appDir

public static string $appDir = 'admin/'
Tags
deprecated

since version 0.87, will be replaced with administration namespace

$order

public static array<string|int, string> $order = ['LANG', 'MODUL', 'ACTION', 'ID']

$extra

protected array<string, mixed> $extra = ['navigation' => null, 'tabpage' => null, 'order' => null]

Url parameters for keeping

$path

protected array<string, string|int> $path = []

Actions for specific modules

Methods

__construct()

public __construct(string $dir, array<string|int, string> $nav, string|null $csrf) : mixed
Parameters
$dir : string
$nav : array<string|int, string>
$csrf : string|null

getLangId()

public getLangId() : string|null
Return values
string|null

getParams()

public getParams() : array<string, string|int>
Return values
array<string, string|int>

getUrl()

Returns url

public getUrl([array<string, mixed>|string|bool $place = false ][, array<string, mixed>|null $params = null ][, bool $csrf = false ][, bool $href = true ]) : string
Parameters
$place : array<string, mixed>|string|bool = false
$params : array<string, mixed>|null = null
$csrf : bool = false
$href : bool = true
Return values
string

getUrlCurrent()

Returns url on current page

public getUrlCurrent([array<string, mixed>|null $params = null ]) : string
Parameters
$params : array<string, mixed>|null = null
Return values
string

getUrlExtra()

Returns url with set-up extra parameters

public getUrlExtra([array<string, mixed>|string|bool $place = true ][, array<string, mixed>|null $params = null ][, bool $csrf = false ][, bool $href = true ]) : string
Parameters
$place : array<string, mixed>|string|bool = true
$params : array<string, mixed>|null = null
$csrf : bool = false
$href : bool = true
Return values
string

getUrlFull()

public getUrlFull(string $uri[, array<string, mixed>|null $params = null ][, bool $href = true ]) : string
Parameters
$uri : string
$params : array<string, mixed>|null = null
$href : bool = true
Return values
string

setExtra()

public setExtra(string $key[, mixed $value = true ]) : void
Parameters
$key : string
$value : mixed = true

setLangId()

public setLangId(string $langId) : void
Parameters
$langId : string

urlDecode()

Convert url into module name

public urlDecode(string $url) : string
Parameters
$url : string
Return values
string

urlEncode()

Convert module name into url

public urlEncode(string $name) : string
Parameters
$name : string
Return values
string

rUnionArrays()

Join arrays and remove empty(null) items

protected final rUnionArrays(array<string|int, mixed>|string|int|null $a, array<string|int, mixed>|string|int|null $b) : array<string|int, mixed>|string|int|null
Parameters
$a : array<string|int, mixed>|string|int|null
$b : array<string|int, mixed>|string|int|null
Return values
array<string|int, mixed>|string|int|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results