Yapeal\Log\MessageBuilderTrait

Complexity

Total Complexity

13

Size/Duplication

Total Lines	145
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

42.5%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	getEmptyXmlDataMessage()	0	5	1
A	createEveApiMessage()	0	17	4
A	createEventMessage()	0	8	1
A	getEmittingEventMessage()	0	5	1
A	getFailedToWriteFileMessage()	0	7	1
A	getFinishedEventMessage()	0	5	1
A	getNonHandledEventMessage()	0	5	1
A	getReceivedEventMessage()	0	8	1
A	getSufficientlyHandledEventMessage()	0	5	1
A	getWasHandledEventMessage()	0	5	1

<?php
declare(strict_types = 1);
/**
 * Contains MessageBuilderTrait Trait.
 *
 * PHP version 7.0+
 *
 * LICENSE:
 * This file is part of Yet Another Php Eve Api Library also know as Yapeal
 * which can be used to access the Eve Online API data and place it into a
 * database.
 * Copyright (C) 2015-2017 Michael Cummings
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see
 * <http://spdx.org/licenses/LGPL-3.0.html>.
 *
 * You should be able to find a copy of this license in the COPYING-LESSER.md
 * file. A copy of the GNU GPL should also be available in the COPYING.md file.
 *
 * @copyright 2015-2017 Michael Cummings
 * @license   LGPL-3.0+
 * @author    Michael Cummings <mgcummings@yahoo.com>
 */
namespace Yapeal\Log;

use Yapeal\Xml\EveApiReadWriteInterface;

/**
 * Trait MessageBuilderTrait
 */
trait MessageBuilderTrait
{
    /**
     * @param string                   $messagePrefix
     * @param EveApiReadWriteInterface $data
     *
     * @return string
     * @throws \LogicException
     */
    protected function createEveApiMessage(string $messagePrefix, EveApiReadWriteInterface $data): string
    {
        $mess = $messagePrefix . ' Eve API %1$s/%2$s';
        $subs = [lcfirst($data->getEveApiSectionName()), $data->getEveApiName()];
        if ($data->hasEveApiArgument('keyID')) {
            $mess .= ' for keyID = %3$s';
            $subs[] = $data->getEveApiArgument('keyID');
            if ($data->hasEveApiArgument('characterID')) {
                $mess .= ' and characterID = %4$s';
                $subs[] = $data->getEveApiArgument('characterID');
            } elseif ($data->hasEveApiArgument('corporationID')) {
                $mess .= ' and corporationID = %4$s';
                $subs[] = $data->getEveApiArgument('corporationID');
            }
        }
        return vsprintf($mess, $subs);
    }
    /**
     * @param string                   $messagePrefix
     * @param EveApiReadWriteInterface $data
     * @param string                   $eventName
     *
     * @return string
     * @throws \LogicException
     */
    protected function createEventMessage(
        string $messagePrefix,
        EveApiReadWriteInterface $data,
        string $eventName
    ): string {
        $messagePrefix .= sprintf(' the %s event while processing', $eventName);
        return $this->createEveApiMessage($messagePrefix, $data);
    }
    /**
     * @param EveApiReadWriteInterface $data
     * @param string                   $eventName
     *
     * @return string
     * @throws \LogicException
     */
    protected function getEmittingEventMessage(EveApiReadWriteInterface $data, string $eventName): string
    {
        $messagePrefix = 'Emitting';
        return $this->createEventMessage($messagePrefix, $data, $eventName);
    }
    /**
     * @param EveApiReadWriteInterface $data
     * @param string                   $eventName
     *
     * @return string
     * @throws \LogicException
     */
    protected function getEmptyXmlDataMessage(EveApiReadWriteInterface $data, string $eventName): string
    {
        $messagePrefix = 'XML is empty after';
        return $this->createEventMessage($messagePrefix, $data, $eventName);
    }
    /**
     * @param EveApiReadWriteInterface $data
     * @param string                   $fileName
     *
     * @return string
     * @throws \LogicException
     */
    protected function getFailedToWriteFileMessage(
        EveApiReadWriteInterface $data,
        string $fileName
    ): string {
        $messagePrefix = sprintf('Writing file %s failed during the creation of', $fileName);
        return $this->createEveApiMessage($messagePrefix, $data);
    }
    /**
     * @param EveApiReadWriteInterface $data
     * @param string                   $eventName
     *
     * @return string
     * @throws \LogicException
     */
    protected function getFinishedEventMessage(EveApiReadWriteInterface $data, string $eventName): string
    {
        $messagePrefix = 'Finished';
        return $this->createEventMessage($messagePrefix, $data, $eventName);
    }
    /**
     * @param EveApiReadWriteInterface $data
     * @param string                   $eventName
     *
     * @return string
     * @throws \LogicException
     */
    protected function getNonHandledEventMessage(EveApiReadWriteInterface $data, string $eventName): string
    {
        $messagePrefix = 'Nothing reported handling';
        return $this->createEventMessage($messagePrefix, $data, $eventName);
    }
    /**
     * @param EveApiReadWriteInterface $data
     * @param string                   $eventName
     * @param string                   $location
     *
     * @return string
     * @throws \LogicException
     */
    protected function getReceivedEventMessage(
        EveApiReadWriteInterface $data,
        string $eventName,
        string $location
    ): string {
        $messagePrefix = sprintf('Received in %s', $location);
        return $this->createEventMessage($messagePrefix, $data, $eventName);
    }
    /**
     * @param EveApiReadWriteInterface $data
     * @param string                   $eventName
     *
     * @return string
     * @throws \LogicException
     */
    protected function getSufficientlyHandledEventMessage(EveApiReadWriteInterface $data, string $eventName): string
    {
        $messagePrefix = 'Sufficiently handled';
        return $this->createEventMessage($messagePrefix, $data, $eventName);
    }
    /**
     * @param EveApiReadWriteInterface $data
     * @param string                   $eventName
     *
     * @return string
     * @throws \LogicException
     */
    protected function getWasHandledEventMessage(EveApiReadWriteInterface $data, string $eventName): string
    {
        $messagePrefix = 'Handled';
        return $this->createEventMessage($messagePrefix, $data, $eventName);
    }
}