class CourseOutline in Course 8.2

Defines a Course outline annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\course\Annotation\CourseOutline

See also

\Drupal\course\Plugin\Course\Outline\CourseOutline

Plugin API

1 file declares its use of CourseOutline

CourseOutlinePluginManager.php in src/Plugin/CourseOutlinePluginManager.php

2 classes are annotated with CourseOutline

CourseOutlineList in src/Plugin/course/CourseOutline/CourseOutlineList.php

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

CourseOutlineNone in src/Plugin/course/CourseOutline/CourseOutlineNone.php

Plugin annotation @CourseOutline( id = "none", label = @Translation("None"), )

File

src/Annotation/CourseOutline.php, line 15

Namespace

Drupal\course\Annotation

class CourseOutline extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The label of the plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $label;

}

Members

Name	Modifiers	Type	Description	Overrides
CourseOutline::$id	public	property	The plugin ID.
CourseOutline::$label	public	property	The label of the plugin.
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2