\LinHUniX\Mcp\ComponentmcpCoreClass

Core class for load modules.

Summary

Methods

Properties

Constants

__construct()
setClearFlagOff()
setClearFlagOn()
setScopeOut()
getScopeOutSub()
setScopeIn()
setScopeCtl()
getScopeIn()
getScopeOut()
getScopeCtl()
rstScopeOut()
statmentModule()
moduleLoader()
moduleCaller()
setStatus()
setWorkingArea()
loadLegacy()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

hasDic()
getCfg()
getMcp()
setDic()
shareModuleVars()
clearScopeIn()
clearScopeOut()
clearScopeCtl()
clearModuleVars()
returnOutAndClear()
executeModule()
isModuleExists()
LoadTemplateModule()
loadModule()
initModule()

$defapp
$mcp
$sub
$scopeIn
$scopeOut
$scopeCtl
$flagClearVars

N/A

final

File: Mcp/Component/mcpCoreClass.php
Package: Default
Class hierarchy: \LinHUniX\Mcp\Component\mcpCoreClass

Properties

$defapp

$defapp : string

Type

string — name of define app module

$mcp

$mcp : \LinHUniX\Mcp\Component\mcp

Type

\LinHUniX\Mcp\Component\mcp — App Module

$sub

$sub :

counter of number of sub function work in a moment.

Type

$scopeIn

$scopeIn : array

Type

array — calling Controlling definitions ;

$scopeOut

$scopeOut : array

Type

array — temproraney input array auto cleanable

$scopeCtl

$scopeCtl : array

Type

array — temproraney output array auto cleanable

$flagClearVars

$flagClearVars : boolean

this flag set clear settins of the scope vars after cleaning.

Type

boolean

Methods

__construct()

__construct(\LinHUniX\Mcp\masterControlProgram  $mcp)

Parameters

\LinHUniX\Mcp\masterControlProgram

$mcp

setClearFlagOff()

setClearFlagOff()

disable the cleaning of the scope vars.

setClearFlagOn()

setClearFlagOn()

Enable the cleaning of the scope vars.

setScopeOut()

setScopeOut(string  $name, \LinHUniX\Mcp\Component\Any  $value)

Parameters

string	$name	of the label you need to save
\LinHUniX\Mcp\Component\Any	$value	of the values that you need stored

getScopeOutSub()

getScopeOutSub(string  $name,   $refsub = null) : \LinHUniX\Mcp\Component\Any

Parameters

string	$name	of the label you need to save
	$refsub

Returns

\LinHUniX\Mcp\Component\Any —

$value of the values that you need stored

setScopeIn()

setScopeIn(string  $name, \LinHUniX\Mcp\Component\Any  $value)

Parameters

string	$name	of the label you need to save
\LinHUniX\Mcp\Component\Any	$value	of the values that you need stored

setScopeCtl()

setScopeCtl(string  $name, \LinHUniX\Mcp\Component\Any  $value)

Parameters

string	$name	of the label you need to save
\LinHUniX\Mcp\Component\Any	$value	of the values that you need stored

getScopeIn()

getScopeIn() : array

Returns

array —

ScopeIn (and set on global session )

getScopeOut()

getScopeOut() : array

Returns

array —

ScopeOut (and set on global session )

getScopeCtl()

getScopeCtl() : array

Returns

array —

ScopeCtl (and set on global session )

rstScopeOut()

rstScopeOut()

clear scope out var shared from oth service.

statmentModule()

statmentModule(\LinHUniX\Mcp\Component\type  $path, \LinHUniX\Mcp\Component\type  $callname, \LinHUniX\Mcp\Component\type  $ispreload = false, \LinHUniX\Mcp\Component\type  $scopeIn = array(), \LinHUniX\Mcp\Component\type  $modinit = null, \LinHUniX\Mcp\Component\type  $subcall = null, \LinHUniX\Mcp\Component\type  $vendor = null, \LinHUniX\Mcp\Component\type  $type = null)

Parameters

\LinHUniX\Mcp\Component\type	$path
\LinHUniX\Mcp\Component\type	$callname
\LinHUniX\Mcp\Component\type	$ispreload
\LinHUniX\Mcp\Component\type	$scopeIn
\LinHUniX\Mcp\Component\type	$modinit
\LinHUniX\Mcp\Component\type	$subcall
\LinHUniX\Mcp\Component\type	$vendor
\LinHUniX\Mcp\Component\type	$type

moduleLoader()

moduleLoader()

load a specific module and clear the var.

moduleCaller()

moduleCaller() : array

Call and execute a module and clear vars after results 0) befor run this method normally use statement module 1) step 1 is intmodule that call loadmodule 2) if is preload is finish or go to execute module.

Returns

array —

Description array (reference of) response of code

setStatus()

setStatus(\LinHUniX\Mcp\Component\type  $status, \LinHUniX\Mcp\Component\type  $message)

Parameters

\LinHUniX\Mcp\Component\type	$status
\LinHUniX\Mcp\Component\type	$message

setWorkingArea()

setWorkingArea(  $area)

status of the Ipl area level.

Parameters

$area

loadLegacy()

loadLegacy()

load the file if is need.

the class or function need to not require arguments on cunstructor.

hasDic()

hasDic(string  $component) : boolean

This a confortable solution to don't use directly the cfg Container.

Parameters

string

$component

nomae of the component on the container

Returns

boolean —

if this Component is present

getCfg()

getCfg(string  $component = null) : \LinHUniX\Mcp\Component\any

This a confortable solution to don't use directly the cfg Container.

Parameters

string

$component

nomae of the component on the container

Throws

\Exception: if the cfg are not present or don't have this component

Returns

\LinHUniX\Mcp\Component\any —

Component object

getMcp()

getMcp() : \LinHUniX\Mcp\Component\any

This a confortable solution to don't use directly the Master Control Program.

Throws

\Exception: if the cfg are not present or don't have this component

Returns

\LinHUniX\Mcp\Component\any —

Component object

setDic()

setDic(string  $tag, \LinHUniX\Mcp\Component\Any  $component)

This a confortable solution to don't use directly the cfg Container.

Parameters

string	$tag	nomae of the component on the container
\LinHUniX\Mcp\Component\Any	$component	the component object

Throws

\Exception: if the cfg are not present or don't have this component

shareModuleVars()

shareModuleVars()

compatibility with older code and set on session this informations l.

clearScopeIn()

clearScopeIn()

Auto clear ScopeIn variables with compatbility.

clearScopeOut()

clearScopeOut()

Auto clear ScopeOut variables with compatbility.

clearScopeCtl()

clearScopeCtl()

Auto clear ScopeCtl variables with compatbility.

clearModuleVars()

clearModuleVars()

Auto clear Variables.

returnOutAndClear()

returnOutAndClear() : \LinHUniX\Mcp\Component\type

Returns

\LinHUniX\Mcp\Component\type

executeModule()

executeModule() : boolean

Returns

boolean

isModuleExists()

isModuleExists() : boolean

isModuleExists function check if the module is extists and has a specific funcitonality.

Returns

boolean

LoadTemplateModule()

LoadTemplateModule(  $scopeCtl,   $scopeIn,   $scopeOut)

LoadTemplateModule.

Parameters

	$scopeCtl
	$scopeIn
	$scopeOut

loadModule()

loadModule()

load the file if is need.

initModule()

initModule() : array

initialize module if is need call loadmodule to call the file.

Returns

array