TheIconic\Tracking\GoogleAnalytics\Traits\Indexable

Complexity

Total Complexity

8

Size/Duplication

Total Lines	54
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	minIndex()	0	4	1
A	maxIndex()	0	4	1
A	addIndex()	0	17	6

<?php

namespace TheIconic\Tracking\GoogleAnalytics\Traits;

use TheIconic\Tracking\GoogleAnalytics\Exception\InvalidIndexException;
use TheIconic\Tracking\GoogleAnalytics\Exception\InvalidNameException;

/**
 * Class Indexable
 *
 * Contains logic for indexing a parameter string with a valid placeholder.
 *
 * @package TheIconic\Tracking\GoogleAnalytics\Traits
 */
trait Indexable
{
    /**
     * Placeholder for the index.
     */
    private $indexPlaceholder = ':i:';

    /**
     * Minimum value index can take in GA.
     *
     * @return int
     */
    protected function minIndex()
    {
        return 1;
    }

    /**
     * Maximum value index can take in GA.
     *
     * @return int
     */
    protected function maxIndex()
    {
        return 200;
    }

    /**
     * Replaces a placeholder for the index passed.
     *
     * @param string $string
     * @param int $index
     * @return string
     * @throws \TheIconic\Tracking\GoogleAnalytics\Exception\InvalidIndexException
     * @throws \TheIconic\Tracking\GoogleAnalytics\Exception\InvalidNameException
     */
    protected function addIndex($string, $index)
    {
        if (empty($string)) {
            throw new InvalidNameException('Name attribute not defined for class ' . get_class($this));
        }

        if (strpos($string, $this->indexPlaceholder) !== false) {
            if (!is_numeric($index) || $index < $this->minIndex() || $index > $this->maxIndex()) {
                throw new InvalidIndexException(
                    'When setting parameter ' . get_class($this)
                    . ' a numeric index between 1 - 200 must be passed for the second argument'
                );
            }
        }

        return str_replace($this->indexPlaceholder, $index, $string);
    }
}