class AcquiaContentHubEntityCommands in Acquia Content Hub 8.2

Drush commands for interacting with Acquia Content Hub entities.

@package Drupal\acquia_contenthub\Commands

Hierarchy

class \Drupal\acquia_contenthub\Commands\AcquiaContentHubEntityCommands extends \Drush\Commands\DrushCommands

Expanded class hierarchy of AcquiaContentHubEntityCommands

1 string reference to 'AcquiaContentHubEntityCommands'

drush.services.yml in ./drush.services.yml: drush.services.yml

1 service uses AcquiaContentHubEntityCommands

acquia_contenthub.commands.entity in ./drush.services.yml: Drupal\acquia_contenthub\Commands\AcquiaContentHubEntityCommands

File

src/Commands/AcquiaContentHubEntityCommands.php, line 16

Namespace

Drupal\acquia_contenthub\Commands

View source

class AcquiaContentHubEntityCommands extends DrushCommands {

  /**
   * The dependency calculator.
   *
   * @var \Drupal\depcalc\DependencyCalculator
   */
  protected $calculator;

  /**
   * The Content Hub Common Actions.
   *
   * @var \Drupal\acquia_contenthub\ContentHubCommonActions
   */
  protected $commonActions;

  /**
   * AcquiaContentHubEntityCommands constructor.
   *
   * @param \Drupal\depcalc\DependencyCalculator $calculator
   *   The dependency calculator.
   * @param \Drupal\acquia_contenthub\ContentHubCommonActions $common_actions
   *   The Content Hub Common Actions service.
   */
  public function __construct(DependencyCalculator $calculator, ContentHubCommonActions $common_actions) {
    $this->calculator = $calculator;
    $this->commonActions = $common_actions;
  }

  /**
   * Retrieves an Entity from a local source or contenthub.
   *
   * @param string $op
   *   The operation being performed.
   * @param string $uuid
   *   Entity identifier or entity's UUID.
   * @param string $entity_type
   *   The entity type in case of local retrieval.
   * @param array $options
   *   An associative array of options whose values come from cli, aliases,
   *   config, etc.
   *
   * @option decode
   *   Decodes the metadata 'data' element to make it easier to understand the
   *   content of each CDF entity stored in Content Hub.
   *
   * @command acquia:contenthub-entity
   * @aliases ach-ent
   *
   * @throws \Exception
   */
  public function contenthubEntity($op, $uuid, $entity_type = NULL, array $options = [
    'decode' => NULL,
  ]) {
    if (empty($uuid)) {
      throw new \Exception("Please supply the uuid of the entity you want to retrieve.");
    }
    switch ($op) {
      case 'local':
        if (empty($entity_type)) {
          throw new \Exception(dt("Entity_type is required for local entities"));
        }
        $repository = \Drupal::service('entity.repository');
        $entity = $repository
          ->loadEntityByUuid($entity_type, $uuid);
        $entities = [];
        $objects = $this->commonActions
          ->getEntityCdf($entity, $entities, FALSE, TRUE);
        $data = [];
        foreach ($objects as $object) {
          $data[$object
            ->getUuid()] = $object
            ->toArray();

          // Decode the base64 'data' element in 'metadata'.
          if ($options['decode']) {
            $this
              ->decodeEntityArrayMetadata($data[$object
              ->getUuid()]);
          }
        }
        $json = json_encode($data, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES);
        $this
          ->output()
          ->writeln($json);
        break;
      case 'remote':
        $entity = $this->commonActions
          ->getRemoteEntity($uuid);
        $entity_array = $entity
          ->toArray();

        // Decode the base64 'data' element in 'metadata'.
        if ($options['decode']) {
          $this
            ->decodeEntityArrayMetadata($entity_array);
        }
        elseif (!$entity instanceof CDFObjectInterface) {
          return;
        }
        $json = json_encode($entity_array, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES);
        $this
          ->output()
          ->writeln($json);
        break;
      default:

        // Invalid operation.
        throw new \Exception(dt('The op "@op" is invalid', [
          '@op' => $op,
        ]));
    }
  }

  /**
   * Prints the CDF from a local source (drupal site)
   *
   * @param string $entity_type
   *   The entity type to load.
   * @param string $entity_id
   *   The entity identifier or entity's UUID.
   * @param array $options
   *   An associative array of options whose values come from cli, aliases,
   *   config, etc.
   *
   * @option decode
   *   Decodes the metadata 'data' element to make it easier to understand the
   *   content of each CDF entity stored in Content Hub.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   * @throws \Drupal\Core\Entity\EntityStorageException
   *
   * @command acquia:contenthub-local
   * @aliases ach-lo,acquia-contenthub-local
   *
   * @deprecated  //@codingStandardsIgnoreLine
   */
  public function contenthubLocal($entity_type, $entity_id, array $options = [
    'decode' => NULL,
  ]) {
    $entity_type_manager = \Drupal::entityTypeManager();

    /** @var \Drupal\Core\Entity\EntityRepository $entity_repository */
    $entity_repository = \Drupal::service('entity.repository');
    if (empty($entity_type) || empty($entity_id)) {
      throw new \Exception(dt("Missing required parameters: entity_type and entity_id (or entity's uuid)"));
    }
    elseif (!$entity_type_manager
      ->getDefinition($entity_type)) {
      throw new \Exception(dt("Entity type @entity_type does not exist", [
        '@entity_type' => $entity_type,
      ]));
    }
    else {
      if (Uuid::isValid($entity_id)) {
        $entity = $entity_repository
          ->loadEntityByUuid($entity_type, $entity_id);
      }
      else {
        $entity = $entity_type_manager
          ->getStorage($entity_type)
          ->load($entity_id);
      }
    }
    if (!$entity) {
      throw new \Exception(dt("Entity having entity_type = @entity_type and entity_id = @entity_id does not exist.", [
        '@entity_type' => $entity_type,
        '@entity_id' => $entity_id,
      ]));
    }

    // If nothing else, return our object structure.
    $this
      ->contenthubEntity('local', $entity
      ->uuid(), $entity_type, $options);
  }

  /**
   * Prints the CDF from a remote source (Content Hub)
   *
   * @param string $uuid
   *   The entity's UUID.
   * @param array $options
   *   An associative array of options whose values come from cli, aliases,
   *   config, etc.
   *
   * @option decode
   *   Decodes the metadata 'data' element to make it easier to understand the
   *   content of each CDF entity stored in Content Hub.
   *
   * @command acquia:contenthub-remote
   * @aliases ach-re,acquia-contenthub-remote
   *
   * @throws \Exception
   */
  public function contenthubRemote($uuid, array $options = [
    'decode' => NULL,
  ]) {
    if (FALSE === Uuid::isValid($uuid)) {
      throw new \Exception(dt("Argument provided is not a UUID."));
    }
    $this
      ->contenthubEntity('remote', $uuid, NULL, $options);
  }

  /**
   * Deletes a single entity from the Content Hub.
   *
   * @param string $uuid
   *   The entity's UUID.
   *
   * @command acquia:contenthub-delete
   * @aliases ach-del,acquia-contenthub-delete
   *
   * @throws \Exception
   */
  public function contenthubDelete($uuid) {
    if (!$this
      ->io()
      ->confirm(dt('Are you sure you want to delete the entity with uuid = @uuid from the Content Hub? There is no way back from this action!', [
      '@uuid' => $uuid,
    ]))) {
      return;
    }
    if ($this->commonActions
      ->deleteRemoteEntity($uuid)) {
      $this
        ->output()
        ->writeln(dt('Entity with UUID = @uuid has been successfully deleted from the Content Hub Service.', [
        '@uuid' => $uuid,
      ]));
      return;
    }
    $this
      ->output()
      ->writeln(dt('WARNING: Entity with UUID = @uuid cannot be deleted from the Content Hub Service.', [
      '@uuid' => $uuid,
    ]));
  }

  /**
   * Decodes the base64 'data' element inside a CDF entity 'metadata'.
   *
   * @param array $cdf_entity
   *   The CDF entity array before it is written to the output.
   */
  protected function decodeEntityArrayMetadata(array &$cdf_entity) {
    $types = [
      'drupal8_content_entity',
      'drupal8_config_entity',
      'rendered_entity',
    ];
    if (in_array($cdf_entity['type'], $types)) {
      $cdf_entity['metadata']['data'] = base64_decode($cdf_entity['metadata']['data']);
    }
  }

}

Members

Name	Modifiers	Type	Description
AcquiaContentHubEntityCommands::$calculator	protected	property	The dependency calculator.
AcquiaContentHubEntityCommands::$commonActions	protected	property	The Content Hub Common Actions.
AcquiaContentHubEntityCommands::contenthubDelete	public	function	Deletes a single entity from the Content Hub.
AcquiaContentHubEntityCommands::contenthubEntity	public	function	Retrieves an Entity from a local source or contenthub.
AcquiaContentHubEntityCommands::contenthubLocal Deprecated	public	function	Prints the CDF from a local source (drupal site)
AcquiaContentHubEntityCommands::contenthubRemote	public	function	Prints the CDF from a remote source (Content Hub)
AcquiaContentHubEntityCommands::decodeEntityArrayMetadata	protected	function	Decodes the base64 'data' element inside a CDF entity 'metadata'.
AcquiaContentHubEntityCommands::__construct	public	function	AcquiaContentHubEntityCommands constructor.

You are here

class AcquiaContentHubEntityCommands in Acquia Content Hub 8.2

Hierarchy

File

Namespace

Members

API Navigation