Chapi\Service\JobRepository\BridgeChronos

Complexity

Total Complexity

18

Size/Duplication

Total Lines	191
Duplicated Lines	11.52 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	1	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	12	12	1
A	addJob()	0	4	1
A	updateJob()	0	4	1
A	__destruct()	0	7	2
A	getJobs()	0	16	3
A	removeJob()	10	10	2
B	hasValidate()	0	24	2
A	getJobList()	0	19	3
A	hasAddOrUpdateJob()	0	13	3

<?php
/**
 * @package: chapi
 *
 * @author:  msiebeneicher
 * @since:   2015-07-28
 *
 */

namespace Chapi\Service\JobRepository;

use Chapi\Component\Cache\CacheInterface;
use Chapi\Component\RemoteClients\ApiClientInterface;
use Chapi\Entity\Chronos\ChronosJobEntity;
use Chapi\Entity\JobEntityInterface;
use Chapi\Service\JobValidator\JobValidatorServiceInterface;
use Psr\Log\LoggerInterface;

class BridgeChronos implements BridgeInterface
{
    const CACHE_TIME_JOB_LIST = 60;

    const CACHE_KEY_JOB_LIST = 'jobs.list';

    const API_CALL_ADD = 'addingJob';

    const API_CALL_UPDATE = 'updatingJob';

    /**
     * @var ApiClientInterface
     */
    private $oApiClient;

    /**
     * @var CacheInterface
     */
    private $oCache;

    /**
     * @var JobValidatorServiceInterface
     */
    private $oJobEntityValidatorService;

    /**
     * @var bool
     */
    private $bCacheHasToDelete = false;

    /**
     * @var LoggerInterface
     */
    private $oLogger;

    /**
     * @param \Chapi\Component\RemoteClients\ApiClientInterface $oApiClient
     * @param CacheInterface $oCache
     * @param JobValidatorServiceInterface $oJobEntityValidatorService
     * @param LoggerInterface $oLogger
     */
    public function __construct(

This method seems to be duplicated in your project.

        ApiClientInterface $oApiClient,
        CacheInterface $oCache,
        JobValidatorServiceInterface $oJobEntityValidatorService,
        LoggerInterface $oLogger
    )
    {
        $this->oApiClient = $oApiClient;
        $this->oCache = $oCache;
        $this->oJobEntityValidatorService = $oJobEntityValidatorService;
        $this->oLogger = $oLogger;
    }

    /**
     * delete cache job.list if a job was removed
     */
    public function __destruct()
    {
        if ($this->bCacheHasToDelete)
        {
            $this->oCache->delete(self::CACHE_KEY_JOB_LIST);
        }
    }


    /**
     * @return ChronosJobEntity[]
     */
    public function getJobs()
    {
        $_aReturn = [];
        $_aJobList = $this->getJobList();

        if (!empty($_aJobList))
        {
            // prepare return value
            foreach ($_aJobList as $_aJobData)
            {
                $_aReturn[] = new ChronosJobEntity($_aJobData);
            }
        }

        return $_aReturn;
    }

    /**
     * @param ChronosJobEntity|JobEntityInterface $oJobEntity
     * @return bool
     */
    public function addJob(JobEntityInterface $oJobEntity)
    {
        return $this->hasAddOrUpdateJob(self::API_CALL_ADD, $oJobEntity);
    }

    /**
     * @param ChronosJobEntity|JobEntityInterface $oJobEntity
     * @return bool
     */
    public function updateJob(JobEntityInterface $oJobEntity)
    {
        return $this->hasAddOrUpdateJob(self::API_CALL_UPDATE, $oJobEntity);
    }


    /**
     * @param ChronosJobEntity|JobEntityInterface $oJobEntity
     * @return bool
     */
    public function removeJob(JobEntityInterface $oJobEntity)

This method seems to be duplicated in your project.

    {
        if ($this->oApiClient->removeJob($oJobEntity->getKey()))
        {
            $this->bCacheHasToDelete = true;
            return true;
        }

        return false;
    }

    /**
     * @param JobEntityInterface $oJobEntity
     * @return bool
     */
    private function hasValidate(JobEntityInterface $oJobEntity)
    {

        $_aInvalidProperties = $this->oJobEntityValidatorService->getInvalidProperties($oJobEntity);
        if (empty($_aInvalidProperties))
        {
            return true;
        }

        $this->oLogger->warning(
            sprintf(
                "Can't update job '%s'",
                $oJobEntity->getKey()
            )
        );
        $this->oLogger->warning(
            sprintf(
                "The following job entity properties are not valid:\n%s",
                implode(', ', $_aInvalidProperties)
            )
        );

        return false;
    }

    /**
     * @return array
     */
    private function getJobList()
    {
        $_aResult = $this->oCache->get(self::CACHE_KEY_JOB_LIST);

        if (is_array($_aResult))
        {
            // return list from cache
            return $_aResult;
        }

        $_aResult = $this->oApiClient->listingJobs();
        if (!empty($_aResult))
        {
            // set result to cache
            $this->oCache->set(self::CACHE_KEY_JOB_LIST, $_aResult, self::CACHE_TIME_JOB_LIST);
        }

        return $_aResult;
    }

    /**
     * @param string $sApiMethod
     * @param JobEntityInterface $oJobEntity
     * @return bool
     */
    private function hasAddOrUpdateJob($sApiMethod, JobEntityInterface $oJobEntity)
    {
        if ($this->hasValidate($oJobEntity))
        {
            if ($this->oApiClient->{$sApiMethod}($oJobEntity))
            {
                $this->bCacheHasToDelete = true;
                return true;
            }
        }

        return false;
    }
}