FakerTask

• Full name: \Zemit\Modules\Cli\Tasks\FakerTask
• Parent class: \Zemit\Modules\Cli\Task

Properties

cliDoc

public string $cliDoc

mdiIcons

public $mdiIcons

Methods

initialize

public initialize(): void

Throws:

• Exception

generateFakeData

public generateFakeData(): array

Inherited methods

mainAction

public mainAction(): ?array

resetAction

The resetAction method is responsible for resetting the state of the application by performing the following actions:

public resetAction(): array

1. Truncate database tables using the truncateAction method.
2. Insert initial data into the database using the insertAction method.

Use Case:

This method can be used when you need to reset the state of the application to its initial state. It is commonly used for testing or when you want to re-populate the database with initial data.

truncateAction

The truncateAction method is responsible for truncating (emptying) database tables specified in the $this->truncate array. Truncating a table removes all of its data, effectively resetting it to an empty state. This method iterates through a list of table names and executes an SQL TRUNCATE TABLE command for each of them.

public truncateAction(): array

Use Case: This method is often used when you need to reset the data in database tables without deleting the table itself. Truncating tables is a quicker alternative to deleting all rows one by one.

dropAction

The dropAction method is responsible for dropping database tables specified in the $this->drop array.

public dropAction(): array

Dropping a table means permanently removing it from the database schema. This method iterates through a list of table names and executes an SQL DROP TABLE command for each of them, with a safety check to ensure that the table is only dropped if it exists.

Use Case: This method is commonly used when performing database schema changes or cleanup tasks, where you need to remove tables that are no longer needed. The IF EXISTS clause is a safety measure to prevent accidental deletion of tables.

fixEngineAction

The fixEngineAction method is responsible for fixing or changing the storage engine for database tables specified in the $this->engine array. A storage engine determines how data is stored and managed within a database table. This method iterates through a list of table names and their corresponding desired storage engines and executes SQL ALTER TABLE commands to make the necessary changes.

public fixEngineAction(): array

Use Case: This method is useful when you need to adjust the storage engine of database tables to optimize performance, compatibility, or for other specific requirements. Different storage engines have different characteristics, and choosing the right one can impact table performance and functionality.

insertAction

Insert records

public insertAction(?string $models = null): array

Parameters:

Throws:

• CliException

optimizeAction

The optimizeAction method is responsible for optimizing database tables specified in the $this->optimize array. Database table optimization is a maintenance task aimed at improving the performance and storage efficiency of database tables. This method iterates through a list of table names and executes an SQL OPTIMIZE TABLE command for each of them.

public optimizeAction(): array

Use Case: This method is typically used in the context of database maintenance and optimization routines. It allows you to automate the process of optimizing database tables, which can help reclaim storage space and improve query performance by reorganizing table data and indexes.

analyzeAction

This method is responsible for analyzing database tables specified in the $this->analyse array.

public analyzeAction(): array

Table analysis is an essential database maintenance task that helps optimize the performance of database queries. Analyzing a table refreshes statistics and metadata about the table's structure, which can lead to improved query execution plans.

Use Case: This method can be used in the context of database optimization and maintenance scripts. It allows you to automate the process of analyzing database tables, ensuring that the database's query optimizer has up-to-date statistics to make informed decisions about query execution plans.

addModelsPermissions

public addModelsPermissions(?array $tables = null): void

Parameters:

Throws:

• Exception

beforeExecuteRoute

public beforeExecuteRoute(): void

helpAction

public helpAction(): void

normalizeResponse

public normalizeResponse(bool $response = true, ?int $code = null, ?string $status = null): array

Parameters:

afterExecuteRoute

Handle rest response automagically

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

Parameters:

Throws:

• CliException