Class PhpFileGenerator

constructor

• new PhpFileGenerator(options?): PhpFileGenerator

• Parameters

  • Optional options: {
        constraints?: { enumKey?: EnumKeyConstraint<PhpOptions> | undefined; enumValue?: EnumValueConstraint<PhpOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; };
        defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; };
        dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; });
        indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
        presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; } | undefined; options?: any; }))[];
        processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...;
        typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PhpOptions, PhpDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
    }

    • Optional constraints?: { enumKey?: EnumKeyConstraint<PhpOptions> | undefined; enumValue?: EnumValueConstraint<PhpOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }

    • Optional defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }

    • Optional dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })

      This dependency manager type serves two functions.

      1. It can be used to provide a factory for generate functions
      2. It can be used to provide a single instance of a dependency manager, to add all dependencies together

      This depends on context and where it's used.

    • Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }

    • Optional presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; } | undefined; options?: any; }))[]

    • Optional processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...

    • Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PhpOptions, PhpDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }

  Returns PhpFileGenerator

Readonly languageName

Readonly options

Static defaultCompleteModelOptions

Static defaultOptions

constrainToMetaModel

• constrainToMetaModel(model, options): ConstrainedMetaModel

• Parameters

  • model: MetaModel

  • options: {
        constraints?: { enumKey?: EnumKeyConstraint<PhpOptions> | undefined; enumValue?: EnumValueConstraint<PhpOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; };
        defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; };
        dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; });
        indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
        presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; } | undefined; options?: any; }))[];
        processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...;
        typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PhpOptions, PhpDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
    }

    • Optional constraints?: { enumKey?: EnumKeyConstraint<PhpOptions> | undefined; enumValue?: EnumValueConstraint<PhpOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }

    • Optional defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }

    • Optional dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })

      This dependency manager type serves two functions.

      1. It can be used to provide a factory for generate functions
      2. It can be used to provide a single instance of a dependency manager, to add all dependencies together

      This depends on context and where it's used.

    • Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }

    • Optional presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; } | undefined; options?: any; }))[]

    • Optional processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...

    • Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PhpOptions, PhpDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }

  Returns ConstrainedMetaModel

generate

• generate(input): Promise<OutputModel[]>

• Generates a scattered model where dependencies and rendered results are separated.

  Parameters

  • input: any

  Returns Promise<OutputModel[]>

generateCompleteModels

• generateCompleteModels(input, completeOptions): Promise<OutputModel[]>

• Generates the full output of a model, instead of a scattered model.

  OutputModels result is no longer the model itself, but including package, package dependencies and model dependencies.

  Parameters

  • input: any

  • completeOptions: Partial<PhpRenderCompleteModelOptions>

  Returns Promise<OutputModel[]>

getDependencyManager

• getDependencyManager(options): PhpDependencyManager

• Wrapper to get an instance of the dependency manager

  Parameters

  • options: PhpOptions

  Returns PhpDependencyManager

process

• process(input): Promise<InputMetaModel>

• Parameters

  • input: Record<string, unknown>

  Returns Promise<InputMetaModel>

render

• render(args): Promise<RenderOutput>

• Render a scattered model, where the source code and library and model dependencies are separated.

  Parameters

  • args: AbstractGeneratorRenderArgs<PhpOptions, ConstrainedMetaModel>

  Returns Promise<RenderOutput>

renderClass

• renderClass(model, inputModel, options?): Promise<RenderOutput>

• Parameters

  • model: ConstrainedObjectModel

  • inputModel: InputMetaModel

  • Optional options: Partial<PhpOptions>

  Returns Promise<RenderOutput>

renderCompleteModel

• renderCompleteModel(args): Promise<RenderOutput>

• Render a complete model result where the model code, library and model dependencies are all bundled appropriately.

  Parameters

  • args: AbstractGeneratorRenderCompleteModelArgs<PhpOptions, PhpRenderCompleteModelOptions>

  Returns Promise<RenderOutput>

renderEnum

• renderEnum(model, inputModel, options?): Promise<RenderOutput>

• Parameters

  • model: ConstrainedEnumModel

  • inputModel: InputMetaModel

  • Optional options: Partial<PhpOptions>

  Returns Promise<RenderOutput>

splitMetaModel

• splitMetaModel(model): MetaModel[]

• This function makes sure we split up the MetaModels accordingly to what we want to render as models.

  Parameters

  • model: MetaModel

  Returns MetaModel[]

Static getPhpOptions

• getPhpOptions(options?): PhpOptions

• Returns the Php options by merging custom options with default ones.

  Parameters

  • Optional options: {
        constraints?: { enumKey?: EnumKeyConstraint<PhpOptions> | undefined; enumValue?: EnumValueConstraint<PhpOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; };
        defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; };
        dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; });
        indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
        presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; } | undefined; options?: any; }))[];
        processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...;
        typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PhpOptions, PhpDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
    }

    • Optional constraints?: { enumKey?: EnumKeyConstraint<PhpOptions> | undefined; enumValue?: EnumValueConstraint<PhpOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }

    • Optional defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }

    • Optional dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })

      This dependency manager type serves two functions.

      1. It can be used to provide a factory for generate functions
      2. It can be used to provide a single instance of a dependency manager, to add all dependencies together

      This depends on context and where it's used.

    • Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }

    • Optional presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; } | undefined; options?: any; }))[]

    • Optional processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...

    • Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, PhpOptions, PhpDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }

  Returns PhpOptions