TsScaffoldTask

Base class for PhalconKit CLI tasks.

Extend this class for framework/application CLI tasks that need Phalcon's native task lifecycle plus PhalconKit injectable service annotations. The class does not add task behavior itself; action methods remain normal Phalcon CLI task methods.

• Full name: \PhalconKit\Modules\Cli\Tasks\TsScaffoldTask
• Parent class: \PhalconKit\Modules\Cli\Task

Properties

cliDoc

public string $cliDoc

path

public string $path

servicesPath

public string $servicesPath

modelsPath

public string $modelsPath

abstractsPath

public string $abstractsPath

interfacesPath

public string $interfacesPath

Methods

getDefinitionsAction

public getDefinitionsAction(string $name): array

Parameters:

generateExportsAction

public generateExportsAction(): array

runAction

public runAction(): array

appendExport

public appendExport(array $definitions, array& $exports): void

Parameters:

createInterfaceOutput

public createInterfaceOutput(array $definitions, array $columns): string

Parameters:

createAbstractOutput

Creates a typescript abstract model output based on the given definitions.

public createAbstractOutput(array $definitions, array $columns): string

Parameters:

createModelOutput

Creates a typescript model output based on the given definitions.

public createModelOutput(array $definitions, array $related): string

Parameters:

createServiceOutput

public createServiceOutput(array $definitions): string

Parameters:

getRelatedImportItems

public getRelatedImportItems(array $related): string

Parameters:

getRelatedDefaultItems

Returns a formatted string representation of the related default items.

public getRelatedDefaultItems(array $related): string

Parameters:

getRelatedMapItems

Returns a formatted string representation of the related map items.

public getRelatedMapItems(array $related): string

Parameters:

getRelatedProperties

Returns a formatted string representation of the related map items.

public getRelatedProperties(array $related): string

Parameters:

getPropertyItems

Returns a formatted string representation of the property items.

public getPropertyItems(\Phalcon\Contracts\Db\Column[] $columns): string

Parameters:

Return Value:

A string representation of the property items.

getRelatedMeta

public getRelatedMeta(string $modelClassName): array

Parameters:

getColumnTsType

public getColumnTsType(\Phalcon\Contracts\Db\Column $column): string

Parameters:

getDefaultValue

public getDefaultValue(\Phalcon\Contracts\Db\Column $column, string $type): ?string

Parameters:

getColumnName

public getColumnName(string $name): string

Parameters:

getTableName

public getTableName(string $name): string

Parameters:

getModelInstance

public getModelInstance(string $modelClassName): \PhalconKit\Mvc\Model

Parameters:

getModelNameFromClassName

public getModelNameFromClassName(string $className): string

Parameters:

saveFile

public saveFile(string $file, string $text, bool $force = false): bool

Parameters:

Inherited methods

beforeExecuteRoute

public beforeExecuteRoute(): void

helpAction

public helpAction(): void

mainAction

public mainAction(): ?array

afterExecuteRoute

Handle rest response automagically

public afterExecuteRoute(\Phalcon\Cli\Dispatcher $dispatcher): void

Parameters:

Throws:

• CliException

normalizeCliPayload

Normalize values before CLI output serializers see them.

protected normalizeCliPayload(mixed $payload): mixed

Phalcon message objects are useful inside the framework but are opaque for JSON automation. This helper recursively converts them into scalar arrays while leaving other payload values unchanged.

Parameters:

normalizeCliMessages

Normalize a list of model messages and optionally add a fallback entry.

protected normalizeCliMessages(iterable $messages, ?string $fallbackMessage = null): list<array{message: string, field: string|null, type: string|null, code: int|null}>

Parameters: