\Action_Scheduler\MigrationConfig

Class Config

Summary

Methods

Properties

Constants

__construct()
get_source_store()
set_source_store()
get_source_logger()
set_source_logger()
get_destination_store()
set_destination_store()
get_destination_logger()
set_destination_logger()
get_dry_run()
set_dry_run()
get_progress_bar()
set_progress_bar()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

$source_store
$source_logger
$destination_store
$destination_logger
$progress_bar
$dry_run

N/A

File: includes/lib/action-scheduler/classes/migration/Config.php
Package: Scheduler\Migration
Class hierarchy: \Action_Scheduler\Migration\Config

Properties

$source_store

$source_store : \Action_Scheduler\Migration\ActionScheduler_Store

Source store instance.

Type

\Action_Scheduler\Migration\ActionScheduler_Store

$source_logger

$source_logger : \Action_Scheduler\Migration\ActionScheduler_Logger

Source logger instance.

Type

\Action_Scheduler\Migration\ActionScheduler_Logger

$destination_store

$destination_store : \Action_Scheduler\Migration\ActionScheduler_Store

Destination store instance.

Type

\Action_Scheduler\Migration\ActionScheduler_Store

$destination_logger

$destination_logger : \Action_Scheduler\Migration\ActionScheduler_Logger

Destination logger instance.

Type

\Action_Scheduler\Migration\ActionScheduler_Logger

$progress_bar

$progress_bar : \Action_Scheduler\Migration\Action_Scheduler\WP_CLI\ProgressBar

Progress bar object.

Type

\Action_Scheduler\Migration\Action_Scheduler\WP_CLI\ProgressBar

$dry_run

$dry_run : bool

Flag indicating a dryrun.

Type

normal

Methods

__construct()

__construct() : mixed

Config constructor.

Returns

mixed

get_source_store()

get_source_store() : \Action_Scheduler\Migration\ActionScheduler_Store

Get the configured source store.

Throws

\RuntimeException: When source store is not configured.

Returns

\Action_Scheduler\Migration\ActionScheduler_Store

set_source_store()

set_source_store(\Action_Scheduler\Migration\ActionScheduler_Store  $store) : mixed

Set the configured source store.

Parameters

\Action_Scheduler\Migration\ActionScheduler_Store

$store

Source store object.

Returns

mixed

get_source_logger()

get_source_logger() : \Action_Scheduler\Migration\ActionScheduler_Logger

Get the configured source logger.

Throws

\RuntimeException: When source logger is not configured.

Returns

\Action_Scheduler\Migration\ActionScheduler_Logger

set_source_logger()

set_source_logger(\Action_Scheduler\Migration\ActionScheduler_Logger  $logger) : mixed

Set the configured source logger.

Parameters

\Action_Scheduler\Migration\ActionScheduler_Logger

$logger

Logger object.

Returns

mixed

get_destination_store()

get_destination_store() : \Action_Scheduler\Migration\ActionScheduler_Store

Get the configured destination store.

Throws

\RuntimeException: When destination store is not configured.

Returns

\Action_Scheduler\Migration\ActionScheduler_Store

set_destination_store()

set_destination_store(\Action_Scheduler\Migration\ActionScheduler_Store  $store) : mixed

Set the configured destination store.

Parameters

\Action_Scheduler\Migration\ActionScheduler_Store

$store

Action store object.

Returns

mixed

get_destination_logger()

get_destination_logger() : \Action_Scheduler\Migration\ActionScheduler_Logger

Get the configured destination logger.

Throws

\RuntimeException: When destination logger is not configured.

Returns

\Action_Scheduler\Migration\ActionScheduler_Logger

set_destination_logger()

set_destination_logger(\Action_Scheduler\Migration\ActionScheduler_Logger  $logger) : mixed

Set the configured destination logger.

Parameters

\Action_Scheduler\Migration\ActionScheduler_Logger

$logger

Logger object.

Returns

mixed

get_dry_run()

get_dry_run() : bool

Get flag indicating whether it's a dry run.

Returns

bool

set_dry_run()

set_dry_run(bool  $dry_run) : mixed

Set flag indicating whether it's a dry run.

Parameters

bool

$dry_run

Dry run toggle.

Returns

mixed

get_progress_bar()

get_progress_bar() : \Action_Scheduler\Migration\ActionScheduler\WPCLI\ProgressBar

Get progress bar object.

Returns

\Action_Scheduler\Migration\ActionScheduler\WPCLI\ProgressBar

set_progress_bar()

set_progress_bar(\Action_Scheduler\Migration\ActionScheduler\WPCLI\ProgressBar  $progress_bar) : mixed

Set progress bar object.

Parameters

\Action_Scheduler\Migration\ActionScheduler\WPCLI\ProgressBar

$progress_bar

Progress bar object.

Returns

mixed