You are here

public function BrightcoveVideoSearch::getHelp in Brightcove Video Connect 8.2

Same name and namespace in other branches
  1. 3.x src/Plugin/Search/BrightcoveVideoSearch.php \Drupal\brightcove\Plugin\Search\BrightcoveVideoSearch::getHelp()

Returns the searching help.

Return value

array Render array for the searching help.

Overrides SearchPluginBase::getHelp

File

src/Plugin/Search/BrightcoveVideoSearch.php, line 125

Class

BrightcoveVideoSearch
Executes a keyword search for videos against the {brightcove_video} table.

Namespace

Drupal\brightcove\Plugin\Search

Code

public function getHelp() {
  $help = [
    'list' => [
      '#theme' => 'item_list',
      '#items' => [
        $this
          ->t('Video search looks for videos using words and partial words from the name and description fields. Example: straw would match videos straw, strawmar, and strawberry.'),
        $this
          ->t('You can use * as a wildcard within your keyword. Example: s*m would match videos that contains strawman, seem, and blossoming.'),
      ],
    ],
  ];
  return $help;
}