Библиотека-генератор php классов (файлов)?

Question

[Игорь]

Коллеги, здравствуйте!
Существует ли какая нибудь библиотека для генерации php класса-файла.

Например:

Имя класса
перечисляю базовые методы заглушки
...
Всё как обычно руками происходит.

На выходе получаем например

<?php

namespace App\Http\Controller\Api;



/**
 * Class IndexController
 * @package App\Http\Controller\Api
 */
class IndexController
{


    public function index()
    {
        echo "The Core greets you!";
    }
}

Спасибо!

Comments

[Дмитрий]

Есть подобное почти в каждом фреймворке

[Игорь]

Дмитрий, В моём нет этого. )))

[Игорь]

Дмитрий, Пойду подсмотрю как у Laravel устроено

Answer 1

[Игорь]

Всё проще, чем я ожидал.

На примере "Laravel"

Файл app/Console/Commands/stubs/controller.stub

<?php

namespace DummyNamespace;

use App\Http\Controllers\Controller;
use Illuminate\Http\Request;

class DummyClass extends Controller
{
	public $user;

	/**
	 * DummyClass constructor.
	 */
	public function __construct()
	{
		$this->middleware(['auth:api', 'role:admin|organizer|prof_organizer'])->only(['store', 'update', 'destroy']);

		$this->user = \Auth::guard('api')->user();
	}

	/**
	 * Display a listing of the resource.
	 *
	 * @return \Illuminate\Http\Response
	 */
	public function index()
	{
		//
	}
	
	/**
	 * Store a newly created resource in storage.
	 *
	 * @param  \Illuminate\Http\Request  $request
	 * @return \Illuminate\Http\Response
	 */
	public function store(Request $request)
	{
		//
	}

	/**
	 * Display the specified resource.
	 *
	 * @param  int  $id
	 * @return \Illuminate\Http\Response
	 */
	public function show($id)
	{
		//
	}
	
	/**
	 * Update the specified resource in storage.
	 *
	 * @param  \Illuminate\Http\Request  $request
	 * @param  int  $id
	 * @return \Illuminate\Http\Response
	 */
	public function update(Request $request, $id)
	{
		//
	}

	/**
	 * Remove the specified resource from storage.
	 *
	 * @param  int  $id
	 * @return \Illuminate\Http\Response
	 */
	public function destroy($id)
	{
		//
	}
}

Класс генератор

<?php

namespace App\Console\Commands;

use Illuminate\Console\GeneratorCommand;
use Symfony\Component\Console\Input\InputOption;

class MakeController extends GeneratorCommand
{
	/**
	 * The console command name.
	 *
	 * @var string
	 */
	protected $name = 'make:controller';

	/**
	 * The console command description.
	 *
	 * @var string
	 */
	protected $description = 'Create a new Controller resource class';

	/**
	 * The type of class being generated.
	 *
	 * @var string
	 */
	protected $type = 'Controller';
	
	/**
	 * Get the stub file for the generator.
	 *
	 * @return string
	 */
	protected function getStub()
	{
		return __DIR__.'/stubs/controller.stub';
	}

	/**
	 * Get the default namespace for the class.
	 *
	 * @param  string  $rootNamespace
	 * @return string
	 */
	protected function getDefaultNamespace($rootNamespace)
	{
		return $rootNamespace."\\Http\\Controllers\\Api";
	}
}

Comments

[Игорь]

В общем у меня получилось вот так:

spoiler

<?php

namespace Console\src\Command;



use Engine\Core\Console\Exception\FileAccessException;
use Engine\Core\Console\GeneratorCommand;
use Exception;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;



/**
 * Class MakeController
 * @package Console\src\Command
 */
class MakeController extends GeneratorCommand
{

    protected static $defaultName = "app:make-controller";

    /** @var string */
    private $class_name;

    /** @var string */
    private $env;

    private $stock;



    /**
     * MakeController constructor.
     */
    public function __construct()
    {
        parent::__construct();
    }



    protected function configure()
    {
        $this
            ->setDescription("Controller creator")
            ->setHelp("This command generates a controller")
            ->addArgument("name", InputArgument::REQUIRED, "New class name")
            ->addArgument("env", InputArgument::REQUIRED, "The environment in which the new class will be created");
    }



    /**
     * @param InputInterface $input
     * @param OutputInterface $output
     *
     * @return int|void|null
     * @throws Exception
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $this->env = $input->getArgument("env");
        $this->class_name = $input->getArgument("name") . "Controller";
        $namespace = $this->makeNamespace($this->env);
        $this->stock = $this->getStock("controller");
        $this->replace("namespace", $namespace);
        $this->replace("class_name", $this->class_name);
        $this->write($this->getRootDirController(ucfirst($this->env)) . "/$this->class_name.php", $this->stock);
        $output->writeln([
            '',
            '================================================================================================',
            '  New controller created: <info>' . $this->class_name.'</>',
            '================================================================================================',
            '',
        ]);
    }



    /**
     * @param $mask
     * @param $new_value
     * @return MakeController
     */
    protected function replace($mask, $new_value)
    {
        $this->stock = str_replace("%$mask%", $new_value, $this->stock);
        return $this;
    }



    /**
     * @param string $env
     * @return string
     */
    protected function getRootDirController(string $env)
    {
        return ROOT_DIR . "/app/Http/Controller/$env";
    }



    /**
     * @param string $rootNamespace
     * @return string
     */
    protected function getDefaultNamespace(string $rootNamespace = "")
    {
        return parent::getDefaultNamespace($rootNamespace) . "App\\Http\\Controllers";
    }



    /**
     * @param string $env
     * @return string
     */
    protected function makeNamespace($env = "Api")
    {
        return $this->getDefaultNamespace() . "\\$env";
    }



    /**
     * @param string $name
     * @return string
     * @throws FileAccessException
     */
    protected function getStock(string $name)
    {
        $file_name = $this->getRootDir() . "/console/src/stock/class/$name";
        if (!file_exists($file_name)) throw new FileAccessException("The file does not exist.");
        return file_get_contents($file_name);
    }



    /**
     * @param string $out_name
     * @param $content
     * @throws Exception
     */
    protected function write(string $out_name, $content)
    {
        if (file_exists($out_name)) throw new Exception("Controller already exists!");
            file_put_contents($out_name, $content);
    }
}

Итоговый шаблон

<?php

namespace App\Http\Controllers\Api;



use App\Http\Controller;



/**
 * Class UserController
 * @package App\Http\Controllers\Api
 */
class UserController extends Controller
{


    public function index()
    {
        // todo: Implement the index method
    }
}

[Lillipup]

Игорь, Не нужно было так мучится, мы умеем пользоваться документацией.

[Игорь]

Lillipup, Пардон.