You are here

abstract class CourseOutlinePluginBase in Course 3.x

Same name and namespace in other branches
  1. 8.3 src/Plugin/CourseOutlinePluginBase.php \Drupal\course\Plugin\CourseOutlinePluginBase
  2. 8.2 src/Plugin/CourseOutlinePluginBase.php \Drupal\course\Plugin\CourseOutlinePluginBase

Base class for Course object access plugins.

Hierarchy

Expanded class hierarchy of CourseOutlinePluginBase

4 files declare their use of CourseOutlinePluginBase
CourseController.php in src/Controller/CourseController.php
CourseOutlineBlock.php in src/Plugin/Block/CourseOutlineBlock.php
CourseOutlineList.php in src/Plugin/course/CourseOutline/CourseOutlineList.php
CourseOutlineNone.php in src/Plugin/course/CourseOutline/CourseOutlineNone.php

File

src/Plugin/CourseOutlinePluginBase.php, line 12

Namespace

Drupal\course\Plugin
View source
abstract class CourseOutlinePluginBase extends PluginBase implements CourseOutlineInterface {

  /**
   * Render a course outline.
   *
   * @param \Drupal\course\Plugin\Course $course
   * @param \Drupal\course\Plugin\AccountInterface $account
   *
   * @return array
   *   Render array.
   */
  abstract function render(Course $course, AccountInterface $account);

}

Members

Namesort descending Modifiers Type Description Overrides
CourseOutlinePluginBase::render abstract function Render a course outline. 2
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 98
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.