Yarak\Config\PathHelpers

Complexity

Total Complexity

9

Size/Duplication

Total Lines	138
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
	get()	0	1	?
	has()	0	1	?
	validate()	0	1	?
A	getAppPath()	0	6	1
A	getDatabaseDirectory()	0	6	1
A	getMigrationDirectory()	0	4	1
A	getFactoryDirectory()	0	4	1
A	getSeedDirectory()	0	4	1
A	getAllDatabaseDirectories()	0	9	1
A	getConsoleDirectory()	0	9	1
A	getCommandsDirectory()	0	11	2

<?php

namespace Yarak\Config;

use Yarak\Helpers\Str;

trait PathHelpers
{
    /**
     * Get a value from the config array.
     *
     * @param string|array $value
     *
     * @return mixed
     */
    abstract public function get($value);

    /**
     * Return true if config array has given value.
     *
     * @param mixed $value
     *
     * @return bool
     */
    abstract public function has($value);

    /**
     * Validate that a setting exists.
     *
     * @param array $settings
     *
     * @throws InvalidConfig
     */
    abstract public function validate(array $settings);

    /**
     * Return the app path.
     *
     * @return string
     */
    public function getAppPath()
    {
        $this->validate(['application', 'appDir']);

        return Str::append($this->get('application')->get('appDir'), '/');
    }

    /**
     * Return the database directory path.
     *
     * @return string
     */
    public function getDatabaseDirectory()
    {
        $this->validate(['application', 'databaseDir']);

        return Str::append($this->get('application')->get('databaseDir'), '/');
    }

    /**
     * Return the migration directory path.
     *
     * @param string $path
     *
     * @return string
     */
    public function getMigrationDirectory($path = '')
    {
        return $this->getDatabaseDirectory().'migrations/'.$path;
    }

    /**
     * Return the factory directory path.
     *
     * @param string $path
     *
     * @return string
     */
    public function getFactoryDirectory($path = '')
    {
        return $this->getDatabaseDirectory().'factories/'.$path;
    }

    /**
     * Return the seeds directory path.
     *
     * @param string $path
     *
     * @return string
     */
    public function getSeedDirectory($path = '')
    {
        return $this->getDatabaseDirectory().'seeds/'.$path;
    }

    /**
     * Make database directory structure if it doesn't exist.
     */
    public function getAllDatabaseDirectories()
    {
        return [
            'database'   => $this->getDatabaseDirectory(),
            'migrations' => $this->getMigrationDirectory(),
            'factories'  => $this->getFactoryDirectory(),
            'seeds'      => $this->getSeedDirectory(),
        ];
    }

    /**
     * Get the console directory path.
     *
     * @param string $path
     *
     * @return string
     */
    public function getConsoleDirectory($path = '')
    {
        $this->validate(['application', 'consoleDir']);

        return Str::append(
            $this->get('application')->get('consoleDir'),
            '/'
        ).$path;
    }

    /**
     * Get the commands directory path.
     *
     * @param string $path
     *
     * @return string
     */
    public function getCommandsDirectory($path = '')
    {
        if ($this->has(['application', 'commandsDir'])) {
            return Str::append(
                $this->get('application')->get('commandsDir'),
                '/'
            ).$path;
        }

        return $this->getConsoleDirectory().'commands/'.$path;
    }
}