ContentTranslationPendingRevisionTestBase.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\content_translation\Functional;

use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Tests\content_moderation\Traits\ContentModerationTestTrait;
use Drupal\Tests\node\Traits\ContentTypeCreationTrait;

/**
 * Base class for pending revision translation tests.
 */
abstract class ContentTranslationPendingRevisionTestBase extends ContentTranslationTestBase {
    use ContentTypeCreationTrait;
    use ContentModerationTestTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'language',
        'content_translation',
        'content_moderation',
        'node',
    ];
    
    /**
     * The entity storage.
     *
     * @var \Drupal\Core\Entity\ContentEntityStorageInterface
     */
    protected $storage;
    
    /**
     * Permissions common to all test accounts.
     *
     * @var string[]
     */
    protected $commonPermissions;
    
    /**
     * The current test account.
     *
     * @var \Drupal\Core\Session\AccountInterface
     */
    protected $currentAccount;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        $this->entityTypeId = 'node';
        $this->bundle = 'article';
        $this->commonPermissions = [
            'view any unpublished content',
            "translate {$this->bundle} {$this->entityTypeId}",
            "create content translations",
            'use editorial transition create_new_draft',
            'use editorial transition publish',
            'use editorial transition archive',
            'use editorial transition archived_draft',
            'use editorial transition archived_published',
        ];
        parent::setUp();
        
        /** @var \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager */
        $entity_type_manager = $this->container
            ->get('entity_type.manager');
        $this->storage = $entity_type_manager->getStorage($this->entityTypeId);
        // @todo Remove this line once https://www.drupal.org/node/2945928 is fixed.
        $this->config('node.settings')
            ->set('use_admin_theme', '1')
            ->save();
    }
    
    /**
     * Enables content moderation for the test entity type and bundle.
     */
    protected function enableContentModeration() {
        $perms = array_merge(parent::getAdministratorPermissions(), [
            'administer workflows',
            'view latest version',
        ]);
        $this->rootUser = $this->drupalCreateUser($perms);
        $this->drupalLogin($this->rootUser);
        $workflow_id = 'editorial';
        $this->drupalGet('/admin/config/workflow/workflows');
        $edit['bundles[' . $this->bundle . ']'] = TRUE;
        $this->drupalGet('admin/config/workflow/workflows/manage/' . $workflow_id . '/type/' . $this->entityTypeId);
        $this->submitForm($edit, 'Save');
        // Ensure the parent environment is up-to-date.
        // @see content_moderation_workflow_insert()
        \Drupal::service('entity_type.bundle.info')->clearCachedBundles();
        \Drupal::service('entity_field.manager')->clearCachedFieldDefinitions();
        
        /** @var \Drupal\Core\Routing\RouteBuilderInterface $router_builder */
        $router_builder = $this->container
            ->get('router.builder');
        $router_builder->rebuildIfNeeded();
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getEditorPermissions() {
        $editor_permissions = [
            "edit any {$this->bundle} content",
            "delete any {$this->bundle} content",
            "view {$this->bundle} revisions",
            "delete {$this->bundle} revisions",
        ];
        return array_merge($editor_permissions, $this->commonPermissions);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getTranslatorPermissions() {
        return array_merge(parent::getTranslatorPermissions(), $this->commonPermissions);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function setupBundle() {
        parent::setupBundle();
        $this->createContentType([
            'type' => $this->bundle,
        ]);
        $this->createEditorialWorkflow();
    }
    
    /**
     * Loads the active revision translation for the specified entity.
     *
     * @param \Drupal\Core\Entity\ContentEntityInterface $entity
     *   The entity being edited.
     * @param string $langcode
     *   The translation language code.
     *
     * @return \Drupal\Core\Entity\ContentEntityInterface|null
     *   The active revision translation or NULL if none could be identified.
     */
    protected function loadRevisionTranslation(ContentEntityInterface $entity, $langcode) {
        // Explicitly invalidate the cache for that node, as the call below is
        // statically cached.
        $this->storage
            ->resetCache([
            $entity->id(),
        ]);
        $revision_id = $this->storage
            ->getLatestTranslationAffectedRevisionId($entity->id(), $langcode);
        
        /** @var \Drupal\Core\Entity\ContentEntityInterface $revision */
        $revision = $revision_id ? $this->storage
            ->loadRevision($revision_id) : NULL;
        return $revision && $revision->hasTranslation($langcode) ? $revision->getTranslation($langcode) : NULL;
    }
    
    /**
     * Returns the edit URL for the specified entity.
     *
     * @param \Drupal\Core\Entity\ContentEntityInterface $entity
     *   The entity being edited.
     *
     * @return \Drupal\Core\Url
     *   The edit URL.
     */
    protected function getEditUrl(ContentEntityInterface $entity) {
        if ($entity->access('update', $this->loggedInUser)) {
            $url = $entity->toUrl('edit-form');
        }
        else {
            $url = $entity->toUrl('drupal:content-translation-edit');
            $url->setRouteParameter('language', $entity->language()
                ->getId());
        }
        return $url;
    }
    
    /**
     * Returns the delete translation URL for the specified entity.
     *
     * @param \Drupal\Core\Entity\ContentEntityInterface $entity
     *   The entity being edited.
     *
     * @return \Drupal\Core\Url
     *   The delete translation URL.
     */
    protected function getDeleteUrl(ContentEntityInterface $entity) {
        if ($entity->access('delete', $this->loggedInUser)) {
            $url = $entity->toUrl('delete-form');
        }
        else {
            $url = $entity->toUrl('drupal:content-translation-delete');
            $url->setRouteParameter('language', $entity->language()
                ->getId());
        }
        return $url;
    }

}