class CourseEnrollmentEditAction in Course 3.x

Action description.

@todo not yet working

Plugin annotation

@Action(
  id = "course_edit_enrollment_action",
  label = @Translation("Edit enrollment"),
  type = "course_enrollment"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Action\ActionBase implements ActionInterface
      • class \Drupal\views_bulk_operations\Action\ViewsBulkOperationsActionBase implements ConfigurableInterface, ViewsBulkOperationsActionInterface uses ViewsBulkOperationsActionCompletedTrait
        • class \Drupal\course\Plugin\Action\CourseEnrollmentEditAction uses StringTranslationTrait

File

src/Plugin/Action/CourseEnrollmentEditAction.php, line 26

Namespace

Drupal\course\Plugin\Action

class CourseEnrollmentEditAction extends ViewsBulkOperationsActionBase {
  use StringTranslationTrait;

  /**
   * {@inheritdoc}
   */
  public function execute($entity = NULL) {
    $course = $entity
      ->getCourse();
    $account = $entity
      ->getUser();
    foreach ($this
      ->getConfiguration()['course_objects'] as $id => $complete) {
      if ($complete !== '') {

        // There was a change
        $courseObject = CourseObject::load($id);
        $fulfillment = $courseObject
          ->getFulfillment($account);
        if ($complete == 1) {

          // Completed
          $fulfillment
            ->setOption('message', "Fulfillment completed via bulk action.");
          $fulfillment
            ->setComplete();
        }
        if ($complete == -1) {

          // Delete attempt
          $fulfillment
            ->delete();
        }
        if ($complete == 0) {

          // Fail user
          $fulfillment
            ->setOption('message', "Fulfillment failed via bulk action.");
          $fulfillment
            ->setComplete(FALSE);
          $fulfillment
            ->setGrade(0);
        }
        $fulfillment
          ->save();
      }
    }

    // Recheck requirements.
    $entity
      ->track();
    \Drupal::messenger()
      ->addStatus(t('Updated enrollment for %user', array(
      '%user' => $account->name,
    )));
  }

  /**
   * {@inheritdoc}
   */
  public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE) {
    if ($object
      ->getEntityType() === 'user') {
      $access = $object
        ->access('update', $account, TRUE)
        ->andIf($object->status
        ->access('edit', $account, TRUE));
      return $return_as_object ? $access : $access
        ->isAllowed();
    }

    // Other entity types may have different
    // access methods and properties.
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {

    // Load the first enrollment.
    $selections = $form_state
      ->getStorage()['views_bulk_operations']['list'];
    $course_enrollment = CourseEnrollment::load(reset($selections)[0]);
    $course = $course_enrollment
      ->getCourse();

    // Check if this action is being performed on a single user, and set the
    // account accordingly.
    $account = NULL;
    if (count($form_state
      ->getStorage()['views_bulk_operations']['list']) === 1) {

      // Only one user and course, so let's prefill values.
      $account = $course_enrollment
        ->getUser();
    }

    // Get course objects, with or without a single user account information.
    $objects = $course
      ->getObjects();

    // Build a list of a single user's fulfillments.
    $fulfillments = NULL;
    if ($account) {
      $fulfillments = array();
      foreach ($objects as $courseObject) {
        $fulfillments[$courseObject
          ->id()] = $courseObject
          ->getFulfillment($account);
      }
    }
    $form['course_objects'] = array(
      '#title' => t('Set completion status'),
      '#description' => t('Set the status of a course object to be applied to selected users.'),
      '#type' => 'fieldset',
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
      '#tree' => TRUE,
      '#prefix' => '<span id="course-objects-wrapper">',
      '#suffix' => '</span>',
    );
    foreach ($objects as $courseObject) {
      $form['course_objects'][$courseObject
        ->id()] = array(
        '#type' => 'select',
        '#title' => $courseObject
          ->getTitle(),
        '#options' => array(
          '' => '- no change - ',
          1 => t('Complete'),
          -1 => t('Incomplete'),
          0 => t('Failed'),
        ),
        '#default_value' => $fulfillments ? $fulfillments[$courseObject
          ->id()]
          ->isComplete() : NULL,
      );
    }
    return $form;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CourseEnrollmentEditAction::access	public	function	Checks object access. Overrides ActionInterface::access
CourseEnrollmentEditAction::buildConfigurationForm	public	function
CourseEnrollmentEditAction::execute	public	function	Executes the plugin. Overrides ExecutableInterface::execute
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::$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.
ViewsBulkOperationsActionBase::$configuration	protected	property	Configuration array. Overrides PluginBase::$configuration
ViewsBulkOperationsActionBase::$context	protected	property	Action context.
ViewsBulkOperationsActionBase::$view	protected	property	The processed view.
ViewsBulkOperationsActionBase::customAccess	public static	function	Default custom access callback.
ViewsBulkOperationsActionBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
ViewsBulkOperationsActionBase::executeMultiple	public	function	Execute action on multiple entities. Overrides ActionBase::executeMultiple	1
ViewsBulkOperationsActionBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ViewsBulkOperationsActionBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ViewsBulkOperationsActionBase::setContext	public	function	Set action context. Overrides ViewsBulkOperationsActionInterface::setContext
ViewsBulkOperationsActionBase::setView	public	function	Set view object. Overrides ViewsBulkOperationsActionInterface::setView
ViewsBulkOperationsActionBase::submitConfigurationForm	public	function	Default configuration form submit handler.	1
ViewsBulkOperationsActionBase::validateConfigurationForm	public	function	Default configuration form validator.
ViewsBulkOperationsActionCompletedTrait::finished	public static	function	Batch finished callback.	1
ViewsBulkOperationsActionCompletedTrait::message	public static	function	Set message function wrapper.	1
ViewsBulkOperationsActionCompletedTrait::translate	public static	function	Translation function wrapper.	1