Path.php

<?php
/**
 * Arikaim
 *
 * @link        http://www.arikaim.com
 * @copyright   Copyright (c)  Konstantin Atanasov <info@arikaim.com>
 * @license     http://www.arikaim.com/license
 * 
 */
namespace Arikaim\Core\Utils;

/**
 * All path constants and helpers
 */
class Path 
{
    const VIEW_PATH               = APP_PATH . DIRECTORY_SEPARATOR . 'view' . DIRECTORY_SEPARATOR;
    const BIN_PATH                = APP_PATH . DIRECTORY_SEPARATOR . 'bin' . DIRECTORY_SEPARATOR;
    const EXTENSIONS_PATH         = APP_PATH . DIRECTORY_SEPARATOR . 'extensions' . DIRECTORY_SEPARATOR;  
    const MODULES_PATH            = APP_PATH . DIRECTORY_SEPARATOR . 'modules' . DIRECTORY_SEPARATOR;
    const SERVICES_PATH           = APP_PATH . DIRECTORY_SEPARATOR . 'services' . DIRECTORY_SEPARATOR;
    const CONFIG_PATH             = APP_PATH . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR;
    const CACHE_PATH              = APP_PATH . DIRECTORY_SEPARATOR . 'cache' . DIRECTORY_SEPARATOR;
    const LOGS_PATH               = APP_PATH . DIRECTORY_SEPARATOR . 'logs' . DIRECTORY_SEPARATOR;
    const STORAGE_PATH            = APP_PATH . DIRECTORY_SEPARATOR . 'storage' . DIRECTORY_SEPARATOR;
    const LIBRARY_PATH            = Self::VIEW_PATH . 'library' . DIRECTORY_SEPARATOR;
    const TEMPLATES_PATH          = Self::VIEW_PATH . 'templates' . DIRECTORY_SEPARATOR;  
    const COMPONENTS_PATH         = Self::VIEW_PATH . 'components' . DIRECTORY_SEPARATOR;
    const VIEW_CACHE_PATH         = Self::CACHE_PATH . 'views' . DIRECTORY_SEPARATOR;
    const STORAGE_TEMP_PATH       = Self::STORAGE_PATH . 'temp' . DIRECTORY_SEPARATOR;
    const STORAGE_BACKUP_PATH     = Self::STORAGE_PATH . 'backup' . DIRECTORY_SEPARATOR;
    const STORAGE_REPOSITORY_PATH = Self::STORAGE_PATH . 'repository' . DIRECTORY_SEPARATOR;
    const STORAGE_PUBLIC_PATH     = Self::STORAGE_PATH . 'public' . DIRECTORY_SEPARATOR;
    const COMPOSER_VENDOR_PATH    = ROOT_PATH . BASE_PATH . DIRECTORY_SEPARATOR . 'vendor' . DIRECTORY_SEPARATOR;
    
    /**
     * Get template theme path 
     *
     * @param string $templateName
     * @return string
     */
    public static function getTemplateThemePath(string $templateName): string
    {
        return Path::TEMPLATES_PATH . $templateName . DIRECTORY_SEPARATOR . 'themes' . DIRECTORY_SEPARATOR;
    }

    /**
     * Get macro path
     *
     * @param string $macroName
     * @param string $template
     * @return string
     */
    public static function getMacroPath(string $macroName, string $template): string
    {
        return DIRECTORY_SEPARATOR . $template . DIRECTORY_SEPARATOR . 'macros' . DIRECTORY_SEPARATOR . $macroName;
    }

    /**
     * Get extension config path
     *
     * @param string $name
     * @return string
     */
    public static function getExtensionConfigPath(string $name): string
    {
        return Path::EXTENSIONS_PATH . $name . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR;
    }
    
    /**
     * Get extension path
     *
     * @param string $name
     * @return string
     */
    public static function getExtensionPath(string $name): string
    {
        return Path::EXTENSIONS_PATH . $name . DIRECTORY_SEPARATOR;
    }

    /**
     * Get module config path
     *
     * @param string $name
     * @return string
     */
    public static function getModuleConfigPath(string $name): string
    {
        return Path::MODULES_PATH . $name . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR;
    }

    /**
     * Get storage relative path
     *
     * @param string $path
     * @return string
     */
    public static function getStorageRelativePath(string $path): string
    {
        return \str_replace(Self::STORAGE_PATH,'',$path);
    }

    /**
     * Return relative path from full path
     *
     * @param string $path
     * @param bool $appPath
     * @return string
     */
    public static function getRelativePath(string $path, bool $appPath = true): string
    {
        if (\defined('APP_PATH') == false) {
            return $path;
        }
        $rootPath = ($appPath == true) ? APP_PATH : ROOT_PATH . BASE_PATH;

        return \str_replace($rootPath,'',$path);
    }

    /**
     * Set app path
     *
     * @param string $path
     * @return void
     */
    public static function setAppPath(string $path): void
    {
        if (\defined('APP_PATH') == false) {
            \define('APP_PATH',ROOT_PATH . BASE_PATH . DIRECTORY_SEPARATOR . $path);  
        }
    }

    /**
     * Get module path
     *
     * @param string $name
     * @return string
     */
    public static function getModulePath(string $name): string
    {
        return Self::MODULES_PATH . $name . DIRECTORY_SEPARATOR;
    }

    /**
     * Get library file path
     *
     * @param string $library
     * @param string $fileName
     * @return string
     */
    public static function getLibraryFilePath(string $library, string $fileName): string 
    {
        return Self::getLibraryPath($library) . $fileName;
    }
    
    /**
     * Get library path
     *
     * @param string $library
     * @return string
     */
    public static function getLibraryPath(string $library): string
    {
        return Self::LIBRARY_PATH . $library . DIRECTORY_SEPARATOR;
    }

    /**
     * Get extension macros relative path
     *
     * @param string $extension
     * @return string
     */
    public static function getExtensionMacrosRelativePath(string $extension): string
    {
        return $extension . DIRECTORY_SEPARATOR . 'view' . DIRECTORY_SEPARATOR . 'macros' . DIRECTORY_SEPARATOR;
    }

    /**
     * Return current script path
     *
     * @return string
     */
    public static function getScriptPath(): string
    {
        return \realpath(\dirname(__FILE__));
    }

    /**
     * Add path
     *
     * @param string $path
     * @param string $add
     * @return string
     */
    public static function addPath(string $path, string $add): string
    {      
        if (\substr($path,-1) == DIRECTORY_SEPARATOR) {
            return ($add == DIRECTORY_SEPARATOR) ? $path : $path . $add;          
        } 

        return ($add == DIRECTORY_SEPARATOR) ? $path . $add : $path . DIRECTORY_SEPARATOR . $add;      
    } 
}