Settings::behaviors() - Code Metrics - nystudio107/craft-instantanalytics-ga4 - Measure and Improve Code Quality continuously with Scrutinizer

Settings::behaviors() A
last analyzed 2024-09-14 20:54 UTC

↳ Parent: Settings

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	7
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	11
rs	10

<?php
/**
 * Instant Analytics plugin for Craft CMS
 *
 * Instant Analytics brings full Google Analytics support to your Twig templates
 *
 * @link      https://nystudio107.com

 * @copyright Copyright (c) 2017 nystudio107

 */


namespace nystudio107\instantanalyticsGa4\models;

use craft\base\Model;
use craft\behaviors\EnvAttributeParserBehavior;
use craft\validators\ArrayValidator;
use yii\behaviors\AttributeTypecastBehavior;

/**

 * @author    nystudio107

 * @package   InstantAnalytics

 * @since     1.0.0

 */

class Settings extends Model
{
    // Public Properties
    // =========================================================================

    /**
     * The default Google Analytics measurement ID used by GA4.
     * @var string

     */
    public string $googleAnalyticsMeasurementId = '';

    /**
     * The default Google Analytics measurement API secret used by GA4.
     * @var string

     */
    public string $googleAnalyticsMeasurementApiSecret = '';

    /**
     * The default Google Analytics tracking ID
     *
     * @var string
     */
    public string $googleAnalyticsTracking = '';

    /**
     * Should the query string be stripped from the page tracking URL?
     *
     * @var bool
     */
    public bool $stripQueryString = true;

    /**
     * Should page views be sent automatically when a page view happens?
     *
     * @var bool
     */
    public bool $autoSendPageView = true;

    /**
     * If you plan to use Instant Analytics in conjunction with frontend JavaScript, this setting should be on, so that Instant Analytics requires a `clientId` from the frontend-set GA cookie before it will send analytics data.
     * @var bool

     */
    public bool $requireGaCookieClientId = true;

    /**

     * @var bool Should the GCLID cookie be created if it doesn't exist?
     */
    public bool $createGclidCookie = true;

    /**

     * @var bool Should the user id property be set on events, if user is logged in.
     */
    public $sendUserId = true;

    /**

     * @var int The session duration as set in GA4 admin settings.
     */
    public $sessionDuration = 30;

    /**
     * The field in a Commerce Product Variant that should be used for the
     * category
     *
     * @var string
     */
    public string $productCategoryField = '';

    /**
     * The field in a Commerce Product Variant that should be used for the brand
     *
     * @var string
     */
    public string $productBrandField = '';

    /**
     * Whether add to cart events should be automatically sent
     *
     * @var bool
     */
    public bool $autoSendAddToCart = true;

    /**
     * Whether remove from cart events should be automatically sent
     *
     * @var bool
     */
    public bool $autoSendRemoveFromCart = true;

    /**
     * Whether purchase complete events should be automatically sent
     *
     * @var bool
     */
    public bool $autoSendPurchaseComplete = true;

    /**
     * Controls whether Instant Analytics will send analytics data.
     *
     * @var bool
     */
    public bool $sendAnalyticsData = true;

    /**
     * Controls whether Instant Analytics will send analytics data when
     * `devMode` is on.
     *
     * @var bool
     */
    public bool $sendAnalyticsInDevMode = true;

    /**
     * Controls whether we should filter out bot UserGents.
     *
     * @var bool
     */
    public bool $filterBotUserAgents = true;

    /**
     * Controls whether we should exclude users logged into an admin account
     * from Analytics tracking.
     *
     * @var bool
     */
    public bool $adminExclude = false;

    /**
     * Controls whether analytics that blocked from being sent should be logged
     * to storage/logs/web.log These are always logged if `devMode` is on
     *
     * @var bool
     */
    public bool $logExcludedAnalytics = true;

    /**
     * Contains an array of Craft user group handles to exclude from Analytics
     * tracking.  If there's a match for any of them, analytics data is not
     * sent.
     *
     * @var array
     */
    public array $groupExcludes = [
    ];

    /**
     * Contains an array of keys that correspond to $_SERVER[] super-global
     * array keys to test against. Each item in the sub-array is tested against
     * the $_SERVER[] super-global key via RegEx; if there's a match for any of
     * them, analytics data is not sent.  This allows you to filter based on
     * whatever information you want. Reference:
     * http://php.net/manual/en/reserved.variables.server.php RegEx tester:
     * http://regexr.com
     *
     * @var array
     */
    public array $serverExcludes = [
        'REMOTE_ADDR' => [
            '/^localhost$|^127(?:\.[0-9]+){0,2}\.[0-9]+$|^(?:0*\:)*?:?0*1$/',
        ],
    ];

    // Public Methods
    // =========================================================================

    /**

     * @return array
     */
    public function defineRules(): array
    {
        return [
            [
                [
                    'stripQueryString',
                    'autoSendPageView',
                    'requireGaCookieClientId',
                    'createGclidCookie',
                    'autoSendAddToCart',
                    'autoSendRemoveFromCart',
                    'autoSendPurchaseComplete',
                    'sendAnalyticsData',
                    'sendAnalyticsInDevMode',
                    'filterBotUserAgents',
                    'adminExclude',
                    'logExcludedAnalytics',
                ],
                'boolean',
            ],
            [
                [
                    'googleAnalyticsTracking',
                    'productCategoryField',
                    'productBrandField',
                    'googleAnalyticsTracking',
                ],
                'string',
            ],
            [
                [
                    'groupExcludes',
                    'serverExcludes',
                ],
                ArrayValidator::class,
            ],
        ];
    }

    /**

     * @return array
     */
    public function behaviors(): array
    {
        return [
            'typecast' => [
                'class' => AttributeTypecastBehavior::class,
                // 'attributeTypes' will be composed automatically according to `rules()`
            ],
            'parser' => [
                'class' => EnvAttributeParserBehavior::class,
                'attributes' => [
                    'googleAnalyticsTracking',
                ],
            ],
        ];
    }
}


1			<?php
2			/**
3			* Instant Analytics plugin for Craft CMS
4			*
5			* Instant Analytics brings full Google Analytics support to your Twig templates
6			*
7			* @link https://nystudio107.com
			0 ignored issues – show Coding Style introduced 2023-06-12 19:52 UTC by Report Bug Copy Issue Report The tag in position 1 should be the @copyright tag Loading history...
8			* @copyright Copyright (c) 2017 nystudio107
			0 ignored issues – show Coding Style introduced 2023-06-12 19:52 UTC by Report Bug Copy Issue Report @copyright tag must contain a year and the name of the copyright holder Loading history...
9			*/
			0 ignored issues – show Coding Style introduced 2023-06-12 19:52 UTC by Report Bug Copy Issue Report PHP version not specified Loading history... Coding Style introduced 2023-06-12 19:52 UTC by Report Bug Copy Issue Report Missing @category tag in file comment Loading history... Coding Style introduced 2023-06-12 19:52 UTC by Report Bug Copy Issue Report Missing @package tag in file comment Loading history... Coding Style introduced 2023-06-12 19:52 UTC by Report Bug Copy Issue Report Missing @author tag in file comment Loading history... Coding Style introduced 2023-06-12 19:52 UTC by Report Bug Copy Issue Report Missing @license tag in file comment Loading history...
10
11			namespace nystudio107\instantanalyticsGa4\models;
12
13			use craft\base\Model;
14			use craft\behaviors\EnvAttributeParserBehavior;
15			use craft\validators\ArrayValidator;
16			use yii\behaviors\AttributeTypecastBehavior;
17
18			/**
			0 ignored issues – show Coding Style introduced 2023-06-12 19:52 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
19			* @author nystudio107
			0 ignored issues – show Coding Style introduced 2023-06-12 19:52 UTC by Report Bug Copy Issue Report The tag in position 1 should be the @package tag Loading history... Coding Style introduced 2023-06-12 19:52 UTC by Report Bug Copy Issue Report Content of the @author tag must be in the form "Display Name <[email protected]>" Loading history... Coding Style introduced 2023-06-12 19:52 UTC by Report Bug Copy Issue Report Tag value for @author tag indented incorrectly; expected 2 spaces but found 4 Loading history...
20			* @package InstantAnalytics
			0 ignored issues – show Coding Style introduced 2023-06-12 19:52 UTC by Report Bug Copy Issue Report Tag value for @package tag indented incorrectly; expected 1 spaces but found 3 Loading history...
21			* @since 1.0.0
			0 ignored issues – show Coding Style introduced 2023-06-12 19:52 UTC by Report Bug Copy Issue Report The tag in position 3 should be the @author tag Loading history... Coding Style introduced 2023-06-12 19:52 UTC by Report Bug Copy Issue Report Tag value for @since tag indented incorrectly; expected 3 spaces but found 5 Loading history...
22			*/
			0 ignored issues – show Coding Style introduced 2023-06-12 19:52 UTC by Report Bug Copy Issue Report Missing @category tag in class comment Loading history... Coding Style introduced 2023-06-12 19:52 UTC by Report Bug Copy Issue Report Missing @license tag in class comment Loading history... Coding Style introduced 2023-06-12 19:52 UTC by Report Bug Copy Issue Report Missing @link tag in class comment Loading history...
23			class Settings extends Model
24			{
25			// Public Properties
26			// =========================================================================
27
28			/**
29			* The default Google Analytics measurement ID used by GA4.
30			* @var string
			0 ignored issues – show Coding Style introduced 2023-06-12 19:52 UTC by Report Bug Copy Issue Report There must be exactly one blank line before the tags in a doc comment Loading history...
31			*/
32			public string $googleAnalyticsMeasurementId = '';
33
34			/**
35			* The default Google Analytics measurement API secret used by GA4.
36			* @var string
			0 ignored issues – show Coding Style introduced 2023-06-12 19:52 UTC by Report Bug Copy Issue Report There must be exactly one blank line before the tags in a doc comment Loading history...
37			*/
38			public string $googleAnalyticsMeasurementApiSecret = '';
39
40			/**
41			* The default Google Analytics tracking ID
42			*
43			* @var string
44			*/
45			public string $googleAnalyticsTracking = '';
46
47			/**
48			* Should the query string be stripped from the page tracking URL?
49			*
50			* @var bool
51			*/
52			public bool $stripQueryString = true;
53
54			/**
55			* Should page views be sent automatically when a page view happens?
56			*
57			* @var bool
58			*/
59			public bool $autoSendPageView = true;
60
61			/**
62			* If you plan to use Instant Analytics in conjunction with frontend JavaScript, this setting should be on, so that Instant Analytics requires a `clientId` from the frontend-set GA cookie before it will send analytics data.
63			* @var bool
			0 ignored issues – show Coding Style introduced 2023-06-12 19:52 UTC by Report Bug Copy Issue Report There must be exactly one blank line before the tags in a doc comment Loading history...
64			*/
65			public bool $requireGaCookieClientId = true;
66
67			/**
			0 ignored issues – show Coding Style introduced 2023-06-12 19:52 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
68			* @var bool Should the GCLID cookie be created if it doesn't exist?
69			*/
70			public bool $createGclidCookie = true;
71
72			/**
			0 ignored issues – show Coding Style introduced 2023-06-12 19:52 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
73			* @var bool Should the user id property be set on events, if user is logged in.
74			*/
75			public $sendUserId = true;
76
77			/**
			0 ignored issues – show Coding Style introduced 2023-06-12 19:52 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
78			* @var int The session duration as set in GA4 admin settings.
79			*/
80			public $sessionDuration = 30;
81
82			/**
83			* The field in a Commerce Product Variant that should be used for the
84			* category
85			*
86			* @var string
87			*/
88			public string $productCategoryField = '';
89
90			/**
91			* The field in a Commerce Product Variant that should be used for the brand
92			*
93			* @var string
94			*/
95			public string $productBrandField = '';
96
97			/**
98			* Whether add to cart events should be automatically sent
99			*
100			* @var bool
101			*/
102			public bool $autoSendAddToCart = true;
103
104			/**
105			* Whether remove from cart events should be automatically sent
106			*
107			* @var bool
108			*/
109			public bool $autoSendRemoveFromCart = true;
110
111			/**
112			* Whether purchase complete events should be automatically sent
113			*
114			* @var bool
115			*/
116			public bool $autoSendPurchaseComplete = true;
117
118			/**
119			* Controls whether Instant Analytics will send analytics data.
120			*
121			* @var bool
122			*/
123			public bool $sendAnalyticsData = true;
124
125			/**
126			* Controls whether Instant Analytics will send analytics data when
127			* `devMode` is on.
128			*
129			* @var bool
130			*/
131			public bool $sendAnalyticsInDevMode = true;
132
133			/**
134			* Controls whether we should filter out bot UserGents.
135			*
136			* @var bool
137			*/
138			public bool $filterBotUserAgents = true;
139
140			/**
141			* Controls whether we should exclude users logged into an admin account
142			* from Analytics tracking.
143			*
144			* @var bool
145			*/
146			public bool $adminExclude = false;
147
148			/**
149			* Controls whether analytics that blocked from being sent should be logged
150			* to storage/logs/web.log These are always logged if `devMode` is on
151			*
152			* @var bool
153			*/
154			public bool $logExcludedAnalytics = true;
155
156			/**
157			* Contains an array of Craft user group handles to exclude from Analytics
158			* tracking. If there's a match for any of them, analytics data is not
159			* sent.
160			*
161			* @var array
162			*/
163			public array $groupExcludes = [
164			];
165
166			/**
167			* Contains an array of keys that correspond to $_SERVER[] super-global
168			* array keys to test against. Each item in the sub-array is tested against
169			* the $_SERVER[] super-global key via RegEx; if there's a match for any of
170			* them, analytics data is not sent. This allows you to filter based on
171			* whatever information you want. Reference:
172			* http://php.net/manual/en/reserved.variables.server.php RegEx tester:
173			* http://regexr.com
174			*
175			* @var array
176			*/
177			public array $serverExcludes = [
178			'REMOTE_ADDR' => [
179			'/^localhost$\|^127(?:\.[0-9]+){0,2}\.[0-9]+$\|^(?:0\:)?:?0*1$/',
180			],
181			];
182
183			// Public Methods
184			// =========================================================================
185
186			/**
			0 ignored issues – show Coding Style introduced 2023-07-03 22:21 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
187			* @return array
188			*/
189			public function defineRules(): array
190			{
191			return [
192			[
193			[
194			'stripQueryString',
195			'autoSendPageView',
196			'requireGaCookieClientId',
197			'createGclidCookie',
198			'autoSendAddToCart',
199			'autoSendRemoveFromCart',
200			'autoSendPurchaseComplete',
201			'sendAnalyticsData',
202			'sendAnalyticsInDevMode',
203			'filterBotUserAgents',
204			'adminExclude',
205			'logExcludedAnalytics',
206			],
207			'boolean',
208			],
209			[
210			[
211			'googleAnalyticsTracking',
212			'productCategoryField',
213			'productBrandField',
214			'googleAnalyticsTracking',
215			],
216			'string',
217			],
218			[
219			[
220			'groupExcludes',
221			'serverExcludes',
222			],
223			ArrayValidator::class,
224			],
225			];
226			}
227
228			/**
			0 ignored issues – show Coding Style introduced 2023-07-03 22:21 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
229			* @return array
230			*/
231			public function behaviors(): array
232			{
233			return [
234			'typecast' => [
235			'class' => AttributeTypecastBehavior::class,
236			// 'attributeTypes' will be composed automatically according to `rules()`
237			],
238			'parser' => [
239			'class' => EnvAttributeParserBehavior::class,
240			'attributes' => [
241			'googleAnalyticsTracking',
242			],
243			],
244			];
245			}
246			}
247

nystudio107 / craft-instantanalytics-ga4

Settings::behaviors() A last analyzed 2024-09-14 20:54 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Settings::behaviors() A
last analyzed 2024-09-14 20:54 UTC