CaMykS  1.0-20181201
 All Classes Files Functions Variables Pages
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
GoogleAnalytics Class Reference
Inheritance diagram for GoogleAnalytics:
Inheritance graph
[legend]
Collaboration diagram for GoogleAnalytics:
Collaboration graph
[legend]

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 ()
 
- Public Member Functions inherited from Input
 Input ($name, $path_type)
 
 initialise ($params=array())
 
 display ()
 
 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_translation ($value, $data=null)
 
 get_languages ()
 
 execute_onCaMykSInitialise ()
 
 execute_onCaMykSPageLoad ()
 
 execute_onCaMykSBodyOpen ()
 
 execute_onCaMykSBodyClose ()
 
 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...
 
 $extraData = array()
 Store additional code to insert in snipper. More...
 

Private Member Functions

 load_configuration ()
 

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

Constructor & Destructor Documentation

GoogleAnalytics::__construct (   $path_type)

Class constructor.

Parameters
string$path_type
Returns
void

Member Function Documentation

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

Add extra data.

Parameters
string$type
string$value
mixed$params
Returns
void
GoogleAnalytics::add_trackingCode (   $trackingId,
  $params = null 
)

Add a tracking code.

Parameters
string$trackingId
mixed$params
Returns
void
GoogleAnalytics::disable ( )

Mark plugin as disabled

Returns
void
GoogleAnalytics::display ( )

Display input.

Returns
void
GoogleAnalytics::display_configDisplay ( )

Display object in Admin_Site / view configuration mode.

Returns
void
GoogleAnalytics::display_configEdition ( )

Display object in Admin_Site / edit configuration mode.

Returns
void
GoogleAnalytics::display_extra (   $extra,
  $addTags = false 
)
protected

Display extra code

Parameters
array$extra
boolean$addTags
Returns
void
GoogleAnalytics::execute_onCaMykSBodyOpen ( )

Execute handler on body opening.

Returns
void
GoogleAnalytics::execute_onCaMykSPageLoad ( )

Execute handler on page loading.

Returns
void
GoogleAnalytics::get_configValue (   $name = '')
protected

Return configuration value.

Parameters
string$name
Returns
mixed
GoogleAnalytics::initialise (   $params = array())

Initialise input.

Parameters
array$params
Returns
void
GoogleAnalytics::initialise_configDisplay ( )

Initialise object in Admin_Site / view configuration mode.

Returns
void
GoogleAnalytics::initialise_configEdition (   $form)

Initialise object in Admin_Site / edit configuration mode.

Parameters
Object$form
Returns
void
GoogleAnalytics::load_configuration ( )
private

Load configuration.

Returns
void
GoogleAnalytics::save_configuration ( )

Execute object in Admin_Site / save configuration mode.

Returns
void

Member Data Documentation

GoogleAnalytics::$config
protected

Input configuration.

var Object $config

GoogleAnalytics::$extraData = array()
protected

Store additional code to insert in snipper.

var array $extraData

GoogleAnalytics::$isLive = false
private

Snippet code is already written.

var boolean $isLive

GoogleAnalytics::$status = 'enabled'
private

Snippet insertion status.

var boolean $status


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