\UBCodeBrowser

Code-environment usable functions and classes directory

Synopsis

class UBCodeBrowser {

• // constants
• const URL_ME = '?module=codebrowser';
• const ROUTE_SCOPE = 'scope';
• const ROUTE_FUNC_NAME = 'funcname';
• const ROUTE_METHOD_NAME = 'methodname';
• const ROUTE_CLASS_NAME = 'classname';
• const SCOPE_FUNC_DESC = 'funcdesc';
• const SCOPE_CLASS_DESC = 'classdesc';
• const SCOPE_FUNC = 'funcs';
• const SCOPE_CLASSES = 'classes';
• const SCOPE_PHP_CLASSES = 'nativeclasses';
• const SCOPE_PHP_FUNC = 'nativefuncs';
• // members
• protected  $inspector = '';
• protected array $fullCodeEnv = ;
• protected string $sourceTree = 'https://github.com/nightflyza/Ubilling/blob/master/';
• protected string $phpDoc = 'https://www.php.net/';
• protected  $messages = '';
• // methods
• public void __construct()
• protected void initMessages()
• public string renderControls()
• protected string getFuncString()
• public string renderFuncsList()
• public string renderFuncDescription()
• public string renderClassesList()
• public string renderMethodDescription()
• public void renderBuiltInFuncsList()
• public void renderBuiltInClassesList()
}


Constants

Name	Value
URL_ME	'?module=codebrowser'
ROUTE_SCOPE	'scope'
ROUTE_FUNC_NAME	'funcname'
ROUTE_METHOD_NAME	'methodname'
ROUTE_CLASS_NAME	'classname'
SCOPE_FUNC_DESC	'funcdesc'
SCOPE_CLASS_DESC	'classdesc'
SCOPE_FUNC	'funcs'
SCOPE_CLASSES	'classes'
SCOPE_PHP_CLASSES	'nativeclasses'
SCOPE_PHP_FUNC	'nativefuncs'

Members

protected

• $fullCodeEnv — array
  Contains full code environment preloaded
• $inspector —
  Code inspector instance
• $messages —
  Messages helper placeholder
• $phpDoc — string
  Default PHP official documentation URL
• $sourceTree — string
  Default functions source tree URL

Methods

protected

• getFuncString() — Returns function doc-like string with params if available
• initMessages() — Inits messages helper instance

public

• __construct()
• renderBuiltInClassesList() — Renders PHP built-in classes and methods directory
• renderBuiltInFuncsList() — Renders PHP built-in functions directory
• renderClassesList() — Renders available code-defined classes and methods directory
• renderControls() — Renders the control buttons
• renderFuncDescription() — Renders code-defined function basic documentation
• renderFuncsList() — Renders available code-defined functions directory
• renderMethodDescription() — renders some code-defined class method description parsed from docblock