wol-soft / php-json-schema-model-generator / 4014311194

<?php

declare(strict_types = 1);

namespace PHPModelGenerator\Utils;

use PHPModelGenerator\Model\SchemaDefinition\JsonSchema;

/**

 * Interface ClassNameGeneratorInterface

 *

 * @package PHPModelGenerator\PropertyProcessor\Decorator\ClassName

 */

interface ClassNameGeneratorInterface

{

    /**

     * Hook into the class name generation. Returns the name of a class.

     *

     * @param string     $propertyName     If a json file is handled, contains the name of the file.

     *                                     Otherwise the name of the property which contains the nested object

     * @param JsonSchema $schema           The structure of the schema which is represented by the generated class

     * @param bool       $isMergeClass     Is it a merge class? example: allOf schema composition

     * @param string     $currentClassName The class name of the parent class if the class represents a nested object

     *

     * @return string

     */

    public function getClassName(

        string $propertyName,

        JsonSchema $schema,

        bool $isMergeClass,

        string $currentClassName = ''

}