You are here

class EnrollUserInOrderedCourses in Course 3.x

Same name in this branch
  1. 3.x modules/course_uc/src/Plugin/RulesAction/EnrollUserInOrderedCourses.php \Drupal\course_uc\Plugin\RulesAction\EnrollUserInOrderedCourses
  2. 3.x modules/course_commerce/src/Plugin/RulesAction/EnrollUserInOrderedCourses.php \Drupal\course_commerce\Plugin\RulesAction\EnrollUserInOrderedCourses

Provides an 'Enroll user in ordered courses' action.

Plugin annotation


@RulesAction(
  id = "course_uc_enroll_user_in_ordered_courses",
  label = @Translation("Enroll user in ordered courses"),
  category = @Translation("Order"),
  context_definitions = {
    "order" = @ContextDefinition("entity:uc_order",
      label = @Translation("Order")
    ),
  }
)

Hierarchy

Expanded class hierarchy of EnrollUserInOrderedCourses

File

modules/course_uc/src/Plugin/RulesAction/EnrollUserInOrderedCourses.php, line 23

Namespace

Drupal\course_uc\Plugin\RulesAction
View source
class EnrollUserInOrderedCourses extends RulesActionBase {

  /**
   * Adds a comment to an order.
   *
   * @param OrderInterface $order
   *   The order object.
   * @param string $comment
   *   Text of the comment.
   * @param string $comment_type
   *   One of 'admin' or 'order'.
   */
  protected function doExecute(OrderInterface $order) {
    course_uc_enroll_user_in_ordered_courses($order);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
EnrollUserInOrderedCourses::doExecute protected function Adds a comment to an order.