class LearningPathContent in Opigno Learning path 8

Class LearningPathContent.

Hierarchy

• class \Drupal\opigno_learning_path\LearningPathContent

4 files declare their use of LearningPathContent

LearningPathController.php in src/Controller/LearningPathController.php

LearningPathStepsController.php in src/Controller/LearningPathStepsController.php

opigno_learning_path.module in ./opigno_learning_path.module

Contains opigno_learning_path.module.

StepsBlock.php in src/Plugin/Block/StepsBlock.php

File

src/LearningPathContent.php, line 10

Namespace

Drupal\opigno_learning_path

class LearningPathContent {
  private $learningPathContentTypeId;
  private $entityType;
  private $entityId;
  private $title;
  private $imageUrl;
  private $imageAlt;

  /**
   * LearningPathContent constructor.
   */
  public function __construct($learning_path_content_type_id, $entity_type, $entity_id, $title, $image_url, $image_alt) {
    $this
      ->setLearningPathContentTypeId($learning_path_content_type_id);
    $this
      ->setEntityType($entity_type);
    $this
      ->setEntityId($entity_id);
    $this
      ->setTitle($title);
    $this
      ->setImageUrl($image_url);
    $this
      ->setImageAlt($image_alt);
  }

  /**
   * {@inheritdoc}
   */
  public function __toString() {
    return implode('.', [
      self::class,
      $this->entityType,
      $this->entityId,
    ]);
  }

  /**
   * Returns LP content properties array to manager.
   *
   * @param \Drupal\opigno_learning_path\Entity\LPManagedContent|null $content
   *   LP content.
   *
   * @return array
   *   LP content properties array.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   */
  public function toManagerArray(LPManagedContent $content = NULL) {
    if ($content === NULL) {
      $cid = '';
      $is_mandatory = FALSE;
      $success_score_min = 0;
      $parents_links = [];
    }
    else {
      $cid = $content
        ->id();
      $is_mandatory = $content
        ->isMandatory();
      $success_score_min = $content
        ->getSuccessScoreMin();
      $parents_links = $content
        ->getParentsLinks();
    }
    $this_array = [
      'cid' => $cid,
      'entityId' => $this
        ->getEntityId(),
      // TODO: Remove this. Avoid duplicate.
      'entityType' => $this
        ->getLearningPathContentTypeId(),
      // TODO: Remove this. Avoid duplicate.
      'entityBundle' => $this
        ->getLearningPathContentTypeId(),
      'contentType' => $this
        ->getLearningPathContentTypeId(),
      'title' => $this
        ->getTitle(),
      'imageUrl' => $this
        ->getImageUrl(),
      'imageAlt' => $this
        ->getImageAlt(),
      'isMandatory' => $is_mandatory,
      'successScoreMin' => $success_score_min,
    ];
    $parents = [];
    foreach ($parents_links as $link) {
      if (get_class($link) != 'Drupal\\opigno_learning_path\\Entity\\LPManagedLink') {
        continue;
      }
      $parents[] = [
        'cid' => $link
          ->getParentContentId(),
        'minScore' => $link
          ->getRequiredScore(),
      ];
    }
    $this_array['parents'] = $parents;
    return $this_array;
  }

  /**
   * Returns entity type.
   *
   * @return string
   *   Entity type.
   */
  public function getEntityType() {
    return $this->entityType;
  }

  /**
   * Sets entity type.
   *
   * @param string $entity_type
   *   Entity type.
   */
  public function setEntityType($entity_type) {
    $this->entityType = $entity_type;
  }

  /**
   * Returns entity ID.
   *
   * @return string
   *   Entity ID.
   */
  public function getEntityId() {
    return $this->entityId;
  }

  /**
   * Sets entity ID.
   *
   * @param string $entity_id
   *   Entity ID.
   */
  public function setEntityId($entity_id) {
    $this->entityId = $entity_id;
  }

  /**
   * Returns entity title.
   *
   * @return string
   *   Entity title.
   */
  public function getTitle() {
    return $this->title;
  }

  /**
   * Sets entity title.
   *
   * @param string $entity_title
   *   Entity title.
   */
  public function setTitle($entity_title) {
    $this->title = $entity_title;
  }

  /**
   * Returns LP content type ID.
   *
   * @return mixed
   *   LP content type ID.
   */
  public function getLearningPathContentTypeId() {
    return $this->learningPathContentTypeId;
  }

  /**
   * Sets LP content type ID.
   *
   * @param mixed $learning_path_content_type_id
   *   LP content type ID.
   */
  public function setLearningPathContentTypeId($learning_path_content_type_id) {
    $this->learningPathContentTypeId = $learning_path_content_type_id;
  }

  /**
   * Returns image url.
   *
   * @return mixed
   *   Image url.
   */
  public function getImageUrl() {
    return $this->imageUrl;
  }

  /**
   * Sets image url.
   *
   * @param mixed $image_url
   *   Image url.
   */
  public function setImageUrl($image_url) {
    $this->imageUrl = $image_url;
  }

  /**
   * Returns image alt.
   *
   * @return mixed
   *   Image alt.
   */
  public function getImageAlt() {
    return $this->imageAlt;
  }

  /**
   * Sets image alt.
   *
   * @param mixed $image_alt
   *   Image alt.
   */
  public function setImageAlt($image_alt) {
    $this->imageAlt = $image_alt;
  }

  /**
   * Returns Class parent groups ids.
   *
   * @param int $id
   *   Group id.
   *
   * @return mixed
   *   Groups ids.
   */
  public static function getClassGroups($id) {
    $db_connection = \Drupal::service('database');
    $parents = $db_connection
      ->select('group_content_field_data', 'g_c_f_d')
      ->fields('g_c_f_d', [
      'gid',
    ])
      ->condition('entity_id', $id)
      ->condition('type', 'group_content_type_27efa0097d858')
      ->execute()
      ->fetchAll();
    return $parents;
  }

  /**
   * Returns Group membership created timestamp.
   *
   * @param int $gid
   *   Group ID.
   * @param int $uid
   *   User ID.
   *
   * @return mixed
   *   Group membership created timestamp.
   */
  public static function getGroupMembershipTimestamp($gid, $uid) {
    $db_connection = \Drupal::service('database');
    $timestamp = $db_connection
      ->select('group_content_field_data', 'g_c_f_d')
      ->fields('g_c_f_d', [
      'created',
    ])
      ->condition('gid', $gid)
      ->condition('entity_id', $uid)
      ->execute()
      ->fetchField();
    return $timestamp;
  }

  /**
   * Returns Group memberships by types.
   *
   * @param int $gid
   *   Group ID.
   * @param mixed $types
   *   Array of membership types.
   *
   * @return mixed
   *   Group membership ids.
   */
  public static function getGroupMembershipIdsByType($gid, $types) {
    $db_connection = \Drupal::service('database');
    $ids = $db_connection
      ->select('group_content_field_data', 'g_c_f_d')
      ->fields('g_c_f_d', [
      'entity_id',
    ])
      ->condition('gid', $gid)
      ->condition('type', $types, 'IN')
      ->execute()
      ->fetchCol();
    return $ids;
  }

  /**
   * Function for getting group steps without courses, only modules.
   */
  public static function getAllStepsOnlyModules($group_id, $uid = NULL, $all = FALSE, $onlyCM = NULL, $latest_cert_date = NULL) {
    if (!$uid) {
      $uid = \Drupal::currentUser()
        ->id();
    }

    // Load group steps.
    if ($all) {
      $group_steps = opigno_learning_path_get_all_steps($group_id, $uid, $onlyCM, $latest_cert_date);
    }
    else {
      $group_steps = opigno_learning_path_get_steps($group_id, $uid, $onlyCM, $latest_cert_date);
    }
    $steps = [];

    // Load group courses substeps.
    array_walk($group_steps, function ($step, $key) use ($uid, &$steps, $onlyCM, $latest_cert_date) {
      $step['position'] = $key;

      // Check access for each step.
      if (!LearningPathAccess::checkStepValidation($step, $uid)) {
        return;
      }
      if ($step['typology'] === 'Course') {
        $course_steps = opigno_learning_path_get_steps($step['id'], $uid, $onlyCM, $latest_cert_date);

        // We also need set last step.
        $last_course_step = end($course_steps);

        // Save parent course and position.
        $course_steps = array_map(function ($course_step, $key) use ($step, $last_course_step) {
          $course_step['parent'] = $step;
          $course_step['position'] = $key;
          $course_step['is last child'] = $course_step['cid'] === $last_course_step['cid'];
          return $course_step;
        }, $course_steps, array_keys($course_steps));
        $steps = array_merge($steps, $course_steps);
      }
      else {
        $steps[] = $step;
      }
    });
    return $steps;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
LearningPathContent::$entityId	private	property
LearningPathContent::$entityType	private	property
LearningPathContent::$imageAlt	private	property
LearningPathContent::$imageUrl	private	property
LearningPathContent::$learningPathContentTypeId	private	property
LearningPathContent::$title	private	property
LearningPathContent::getAllStepsOnlyModules	public static	function	Function for getting group steps without courses, only modules.
LearningPathContent::getClassGroups	public static	function	Returns Class parent groups ids.
LearningPathContent::getEntityId	public	function	Returns entity ID.
LearningPathContent::getEntityType	public	function	Returns entity type.
LearningPathContent::getGroupMembershipIdsByType	public static	function	Returns Group memberships by types.
LearningPathContent::getGroupMembershipTimestamp	public static	function	Returns Group membership created timestamp.
LearningPathContent::getImageAlt	public	function	Returns image alt.
LearningPathContent::getImageUrl	public	function	Returns image url.
LearningPathContent::getLearningPathContentTypeId	public	function	Returns LP content type ID.
LearningPathContent::getTitle	public	function	Returns entity title.
LearningPathContent::setEntityId	public	function	Sets entity ID.
LearningPathContent::setEntityType	public	function	Sets entity type.
LearningPathContent::setImageAlt	public	function	Sets image alt.
LearningPathContent::setImageUrl	public	function	Sets image url.
LearningPathContent::setLearningPathContentTypeId	public	function	Sets LP content type ID.
LearningPathContent::setTitle	public	function	Sets entity title.
LearningPathContent::toManagerArray	public	function	Returns LP content properties array to manager.
LearningPathContent::__construct	public	function	LearningPathContent constructor.
LearningPathContent::__toString	public	function