CaMykS  1.0-20231201
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
CookieAgreementMessage Class Reference

CookieAgreementMessage input.
Automatic cookie agremement message displayed in site mode. More...

Inheritance diagram for CookieAgreementMessage:
Input Plugin

Public Member Functions

 __construct ($path_type)
 
 initialise ($params=array())
 
 display ()
 
 execute_onCaMykSPageLoad ()
 
 execute_onCaMykSBodyClose ()
 
 check_serviceIsAccepted ($service)
 
 get_servicesList ()
 
 get_cookieManagementPanelOpenLink ()
 
 initialise_configDisplay ()
 
 display_configDisplay ()
 
 initialise_configEdition ($form)
 
 display_configEdition ()
 
 save_configuration ()
 
- Public Member Functions inherited from Input
 __construct ($name, $path_type)
 
 Input ($name, $path_type)
 
 get_translation ($value, $data=null)
 
 set_selectedLayout ($layout='')
 
- Public Member Functions inherited from Plugin
 __construct ($name, $plugin_type, $path_type)
 
 get_version ()
 
 load_library ($library='')
 
 load_file ($file='')
 
 load_varFile ($file='')
 
 load_engineFile ($file='')
 
 get_engineFileURL ($file='', $path=false)
 
 get_fileURL ($file='', $path=null, $default='')
 
 get_varFileURL ($file='', $path=false, $default='')
 
 get_filePath ($file='')
 
 get_varFilePath ($file='')
 
 add_JSFile ($file)
 
 add_JSEngineFile ($file)
 
 add_JSExternFile ($file)
 
 add_JSScript ($script, $unique=false)
 
 add_JSPreScript ($script, $unique=false)
 
 add_JSWindowEventScript ($event, $script, $unique=false)
 
 add_JSLoadScript ($script, $unique=false)
 
 add_JSUnloadScript ($script, $unique=false)
 
 add_styleFile ($file, $media='', $condition='')
 
 add_styleScript ($css)
 
 add_styleIncludedFile ($file)
 
 add_StyleExternFile ($file, $media='', $condition='')
 
 set_RSSFeed ($title, $url)
 
 add_headerExtra ($content='')
 
 install ()
 
 uninstall ()
 
 is_installed ()
 
 update ($version, $more='')
 
 add_translation ($more='', $lg=null)
 
 get_languages ()
 
 execute_onCaMykSInitialise ()
 
 execute_onCaMykSBodyOpen ()
 
 execute_onCaMykSAdminPageLoad ()
 
 execute_onCaMykSAdminBodyOpen ()
 
 execute_onCaMykSAdminBodyClose ()
 
 execute_onCaMykSTerminate ()
 
 get_requestLink ($params=array())
 
 get_requestJSLink ($params=array())
 
 execute_request ()
 
 get_varFile ($file)
 

Public Attributes

 $params
 Input parameters. More...
 
- Public Attributes inherited from Input
 $title
 Input title. More...
 
 $params = array()
 Input parameters. More...
 
 $selected_layout = 'input.html.inc'
 Input layout to use. More...
 
- Public Attributes inherited from Plugin
 $name
 Plugin name. More...
 
 $version
 Plugin version. More...
 
 $active = false
 Plugin installation status. More...
 
 $plugin_package = ''
 Plugin package. More...
 
 $plugin_type
 Plugin type. More...
 
 $object_type
 Plugin type. More...
 
 $plugin_path
 Plugin path. More...
 
 $plugin_site_path
 Plugin site path (for element overwriting). More...
 
 $plugin_var_path
 Plugin var path. More...
 
 $plugin_url
 Plugin URL. More...
 
 $plugin_site_url
 Plugin site URL (for element overwriting). More...
 
 $plugin_var_url
 Plugin var URL. More...
 
 $path_type
 Plugin path type. More...
 
 $author_name
 Plugin author name. More...
 
 $author_mail
 Plugin author email. More...
 
 $author_group
 Plugin author group. More...
 
 $plugin_dependencies = array()
 Plugin dependencies. More...
 

Protected Member Functions

 get_serviceStatus ($service)
 
- Protected Member Functions inherited from Plugin
 set_redirect ($time, $url='')
 
 add_meta ($name, $content, $method='name')
 
 add_toHtaccess ($content='')
 
 add_dependency ($plugin, $type, $version='1.0', $mandatory=false)
 
 set_dependencies ()
 
 register_asSharedObject ($name)
 
get_sharedObject ($name)
 
 register_asExtension ($plugin)
 
 get_registeredExtensions ()
 
 register_asCaMykSEventHandler ($event)
 

Protected Attributes

 $config
 Input configuration. More...
 
 $serviceInformation = array()
 Store services information from extenstions. More...
 
 $cookieData
 Store data from cookie. More...
 

Private Member Functions

 load_data ()
 
 check_params ($params=array())
 

Private Attributes

 $isDataLoaded = false
 Store data have been loaded. More...
 

Detailed Description

CookieAgreementMessage input.
Automatic cookie agremement message displayed in site mode.

Plugin / Input Engine

Author
CaMykS Team camyk.nosp@m.s.co.nosp@m.ntact.nosp@m.@gma.nosp@m.il.co.nosp@m.m
Version
1.1.0.6
Date
Creation: May 2017
Modification: Dec 2022
Note
This program is distributed as is - WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. CookieAgreementMessage Input class.

Constructor & Destructor Documentation

◆ __construct()

CookieAgreementMessage::__construct (   $path_type)

Class constructor.

Parameters
string$path_type
Returns
void

Member Function Documentation

◆ initialise()

CookieAgreementMessage::initialise (   $params = array())

Initialise input.

Parameters
array$params
Returns
void

Reimplemented from Input.

◆ display()

CookieAgreementMessage::display ( )

Display input.

Returns
void

Reimplemented from Input.

◆ execute_onCaMykSPageLoad()

CookieAgreementMessage::execute_onCaMykSPageLoad ( )

Execute handler on page load.

Returns
string

Reimplemented from Plugin.

◆ execute_onCaMykSBodyClose()

CookieAgreementMessage::execute_onCaMykSBodyClose ( )

Execute handler on body closing.

Returns
string

Reimplemented from Plugin.

◆ check_serviceIsAccepted()

CookieAgreementMessage::check_serviceIsAccepted (   $service)

Check service is cookie accepted.

Parameters
string$service
Returns
boolean

◆ get_servicesList()

CookieAgreementMessage::get_servicesList ( )

Return services list with details.

Returns
array

◆ get_cookieManagementPanelOpenLink()

CookieAgreementMessage::get_cookieManagementPanelOpenLink ( )

Return cookie management panel, open link.

Returns
array

◆ get_serviceStatus()

CookieAgreementMessage::get_serviceStatus (   $service)
protected

Return cookie status for service.

Parameters
string$service
Returns
integer

◆ load_data()

CookieAgreementMessage::load_data ( )
private

Load cookie data and information.

Returns
void

◆ check_params()

CookieAgreementMessage::check_params (   $params = array())
private

Check parameters from current parameters and configuration.

Parameters
array$params
Returns
void

◆ initialise_configDisplay()

CookieAgreementMessage::initialise_configDisplay ( )

Initialise object in Admin_Site / view configuration mode.

Returns
void

◆ display_configDisplay()

CookieAgreementMessage::display_configDisplay ( )

Display object in Admin_Site / view configuration mode.

Returns
void

◆ initialise_configEdition()

CookieAgreementMessage::initialise_configEdition (   $form)

Initialise object in Admin_Site / edit configuration mode.

Parameters
Object$form
Returns
void

◆ display_configEdition()

CookieAgreementMessage::display_configEdition ( )

Display object in Admin_Site / edit configuration mode.

Returns
void

◆ save_configuration()

CookieAgreementMessage::save_configuration ( )

Execute object in Admin_Site / save configuration mode.

Returns
void

Member Data Documentation

◆ $config

CookieAgreementMessage::$config
protected

Input configuration.

var Object $config

◆ $serviceInformation

CookieAgreementMessage::$serviceInformation = array()
protected

Store services information from extenstions.

var array $serviceInformation

◆ $cookieData

CookieAgreementMessage::$cookieData
protected

Store data from cookie.

var array $cookieData

◆ $isDataLoaded

CookieAgreementMessage::$isDataLoaded = false
private

Store data have been loaded.

var boolean $isDataLoaded

◆ $params

CookieAgreementMessage::$params
Initial value:
= array(
'status' => 'enabled',
'message' => '',
'aboutCookie' => false,
'styleSource' => 'plugin',
'location' => 'top',
'remindTTL' => 365,
)

Input parameters.

var array $params


The documentation for this class was generated from the following file: