Astrotomic / stancy

src/Commands/MakePageCommand.php

<?php

namespace Astrotomic\Stancy\Commands;

use Illuminate\Console\GeneratorCommand;
use Illuminate\Contracts\Config\Repository as ConfigContract;
use Illuminate\Contracts\Filesystem\Factory as FilesystemManagerContract;
use Illuminate\Filesystem\Filesystem;
use Illuminate\Support\Str;
use Spatie\Sheets\Facades\Sheets;
use Spatie\Sheets\Repositories\FilesystemRepository;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Yaml\Yaml;

class MakePageCommand extends GeneratorCommand
{
    protected $name = 'make:page';

Property \Astrotomic\Stancy\Commands\MakePageCommand::$name does not have @var annotation for its value.

    protected $description = 'Create a new page for stancy package.';

Property \Astrotomic\Stancy\Commands\MakePageCommand::$description does not have @var annotation for its value.

    /** @var ConfigContract */
    protected $config;

    /** @var FilesystemManagerContract */
    protected $filesystemManager;

    public function __construct(Filesystem $files, ConfigContract $config, FilesystemManagerContract $filesystemManager)
    {
        parent::__construct($files);

        $this->config = $config;
        $this->filesystemManager = $filesystemManager;
    }

    public function getOptions()

Method \Astrotomic\Stancy\Commands\MakePageCommand::getOptions() does not have return type hint nor @return annotation for its return value.

    {
        return [
            ['collection', null, InputOption::VALUE_REQUIRED, 'The sheet collection to create the page in'],
        ];
    }

    public function handle()

Method \Astrotomic\Stancy\Commands\MakePageCommand::handle() does not have return type hint nor @return annotation for its return value.

    {
        $this->createSheet();

        return parent::handle();
    }

    protected function createSheet(): void
    {
        $name = $this->getNameInput();
        $collection = $this->option('collection');

        if (! $collection) {
            return;
        }

        $repository = Sheets::collection($collection);

        if (! $repository instanceof FilesystemRepository) {
            $this->warn('can not create a sheet if collection is not instance of `'.FilesystemRepository::class.'`'); // @codeCoverageIgnore

            return; // @codeCoverageIgnore
        }

        $extension = $this->config->get('sheets.collections.'.$collection.'.extension', 'md');

Are you sure $collection of type string|string[]|true can be used in concatenation?

        $disk = $this->config->get('sheets.collections.'.$collection.'.disk', $collection);
        $filesystem = $this->filesystemManager->disk($disk);

        $filename = Str::kebab(class_basename($name)).'.'.$extension;

        if (
            (! $this->hasOption('force') || ! $this->option('force'))
            && $filesystem->exists($filename)
        ) {
            $this->error('the sheet `'.$filename.'` already exists');

            return;
        }

        $filesystem->put($filename, $this->getDefaultSheetContent($extension));
    }

    protected function getDefaultSheetContent(string $extension): string
    {
        if (! in_array($extension, ['md', 'json', 'yaml', 'yml'])) {
            return '';
        }

        $data = [
            '_pageData' => '\\'.$this->qualifyClass($this->getNameInput()),
        ];

        if ($extension === 'json') {
            return json_encode($data);
        }

        if (in_array($extension, ['yaml', 'yml'])) {
            return Yaml::dump($data);
        }

        return implode(PHP_EOL, [
            '---',
            trim(Yaml::dump(array_merge($data, ['_view' => null]))),
            '---',
            '',
        ]);
    }

    protected function getStub(): string
    {
        return __DIR__.'/../../resources/stubs/page.stub';
    }

    protected function getDefaultNamespace($rootNamespace): string

Method \Astrotomic\Stancy\Commands\MakePageCommand::getDefaultNamespace() does not have parameter type hint nor @param annotation for its parameter $rootNamespace.

    {
        return rtrim($rootNamespace, '\\').'\Pages';
    }

    protected function replaceClass($stub, $name): string

Method \Astrotomic\Stancy\Commands\MakePageCommand::replaceClass() does not have parameter type hint nor @param annotation for its parameter $name.

Method \Astrotomic\Stancy\Commands\MakePageCommand::replaceClass() does not have parameter type hint nor @param annotation for its parameter $stub.

    {
        return parent::replaceClass($stub, $name);
    }
}