YAWK\WIDGETS\GOOGLE\ANALYTICS\googleAnalytics Class Reference

Embed Google Analytics on your page. More...

Inheritance diagram for YAWK\WIDGETS\GOOGLE\ANALYTICS\googleAnalytics:

Public Member Functions
	__construct ($db)
	Load all widget settings from database and fill object. More...
	embed ()
	init ()
	Init and embed Google Analytics. More...
	printObject ()
	Print all object data. More...
Public Member Functions inherited from YAWK\widget
	getHeading ($heading, $subtext)
	Get widget heading and subtext, return headline. More...
	getWidgetSettingsArray ($db)
	Get widget settings and return it as array. More...

Public Attributes
	$gaTrackingCode = ''
	$gaTrackingID = ''
	$widget = ''
Public Attributes inherited from YAWK\widget
	$data
	$date_publish
	$date_unpublish
	$folder
	$id
	$marginBottom
	$marginTop
	$name
	$pageID
	$position
	$published
	$sort
	$widgetTitle
	$widgetType

Additional Inherited Members
Static Public Member Functions inherited from YAWK\widget
static	getAllSettingsIntoArray ($db, $widgetID)
	Returns an array with all widget settings data. More...
static	getAllWidgetTypes ($db)
	Return all widget types as associative array. More...
static	getCurrentWidgetPath ($db)
	return current widget path More...
static	getFacebookLikeBox ()
	return the facebook likebox widget More...
static	getLoginBox ()
	return the user login box widget More...
static	loadWidgetsOfPage ($db, $page)
	Returns an array of all widgets that are linked with given page->id. More...

Detailed Description

Embed Google Analytics on your page.

Google Analytics Widget - Embed Google Analytics on your page

If you need to track your users with google analytics, you can use this widget. It requires a tracking ID and allows a few settings. In order to work properly, it is required to embed this widget on 'all pages' in any position that is not used by anything else. A recommended position would be debug or any other empty position.

Author

Daniel Retzl danie.nosp@m.lret.nosp@m.zl@gm.nosp@m.ail..nosp@m.com

Copyright

2018 Daniel Retzl

Version

1.0.0

Definition at line 17 of file googleAnalytics.php.

Constructor & Destructor Documentation

__construct()

YAWK\WIDGETS\GOOGLE\ANALYTICS\googleAnalytics::__construct

(

$db

)

Load all widget settings from database and fill object.

Parameters

object

$db

Database Object

Load all widget settings on object init.

Definition at line 31 of file googleAnalytics.php.

        {
            // load this widget settings from db
            $this->widget = new \YAWK\widget();
            $settings = $this->widget->getWidgetSettingsArray($db);
            foreach ($settings as $property => $value) {
                $this->$property = $value;
                $this->gaTrackingID = $this->gaTrackingCode;
            }

References $db, YAWK\WIDGETS\GOOGLE\ANALYTICS\googleAnalytics\$gaTrackingCode, $settings, $value, and YAWK\widget\getWidgetSettingsArray().

Member Function Documentation

embed()

YAWK\WIDGETS\GOOGLE\ANALYTICS\googleAnalytics::embed

(

)

Definition at line 62 of file googleAnalytics.php.

        {
            if (isset($this->gaTrackingID)
            && (!empty($this->gaTrackingID)))
            {
                // make sure that the string contains no html
                $this->gaTrackingID = strip_tags($this->gaTrackingID);
 
                // tracking code seems to be valid -
                // embed Google Analytics
                echo'<!-- google analytics -->
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id='.$this->gaTrackingID.'"></script>
<script>
    window.dataLayer = window.dataLayer || [];
    function gtag(){dataLayer.push(arguments);}
    gtag(\'js\', new Date());
    gtag(\'config\', \''.$this->gaTrackingCode.'\');
</script>';
            }
            else
                {   // tracking code not set, empty or wrong data type
                    echo "Google Analytics could not be loaded - tracking code not set, empty or wrong data type.";
                }

Referenced by YAWK\WIDGETS\GOOGLE\ANALYTICS\googleAnalytics\init().

init()

YAWK\WIDGETS\GOOGLE\ANALYTICS\googleAnalytics::init

(

)

Init and embed Google Analytics.

Embed Google Analytics

Definition at line 57 of file googleAnalytics.php.

        {   // embed GoogleAnalytics
            $this->embed();

References YAWK\WIDGETS\GOOGLE\ANALYTICS\googleAnalytics\embed().

printObject()

YAWK\WIDGETS\GOOGLE\ANALYTICS\googleAnalytics::printObject

(

)

Print all object data.

(for development and testing purpose)

Reimplemented from YAWK\widget.

Definition at line 46 of file googleAnalytics.php.

        {   // output data to screen
            echo "<pre>";
            print_r($this);
            echo "</pre>";

Member Data Documentation

$gaTrackingCode

YAWK\WIDGETS\GOOGLE\ANALYTICS\googleAnalytics::$gaTrackingCode = ''

Parameters

string

Tracking Code

Definition at line 24 of file googleAnalytics.php.

Referenced by YAWK\WIDGETS\GOOGLE\ANALYTICS\googleAnalytics\__construct().

$gaTrackingID

YAWK\WIDGETS\GOOGLE\ANALYTICS\googleAnalytics::$gaTrackingID = ''

Parameters

string

Tracking ID

Definition at line 22 of file googleAnalytics.php.

$widget

YAWK\WIDGETS\GOOGLE\ANALYTICS\googleAnalytics::$widget = ''

Parameters

object

global widget object data

Definition at line 20 of file googleAnalytics.php.

---

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

• /var/www/htdocs/yawk.io/system/widgets/googleAnalytics/classes/googleAnalytics.php