Gendoria\CruftFlake\Config\FixedConfig

Complexity

Total Complexity

5

Size/Duplication

Total Lines	64
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes	6
Bugs	0	Features	5

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getMachine()	0	6	1
A	__construct()	0	9	2
A	heartbeat()	0	4	1
A	setLogger()	0	4	1

<?php
/**
 * Fixed configuration.
 * 
 * This is designed to be used where each machine **knows** what its machine
 * ID is - eg: via some kind of automatically deployed configuration
 * (puppet etc.)
 * 
 * @author @davegardnerisme
 */

namespace Gendoria\CruftFlake\Config;

use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;

class FixedConfig implements ConfigInterface, LoggerAwareInterface
{
    /**
     * Machine ID.
     * 
     * @var int
     */
    private $machineId;

    /**
     * Logger.
     * 
     * @var LoggerInterface
     */
    private $logger;

    /**
     * Constructor.
     * 
     * @param int             $machineId Fixed machine ID.
     * @param LoggerInterface $logger    Logger class
     */
    public function __construct($machineId, LoggerInterface $logger = null)
    {
        $this->machineId = (int) $machineId;
        if ($logger) {
            $this->logger = $logger;
        } else {
            $this->logger = new NullLogger();
        }
    }

    /**
     * Get machine identifier.
     * 
     * @return int Should be a 10-bit int (decimal 0 to 1023)
     */
    public function getMachine()
    {
        $this->logger->debug('Obtained machine ID '.$this->machineId.' through fixed configuration.');

        return $this->machineId;
    }

    /**
     * {@inheritdoc}
     * 
     * This function will always return false, as fixed config does not resync machine ID.
     */
    public function heartbeat()
    {
        return false;
    }

    /**
     * Set logger.
     * 
     * @param LoggerInterface $logger
     */
    public function setLogger(LoggerInterface $logger)
    {
        $this->logger = $logger;
    }
}