luyadev/luya

View on GitHub
core/console/commands/ThemeController.php

Summary

Maintainability
A
4 hrs
Test Coverage
A
100%
<?php

namespace luya\console\commands;

use luya\helpers\FileHelper;
use luya\helpers\Json;
use luya\theme\ThemeConfig;
use Yii;
use yii\helpers\Console;
use yii\helpers\Inflector;

/**
 * Command to create a new LUYA theme.
 *
 * @author Bennet Klarhoelter <boehsermoe@me.com>
 * @since 1.0.21
 */
class ThemeController extends \luya\console\Command
{
    /**
     * @inheritdoc
     */
    public $defaultAction = 'create';
    
    /**
     * Create a new theme.
     *
     * @param string|null $themeName
     *
     * @return int
     * @throws \yii\base\Exception
     */
    public function actionCreate(string $themeName = null)
    {
        Console::clearScreenBeforeCursor();
        
        $themeName = $this->prompt("Enter the name (lower case) of the theme you like to generate:", ['default' => $themeName]);
        
        $newName = preg_replace("/[^a-z]/", "", strtolower($themeName));
        if ($newName !== $themeName) {
            if (!$this->confirm("We have changed the name to '{$newName}'. Do you want to proceed with this name?")) {
                return $this->outputError('Abort by user.');
            } else {
                $themeName = $newName;
            }
        }
        
        $availableModules = implode(', ', array_column(Yii::$app->getFrontendModules(), 'id'));
        $themeLocation = $this->prompt("Enter the theme location where to generate (as path alias e.g. app, $availableModules):", ['default' => 'app']);
        $themeLocation = '@' . ltrim($themeLocation, '@');
        
        preg_match("#^@[A-z]+#", $themeLocation, $newThemeLocation);
        
        if ($newThemeLocation[0] !== $themeLocation) {
            if (!$this->confirm("We have changed the name to '{$newThemeLocation[0]}'. Do you want to proceed with this name?")) {
                return $this->outputError('Abort by user.');
            } else {
                $themeLocation = $newThemeLocation[0];
            }
        }
        
        $basePath = $themeLocation . '/themes/' . $themeName;
        $themeFolder = Yii::getAlias($basePath);
        
        if (file_exists($themeFolder)) {
            return $this->outputError("The folder " . $themeFolder . " exists already.");
        }
        
        $this->outputInfo("Theme path alias: " . $basePath);
        $this->outputInfo("Theme real path: " . $themeFolder);
        if (!$this->confirm("Do you want continue?")) {
            return $this->outputError('Abort by user.');
        }
        
        $folders = [
            '',
            'resources',
            'views',
            'views/layouts',
            'views/cmslayouts',
        ];
        
        foreach ($folders as $folder) {
            FileHelper::createDirectory($themeFolder . DIRECTORY_SEPARATOR . $folder);
        }
        
        $contents = [
            $themeFolder. DIRECTORY_SEPARATOR . 'theme.json' => $this->renderJson($basePath, $themeName),
            $themeFolder. DIRECTORY_SEPARATOR . ucfirst($themeName) . 'Asset.php' => $this->renderAssetClass($themeName),
            $themeFolder. DIRECTORY_SEPARATOR . 'resources/'. $themeName .'.css' => '',
            $themeFolder. DIRECTORY_SEPARATOR . 'views/layouts/theme.php' => $this->renderLayout($themeName),
            $themeFolder. DIRECTORY_SEPARATOR . 'views/cmslayouts/theme.php' => $this->renderCmsLayout($themeName),
        ];
        
        foreach ($contents as $fileName => $content) {
            FileHelper::writeFile($fileName, $content);
        }
        
        return $this->outputSuccess("Theme files has been created successfully. Please run `".$_SERVER['PHP_SELF']." import` to import the theme into the database.");
    }
    
    /**
     * Render the json template.
     *
     * @param string $basePath
     * @param string $themeName
     * @return string
     */
    private function renderJson(string $basePath, string $themeName)
    {
        $themeConfig = new ThemeConfig($basePath, []);
        $themeConfig->name = $themeName;
        
        if ($this->confirm('Inherit from other theme?')) {
            $themeConfig->parentTheme = $this->prompt(
                "Enter the base path (e.g. `@app/themes/blank`) of the parent theme:",
                [
                    'default' => null,
                    'validator' => [$this, 'validateParentTheme'],
                ]
            );
        }
        
        return Json::encode($themeConfig->toArray(), JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT);
    }
    
    /**
     * @param $input
     * @param $error
     *
     * @return bool
     */
    private function validateParentTheme($input, &$error)
    {
        if (!preg_match('/^@[a-z]+$/', $input)) {
            $error = 'The theme name must be only letter chars!';
            return false;
        } elseif (Yii::getAlias($input, false) === false) {
            $error = 'The theme base path not exists!';
            return false;
        }
        
        return true;
    }
    
    /**
     * @param $themeName
     *
     * @return string
     */
    private function renderAssetClass($themeName)
    {
        $className = ucfirst($themeName) . 'Asset';
        return "<?php
namespace app\\themes\\{$themeName};

use luya\web\Asset;

class {$className} extends Asset
{
    public \$css = [
        'resources/{$themeName}.css',
    ];
}";
    }
    
    /**
     * @param $themeName
     *
     * @return string
     */
    private function renderLayout($themeName)
    {
        $className = ucfirst($themeName) . 'Asset';
    
        return '<?php
/**
 * @var $this \luya\web\View
 */
use app\themes\\'.$themeName.'\\'.$className.';

'.$className.'::register($this);

$this->beginPage();
?>
<!DOCTYPE html>
<html lang="<?= Yii::$app->composition->language; ?>">
    <head>
        <title><?= $this->title; ?></title>
        <meta charset="utf-8">
        <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
        <meta http-equiv="x-ua-compatible" content="ie=edge">
        <?php $this->head() ?>
    </head>
    <body class="homepage">
    <?php $this->beginBody() ?>

        <div id="wrapper">
            <?php echo $content ?>
        </div>

    <?php $this->endBody() ?>
    </body>
</html>
<?php $this->endPage() ?>
';
    }
    
    /**
     * @return string
     */
    private function renderCmsLayout()
    {
        return '<?= $placeholders[\'content\'] ?>';
    }
}