Elgg  Version 3.0
Public Member Functions | Protected Member Functions | List of all members
Elgg\Debug\Inspector Class Reference

WARNING: API IN FLUX. More...

Public Member Functions

 getEvents ()
 Get Elgg event information. More...
 
 getPluginHooks ()
 Get Elgg plugin hooks information. More...
 
 getViewtypes ()
 Get all view types for known views. More...
 
 getViews ($viewtype= 'default')
 Get Elgg view information. More...
 
 getWidgets ()
 Get Elgg widget information. More...
 
 getActions ()
 Get Elgg actions information. More...
 
 getSimpleCache ()
 Get simplecache information. More...
 
 getRoutes ()
 Get Elgg route information. More...
 
 getWebServices ()
 Get Elgg web services API methods. More...
 
 getMenus ()
 Get information about registered menus. More...
 
 describeCallable ($callable, $file_root= '')
 Get a string description of a callback. More...
 
 getServices ()
 Returns public DI services. More...
 

Protected Member Functions

 buildHandlerTree ($all_handlers)
 Build a tree of event handlers. More...
 

Detailed Description

WARNING: API IN FLUX.

DO NOT USE DIRECTLY.

Definition at line 16 of file Inspector.php.

Member Function Documentation

Elgg\Debug\Inspector::buildHandlerTree (   $all_handlers)
protected

Build a tree of event handlers.

Parameters
array$all_handlersSet of handlers from a HooksRegistrationService
Returns
array

Definition at line 389 of file Inspector.php.

Elgg\Debug\Inspector::describeCallable (   $callable,
  $file_root = '' 
)

Get a string description of a callback.

E.g. "function_name", "Static::method", "(ClassName)->method", "(Closure path/to/file.php:23)"

Parameters
mixed$callableCallable
string$file_rootIf provided, it will be removed from the beginning of file names
Returns
string

Definition at line 378 of file Inspector.php.

Elgg\Debug\Inspector::getActions ( )

Get Elgg actions information.

returns [action] => array(file, access)

Returns
array

Definition at line 151 of file Inspector.php.

Elgg\Debug\Inspector::getEvents ( )

Get Elgg event information.

Returns
array [event,type] => array(handlers)

Definition at line 23 of file Inspector.php.

Elgg\Debug\Inspector::getMenus ( )

Get information about registered menus.

Returns
array [menu name] => array(item name => array(text, href, section, parent))

Definition at line 285 of file Inspector.php.

Elgg\Debug\Inspector::getPluginHooks ( )

Get Elgg plugin hooks information.

Returns
array [hook,type] => array(handlers)

Definition at line 32 of file Inspector.php.

Elgg\Debug\Inspector::getRoutes ( )

Get Elgg route information.

returns [route] => array(path, resource)

Returns
array

Definition at line 207 of file Inspector.php.

Elgg\Debug\Inspector::getServices ( )

Returns public DI services.

returns [service_name => [class, path]]

Returns
array

Definition at line 433 of file Inspector.php.

Elgg\Debug\Inspector::getSimpleCache ( )

Get simplecache information.

Returns
array [views]

Definition at line 176 of file Inspector.php.

Elgg\Debug\Inspector::getViews (   $viewtype = 'default')

Get Elgg view information.

Parameters
string$viewtypeThe Viewtype we wish to inspect
Returns
array [view] => map of priority to ViewComponent[]

Definition at line 52 of file Inspector.php.

Elgg\Debug\Inspector::getViewtypes ( )

Get all view types for known views.

Returns
string[]

Definition at line 41 of file Inspector.php.

Elgg\Debug\Inspector::getWebServices ( )

Get Elgg web services API methods.

Returns
array [method] => array(function, parameters, call_method, api auth, user auth)

Definition at line 257 of file Inspector.php.

Elgg\Debug\Inspector::getWidgets ( )

Get Elgg widget information.

Returns
array [widget] => array(name, contexts)

Definition at line 132 of file Inspector.php.


The documentation for this class was generated from the following file: