Jeedom Core

API Documentation

Table of Contents

Classes

ajax
Gère les réponses AJAX de Jeedom
cache
MariadbCache
RedisCache
FileCache
cmd
config
cron
dataStore
DB
eqLogic
eqLogic is the base class for any plugin equipment.
event
history
historyArch
interactDef
interactQuery
jeedom
jeeObject
jsonrpc
jsonrpcClient
listener
log
message
network
note
plan
plan3d
plan3dHeader
planHeader
plugin
queue
report
scenarioElement
scenarioExpression
scenarioSubElement
system
timeline
translate
update
user
utils
view
viewData
viewZone
widgets
com_http
com_shell
repo_file
repo_github
repo_samba
repo_url

Constants

DEBUG  = 0

Functions

__()  : mixed
login()  : mixed
loginByHash()  : mixed
logout()  : mixed
jeedomAutoload()  : mixed
access()  : bool|null
Simple function to demonstrate how to control file access using "accessControl" callback.
help()  : mixed
jeeCron_errorHandler()  : mixed
jeeCronAll_errorHandler()  : mixed
jeeQueue_errorHandler()  : mixed
include_file()  : mixed
getTemplate()  : mixed
template_replace()  : mixed
init()  : mixed
sendVarToJS()  : mixed
resizeImage()  : mixed
getmicrotime()  : mixed
redirect()  : mixed
convertDuration()  : mixed
getClientIp()  : mixed
mySqlIsHere()  : mixed
displayException()  : mixed
is_json()  : mixed
is_sha1()  : mixed
is_sha512()  : mixed
cleanPath()  : mixed
getRootPath()  : mixed
hadFileRight()  : mixed
getVersion()  : mixed
polyfill_glob_brace()  : mixed
glob_brace()  : mixed
ls()  : mixed
removeCR()  : mixed
rcopy()  : mixed
rmove()  : mixed
rrmdir()  : mixed
date_fr()  : mixed
convertDayFromEn()  : mixed
create_zip()  : mixed
br2nl()  : mixed
calculPath()  : mixed
getDirectorySize()  : mixed
sizeFormat()  : mixed
netMatch()  : bool
getNtpTime()  : mixed
cast()  : mixed
getIpFromString()  : mixed
evaluate()  : mixed
secureXSS()  : string
minify()  : mixed
sanitizeAccent()  : mixed
isConnect()  : mixed
hasRight()  : mixed
ZipErrorMessage()  : mixed
arg2array()  : mixed
strToHex()  : mixed
hex2rgb()  : mixed
getDominantColor()  : mixed
colorsAreClose()  : mixed
sha512()  : mixed
findCodeIcon()  : mixed
addGraphLink()  : mixed
getSystemMemInfo()  : mixed
strContain()  : mixed
makeZipSupport()  : mixed
decodeSessionData()  : mixed
listSession()  : mixed
deleteSession()  : mixed
unautorizedInDemo()  : mixed
checkAndFixCron()  : mixed
cronIsDue()  : mixed
getTZoffsetMin()  : mixed
pageTitle()  : mixed
cleanComponanteName()  : mixed
startsWith()  : mixed
endsWith()  : mixed
getWhiteListFolders()  : mixed
implode_recursive()  : mixed
buildUrl()  : mixed
formatJeedomObjectDiv()  : mixed
buildTreeRecursively()  : mixed
jeedom_displayObjectGroup()  : mixed
setTheme()  : mixed
jeedom_displayInteractGroup()  : mixed
scanDB()  : mixed
jeedom_displayScenarioGroup()  : mixed
jeedom_displayGenFamily()  : mixed
jeedom_displayWidgetGroup()  : mixed

Constants

Functions

__()

__(mixed $_content, mixed $_name[, mixed $_backslash = false ]) : mixed
Parameters
$_content : mixed
$_name : mixed
$_backslash : mixed = false

login()

login(mixed $_login, mixed $_password[, mixed $_twoFactor = null ]) : mixed
Parameters
$_login : mixed
$_password : mixed
$_twoFactor : mixed = null

loginByHash()

loginByHash(mixed $_key) : mixed
Parameters
$_key : mixed

jeedomAutoload()

jeedomAutoload(mixed $_classname) : mixed
Parameters
$_classname : mixed

access()

Simple function to demonstrate how to control file access using "accessControl" callback.

access(string $attr, string $path, string $data, object $volume, bool|null $isDir, string $relpath) : bool|null

This method will disable accessing files/folders starting from '.' (dot)

Parameters
$attr : string

attribute name (read|write|locked|hidden)

$path : string

absolute file path

$data : string

value of volume option accessControlData

$volume : object

elFinder volume driver object

$isDir : bool|null

path is directory (true: directory, false: file, null: unknown)

$relpath : string

file path relative to volume root directory started with directory separator

Return values
bool|null

jeeCron_errorHandler()

jeeCron_errorHandler(mixed $cron, mixed $class, mixed $function, mixed $datetimeStart, mixed $e) : mixed
Parameters
$cron : mixed
$class : mixed
$function : mixed
$datetimeStart : mixed
$e : mixed

jeeCronAll_errorHandler()

jeeCronAll_errorHandler(mixed $cron, mixed $e) : mixed
Parameters
$cron : mixed
$e : mixed

jeeQueue_errorHandler()

jeeQueue_errorHandler(mixed $queue, mixed $class, mixed $function, mixed $datetimeStart, mixed $e) : mixed
Parameters
$queue : mixed
$class : mixed
$function : mixed
$datetimeStart : mixed
$e : mixed

include_file()

include_file(mixed $_folder, mixed $_fn, mixed $_type[, mixed $_plugin = '' ]) : mixed
Parameters
$_folder : mixed
$_fn : mixed
$_type : mixed
$_plugin : mixed = ''

getTemplate()

getTemplate(mixed $_folder, mixed $_version, mixed $_filename[, mixed $_plugin = '' ]) : mixed
Parameters
$_folder : mixed
$_version : mixed
$_filename : mixed
$_plugin : mixed = ''

template_replace()

template_replace(mixed $_array, mixed $_subject) : mixed
Parameters
$_array : mixed
$_subject : mixed

init()

init(mixed $_name[, mixed $_default = '' ]) : mixed
Parameters
$_name : mixed
$_default : mixed = ''

sendVarToJS()

sendVarToJS(mixed $_varName[, mixed $_value = '' ]) : mixed
Parameters
$_varName : mixed
$_value : mixed = ''

resizeImage()

resizeImage(mixed $contents, mixed $width, mixed $height) : mixed
Parameters
$contents : mixed
$width : mixed
$height : mixed

redirect()

redirect(mixed $_url[, mixed $_forceType = null ]) : mixed
Parameters
$_url : mixed
$_forceType : mixed = null

convertDuration()

convertDuration(mixed $time) : mixed
Parameters
$time : mixed

displayException()

displayException(mixed $e) : mixed
Parameters
$e : mixed

is_json()

is_json(mixed $_string[, mixed $_default = null ]) : mixed
Parameters
$_string : mixed
$_default : mixed = null

is_sha1()

is_sha1([mixed $_string = '' ]) : mixed
Parameters
$_string : mixed = ''

is_sha512()

is_sha512([mixed $_string = '' ]) : mixed
Parameters
$_string : mixed = ''

cleanPath()

cleanPath(mixed $path) : mixed
Parameters
$path : mixed

hadFileRight()

hadFileRight(mixed $_allowPath, mixed $_path) : mixed
Parameters
$_allowPath : mixed
$_path : mixed

getVersion()

getVersion(mixed $_name) : mixed
Parameters
$_name : mixed

polyfill_glob_brace()

polyfill_glob_brace(mixed $pattern, mixed $flags) : mixed
Parameters
$pattern : mixed
$flags : mixed

glob_brace()

glob_brace(mixed $pattern[, mixed $flags = 0 ]) : mixed
Parameters
$pattern : mixed
$flags : mixed = 0

ls()

ls([mixed $folder = "" ][, mixed $pattern = "*" ][, mixed $recursivly = false ][, mixed $options = array('files', 'folders') ]) : mixed
Parameters
$folder : mixed = ""
$pattern : mixed = "*"
$recursivly : mixed = false
$options : mixed = array('files', 'folders')

removeCR()

removeCR(mixed $_string) : mixed
Parameters
$_string : mixed

rcopy()

rcopy(mixed $src, mixed $dst[, mixed $_emptyDest = true ][, mixed $_exclude = array() ][, mixed $_noError = false ][, mixed $_params = array() ]) : mixed
Parameters
$src : mixed
$dst : mixed
$_emptyDest : mixed = true
$_exclude : mixed = array()
$_noError : mixed = false
$_params : mixed = array()

rmove()

rmove(mixed $src, mixed $dst[, mixed $_emptyDest = true ][, mixed $_exclude = array() ][, mixed $_noError = false ][, mixed $_params = array() ]) : mixed
Parameters
$src : mixed
$dst : mixed
$_emptyDest : mixed = true
$_exclude : mixed = array()
$_noError : mixed = false
$_params : mixed = array()

rrmdir()

rrmdir(mixed $dir) : mixed
Parameters
$dir : mixed

date_fr()

date_fr(mixed $date_en) : mixed
Parameters
$date_en : mixed

convertDayFromEn()

convertDayFromEn(mixed $_day) : mixed
Parameters
$_day : mixed

create_zip()

create_zip(mixed $source_arr, mixed $destination[, mixed $_excludes = array() ]) : mixed
Parameters
$source_arr : mixed
$destination : mixed
$_excludes : mixed = array()

br2nl()

br2nl(mixed $string) : mixed
Parameters
$string : mixed

calculPath()

calculPath(mixed $_path) : mixed
Parameters
$_path : mixed

getDirectorySize()

getDirectorySize(mixed $path) : mixed
Parameters
$path : mixed

sizeFormat()

sizeFormat(mixed $size) : mixed
Parameters
$size : mixed

netMatch()

netMatch(string $network, string $ip) : bool
Parameters
$network : string
$ip : string
Return values
bool

cast()

cast(mixed $sourceObject, mixed $destination) : mixed
Parameters
$sourceObject : mixed
$destination : mixed

getIpFromString()

getIpFromString(mixed $_string) : mixed
Parameters
$_string : mixed

evaluate()

evaluate(mixed $_string) : mixed
Parameters
$_string : mixed

secureXSS()

secureXSS(string $_string) : string
Parameters
$_string : string
Return values
string

minify()

minify(mixed $_buffer) : mixed
Parameters
$_buffer : mixed

sanitizeAccent()

sanitizeAccent(mixed $_message) : mixed
Parameters
$_message : mixed

isConnect()

isConnect([mixed $_right = '' ]) : mixed
Parameters
$_right : mixed = ''

hasRight()

hasRight([mixed $_name = '' ][, mixed $_right = 'r' ][, mixed $_default = 'r' ]) : mixed
Parameters
$_name : mixed = ''
$_right : mixed = 'r'
$_default : mixed = 'r'

ZipErrorMessage()

ZipErrorMessage(mixed $code) : mixed
Parameters
$code : mixed

arg2array()

arg2array(mixed $_string) : mixed
Parameters
$_string : mixed

strToHex()

strToHex(mixed $string) : mixed
Parameters
$string : mixed

hex2rgb()

hex2rgb(mixed $hex) : mixed
Parameters
$hex : mixed

getDominantColor()

getDominantColor(mixed $_pathimg[, mixed $_level = null ][, mixed $_smartMode = false ]) : mixed
Parameters
$_pathimg : mixed
$_level : mixed = null
$_smartMode : mixed = false

colorsAreClose()

colorsAreClose(mixed $_c1, mixed $_c2, mixed $_threshold) : mixed
Parameters
$_c1 : mixed
$_c2 : mixed
$_threshold : mixed

sha512()

sha512(mixed $_string) : mixed
Parameters
$_string : mixed

findCodeIcon()

findCodeIcon(mixed $_icon) : mixed
Parameters
$_icon : mixed

addGraphLink()

addGraphLink(mixed $_from, mixed $_from_type, mixed $_to, mixed $_to_type, mixed &$_data, mixed $_level, mixed $_drill[, mixed $_display = array('dashvalue' => '5,3', 'lengthfactor' => 0.6) ]) : mixed
Parameters
$_from : mixed
$_from_type : mixed
$_to : mixed
$_to_type : mixed
$_data : mixed
$_level : mixed
$_drill : mixed
$_display : mixed = array('dashvalue' => '5,3', 'lengthfactor' => 0.6)

getSystemMemInfo()

getSystemMemInfo() : mixed

strContain()

strContain(mixed $_string, mixed $_words) : mixed
Parameters
$_string : mixed
$_words : mixed

decodeSessionData()

decodeSessionData(mixed $_data) : mixed
Parameters
$_data : mixed

deleteSession()

deleteSession(mixed $_id) : mixed
Parameters
$_id : mixed

unautorizedInDemo()

unautorizedInDemo([mixed $_user = null ]) : mixed
Parameters
$_user : mixed = null

checkAndFixCron()

checkAndFixCron(mixed $_cron) : mixed
Parameters
$_cron : mixed

cronIsDue()

cronIsDue(mixed $_cron[, mixed $_datetime = null ][, mixed $_lastlaunch = null ]) : mixed
Parameters
$_cron : mixed
$_datetime : mixed = null
$_lastlaunch : mixed = null

pageTitle()

pageTitle(mixed $_page) : mixed
Parameters
$_page : mixed

cleanComponanteName()

cleanComponanteName(mixed $_name) : mixed
Parameters
$_name : mixed

startsWith()

startsWith(mixed $haystack, mixed $needle) : mixed
Parameters
$haystack : mixed
$needle : mixed

endsWith()

endsWith(mixed $haystack, mixed $needle) : mixed
Parameters
$haystack : mixed
$needle : mixed

getWhiteListFolders()

getWhiteListFolders([mixed $_plugin = 'all' ]) : mixed
Parameters
$_plugin : mixed = 'all'

implode_recursive()

implode_recursive(mixed $_array, mixed $_separator[, mixed $_key = '' ]) : mixed
Parameters
$_array : mixed
$_separator : mixed
$_key : mixed = ''

buildUrl()

buildUrl(mixed $_key, mixed $_value) : mixed
Parameters
$_key : mixed
$_value : mixed

formatJeedomObjectDiv()

formatJeedomObjectDiv(mixed $object[, mixed $toSummary = false ]) : mixed
Parameters
$object : mixed
$toSummary : mixed = false

buildTreeRecursively()

buildTreeRecursively([mixed $_return = null ]) : mixed
Parameters
$_return : mixed = null

jeedom_displayObjectGroup()

jeedom_displayObjectGroup([mixed $object = -1 ]) : mixed
Parameters
$object : mixed = -1

setTheme()

setTheme() : mixed

jeedom_displayInteractGroup()

jeedom_displayInteractGroup([mixed $_group = '' ][, mixed $_index = -1 ]) : mixed
Parameters
$_group : mixed = ''
$_index : mixed = -1

scanDB()

scanDB(mixed $_table) : mixed
Parameters
$_table : mixed

jeedom_displayScenarioGroup()

jeedom_displayScenarioGroup([mixed $_group = '' ][, mixed $_index = -1 ]) : mixed
Parameters
$_group : mixed = ''
$_index : mixed = -1

jeedom_displayGenFamily()

jeedom_displayGenFamily(mixed $_family[, mixed $_familyId = '' ]) : mixed
Parameters
$_family : mixed
$_familyId : mixed = ''

jeedom_displayWidgetGroup()

jeedom_displayWidgetGroup(mixed $_type, mixed $_widgets) : mixed
Parameters
$_type : mixed
$_widgets : mixed 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results