\Action_Scheduler\MigrationController

Class Controller

The main plugin/initialization class for migration to custom tables.

Summary

Methods
Properties
Constants
get_store_class()
get_logger_class()
has_custom_datastore()
schedule_migration()
get_migration_config_object()
hook_admin_notices()
display_migration_notice()
maybe_hook_migration()
allow_migration()
init()
instance()
No public properties found
No constants found
__construct()
No protected properties found
N/A
hook()
$instance
$migration_scheduler
$store_classname
$logger_classname
$migrate_custom_store
N/A

Properties

$instance

$instance : self

Instance.

Type

normal

$migration_scheduler

$migration_scheduler : \Action_Scheduler\Migration\Action_Scheduler\Migration\Scheduler

Scheduler instance.

Type

\Action_Scheduler\Migration\Action_Scheduler\Migration\Scheduler

$store_classname

$store_classname : string

Class name of the store object.

Type

normal

$logger_classname

$logger_classname : string

Class name of the logger object.

Type

normal

$migrate_custom_store

$migrate_custom_store : bool

Flag to indicate migrating custom store.

Type

normal

Methods

get_store_class()

get_store_class(string  $class) : string

Set the action store class name.

Parameters

string $class

Classname of the store class.

Returns

string

get_logger_class()

get_logger_class(string  $class) : string

Set the action logger class name.

Parameters

string $class

Classname of the logger class.

Returns

string

has_custom_datastore()

has_custom_datastore() : bool

Get flag indicating whether a custom datastore is in use.

Returns

bool

schedule_migration()

schedule_migration() : void

Set up the background migration process.

get_migration_config_object()

get_migration_config_object() : \Action_Scheduler\Migration\ActionScheduler\Migration\Config

Get the default migration config object

Returns

\Action_Scheduler\Migration\ActionScheduler\Migration\Config

hook_admin_notices()

hook_admin_notices() : mixed

Hook dashboard migration notice.

Returns

mixed

display_migration_notice()

display_migration_notice() : mixed

Show a dashboard notice that migration is in progress.

Returns

mixed

maybe_hook_migration()

maybe_hook_migration() : mixed

Possibly hook the migration scheduler action.

Returns

mixed

allow_migration()

allow_migration() : mixed

Allow datastores to enable migration to AS tables.

Returns

mixed

init()

init() : mixed

Proceed with the migration if the dependencies have been met.

Returns

mixed

instance()

instance() : mixed

Singleton factory.

Returns

mixed

__construct()

__construct(\Action_Scheduler\Migration\Scheduler  $migration_scheduler) : mixed

Controller constructor.

Parameters

\Action_Scheduler\Migration\Scheduler $migration_scheduler

Migration scheduler object.

Returns

mixed

hook()

hook() : mixed

Add store classes. Hook migration.

Returns

mixed