public function CMSContentSyncCommands::pull in CMS Content Sync 2.1.x

Same name and namespace in other branches

1. 8 src/Commands/CMSContentSyncCommands.php \Drupal\cms_content_sync\Commands\CMSContentSyncCommands::pull()
2. 2.0.x src/Commands/CMSContentSyncCommands.php \Drupal\cms_content_sync\Commands\CMSContentSyncCommands::pull()

Kindly ask the Sync Core to pull all entities for a specific flow, or to force pull one specific entity.

@command cms_content_sync:pull

@aliases cs-pull

@options force Also update entities which have already been pulled. @options entity_type The type of the entity that should be pulled, e.g. "node". @options entity_uuid The uuid of the entity that should be pulled.

@usage cms_content_sync:pull example_flow Pulls all entities from the example flow. @usage cms_content_sync:pull example_flow --force Pull all entities from the "example_flow" and force entities which already have been pulled to be updated as well. @usage cms_content_sync:pull example_flow --entity_type="node" --entity_uuid="3a150294-90eb-48c2-911d-672043a45683" Force pull the node having the uuid 3a150294-90eb-48c2-911d-672043a45683 from the example flow.

Parameters

string $flow_id: The flow the entities should be pulled from

array $options:

Throws

\Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException

\Drupal\Component\Plugin\Exception\PluginNotFoundException

\EdgeBox\SyncCore\Exception\SyncCoreException

File

src/Commands/CMSContentSyncCommands.php, line 96

Class

CMSContentSyncCommands

Content Sync Drush Commands.

Namespace

Drupal\cms_content_sync\Commands

Code

public function pull($flow_id, $options = [
  'force' => false,
  'entity_type' => null,
  'entity_uuid' => null,
]) {
  $this->cliService
    ->pull($this
    ->io(), $flow_id, $options);
}