abstract class CourseObjectAccessPluginBase in Course 8.2

Base class for Course object access plugins.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\course\Plugin\CourseObjectAccessPluginBase implements CourseObjectAccessInterface

4 files declare their use of CourseObjectAccessPluginBase

CourseObject.php in src/Entity/CourseObject.php

CourseObjectAccessConditional.php in src/Plugin/course/CourseObjectAccess/CourseObjectAccessConditional.php

CourseObjectAccessGrade.php in src/Plugin/course/CourseObjectAccess/CourseObjectAccessGrade.php

CourseObjectAccessTiming.php in src/Plugin/course/CourseObjectAccess/CourseObjectAccessTiming.php

File

src/Plugin/CourseObjectAccessPluginBase.php, line 10

Namespace

Drupal\course\Plugin

abstract class CourseObjectAccessPluginBase extends PluginBase implements CourseObjectAccessInterface {
  private $courseObject;
  private $type;
  public function setType($type) {
    $this->type = $type;
  }

  /**
   * Helper method to get possible objects.
   */
  public function getObjectOptions() {
    $options = array(
      '',
    );
    foreach ($this
      ->getCourseObject()
      ->getCourse()
      ->getObjects() as $courseObject) {
      if ($courseObject
        ->getId() != $this
        ->getCourseObject()
        ->getId()) {
        $options[$courseObject
          ->getId()] = $courseObject
          ->getTitle();
      }
    }
    return $options;
  }
  public function setCourseObject($courseObject) {
    $this->courseObject = $courseObject;
  }
  public function getCourseObject() {
    return $this->courseObject;
  }
  public abstract function take($account);
  public abstract function see($account);
  public abstract function view($account);
  public function getOptions() {
    $plugins = $this
      ->getCourseObject()
      ->getOption('plugins');
    if (isset($plugins['access'][$this->pluginId])) {
      return $plugins['access'][$this->pluginId];
    }
    else {
      return $this
        ->optionsDefinition();
    }
  }
  public function getOption($option) {
    $options = $this
      ->getOptions();
    if (isset($options[$option])) {
      return $options[$option];
    }
    else {
      return NULL;
    }
  }
  public function optionsValidate($form, &$form_state) {
  }
  public function optionsDefinition() {
    return array();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CourseObjectAccessPluginBase::$courseObject	private	property
CourseObjectAccessPluginBase::$type	private	property
CourseObjectAccessPluginBase::getCourseObject	public	function
CourseObjectAccessPluginBase::getObjectOptions	public	function	Helper method to get possible objects.	1
CourseObjectAccessPluginBase::getOption	public	function
CourseObjectAccessPluginBase::getOptions	public	function
CourseObjectAccessPluginBase::optionsDefinition	public	function		3
CourseObjectAccessPluginBase::optionsValidate	public	function		1
CourseObjectAccessPluginBase::see	abstract public	function		3
CourseObjectAccessPluginBase::setCourseObject	public	function
CourseObjectAccessPluginBase::setType	public	function
CourseObjectAccessPluginBase::take	abstract public	function		3
CourseObjectAccessPluginBase::view	abstract public	function		3
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.