ArticleEventsExtension::renderPageViewCount() - Code Metrics - Inspection of "impressions performance improvements (#861)" - superdesk/web-publisher - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 1.5 ( 293f07...bc7cd6 )

by Rafał

created 2019-06-14 12:43 UTC

ArticleEventsExtension::renderPageViewCount() A

↳ Parent: ArticleEventsExtension

Complexity

Conditions	4
Paths	4

Size

Total Lines

Duplication

Lines	3
Ratio	11.54 %

Importance

Changes

Metric	Value
dl	3
loc	26
rs	9.504
c	0
b	0
f	0
cc	4
nc	4
nop	1

<?php

declare(strict_types=1);

/*
 * This file is part of the Superdesk Web Publisher Core Bundle.
 *
 * Copyright 2017 Sourcefabric z.u. and contributors.
 *
 * For the full copyright and license information, please see the
 * AUTHORS and LICENSE files distributed with this source code.
 *
 * @copyright 2017 Sourcefabric z.ú
 * @license http://www.superdesk.org/license
 */

namespace SWP\Bundle\CoreBundle\Twig;

use SWP\Bundle\CoreBundle\Model\ArticleInterface;
use SWP\Component\TemplatesSystem\Gimme\Meta\Meta;
use Twig\Extension\AbstractExtension;
use Twig\TwigFunction;

class ArticleEventsExtension extends AbstractExtension
{
    protected $analyticsHost;

    public function __construct(string $analyticsHost = null)
    {
        $this->analyticsHost = $analyticsHost;
    }

    /**
     * @return TwigFunction[]
     */
    public function getFunctions()
    {
        return [
            new TwigFunction('countPageView', [$this, 'renderPageViewCount'], ['is_safe' => ['html']]),
            new TwigFunction('countArticlesImpressions', [$this, 'renderLinkImpressionCount'], ['is_safe' => ['html']]),
        ];
    }

    /**
     * @param Meta $meta
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return string|void
     */
    public function renderLinkImpressionCount()
    {
        $jsTemplate = <<<'EOT'
<script type="text/javascript">
function isInCurrentViewport(el) {
    const rect = el.getBoundingClientRect();

    return (
        rect.top >= 0 &&
        rect.left >= 0 &&
        rect.bottom <= (window.innerHeight || document.documentElement.clientHeight) &&
        rect.right <= (window.innerWidth || document.documentElement.clientWidth)
    );
}


let arr = [], links = [], processedLinks = [], l = document.links;
const hostname = window.location.hostname;
var iterator = 0;
var breakpoint = 200;

var process = function process() {
  links = [];
  arr = [];
  // filter out section pages
  for(let i=0; i<l.length; i++) {
      const parts = l[i].pathname.split('/');
      if (parts.length > 2 && isInCurrentViewport(l[i]) && processedLinks.indexOf(l[i].href) === -1) {
          links.push(l[i]);
      }
  }
  // filter out links with data-article, add article id
  for(let i=0; i<links.length; i++) {
      const attr = links[i].dataset['article'];
      // if attribute not in array
      if(typeof attr !== 'undefined' && arr.indexOf(attr) === -1 && isInCurrentViewport(links[i]) && processedLinks.indexOf(links[i].href) === -1){
          arr.push(attr); 
          links.splice(i, 1);
      }
  }
  
  // filter out links different than current domain
  for(let i=0; i<links.length; i++){
      if(arr.indexOf(links[i].href) === -1 && links[i].href.indexOf(hostname) !== -1){
          arr.push(links[i].href);
      }
  }

  processedLinks = unique(processedLinks.concat(arr));
  
  if (arr.length > 0) {
      let xhr = new XMLHttpRequest();
      let read_date = new Date();
      let request_randomizer = "&" + read_date.getTime() + Math.random();
      xhr.open('POST', '/_swp_analytics?type=impression'+request_randomizer);
      xhr.setRequestHeader("Content-Type", "application/json");
      xhr.send(JSON.stringify(arr));
  }
}

var countImpressions = function countImpressions() {
    let scrollDown = document.body.scrollTop || document.documentElement.scrollTop;
    if (scrollDown >= breakpoint) {
       process();
       breakpoint += 200;
       iterator++;
    }
}

var unique = function unique(array) {
    let a = array.concat();
    for(let i=0; i<a.length; ++i) {
        for(let j=i+1; j<a.length; ++j) {
            if(a[i] === a[j])
                a.splice(j--, 1);
        }
    }

    return a;
}

window.onscroll = function() {countImpressions()};
process();

</script>
EOT;

        if (null !== $this->analyticsHost) {

            $jsTemplate = str_replace('/_swp_analytics', $this->analyticsHost.'/_swp_analytics', $jsTemplate);
        }

        return $jsTemplate;
    }

    /**
     * @param Meta $meta
     *
     * @return string|void
     */
    public function renderPageViewCount(Meta $meta = null)
    {
        if (null === $meta) {
            return;
        }

        $jsTemplate = <<<'EOT'
<script type="text/javascript">
var xhr = new XMLHttpRequest();
var read_date = new Date();
var request_randomizer = "&" + read_date.getTime() + Math.random();
xhr.open('GET', '/_swp_analytics?articleId=%s'+request_randomizer+'&ref='+document.referrer);
xhr.send();
</script>
EOT;
        $article = $meta->getValues();
        if (!$article instanceof ArticleInterface) {
            return;
        }

        if (null !== $this->analyticsHost) {

            $jsTemplate = str_replace('/_swp_analytics', $this->analyticsHost.'/_swp_analytics', $jsTemplate);
        }

        return sprintf($jsTemplate, $article->getId());
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		/*
6		* This file is part of the Superdesk Web Publisher Core Bundle.
7		*
8		* Copyright 2017 Sourcefabric z.u. and contributors.
9		*
10		* For the full copyright and license information, please see the
11		* AUTHORS and LICENSE files distributed with this source code.
12		*
13		* @copyright 2017 Sourcefabric z.ú
14		* @license http://www.superdesk.org/license
15		*/
16
17		namespace SWP\Bundle\CoreBundle\Twig;
18
19		use SWP\Bundle\CoreBundle\Model\ArticleInterface;
20		use SWP\Component\TemplatesSystem\Gimme\Meta\Meta;
21		use Twig\Extension\AbstractExtension;
22		use Twig\TwigFunction;
23
24		class ArticleEventsExtension extends AbstractExtension
25		{
26		protected $analyticsHost;
27
28		public function __construct(string $analyticsHost = null)
29		{
30		$this->analyticsHost = $analyticsHost;
31		}
32
33		/**
34		* @return TwigFunction[]
35		*/
36		public function getFunctions()
37		{
38		return [
39		new TwigFunction('countPageView', [$this, 'renderPageViewCount'], ['is_safe' => ['html']]),
40		new TwigFunction('countArticlesImpressions', [$this, 'renderLinkImpressionCount'], ['is_safe' => ['html']]),
41		];
42		}
43
44		/**
45		* @param Meta $meta
		0 ignored issues – show Bug introduced 2018-07-10 13:02 UTC by Report Bug Copy Issue Report There is no parameter named `$meta`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
46		*
47		* @return string\|void
48		*/
49		public function renderLinkImpressionCount()
50		{
51		$jsTemplate = <<<'EOT'
52		<script type="text/javascript">
53		function isInCurrentViewport(el) {
54		const rect = el.getBoundingClientRect();
55
56		return (
57		rect.top >= 0 &&
58		rect.left >= 0 &&
59		rect.bottom <= (window.innerHeight \|\| document.documentElement.clientHeight) &&
60		rect.right <= (window.innerWidth \|\| document.documentElement.clientWidth)
61		);
62		}
63
64
65		let arr = [], links = [], processedLinks = [], l = document.links;
66		const hostname = window.location.hostname;
67		var iterator = 0;
68		var breakpoint = 200;
69
70		var process = function process() {
71		links = [];
72		arr = [];
73		// filter out section pages
74		for(let i=0; i<l.length; i++) {
75		const parts = l[i].pathname.split('/');
76		if (parts.length > 2 && isInCurrentViewport(l[i]) && processedLinks.indexOf(l[i].href) === -1) {
77		links.push(l[i]);
78		}
79		}
80		// filter out links with data-article, add article id
81		for(let i=0; i<links.length; i++) {
82		const attr = links[i].dataset['article'];
83		// if attribute not in array
84		if(typeof attr !== 'undefined' && arr.indexOf(attr) === -1 && isInCurrentViewport(links[i]) && processedLinks.indexOf(links[i].href) === -1){
85		arr.push(attr);
86		links.splice(i, 1);
87		}
88		}
89
90		// filter out links different than current domain
91		for(let i=0; i<links.length; i++){
92		if(arr.indexOf(links[i].href) === -1 && links[i].href.indexOf(hostname) !== -1){
93		arr.push(links[i].href);
94		}
95		}
96
97		processedLinks = unique(processedLinks.concat(arr));
98
99		if (arr.length > 0) {
100		let xhr = new XMLHttpRequest();
101		let read_date = new Date();
102		let request_randomizer = "&" + read_date.getTime() + Math.random();
103		xhr.open('POST', '/_swp_analytics?type=impression'+request_randomizer);
104		xhr.setRequestHeader("Content-Type", "application/json");
105		xhr.send(JSON.stringify(arr));
106		}
107		}
108
109		var countImpressions = function countImpressions() {
110		let scrollDown = document.body.scrollTop \|\| document.documentElement.scrollTop;
111		if (scrollDown >= breakpoint) {
112		process();
113		breakpoint += 200;
114		iterator++;
115		}
116		}
117
118		var unique = function unique(array) {
119		let a = array.concat();
120		for(let i=0; i<a.length; ++i) {
121		for(let j=i+1; j<a.length; ++j) {
122		if(a[i] === a[j])
123		a.splice(j--, 1);
124		}
125		}
126
127		return a;
128		}
129
130		window.onscroll = function() {countImpressions()};
131		process();
132
133		</script>
134		EOT;
135
136	View Code Duplication	if (null !== $this->analyticsHost) {
		0 ignored issues – show Duplication introduced 2019-01-14 13:43 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
137		$jsTemplate = str_replace('/_swp_analytics', $this->analyticsHost.'/_swp_analytics', $jsTemplate);
138		}
139
140		return $jsTemplate;
141		}
142
143		/**
144		* @param Meta $meta
145		*
146		* @return string\|void
147		*/
148		public function renderPageViewCount(Meta $meta = null)
149		{
150		if (null === $meta) {
151		return;
152		}
153
154		$jsTemplate = <<<'EOT'
155		<script type="text/javascript">
156		var xhr = new XMLHttpRequest();
157		var read_date = new Date();
158		var request_randomizer = "&" + read_date.getTime() + Math.random();
159		xhr.open('GET', '/_swp_analytics?articleId=%s'+request_randomizer+'&ref='+document.referrer);
160		xhr.send();
161		</script>
162		EOT;
163		$article = $meta->getValues();
164		if (!$article instanceof ArticleInterface) {
165		return;
166		}
167
168	View Code Duplication	if (null !== $this->analyticsHost) {
		0 ignored issues – show Duplication introduced 2019-01-14 13:43 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
169		$jsTemplate = str_replace('/_swp_analytics', $this->analyticsHost.'/_swp_analytics', $jsTemplate);
170		}
171
172		return sprintf($jsTemplate, $article->getId());
173		}
174		}
175

superdesk / web-publisher

Push — 1.5 ( 293f07...bc7cd6 )

ArticleEventsExtension::renderPageViewCount() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like