PHP Class Elgg\Debug\Inspector

Since: 1.11
Show file Open project: elgg/elgg Class Usage Examples

Public Methods

Method Description
describeCallable ( mixed $callable, string $file_root = '' ) : string Get a string description of a callback
getActions ( ) : array Get Elgg actions information
getEvents ( ) : array Get Elgg event information
getMenus ( ) : array Get information about registered menus
getPluginHooks ( ) : array Get Elgg plugin hooks information
getSimpleCache ( ) : array Get simplecache information
getViews ( string $viewtype = 'default' ) : array Get Elgg view information
getViewtypes ( ) : string[] Get all view types for known views
getWebServices ( ) : array Get Elgg web services API methods
getWidgets ( ) : array Get Elgg widget information

Protected Methods

Method Description
buildHandlerTree ( array $all_handlers ) : array Build a tree of event handlers

Private Methods

Method Description
getViewsData ( ) : array Get data from the Views service

Method Details

buildHandlerTree() protected method

Build a tree of event handlers
protected buildHandlerTree ( array $all_handlers ) : array
$all_handlers array Set of handlers from a HooksRegistrationService
return array

describeCallable() public method

E.g. "function_name", "Static::method", "(ClassName)->method", "(Closure path/to/file.php:23)"
public describeCallable ( mixed $callable, string $file_root = '' ) : string
$callable mixed The callable value to describe
$file_root string if provided, it will be removed from the beginning of file names
return string

getActions() public method

returns [action] => array(file, access)
public getActions ( ) : array
return array

getEvents() public method

Get Elgg event information
public getEvents ( ) : array
return array [event,type] => array(handlers)

getMenus() public method

Get information about registered menus
public getMenus ( ) : array
return array [menu name] => array(item name => array(text, href, section, parent))

getPluginHooks() public method

Get Elgg plugin hooks information
public getPluginHooks ( ) : array
return array [hook,type] => array(handlers)

getSimpleCache() public method

Get simplecache information
public getSimpleCache ( ) : array
return array [views]

getViews() public method

Get Elgg view information
public getViews ( string $viewtype = 'default' ) : array
$viewtype string The Viewtype we wish to inspect
return array [view] => map of priority to ViewComponent[]

getViewtypes() public method

Get all view types for known views
public getViewtypes ( ) : string[]
return string[]

getWebServices() public method

Get Elgg web services API methods
public getWebServices ( ) : array
return array [method] => array(function, parameters, call_method, api auth, user auth)

getWidgets() public method

Get Elgg widget information
public getWidgets ( ) : array
return array [widget] => array(name, contexts)