-
Notifications
You must be signed in to change notification settings - Fork 4
/
GoogleTagManager.php
192 lines (155 loc) · 5.08 KB
/
GoogleTagManager.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
<?php
namespace ezoterik\googleTagManager;
use Yii;
use yii\base\Application;
use yii\base\BaseObject;
use yii\base\BootstrapInterface;
use yii\base\Event;
use yii\helpers\Html;
use yii\helpers\Json;
use yii\web\View;
class GoogleTagManager extends BaseObject implements BootstrapInterface
{
/** @var string|null */
public $tagManagerId = null;
/** @var array|object[] */
protected $_dataLayerForCurrentRequest = [];
/** @var string */
public $sessionKey = 'google-tag-manager-data-layer';
/** @var bool */
public $isIgnorePostRequest = true;
/** @var bool */
public $isInitInHead = false;
/**
* @inheritdoc
*/
public function bootstrap($app)
{
if ($app->getRequest()->getIsAjax() || (!$app->getRequest()->getIsGet() && !$app->getRequest()->getIsPost())) {
return;
}
if ($this->isIgnorePostRequest && $app->getRequest()->getIsPost()) {
return;
}
//Delay attaching event handler to the view component after it is fully configured
$app->on(Application::EVENT_BEFORE_REQUEST, function () use ($app) {
$app->getView()->on(View::EVENT_BEGIN_BODY, [$this, 'renderCode']);
});
}
/**
* @param string|null $key
* @param string|object $value
*/
public function dataLayerPushItemDelay($key, $value)
{
$session = Yii::$app->getSession();
$dataLayerItems = $session->get($this->sessionKey, []);
if ($key === null) {
$dataLayerItem = $value;
} else {
$dataLayerItem = [$key => $value];
}
$dataLayerItems[] = $dataLayerItem;
$session->set($this->sessionKey, $dataLayerItems);
}
/**
* @param string|null $key
* @param string|object $value
*/
public function dataLayerPushItem($key, $value)
{
if ($key === null) {
$dataLayerItem = $value;
} else {
$dataLayerItem = (object)[$key => $value];
}
$this->_dataLayerForCurrentRequest[] = $dataLayerItem;
}
/**
* Rendering JavaScript code
*
* @param Event $event
*/
public function renderCode(Event $event)
{
/* @var $view View */
$view = $event->sender;
$scriptDelayedEvents = $this->renderDelayedEvents();
$tagManagerId = $this->getTagManagerId();
if ($tagManagerId === '') {
return;
}
$scriptInit = "(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','" . Html::encode($tagManagerId) . "');";
if ($scriptDelayedEvents || $this->_dataLayerForCurrentRequest) {
$scriptInit .= "\nwindow.dataLayer = window.dataLayer || [];";
if ($scriptDelayedEvents) {
$scriptInit .= "\n" . $scriptDelayedEvents;
}
foreach ($this->_dataLayerForCurrentRequest as $dataLayerItem) {
$scriptInit .= "\n" . 'dataLayer.push(' . Json::encode($dataLayerItem) . ');';
}
}
if ($this->isInitInHead) {
$view->registerJs($scriptInit, View::POS_HEAD);
$scriptInit = '';
}
echo $view->renderFile(__DIR__ . '/views/google-tag-manager.php', [
'tagManagerId' => $tagManagerId,
'scriptInit' => $scriptInit,
]);
}
/**
* Returns a code for triggering on a client side.
* For example: "dataLayer.push(....);"
*
* @param array $variables
*
* @return string
*/
public static function getClientDataLayerPush(array $variables)
{
if (count($variables) == 0) {
return '';
}
return 'dataLayer.push(' . Json::encode($variables) . ');';
}
/**
* @return string
*/
public function renderDelayedEvents()
{
$callEvents = [];
//If the session has data for dataLayer, then displays them and remove from the session
$session = Yii::$app->getSession();
if ($session->has($this->sessionKey)) {
if ($this->getTagManagerId() !== '') {
$dataLayerItems = $session->get($this->sessionKey, []);
foreach ($dataLayerItems as $dataLayerItem) {
$callEvents[] = 'dataLayer.push(' . Json::encode($dataLayerItem) . ');';
}
}
//Remove data from a session
$session->remove($this->sessionKey);
}
return implode("\n", $callEvents);
}
/**
* @return string
*/
private function getTagManagerId()
{
$tagManagerId = trim($this->tagManagerId);
if ($tagManagerId === '') {
return '';
}
if (stripos($tagManagerId, 'GTM-') === 0) {
return $tagManagerId;
}
//Adding a GTM prefix
return 'GTM-' . $tagManagerId;
}
}