Heratio Framework API Reference

MigrationHandler
in package

Table of Contents

Methods

__construct()  : mixed
getMigrationFiles()  : array<string|int, mixed>
Get migration files for extension
getSqlFilePath()  : string|null
Get SQL file path for manual installation
hasMigrations()  : bool
Check if extension has migrations
hasSqlFile()  : bool
Check if extension has SQL file
rollbackMigrations()  : array<string|int, mixed>
Rollback migrations
runMigrations()  : array<string|int, mixed>
Run migrations for extension
runSqlFile()  : bool
Run SQL file for extension
tablesExist()  : bool
Check if required tables exist

Methods

__construct()

public __construct([string|null $pluginsPath = null ]) : mixed
Parameters
$pluginsPath : string|null = null

getMigrationFiles()

Get migration files for extension

public getMigrationFiles(string $machineName) : array<string|int, mixed>
Parameters
$machineName : string
Return values
array<string|int, mixed>

getSqlFilePath()

Get SQL file path for manual installation

public getSqlFilePath(string $machineName) : string|null
Parameters
$machineName : string
Return values
string|null

hasMigrations()

Check if extension has migrations

public hasMigrations(string $machineName) : bool
Parameters
$machineName : string
Return values
bool

hasSqlFile()

Check if extension has SQL file

public hasSqlFile(string $machineName) : bool
Parameters
$machineName : string
Return values
bool

rollbackMigrations()

Rollback migrations

public rollbackMigrations(string $machineName) : array<string|int, mixed>
Parameters
$machineName : string
Return values
array<string|int, mixed>

runMigrations()

Run migrations for extension

public runMigrations(string $machineName) : array<string|int, mixed>
Parameters
$machineName : string
Return values
array<string|int, mixed>

runSqlFile()

Run SQL file for extension

public runSqlFile(string $machineName) : bool
Parameters
$machineName : string
Return values
bool

tablesExist()

Check if required tables exist

public tablesExist(array<string|int, mixed> $tables) : bool
Parameters
$tables : array<string|int, mixed>
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results