ConfigCacheCommand.php

TLDR

The file ConfigCacheCommand.php is a part of the Illuminate\Foundation\Console namespace in the Demo Projects project. It contains the ConfigCacheCommand class, which is responsible for creating a cache file to speed up the loading of configuration files.

Classes

ConfigCacheCommand

The ConfigCacheCommand class is a subclass of the Command class and is used to create a cache file for faster configuration loading. It has the following attributes and methods:

• name: The console command name.
• description: The console command description.
• files: The filesystem instance used for file operations.
• __construct(Filesystem $files): The constructor method that accepts an instance of the Filesystem class.
• handle(): The method responsible for executing the console command. It clears the configuration cache, retrieves the fresh configuration, caches it in a file, and then loads the cached configuration. If an error occurs during the caching process, the cached file is deleted and a LogicException is thrown.
• getFreshConfiguration(): A protected method that retrieves the fresh configuration by bootstrapping a fresh copy of the application configuration.

Note: There are no other classes in the file.

<?php

namespace Illuminate\Foundation\Console;

use Illuminate\Console\Command;
use Illuminate\Contracts\Console\Kernel as ConsoleKernelContract;
use Illuminate\Filesystem\Filesystem;
use LogicException;
use Symfony\Component\Console\Attribute\AsCommand;
use Throwable;

#[AsCommand(name: 'config:cache')]
class ConfigCacheCommand extends Command
{
    /**
     * The console command name.
     *
     * @var string
     */
    protected $name = 'config:cache';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Create a cache file for faster configuration loading';

    /**
     * The filesystem instance.
     *
     * @var \Illuminate\Filesystem\Filesystem
     */
    protected $files;

    /**
     * Create a new config cache command instance.
     *
     * @param  \Illuminate\Filesystem\Filesystem  $files
     * @return void
     */
    public function __construct(Filesystem $files)
    {
        parent::__construct();

        $this->files = $files;
    }

    /**
     * Execute the console command.
     *
     * @return void
     *
     * @throws \LogicException
     */
    public function handle()
    {
        $this->callSilent('config:clear');

        $config = $this->getFreshConfiguration();

        $configPath = $this->laravel->getCachedConfigPath();

        $this->files->put(
            $configPath, '<?php return '.var_export($config, true).';'.PHP_EOL
        );

        try {
            require $configPath;
        } catch (Throwable $e) {
            $this->files->delete($configPath);

            throw new LogicException('Your configuration files are not serializable.', 0, $e);
        }

        $this->components->info('Configuration cached successfully.');
    }

    /**
     * Boot a fresh copy of the application configuration.
     *
     * @return array
     */
    protected function getFreshConfiguration()
    {
        $app = require $this->laravel->bootstrapPath('app.php');

        $app->useStoragePath($this->laravel->storagePath());

        $app->make(ConsoleKernelContract::class)->bootstrap();

        return $app['config']->all();
    }
}