Yapeal\Console\Command\EveApiCreatorTrait

Complexity

Total Complexity

9

Size/Duplication

Total Lines	98
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	isOverwrite()	0	4	1
A	setDir()	0	5	1
A	setOverwrite()	0	5	1
A	setTwig()	0	5	1
A	getDir()	0	4	1
A	getTemplateName()	0	15	3
A	getTwig()	0	4	1

<?php
declare(strict_types=1);
/**
 * Contains EveApiCreatorTrait 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-2016 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-2016 Michael Cummings
 * @license   http://www.gnu.org/copyleft/lesser.html GNU LGPL
 * @author    Michael Cummings <mgcummings@yahoo.com>
 */
namespace Yapeal\Console\Command;

use Twig_Environment;
use Yapeal\Event\EveApiEventEmitterTrait;
use Yapeal\FileSystem\CommonFileHandlingTrait;

/**
 * Trait EveApiCreatorTrait
 */
trait EveApiCreatorTrait
{
    use CommonFileHandlingTrait, EveApiEventEmitterTrait;
    /**
     * Getter for $overwrite.
     *
     * @return boolean
     */
    public function isOverwrite(): bool
    {
        return $this->overwrite;
    }
    /**
     * @param string $value
     *
     * @return self Fluent interface.
     */
    public function setDir($value)
    {
        $this->dir = (string)$value;
        return $this;
    }
    /**
     * Fluent interface setter for $overwrite.
     *
     * @param bool $value
     *
     * @return self Fluent interface.
     */
    public function setOverwrite(bool $value = true)
    {
        $this->overwrite = (bool)$value;
        return $this;
    }
    /**
     * @param Twig_Environment $twig
     *
     * @return self Fluent interface.
     */
    public function setTwig(Twig_Environment $twig)
    {
        $this->twig = $twig;
        return $this;
    }
    /**
     * @return string
     */
    protected function getDir(): string
    {
        return $this->dir;
    }
    /**
     * @param string $for
     * @param string $sectionName
     * @param string $apiName
     *
     * @return false|string
     * @throws \DomainException
     * @throws \InvalidArgumentException
     * @throws \LogicException
     */
    protected function getTemplateName(string $for, string $sectionName, string $apiName)
    {
        // section/api.for.twig, api.for.twig, section.for.twig, for.twig
        $templateNames = explode(
            ',',
            sprintf('%1$s/%2$s.%3$s.twig,%2$s.%3$s.twig,%1$s.%3$s.twig,%3$s.twig', $sectionName, $apiName, $for)
        );
        $dir = $this->getDir();
        foreach ($templateNames as $templateName) {
            if (is_file($dir . $templateName)) {
                return $dir . $templateName;
            }
        }
        return false;
    }
    /**
     * @return Twig_Environment
     */
    protected function getTwig(): Twig_Environment
    {
        return $this->twig;
    }
    /**
     * @var string $dir Directory path used when saving new files.
     */
    protected $dir;
    /**
     * Used to decide if existing file should be overwritten.
     *
     * @var bool $overwrite
     */
    protected $overwrite = false;
    /**
     * @var Twig_Environment $twig
     */
    protected $twig;
}