API Documentation
\

\plugin

Summary

Methods
Properties
Constants
byId()
forceDisablePlugin()
getPathById()
getPathToConfigurationById()
listPlugin()
getTranslation()
orderPlugin()
heartbeat()
cron()
cron5()
cron10()
cron15()
cron30()
cronDaily()
cronHourly()
start()
stop()
checkDeamon()
report()
isActive()
callInstallFunction()
dependancy_info()
dependancy_install()
deamon_changeAutoMode()
deamon_info()
deamon_start()
deamon_stop()
setIsEnable()
launch()
getUpdate()
getPathImgIcon()
getLogList()
getId()
getName()
getDescription()
getInfo()
getAuthor()
getRequire()
getCategory()
getLicense()
getFilepath()
getInstallation()
getIndex()
getInclude()
getDisplay()
setDisplay()
getMobile()
setMobile()
getEventjs()
setEventjs()
getHasDependency()
setHasDependency()
getHasOwnDeamon()
setHasOwnDeamony()
getHasTtsEngine()
setHasTtsEngine()
getMaxDependancyInstallTime()
setMaxDependancyInstallTime()
getIssue()
setIssue()
getChangelog()
setChangelog()
getDocumentation()
setDocumentation()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$id
$name
$description
$license
$installation
$author
$require
$category
$filepath
$index
$display
$mobile
$eventjs
$hasDependency
$maxDependancyInstallTime
$hasTtsEngine
$hasOwnDeamon
$issue
$changelog
$documentation
$info
$include
$functionality
$_cache
$_enable
N/A

Properties

$id

$id :

Type

$name

$name :

Type

$description

$description :

Type

$license

$license :

Type

$installation

$installation :

Type

$author

$author :

Type

$require

$require :

Type

$category

$category :

Type

$filepath

$filepath :

Type

$index

$index :

Type

$display

$display :

Type

$mobile

$mobile :

Type

$eventjs

$eventjs :

Type

$hasDependency

$hasDependency :

Type

$maxDependancyInstallTime

$maxDependancyInstallTime :

Type

$hasTtsEngine

$hasTtsEngine :

Type

$hasOwnDeamon

$hasOwnDeamon :

Type

$issue

$issue :

Type

$changelog

$changelog :

Type

$documentation

$documentation :

Type

$info

$info :

Type

$include

$include :

Type

$functionality

$functionality :

Type

$_cache

$_cache :

Type

$_enable

$_enable :

Type

Methods

byId()

byId(  $_id)

Parameters

$_id

forceDisablePlugin()

forceDisablePlugin(  $_id)

Parameters

$_id

getPathById()

getPathById(  $_id)

Parameters

$_id

getPathToConfigurationById()

getPathToConfigurationById()

listPlugin()

listPlugin(  $_activateOnly = false,   $_orderByCaterogy = false,   $_translate = true,   $_nameOnly = false)

Parameters

$_activateOnly
$_orderByCaterogy
$_translate
$_nameOnly

getTranslation()

getTranslation(  $_plugin,   $_language)

Parameters

$_plugin
$_language

orderPlugin()

orderPlugin(  $a,   $b)

Parameters

$a
$b

heartbeat()

heartbeat()

cron()

cron()

cron5()

cron5()

cron10()

cron10()

cron15()

cron15()

cron30()

cron30()

cronDaily()

cronDaily()

cronHourly()

cronHourly()

start()

start()

stop()

stop()

checkDeamon()

checkDeamon()

report()

report(  $_format = 'pdf',   $_parameters = array())

Parameters

$_format
$_parameters

isActive()

isActive()

callInstallFunction()

callInstallFunction(  $_function,   $_direct = false)

Parameters

$_function
$_direct

dependancy_info()

dependancy_info(  $_refresh = false)

Parameters

$_refresh

dependancy_install()

dependancy_install() : null

Throws

\Exception

Returns

null

deamon_changeAutoMode()

deamon_changeAutoMode(  $_mode)

Parameters

$_mode

deamon_info()

deamon_info() : array

Returns

array

deamon_start()

deamon_start(  $_forceRestart = false,   $_auto = false)

Parameters

$_forceRestart
$_auto

deamon_stop()

deamon_stop()

setIsEnable()

setIsEnable(  $_state)

Parameters

$_state

launch()

launch(  $_function,   $_callInstallFunction = false)

Parameters

$_function
$_callInstallFunction

getUpdate()

getUpdate()

getPathImgIcon()

getPathImgIcon()

getLogList()

getLogList()

getId()

getId()

getName()

getName()

getDescription()

getDescription()

getInfo()

getInfo(  $_name = '',   $_default = '')

Parameters

$_name
$_default

getAuthor()

getAuthor()

getRequire()

getRequire()

getCategory()

getCategory()

getLicense()

getLicense()

getFilepath()

getFilepath()

getInstallation()

getInstallation()

getIndex()

getIndex()

getInclude()

getInclude()

getDisplay()

getDisplay()

setDisplay()

setDisplay(  $display)

Parameters

$display

getMobile()

getMobile()

setMobile()

setMobile(  $mobile)

Parameters

$mobile

getEventjs()

getEventjs()

setEventjs()

setEventjs(  $eventjs)

Parameters

$eventjs

getHasDependency()

getHasDependency()

setHasDependency()

setHasDependency(  $hasDependency)

Parameters

$hasDependency

getHasOwnDeamon()

getHasOwnDeamon()

setHasOwnDeamony()

setHasOwnDeamony(  $hasOwnDeamon)

Parameters

$hasOwnDeamon

getHasTtsEngine()

getHasTtsEngine()

setHasTtsEngine()

setHasTtsEngine(  $hasTtsEngine)

Parameters

$hasTtsEngine

getMaxDependancyInstallTime()

getMaxDependancyInstallTime()

setMaxDependancyInstallTime()

setMaxDependancyInstallTime(  $maxDependancyInstallTime)

Parameters

$maxDependancyInstallTime

getIssue()

getIssue()

setIssue()

setIssue(  $issue)

Parameters

$issue

getChangelog()

getChangelog()

setChangelog()

setChangelog(  $changelog)

Parameters

$changelog

getDocumentation()

getDocumentation()

setDocumentation()

setDocumentation(  $documentation)

Parameters

$documentation