CodeIgniter v4.5 API

MigrationGenerator extends BaseCommand

in package

• Application

uses GeneratorTrait

Generates a skeleton migration file.

Table of Contents

Properties

$arguments  : array<string, string>

$commands  : Commands

$description  : string

$group  : string

$logger  : LoggerInterface

$name  : string

$options  : array<string, string>

$usage  : string

$arguments  : array<string, string>

The Command's Arguments

$classNameLang  : string

Language string key for required class names.

$commands  : Commands

Instance of Commands so commands can call other commands.

$component  : string

Component Name

$description  : string

The Command's Description

$directory  : string

File directory

$group  : string

The Command's Group

$logger  : LoggerInterface

The Logger to use for a command

$name  : string

The Command's Name

$namespace  : string|null

Namespace to use for class.

$options  : array<string, string>

The Command's Options

$template  : string

View template name for fallback

$templatePath  : string|null

(Optional) View template path

$usage  : string

The Command's Usage

Methods

__construct()  : mixed

__get()  : array<string, string>|Commands|LoggerInterface|string|null

Makes it simple to access our protected properties.

__isset()  : bool

Makes it simple to check our protected properties.

getPad()  : int

Get pad for $key => $value array output

run()  : int|void

Actually execute a command.

setPad()  : string

Pads our string out so that all titles are the same length to nicely line up descriptions.

showHelp()  : void

Show Help includes (Usage, Arguments, Description, Options).

basename()  : string

Change file basename before saving.

buildContent()  : string

Builds the contents for class being generated, doing all the replacements necessary, and alphabetically sorts the imports for a given template.

buildPath()  : string

Builds the file path from the class name.

call()  : int|void

Can be used by a command to run other commands.

execute()  : void

Execute the command.

generateClass()  : void

Generates a class file from an existing template.

generateView()  : void

Generate a view file from an existing template.

getNamespace()  : string

Gets the namespace from the command-line option, or the default namespace if the option is not set.

getOption()  : bool|string|null

Gets a single command-line option. Returns TRUE if the option exists, but doesn't have a value, and is simply acting as a flag.

parseTemplate()  : string

Performs pseudo-variables contained within view file.

prepare()  : string

Prepare options and do the necessary replacements.

qualifyClassName()  : string

Parses the class name and checks if it is already qualified.

renderTemplate()  : string

Gets the generator view as defined in the `Config\Generators::$views`, with fallback to `$template` when the defined view does not exist.

setEnabledSuffixing()  : $this

Allows child generators to modify the internal `$enabledSuffixing` flag.

setHasClassName()  : $this

Allows child generators to modify the internal `$hasClassName` flag.

setSortImports()  : $this

Allows child generators to modify the internal `$sortImports` flag.

showError()  : void

A simple method to display an error with line/file, in child commands.

generateFile()  : void

Handles writing the file to disk, and all of the safety checks around that.

normalizeInputClassName()  : string

Normalize input classname.