WMDE\BannerServer\Entity\Visitor

Complexity

Total Complexity

6

Size/Duplication

Total Lines	45
Duplicated Lines	0 %

Test Coverage

Coverage

73.32%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getBucketIdentifier()	0	2	1
A	__construct()	0	9	1
A	getTotalImpressionCount()	0	2	1
A	getCategories()	0	2	1
A	inCategory()	0	2	1
A	getDisplayWidth()	0	2	1

<?php

declare( strict_types = 1 );

namespace WMDE\BannerServer\Entity;

/**
 * @license GPL-2.0-or-later
 */
class Visitor {

	private int $totalImpressionCount = 0;
	private ?string $bucketIdentifier;
	private array $activeCategories;
	private int $displayWidth;

	/**
	 * @param int $totalImpressionCount How many banners the visitor has seen overall
	 * @param string|null $bucketIdentifier Last bucket identifier of the visitor (to put recurring visitors in the same buckets, but only per-campaign)
	 * @param int $displayWidth Viewport width of the visitor's browser window.
	 * @param string ...$activeCategories
	 */
	public function __construct(
			int $totalImpressionCount,
			?string $bucketIdentifier,
			int $displayWidth,
			string ...$activeCategories ) {
		$this->totalImpressionCount = $totalImpressionCount;
		$this->bucketIdentifier = $bucketIdentifier;
		$this->displayWidth = $displayWidth;
		$this->activeCategories = $activeCategories;
	}

	public function getTotalImpressionCount(): int {
		return $this->totalImpressionCount;
	}

	public function getBucketIdentifier(): ?string {
		return $this->bucketIdentifier;
	}

	public function inCategory( string $categoryName ): bool {
		return in_array( $categoryName, $this->activeCategories, true );
	}

	public function getDisplayWidth(): ?int {
		return $this->displayWidth;
	}

	/**
	 * @return string[]
	 */
	public function getCategories(): array {
		return $this->activeCategories;
	}
}