CaMykS
1.0-20231201
|
Public Member Functions | |
__construct ($site_conf, $mode=CAMYKS_MODE_SITE) | |
execute () | |
initialise () | |
get_siteInit () | |
get_adminInit () | |
set_confValue ($confName, $value='') | |
get_confValue ($confName, $default='') | |
update_siteConfFile ($params=array()) | |
add_translation ($path, $lang=null) | |
add_generic_translation ($more='', $language=null) | |
get_translation ($string, $data=array()) | |
get_currentLanguage ($type) | |
decode_value ($v) | |
encode_value ($v) | |
get_htmlEncodingValue () | |
get_mysqlEncodingValue () | |
get_modules () | |
get_themes () | |
get_templates () | |
get_inputs () | |
& | get_module ($moduleName) |
& | get_theme ($themeName) |
& | get_template ($templateName) |
& | get_input ($inputName) |
get_neededPlugins () | |
get_pluginPath ($path_type) | |
get_pluginURL ($path_type) | |
get_adminUser () | |
check_adminUser () | |
get_cache ($title) | |
set_cache ($title, $content, $desc='') | |
check_deviceMode ($device='') | |
throwFatalError ($error) | |
are_logsAvailable () | |
log ($object, $action, $message='') | |
log_event ($type, &$object, $desc1='', $desc2='', $file='', $line=0) | |
log_sqlerror (&$object, $sqlquery='', $file='', $line=0) | |
log_internalerror (&$object, $desc1='', $desc2='', $file='', $line=0) | |
log_information (&$object, $desc1='', $desc2='') | |
log_executionerror (&$object, $desc1='', $desc2='') | |
update_statistic ($name='', $module='', $type='', $main='', $data1='', $data2='', $params=array()) | |
update_siteStatistics () | |
get_databaseConnection () | |
& | get_dbConnection () |
register_dbConnection (&$connection) | |
set_sessionValue ($name, $value='') | |
get_sessionValue ($name, $value=null) | |
kill_session () | |
get_executionVariable ($name) | |
set_executionVariable ($name, $value) | |
set_sharedData ($name, $data=null, $sub=null) | |
get_sharedData ($name=null, $value=null) | |
check_sharedData ($name) | |
register_sharedObject ($name, &$object) | |
& | get_sharedObject ($name) |
get_sharedObjectList () | |
Register_asExtension ($plugin, $ext_name, $ext_type) | |
get_registeredExtensions ($plugin) | |
register_eventHandler ($event, &$plugin) | |
get_rootBaseURL ($mode=null) | |
get_defaultBaseURL ($mode=null) | |
get_fileURL ($file='', $mode=null) | |
get_dataFileURL ($file, $full=null, $default='') | |
get_dataFilePath ($file) | |
get_visitorInformation () | |
is_visitorHuman () | |
terminate () | |
get_adminLink ($module='', $params=array()) | |
get_adminJSLink ($module='', $params=array()) | |
get_requestLink ($params=array()) | |
get_requestJSLink ($params=array()) | |
get_siteLink ($page, $name='', $lg='', $params=array()) | |
get_siteHomepageLink () | |
get_siteCurrentLink ($lg='', $params=null) | |
get_siteKeypageLink ($key='', $lg='', $params=array()) | |
get_siteLinkEncodeParams ($params) | |
get_siteLinkDecodeParams ($params) | |
get_requestPageContent () | |
get_availableLanguages () | |
init_kill () | |
get_siteLinkByName ($name, $lg='', $params=array()) | |
Public Attributes | |
$name = CAMYKS_NAME | |
CaMykS object name. More... | |
$title = CAMYKS_NAME | |
CaMykS object title. More... | |
$object_type = CAMYKS_NAME | |
CaMykS object type. More... | |
$version | |
CaMykS current version. More... | |
$last_modification_date | |
CaMykS last modification date. More... | |
$site_name | |
CaMykS current site name. More... | |
$mode | |
CaMykS running mode (admin / site / manager / install). More... | |
$trads = array() | |
CaMykS merged locales. More... | |
$camyks_path | |
CaMykS path. More... | |
$camyks_plugin_path | |
CaMykS plugins path. More... | |
$camyks_plugin_url | |
CaMykS plugins base url. More... | |
$camyks_engine_path | |
CaMykS libraries path. More... | |
$site_path | |
Current site path. More... | |
$site_plugin_path | |
Current site plugins path. More... | |
$site_plugin_url | |
Current site plugins base url. More... | |
$site_cache_path | |
Current site cache path. More... | |
$site_data_url | |
Current site data folder base url. More... | |
$site_base_url | |
Current site base url. More... | |
$db_table_prefix | |
Database tables prefix. More... | |
$db_conn | |
Main database connection. More... | |
$file_extension | |
Files extension. More... | |
$modules | |
CaMykS modules. More... | |
$templates | |
CaMykS templates. More... | |
$themes | |
CaMykS themes. More... | |
$inputs | |
CaMykS inputs. More... | |
$theme | |
CaMykS current theme. More... | |
$current_language | |
CaMykS current language. More... | |
$cache = array() | |
CaMykS cache. More... | |
$shared_data = array() | |
CaMykS shared data. More... | |
$sharedObjects = array() | |
CaMykS shared objects. More... | |
$plugin_extensions = array() | |
CaMykS plugins extensions. More... | |
$HTMLPage | |
CaMykS HTML page. More... | |
$contentPage | |
CaMykS content page. More... | |
$previewMode | |
CaMykS current preview mode. More... | |
$deviceMode | |
CaMykS current device mode. More... | |
$adminUser = false | |
Current logged admin user. More... | |
Private Member Functions | |
get_genericInit () | |
get_requestInit () | |
get_installInit () | |
get_managerInit () | |
get_confFiles () | |
get_camyksPathes () | |
get_libs () | |
get_sitePathes () | |
check_security ($mode) | |
check_siteConf () | |
check_adminConf () | |
get_plugins () | |
check_plugins () | |
load_neededPlugins () | |
run_eventHandlers ($event) | |
load_visitorInformation () | |
get_pageContent () | |
get_sitePageContent () | |
get_adminPageContent () | |
get_managerPageContent () | |
get_installPageContent () | |
Private Attributes | |
$openedDBonnections = array() | |
CaMykS opened database connections. More... | |
$eventsHandlers = array('onInitialise'=>array(), 'onPageLoad'=>array(), 'onBodyOpen'=>array(), 'onBodyClose'=>array(), 'onAdminPageLoad'=>array(), 'onAdminBodyOpen'=>array(), 'onAdminBodyClose'=>array(), 'onTerminate'=>array()) | |
CaMykS event handlers. More... | |
$falseRef = false | |
CaMykS false value as reference. More... | |
$errorCheck = false | |
Error check for logging system. More... | |
$visitorInfo = null | |
Store visitor or bot information. More... | |
CaMykS master class.
Camyks::__construct | ( | $site_conf, | |
$mode = CAMYKS_MODE_SITE |
|||
) |
CaMykS Constructor.
array | $site_conf | |
integer | $mode |
Camyks::execute | ( | ) |
Execute CaMykS.
Camyks::initialise | ( | ) |
CaMykS global initialisation.
|
private |
CaMykS generic initialisation.
Camyks::get_siteInit | ( | ) |
Initialise CaMykS in site mode.
Camyks::get_adminInit | ( | ) |
Initialise CaMykS in admin mode.
|
private |
Initialise CaMykS in request mode.
|
private |
Initialise CaMykS in install mode.
|
private |
Initialise CaMykS in manager mode.
|
private |
get CaMykS conf files
|
private |
Initialise required CaMykS pathes.
|
private |
Load all internal libs files.
|
private |
Initialise needed site pathes.
|
private |
Check security.
string | $mode |
|
private |
Check site configuration.
|
private |
Check admin configuration.
Camyks::set_confValue | ( | $confName, | |
$value = '' |
|||
) |
Define/update configuration value.
string | $confName | |
mixed | $value |
Camyks::get_confValue | ( | $confName, | |
$default = '' |
|||
) |
Return a configuration value.
string | $confName | |
mixed | $default |
Camyks::update_siteConfFile | ( | $params = array() | ) |
Update configuration file.
array | $params |
Camyks::add_translation | ( | $path, | |
$lang = null |
|||
) |
Load dictionnary from its path.
string | $path | |
string | $lang |
Camyks::add_generic_translation | ( | $more = '' , |
|
$language = null |
|||
) |
Load an internal dictionnary.
string | $more | |
string | $language |
Camyks::get_translation | ( | $string, | |
$data = array() |
|||
) |
Return localisation values.
string | $string | |
mixed | $data |
Camyks::get_currentLanguage | ( | $type | ) |
Manage the language to use.
string | $type |
Camyks::decode_value | ( | $v | ) |
Return decoded value.
mixed | $v |
Camyks::encode_value | ( | $v | ) |
Return encoded value.
mixed | $v |
Camyks::get_htmlEncodingValue | ( | ) |
Return HTML value for encoding.
Camyks::get_mysqlEncodingValue | ( | ) |
Return SQL value for encoding.
|
private |
Get all available and active plugins.
|
private |
Compare active plugins and required plugins.
Camyks::get_modules | ( | ) |
Load modules list in CaMykS object.
Camyks::get_themes | ( | ) |
Load themes list in CaMykS object.
Camyks::get_templates | ( | ) |
Load templates list in CaMykS object.
Camyks::get_inputs | ( | ) |
Load inputs list in CaMykS object.
& Camyks::get_module | ( | $moduleName | ) |
& Camyks::get_theme | ( | $themeName | ) |
& Camyks::get_template | ( | $templateName | ) |
& Camyks::get_input | ( | $inputName | ) |
Camyks::get_neededPlugins | ( | ) |
Load needed plugins list from CaMykS configuration.
|
private |
Load needed plugins.
Camyks::get_pluginPath | ( | $path_type | ) |
Return plugin path case of plugin path type.
string | $path_type |
Camyks::get_pluginURL | ( | $path_type | ) |
Return plugin url case of plugin path type.
string | $path_type |
Camyks::get_adminUser | ( | ) |
Load admin user from session.
Camyks::check_adminUser | ( | ) |
Check if admin user is connected.
Camyks::get_cache | ( | $title | ) |
Return cache file.
string | $title |
Camyks::set_cache | ( | $title, | |
$content, | |||
$desc = '' |
|||
) |
Set cache file.
string | $title | |
mixed | $content | |
string | $desc |
Camyks::check_deviceMode | ( | $device = '' | ) |
Check selected device mode value.
string | $device |
Camyks::throwFatalError | ( | $error | ) |
Stop CaMykS, with an error.
array | $error |
Camyks::are_logsAvailable | ( | ) |
Check is log manager module is available
Camyks::log | ( | $object, | |
$action, | |||
$message = '' |
|||
) |
Log message in log manager module.
string | $object | |
string | $action | |
string | $message |
Camyks::log_event | ( | $type, | |
& | $object, | ||
$desc1 = '' , |
|||
$desc2 = '' , |
|||
$file = '' , |
|||
$line = 0 |
|||
) |
Log event in system report module.
string | $type | |
Object | $object | |
string | $desc1 | |
string | $desc2 | |
string | $file | |
integer | $line |
Camyks::log_sqlerror | ( | & | $object, |
$sqlquery = '' , |
|||
$file = '' , |
|||
$line = 0 |
|||
) |
Log sql error in system report module.
Object | $object | |
string | $sqlquery | |
string | $file | |
integer | $line |
Camyks::log_internalerror | ( | & | $object, |
$desc1 = '' , |
|||
$desc2 = '' , |
|||
$file = '' , |
|||
$line = 0 |
|||
) |
Log internal error in system report module.
object | $object | |
string | $desc1 | |
string | $desc2 | |
string | $file | |
integer | $line |
Camyks::log_information | ( | & | $object, |
$desc1 = '' , |
|||
$desc2 = '' |
|||
) |
Log information in system report module.
object | $object | |
string | $desc1 | |
string | $desc2 |
Camyks::log_executionerror | ( | & | $object, |
$desc1 = '' , |
|||
$desc2 = '' |
|||
) |
Log execution error in system report module.
object | $object | |
string | $desc1 | |
string | $desc2 |
Camyks::update_statistic | ( | $name = '' , |
|
$module = '' , |
|||
$type = '' , |
|||
$main = '' , |
|||
$data1 = '' , |
|||
$data2 = '' , |
|||
$params = array() |
|||
) |
Try to update statistic.
string | $name | |
string | $module | |
string | $type | |
string | $main | |
string | $data1 | |
strint | $data2 | |
array | $params |
Camyks::update_siteStatistics | ( | ) |
Update site statistics.
Camyks::get_databaseConnection | ( | ) |
Create connection to the database.
& Camyks::get_dbConnection | ( | ) |
Return database connection.
Camyks::register_dbConnection | ( | & | $connection | ) |
Register an opened connection.
Object | $connection |
Camyks::set_sessionValue | ( | $name, | |
$value = '' |
|||
) |
Save var to session.
string | $name | |
mixed | $value |
Camyks::get_sessionValue | ( | $name, | |
$value = null |
|||
) |
Get var from session.
string | $name | |
mixed | $value |
Camyks::kill_session | ( | ) |
close session.
Camyks::get_executionVariable | ( | $name | ) |
Get variable from session or header
string | $name |
Camyks::set_executionVariable | ( | $name, | |
$value | |||
) |
Set variable to session
string | $name | |
mixed | $value |
Camyks::set_sharedData | ( | $name, | |
$data = null , |
|||
$sub = null |
|||
) |
Set a shared data.
string | $name | |
mixed | $data | |
string | $sub |
Camyks::get_sharedData | ( | $name = null , |
|
$value = null |
|||
) |
Get a shared data.
string | $name | |
mixed | $value |
Camyks::check_sharedData | ( | $name | ) |
Check some shared data.
string | $name |
Camyks::register_sharedObject | ( | $name, | |
& | $object | ||
) |
Register a plugin to be accessed by any other.
string | $name | |
Plugin | $object |
& Camyks::get_sharedObject | ( | $name | ) |
Return requested shared object.
string | $name |
Camyks::get_sharedObjectList | ( | ) |
Return shared object name list.
Camyks::Register_asExtension | ( | $plugin, | |
$ext_name, | |||
$ext_type | |||
) |
Register a plugin as an extension to another.
string | $plugin | |
string | $ext_name | |
string | $ext_type |
Camyks::get_registeredExtensions | ( | $plugin | ) |
Get registered extensions.
string | $plugin |
Camyks::register_eventHandler | ( | $event, | |
& | $plugin | ||
) |
Register an event handler.
string | $event | |
Object | $plugin |
|
private |
Run event handlers.
string | $event |
Camyks::get_rootBaseURL | ( | $mode = null | ) |
Return root base url.
string | $mode |
Camyks::get_defaultBaseURL | ( | $mode = null | ) |
Return default base url.
mixed | $mode |
Camyks::get_fileURL | ( | $file = '' , |
|
$mode = null |
|||
) |
Return file url.
string | $file | |
string | $mode |
Camyks::get_dataFileURL | ( | $file, | |
$full = null , |
|||
$default = '' |
|||
) |
Return data file URL.
string | $file | |
boolean | $full | |
string | $default |
Camyks::get_dataFilePath | ( | $file | ) |
Return data file path.
string | $file |
|
private |
Load visitor's information.
Camyks::get_visitorInformation | ( | ) |
Return visitor's information.
Camyks::is_visitorHuman | ( | ) |
Check if visitor is a human.
Camyks::terminate | ( | ) |
Finish closing CaMykS object.
Camyks::get_adminLink | ( | $module = '' , |
|
$params = array() |
|||
) |
Return HTML admin mode link.
string | $module | |
array | $params |
Camyks::get_adminJSLink | ( | $module = '' , |
|
$params = array() |
|||
) |
Return JavaScript admin mode link.
string | $module | |
array | $params |
Camyks::get_requestLink | ( | $params = array() | ) |
Return HTML request mode link.
array | $params |
Camyks::get_requestJSLink | ( | $params = array() | ) |
Return JavaScript request mode link.
array | $params |
Camyks::get_siteLink | ( | $page, | |
$name = '' , |
|||
$lg = '' , |
|||
$params = array() |
|||
) |
Return site mode link.
mixed | $page | |
string | $name | |
string | $lg | |
array | $params |
Camyks::get_siteHomepageLink | ( | ) |
Return home page link in site mode.
Camyks::get_siteCurrentLink | ( | $lg = '' , |
|
$params = null |
|||
) |
Return site mode link based on current one.
string | $lg | |
array | $params |
Camyks::get_siteKeypageLink | ( | $key = '' , |
|
$lg = '' , |
|||
$params = array() |
|||
) |
Return site mode link to key page.
string | $key | |
string | $lg | |
array | $params |
Camyks::get_siteLinkEncodeParams | ( | $params | ) |
Return encoded params for link.
array | $params |
Camyks::get_siteLinkDecodeParams | ( | $params | ) |
Return decoded params for link.
string | $params |
|
private |
Build page content.
|
private |
Build page content in site mode.
|
private |
Build page content in admin mode.
Camyks::get_requestPageContent | ( | ) |
Build page content in request mode.
|
private |
Build page content in manager mode.
|
private |
Build content in install mode.
Camyks::get_availableLanguages | ( | ) |
Camyks::init_kill | ( | ) |
Camyks::get_siteLinkByName | ( | $name, | |
$lg = '' , |
|||
$params = array() |
|||
) |
Return site mode link based name.
string | $name | |
string | $lg | |
array | $params |
string Camyks::$name = CAMYKS_NAME |
CaMykS object name.
string Camyks::$title = CAMYKS_NAME |
CaMykS object title.
string Camyks::$object_type = CAMYKS_NAME |
CaMykS object type.
string Camyks::$version |
CaMykS current version.
integer Camyks::$last_modification_date |
CaMykS last modification date.
string Camyks::$site_name |
CaMykS current site name.
string Camyks::$mode |
CaMykS running mode (admin / site / manager / install).
array Camyks::$trads = array() |
CaMykS merged locales.
string Camyks::$camyks_path |
CaMykS path.
string Camyks::$camyks_plugin_path |
CaMykS plugins path.
string Camyks::$camyks_plugin_url |
CaMykS plugins base url.
string Camyks::$camyks_engine_path |
CaMykS libraries path.
string Camyks::$site_path |
Current site path.
string Camyks::$site_plugin_path |
Current site plugins path.
string Camyks::$site_plugin_url |
Current site plugins base url.
string Camyks::$site_cache_path |
Current site cache path.
string Camyks::$site_data_url |
Current site data folder base url.
string Camyks::$site_base_url |
Current site base url.
string Camyks::$db_table_prefix |
Database tables prefix.
Database_connection Camyks::$db_conn |
Main database connection.
string Camyks::$file_extension |
Files extension.
array Camyks::$modules |
CaMykS modules.
array Camyks::$templates |
CaMykS templates.
array Camyks::$themes |
CaMykS themes.
array Camyks::$inputs |
CaMykS inputs.
Theme Camyks::$theme |
CaMykS current theme.
string Camyks::$current_language |
CaMykS current language.
array Camyks::$cache = array() |
CaMykS cache.
array Camyks::$shared_data = array() |
CaMykS shared data.
array Camyks::$sharedObjects = array() |
CaMykS shared objects.
array Camyks::$plugin_extensions = array() |
CaMykS plugins extensions.
HTMLPage Camyks::$HTMLPage |
CaMykS HTML page.
ContentPage Camyks::$contentPage |
CaMykS content page.
string Camyks::$previewMode |
CaMykS current preview mode.
string Camyks::$deviceMode |
CaMykS current device mode.
|
private |
CaMykS opened database connections.
|
private |
CaMykS event handlers.
|
private |
CaMykS false value as reference.
mixed Camyks::$adminUser = false |
Current logged admin user.
|
private |
Error check for logging system.
|
private |
Store visitor or bot information.