Contentserv PHP API

CSToolbox
in package

This class defines the Toolbox API

Tags
since

PXC24.2

Table of Contents

createGui()  : CSToolboxGui
getAvailablePlugins()  : array<string|int, CSToolboxLinkPlugin>
Retrieves a list of plugins that are currently licensed available
getDialogUrl()  : string
Builds the URL for the Toolbox Dialog
getSelectedPlugins()  : array<string|int, CSToolboxLinkPlugin>
Retrieves a list of plugins that are currently selected by the global options
isSelectedPlugin()  : bool
Tells if a plugin is amongst the globally selected plugins if they are filtered

Methods

getAvailablePlugins()

Retrieves a list of plugins that are currently licensed available

public static getAvailablePlugins() : array<string|int, CSToolboxLinkPlugin>

This does not mean, that each plugin is also permitted for the current user

Tags
Return values
array<string|int, CSToolboxLinkPlugin> —

getDialogUrl()

Builds the URL for the Toolbox Dialog

public static getDialogUrl(string $sClass, int $iID[, string $sTool = null ]) : string
Parameters
$sClass : string
$iID : int
$sTool : string = null
Tags
Return values
string —

the URL

getSelectedPlugins()

Retrieves a list of plugins that are currently selected by the global options

public static getSelectedPlugins() : array<string|int, CSToolboxLinkPlugin>

This does not mean, that each plugin is also permitted for the current user

Tags
Return values
array<string|int, CSToolboxLinkPlugin> —

isSelectedPlugin()

Tells if a plugin is amongst the globally selected plugins if they are filtered

public static isSelectedPlugin(string $sPluginName) : bool
Parameters
$sPluginName : string
Tags
Return values
bool —

true if either no filter is configured or the plugin is amongst the selected ones


        

        
    




    

    

                

    

        

            
Search results