GoogleAnalytics Class Reference

GoogleAnalytics Input
Adds Google Analytics snippet on page. More...

Inheritance diagram for GoogleAnalytics:

Public Member Functions
	__construct ($path_type)
	initialise ($params=array())
	display ()
	disable ()
	add_trackingCode ($trackingId, $params=null)
	add_extraData ($type='', $value='', $params=null)
	execute_onCaMykSPageLoad ()
	execute_onCaMykSBodyOpen ()
	initialise_configDisplay ()
	display_configDisplay ()
	initialise_configEdition ($form)
	display_configEdition ()
	save_configuration ()
	get_cookieInformationData ()
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_onCaMykSBodyClose ()
	execute_onCaMykSAdminPageLoad ()
	execute_onCaMykSAdminBodyOpen ()
	execute_onCaMykSAdminBodyClose ()
	execute_onCaMykSTerminate ()
	get_requestLink ($params=array())
	get_requestJSLink ($params=array())
	execute_request ()
	get_varFile ($file)

Protected Member Functions
	get_configValue ($name='')
	display_extra ($extra, $addTags=false)
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...
	$isConfigLoaded = false
	Stores if the configuration is loaded. More...
	$extraData = array()
	Store additional code to insert in snipper. More...

Private Member Functions
	load_configuration ()
	is_cookieAccepted ()

Private Attributes
	$status = 'enabled'
	Snippet insertion status. More...
	$isLive = false
	Snippet code is already written. More...

Additional Inherited Members
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...

Detailed Description

GoogleAnalytics Input
Adds Google Analytics snippet on page.

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.0.2

Date

Creation: Sep 2018

Modification: Feb 2023

Copyright

2018 - 2023 CaMykS Team

Note

This program is distributed as is - WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. GoogleAnalytics Input class.

Constructor & Destructor Documentation

__construct()

GoogleAnalytics::__construct

(

$path_type

)

Class constructor.

Parameters

string

$path_type

Returns

void

Member Function Documentation

initialise()

GoogleAnalytics::initialise

(

$params = array()

)

Initialise input.

Parameters

array

$params

Returns

void

Reimplemented from Input.

display()

GoogleAnalytics::display

(

)

Display input.

Returns

void

Reimplemented from Input.

disable()

GoogleAnalytics::disable

(

)

Mark plugin as disabled

Returns

void

add_trackingCode()

GoogleAnalytics::add_trackingCode	(		$trackingId,
			$params = null
	)

Add a tracking code.

Parameters

string	$trackingId
mixed	$params

Returns

void

add_extraData()

GoogleAnalytics::add_extraData	(		$type = '',
			$value = '',
			$params = null
	)

Add extra data.

Parameters

string	$type
string	$value
mixed	$params

Returns

void

load_configuration()

GoogleAnalytics::load_configuration ( )

private

Load configuration.

Returns

void

get_configValue()

GoogleAnalytics::get_configValue (   $name = '' )

protected

Return configuration value.

Parameters

string

$name

Returns

mixed

display_extra()

GoogleAnalytics::display_extra (   $extra,   $addTags = false  )

protected

Display extra code

Parameters

array	$extra
boolean	$addTags

Returns

void

execute_onCaMykSPageLoad()

GoogleAnalytics::execute_onCaMykSPageLoad

(

)

Execute handler on page loading.

Returns

void

Reimplemented from Plugin.

execute_onCaMykSBodyOpen()

GoogleAnalytics::execute_onCaMykSBodyOpen

(

)

Execute handler on body opening.

Returns

void

Reimplemented from Plugin.

initialise_configDisplay()

GoogleAnalytics::initialise_configDisplay

(

)

Initialise object in Admin_Site / view configuration mode.

Returns

void

display_configDisplay()

GoogleAnalytics::display_configDisplay

(

)

Display object in Admin_Site / view configuration mode.

Returns

void

initialise_configEdition()

GoogleAnalytics::initialise_configEdition

(

$form

)

Initialise object in Admin_Site / edit configuration mode.

Parameters

Object

$form

Returns

void

display_configEdition()

GoogleAnalytics::display_configEdition

(

)

Display object in Admin_Site / edit configuration mode.

Returns

void

save_configuration()

GoogleAnalytics::save_configuration

(

)

Execute object in Admin_Site / save configuration mode.

Returns

void

get_cookieInformationData()

GoogleAnalytics::get_cookieInformationData

(

)

Return plugin information related to cookies.

Returns

void

is_cookieAccepted()

GoogleAnalytics::is_cookieAccepted ( )

private

Check if plugin is cookie accepted.

Returns

boolean

Member Data Documentation

$config

GoogleAnalytics::$config

protected

Input configuration.

var Object $config

$isConfigLoaded

GoogleAnalytics::$isConfigLoaded = false

protected

Stores if the configuration is loaded.

var boolean isConfigLoaded

$status

GoogleAnalytics::$status = 'enabled'

private

Snippet insertion status.

var boolean $status

$isLive

GoogleAnalytics::$isLive = false

private

Snippet code is already written.

var boolean $isLive

$extraData

GoogleAnalytics::$extraData = array()

protected

Store additional code to insert in snipper.

var array $extraData

---

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

• CaMykS/plugin/input/GoogleAnalytics/GoogleAnalytics.php.inc