class CourseOutlineList in Course 8.2

Plugin annotation

@CourseOutline(
  id = "course",
  label = @Translation("Course"),
  description = @Translation("Displays course objects in an HTML list."),
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\course\Plugin\CourseOutlinePluginBase implements CourseOutlineInterface
      • class \Drupal\course\Plugin\course\CourseOutline\CourseOutlineList

File

src/Plugin/course/CourseOutline/CourseOutlineList.php, line 22

Namespace

Drupal\course\Plugin\course\CourseOutline

class CourseOutlineList extends CourseOutlinePluginBase {

  /**
   * {@inheritdoc}
   */
  function render(Course $course, AccountInterface $account) {

    // Iterate over objects.
    $workflow = array();
    $img = NULL;
    foreach ($course
      ->getObjects() as $key => $courseObject) {
      if ($courseObject
        ->access('see', $account)) {

        // The item will be in the list only if the user can see it. If they can
        // take it, entity_view() will output a link instead of text.
        $entity = \Drupal\course\Entity\CourseObject::load($courseObject
          ->getId());
        $render_controller = \Drupal::entityTypeManager()
          ->getViewBuilder('course_object');
        $item = $render_controller
          ->view($entity);
        if ($courseObject
          ->access('take', $account)) {

          // User can take this course object.
          $item['#class'][] = 'accessible';

          // Step is complete.
          if ($courseObject
            ->getFulfillment($account)
            ->isComplete()) {
            $item['#class'][] = 'completed';
          }
          elseif ($courseObject
            ->getFulfillment($account)
            ->getId()) {
            $item['#class'][] = 'in-progress';
          }
          if ($course
            ->getActive() === $courseObject) {
            $item['#class'][] = 'active';
          }
        }

        // Allow other modules to modify this list item.
        $courseObject
          ->overrideOutlineListItem($item);

        // Add this item to the list.
        $workflow[] = $item;
      }
    }
    if ($course
      ->getTracker($account)
      ->isComplete()) {
      $image = [
        '#uri' => 'core/misc/icons/73b355/check.svg',
        '#alt' => t('An icon'),
        '#theme' => 'image',
      ];
      $workflow[] = array(
        '#markup' => render($image) . Link::fromTextAndUrl(t('Complete'), Url::fromRoute('course.complete', [
          'course' => $course
            ->id(),
        ]))
          ->toString(),
        '#id' => 'complete',
      );
    }
    $output = [];
    if ($workflow) {
      $page = [];
      $page['course_outline']['#theme'] = 'item_list';
      $page['course_outline']['#items'] = $workflow;
      return $page;
    }
    return $output;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CourseOutlineList::render		function	Render a course outline. Overrides CourseOutlinePluginBase::render
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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	3
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.	92
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.