Link
in package
Provides API to handle custom links.
Table of Contents
- IGNORE_MODULE = -1
- $__cacheSchemaChanges : mixed
- Cache (Record) the schema changes to improve performance
- $handler : mixed
- $handler_class : mixed
- $handler_path : mixed
- $icon : mixed
- $linkicon : mixed
- $linkid : mixed
- $linklabel : mixed
- $linktype : mixed
- $linkurl : mixed
- $params : mixed
- $sequence : mixed
- $status : mixed
- $tabid : mixed
- addLink() : mixed
- Add link given module.
- deleteAll() : mixed
- Delete all links related to module.
- deleteLink() : mixed
- Delete link of the module.
- getAll() : mixed
- Get all the links related to module.
- getAllByType() : mixed
- Get all the link related to module based on type.
- getAllForExport() : mixed
- Extract the links of module for export.
- getLinkData() : array<string|int, mixed>
- Link data.
- initialize() : mixed
- Initialize this instance.
- module() : mixed
- Get module name.
Constants
IGNORE_MODULE
public
mixed
IGNORE_MODULE
= -1
Properties
$__cacheSchemaChanges
Cache (Record) the schema changes to improve performance
public
static mixed
$__cacheSchemaChanges
= []
$handler
public
mixed
$handler
$handler_class
public
mixed
$handler_class
$handler_path
public
mixed
$handler_path
$icon
public
mixed
$icon
$linkicon
public
mixed
$linkicon
$linkid
public
mixed
$linkid
$linklabel
public
mixed
$linklabel
$linktype
public
mixed
$linktype
$linkurl
public
mixed
$linkurl
$params
public
mixed
$params
$sequence
public
mixed
$sequence
$status
public
mixed
$status
= false
$tabid
public
mixed
$tabid
Methods
addLink()
Add link given module.
public
static addLink(int $tabid, string $type, string $label, string $url[, string $iconpath = '' ], int $sequence[, array<string|int, mixed>|null $handlerInfo = null ][, string|null $linkParams = null ]) : mixed
Parameters
- $tabid : int
-
Module ID
- $type : string
-
Link Type (like DETAIL_VIEW_BASIC). Useful for grouping based on pages
- $label : string
-
Label to display
- $url : string
-
HREF value or URL to use for the link
- $iconpath : string = ''
-
ICON to use on the display
- $sequence : int
-
Order or sequence of displaying the link
- $handlerInfo : array<string|int, mixed>|null = null
- $linkParams : string|null = null
Return values
mixed —deleteAll()
Delete all links related to module.
public
static deleteAll(int $tabid) : mixed
Parameters
- $tabid : int
-
Module ID
Return values
mixed —deleteLink()
Delete link of the module.
public
static deleteLink(int $tabid, string $type, string $label[, string $url = false ]) : mixed
Parameters
- $tabid : int
-
Module ID
- $type : string
-
Link Type (like DETAIL_VIEW_BASIC). Useful for grouping based on pages
- $label : string
-
Display label
- $url : string = false
-
URL of link to lookup while deleting
Return values
mixed —getAll()
Get all the links related to module.
public
static getAll(int $tabid) : mixed
Parameters
- $tabid : int
-
Module ID
Return values
mixed —getAllByType()
Get all the link related to module based on type.
public
static getAllByType(int $tabid[, mixed $type = false ][, array<string|int, mixed> $parameters = false ]) : mixed
Parameters
- $tabid : int
-
Module ID
- $type : mixed = false
-
String or List of types to select
- $parameters : array<string|int, mixed> = false
-
Map Key-Value pair to use for formating the link url
Return values
mixed —getAllForExport()
Extract the links of module for export.
public
static getAllForExport(mixed $tabid) : mixed
Parameters
- $tabid : mixed
Return values
mixed —getLinkData()
Link data.
public
static getLinkData(int $linkId) : array<string|int, mixed>
Parameters
- $linkId : int
Return values
array<string|int, mixed> —initialize()
Initialize this instance.
public
initialize(array<string|int, mixed> $valuemap) : mixed
Parameters
- $valuemap : array<string|int, mixed>
Return values
mixed —module()
Get module name.
public
module() : mixed