edmondscommerce/doctrine-static-meta

<?php

declare(strict_types=1);

namespace EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Creation;

interface CreatorInterface
{

    public const SRC_FOLDER = 'src';

    public const TESTS_FOLDER = 'tests';

    /**
     * Set the root namespace used when creating project files
     *
     * @param string $projectRootNamespace
     *
     * @return mixed
     */
    public function setProjectRootNamespace(string $projectRootNamespace);

    /**
     * Set the root directory in which to create project files
     *
     * @param string $projectRootDirectory
     *
     * @return mixed
     */
    public function setProjectRootDirectory(string $projectRootDirectory);

    /**
     * Create the new Object and return the File object for the target file with:
     * - correct path to write to
     * - fully updated contents
     * ready to have `putContents()` called
     *
     * @param string $newObjectFqn
     *
     * @return $this
     */
    public function createTargetFileObject(string $newObjectFqn);

    /**
     * Write the created file object to the filesystem and return the path to which is was written
     *
     * @return string
     */
    public function write(): string;
}