TestHelpSection.php

Same filename in other branches
  1. 8.9.x core/modules/help_topics/tests/modules/help_topics_test/src/Plugin/HelpSection/TestHelpSection.php
  2. 10 core/modules/help/tests/modules/help_topics_test/src/Plugin/HelpSection/TestHelpSection.php
  3. 11.x core/modules/help/tests/modules/help_topics_test/src/Plugin/HelpSection/TestHelpSection.php

Namespace

Drupal\help_topics_test\Plugin\HelpSection

File

core/modules/help_topics/tests/modules/help_topics_test/src/Plugin/HelpSection/TestHelpSection.php

View source
<?php

namespace Drupal\help_topics_test\Plugin\HelpSection;

use Drupal\help_topics\SearchableHelpInterface;
use Drupal\Core\Language\LanguageInterface;
use Drupal\Core\Url;
use Drupal\Core\Link;
use Drupal\help\Plugin\HelpSection\HelpSectionPluginBase;
// cspell:ignore asdrsad barmm foomm sqruct wcsrefsdf sdeeeee

/**
 * Provides a searchable help section for testing.
 *
 * @HelpSection(
 *   id = "help_topics_test",
 *   title = @Translation("Test section"),
 *   weight = 100,
 *   description = @Translation("For testing search"),
 *   permission = "access test help"
 * )
 */
class TestHelpSection extends HelpSectionPluginBase implements SearchableHelpInterface {
    
    /**
     * {@inheritdoc}
     */
    public function listTopics() {
        return [
            Link::fromTextAndUrl('Foo', Url::fromUri('https://foo.com')),
            Link::fromTextAndUrl('Bar', Url::fromUri('https://bar.com')),
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function listSearchableTopics() {
        return [
            'foo',
            'bar',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function renderTopicForSearch($topic_id, LanguageInterface $language) {
        switch ($topic_id) {
            case 'foo':
                if ($language->getId() == 'en') {
                    return [
                        'title' => 'Foo in English title wcsrefsdf',
                        'text' => 'Something about foo body not-a-word-english sqruct',
                        'url' => Url::fromUri('https://foo.com'),
                    ];
                }
                return [
                    'title' => 'Foomm Foreign heading',
                    'text' => 'Fake foreign foo text not-a-word-german asdrsad',
                    'url' => Url::fromUri('https://mm.foo.com'),
                ];
            case 'bar':
                if ($language->getId() == 'en') {
                    return [
                        'title' => 'Bar in English',
                        'text' => 'Something about bar another-word-english asdrsad',
                        'url' => Url::fromUri('https://bar.com'),
                    ];
                }
                return [
                    'title' => \Drupal::state()->get('help_topics_test:translated_title', 'Barmm Foreign sdeeeee'),
                    'text' => 'Fake foreign barmm another-word-german sqruct',
                    'url' => Url::fromUri('https://mm.bar.com'),
                ];
            default:
                throw new \InvalidArgumentException('Unexpected ID encountered');
        }
    }

}

Classes

Title Deprecated Summary
TestHelpSection Provides a searchable help section for testing.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.