nystudio107\instantanalyticsGa4\helpers\Analytics::shouldSendAnalytics()

Complexity

Conditions	23
Paths	28

Size

Total Lines	93
Code Lines	51

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

<?php
    public static function shouldSendAnalytics(): bool
    {
        $result = true;
        $request = Craft::$app->getRequest();

        $logExclusion = static function(string $setting) {

Expected 1 space after FUNCTION keyword; 0 found

            if (InstantAnalytics::$settings->logExcludedAnalytics) {
                $request = Craft::$app->getRequest();
                $requestIp = $request->getUserIP();
                InstantAnalytics::$plugin->logAnalyticsEvent(
                    'Analytics excluded for:: {requestIp} due to: `{setting}`',
                    compact('requestIp', 'setting'),
                    __METHOD__
                );
            }
        };

        if (!InstantAnalytics::$settings->sendAnalyticsData) {
            $logExclusion('sendAnalyticsData');
            return false;
        }

        if (!InstantAnalytics::$settings->sendAnalyticsInDevMode && Craft::$app->getConfig()->getGeneral()->devMode) {
            $logExclusion('sendAnalyticsInDevMode');
            return false;
        }

        if ($request->getIsConsoleRequest()) {
            $logExclusion('Craft::$app->getRequest()->getIsConsoleRequest()');
            return false;
        }

        if ($request->getIsCpRequest()) {
            $logExclusion('Craft::$app->getRequest()->getIsCpRequest()');
            return false;
        }

        if ($request->getIsLivePreview()) {
            $logExclusion('Craft::$app->getRequest()->getIsLivePreview()');
            return false;
        }

        // Check the $_SERVER[] super-global exclusions
        if (InstantAnalytics::$settings->serverExcludes !== null
            && !empty(InstantAnalytics::$settings->serverExcludes)) {

Closing parenthesis of a multi-line IF statement must be on a new line

            foreach (InstantAnalytics::$settings->serverExcludes as $match => $matchArray) {
                if (isset($_SERVER[$match])) {
                    foreach ($matchArray as $matchItem) {
                        if (preg_match($matchItem, $_SERVER[$match])) {
                            $logExclusion('serverExcludes');

                            return false;
                        }
                    }
                }
            }
        }

        // Filter out bot/spam requests via UserAgent
        if (InstantAnalytics::$settings->filterBotUserAgents) {
            $crawlerDetect = new CrawlerDetect();
            // Check the user agent of the current 'visitor'
            if ($crawlerDetect->isCrawler()) {
                $logExclusion('filterBotUserAgents');

                return false;
            }
        }

        // Filter by user group
        $userService = Craft::$app->getUser();
        /** @var ?UserElement $user */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $user = $userService->getIdentity();
        if ($user) {
            if (InstantAnalytics::$settings->adminExclude && $user->admin) {
                $logExclusion('adminExclude');

                return false;
            }

            if (InstantAnalytics::$settings->groupExcludes !== null
                && !empty(InstantAnalytics::$settings->groupExcludes)) {

Closing parenthesis of a multi-line IF statement must be on a new line

                foreach (InstantAnalytics::$settings->groupExcludes as $matchItem) {
                    if ($user->isInGroup($matchItem)) {
                        $logExclusion('groupExcludes');

                        return false;
                    }
                }
            }
        }

        return $result;
    }