[SITE-5342] Add proper publish and unpublish support. (#32)

Author: malikkotob

src/Entity/PantheonDocument.php

@@ -6,6 +6,8 @@
 
 use Drupal\Core\Entity\ContentEntityBase;
 use Drupal\Core\Entity\EntityChangedTrait;
+use Drupal\Core\Entity\EntityPublishedInterface;
+use Drupal\Core\Entity\EntityPublishedTrait;
 use Drupal\Core\Entity\EntityTypeInterface;
 use Drupal\Core\Field\BaseFieldDefinition;
 use Drupal\Core\StringTranslation\TranslatableMarkup;
@@ -47,6 +49,7 @@
  *     "bundle" = "collection",
  *     "label" = "title",
  *     "uuid" = "uuid",
+ *     "published" = "status",
  *   },
  *   links = {
  *     "collection" = "/admin/content/pantheon-content-publisher",
@@ -59,13 +62,15 @@
 class PantheonDocument extends ContentEntityBase implements PantheonDocumentInterface {
 
   use EntityChangedTrait;
+  use EntityPublishedTrait;
 
   /**
    * {@inheritdoc}
    */
   public static function baseFieldDefinitions(EntityTypeInterface $entity_type): array {
 
     $fields = parent::baseFieldDefinitions($entity_type);
+    $fields += static::publishedBaseFieldDefinitions($entity_type);
     // In order to work around the InnoDB 191 character limit on utf8mb4
     // primary keys, we set the character set for the field to ASCII.
     $fields['id'] = BaseFieldDefinition::create('string')
@@ -110,10 +115,9 @@ public static function baseFieldDefinitions(EntityTypeInterface $entity_type): a
       ])
       ->setDisplayConfigurable('view', TRUE);
 
-    $fields['status'] = BaseFieldDefinition::create('boolean')
-      ->setLabel(t('Status'))
-      ->setDefaultValue(TRUE)
-      ->setSetting('on_label', 'Enabled')
+    $fields['status']
+      ->setDescription(t('A boolean value indicating whether the document is published. Controlled externally by Content Publisher.'))
+      ->setDisplayConfigurable('form', FALSE)
       ->setDisplayOptions('view', [
         'region' => 'hidden',
       ])

src/GraphQL.php

@@ -33,6 +33,7 @@ public function getArticle(string $id): array {
       'slug',
       'createdAt',
       'publishedDate',
+      'publishStatus',
       'metadata',
     ]);
     return $this->request($query);

src/PantheonContentPublisherConverter.php

@@ -60,6 +60,7 @@ public function convert(array $pantheon_data, string $collection_name, string|in
     $date_convert = fn (&$x) => $x ? $this->date($x) : (int) $_SERVER['REQUEST_TIME'];
     return $drupal_data + [
       'id' => $id,
+      'status' => ($pantheon_data['publishStatus'] ?? '') === 'published',
       'collection' => $collection_name,
       'content' => $pantheon_data['content'] ?? '',
       'title' => $pantheon_data['title'] ?? '',

src/PantheonDocumentInterface.php

@@ -6,10 +6,21 @@
 
 use Drupal\Core\Entity\ContentEntityInterface;
 use Drupal\Core\Entity\EntityChangedInterface;
+use Drupal\Core\Entity\EntityPublishedInterface;
 
 /**
  * Provides an interface defining a pantheon content publisher entity type.
  */
-interface PantheonDocumentInterface extends ContentEntityInterface, EntityChangedInterface {
+interface PantheonDocumentInterface extends ContentEntityInterface, EntityChangedInterface, EntityPublishedInterface {
+
+  /**
+   * Denotes that the document is not published.
+   */
+  const NOT_PUBLISHED = 0;
+
+  /**
+   * Denotes that the document is published.
+   */
+  const PUBLISHED = 1;
 
 }

src/PantheonDocumentListBuilder.php

@@ -31,7 +31,7 @@ public function buildRow(EntityInterface $entity): array {
     /** @var \Drupal\pantheon_content_publisher\PantheonDocumentInterface $entity */
     $row['id'] = $entity->id();
     $row['label'] = $entity->toLink();
-    $row['status'] = $entity->get('status')->value ? $this->t('Enabled') : $this->t('Disabled');
+    $row['status'] = $entity->isPublished() ? $this->t('Published') : $this->t('Draft');
     $row['created']['data'] = $entity->get('created')->view(['label' => 'hidden']);
     $row['changed']['data'] = $entity->get('changed')->view(['label' => 'hidden']);
     return $row;