Class Salient\Sync\Command\CheckSyncProviderHeartbeat

`final`
`extends`	`AbstractSyncCommand`

A generic sync provider heartbeat check command

Salient\Cli\CliCommand implements CliCommandInterface
- Salient\Sync\Command\AbstractSyncCommand
  - Salient\Sync\Command\CheckSyncProviderHeartbeat

Located at Toolkit/Sync/Command/CheckSyncProviderHeartbeat.php

Methods


					
	public

getDescription(): string

Get a description of the object

Implements

Salient\Contract\Core\HasDescription::getDescription()


					
	protected

getOptionList(): iterable

Override to return a list of options for the command

Overrides

Salient\Cli\CliCommand::getOptionList()


					
	public

getLongDescription(): ?string

Override to return a detailed description of the command

Overrides

Salient\Cli\CliCommand::getLongDescription()


					
	protected

run(string ...$args)

Run the command

The command's return value will be:

the return value of this method (if an int is returned)
the last value passed to {@see CliCommand::setExitStatus()}, or
0, indicating success

Parameters

...$args

Non-option arguments passed to the command.

Implements

Salient\Cli\CliCommand::run()

Methods inherited from Salient\Sync\Command\AbstractSyncCommand
`__construct(), getGlobalOptionList(), startRun(), getJson()`

Methods inherited from Salient\Cli\CliCommand
`getHelpSections(), filterJsonSchema(), filterGetSchemaValues(), filterNormaliseSchemaValues(), filterApplySchemaValues(), __invoke(), getContainer(), getName(), getNameParts(), setName(), getHelp(), getSynopsis(), getNameWithProgram(), getJsonSchema(), applyOptionValues(), normaliseOptionValues(), checkOptionValues(), getOptionValues(), getDefaultOptionValues(), getOptionValue(), optionHasArgument(), getOption(), hasOption(), getOptions(), isRunning(), setExitStatus(), getExitStatus(), getRuns()`

Methods inherited from Salient\Cli\CliCommand

getHelpSections(), filterJsonSchema(), filterGetSchemaValues(), filterNormaliseSchemaValues(), filterApplySchemaValues(), __invoke(), getContainer(), getName(), getNameParts(), setName(), getHelp(), getSynopsis(), getNameWithProgram(), getJsonSchema(), applyOptionValues(), normaliseOptionValues(), checkOptionValues(), getOptionValues(), getDefaultOptionValues(), getOptionValue(), optionHasArgument(), getOption(), hasOption(), getOptions(), isRunning(), setExitStatus(), getExitStatus(), getRuns()

Constants inherited from Salient\Contract\Core\JsonSchemaInterface
`DRAFT_04_SCHEMA_ID`

Properties inherited from Salient\Sync\Command\AbstractSyncCommand
`$ExportHar, $Store, $Entities, $Providers, $EntityProviders, $HttpProviders`

Properties inherited from Salient\Cli\CliCommand
`$App`

Namespaces

Classes

Class Salient\Sync\Command\CheckSyncProviderHeartbeat

Implements

Overrides

Overrides

Parameters

Implements