class OpignoScormPlayer in Opigno SCORM 8

Class OpignoScormPlayer.

Hierarchy

• class \Drupal\opigno_scorm\OpignoScormPlayer

1 string reference to 'OpignoScormPlayer'

opigno_scorm.services.yml in ./opigno_scorm.services.yml

opigno_scorm.services.yml

1 service uses OpignoScormPlayer

opigno_scorm.scorm_player in ./opigno_scorm.services.yml

Drupal\opigno_scorm\OpignoScormPlayer

File

src/OpignoScormPlayer.php, line 10

Namespace

Drupal\opigno_scorm

class OpignoScormPlayer {
  protected $database;
  protected $scorm_service;

  /**
   * OpignoScormPlayer constructor.
   */
  public function __construct(Connection $database, OpignoScorm $scorm_service) {
    $this->database = $database;
    $this->scorm_service = $scorm_service;
  }

  /**
   * Build rendarable array for scorm package output.
   */
  public function toRendarableArray($scorm) {
    $account = \Drupal::currentUser();

    // Get SCORM API version.
    $metadata = unserialize($scorm->metadata);
    if (strpos($metadata['schemaversion'], '1.2') !== FALSE) {
      $scorm_version = '1.2';
    }
    else {
      $scorm_version = '2004';
    }

    // Get the SCO tree.
    $tree = $this
      ->opignoScormPlayerScormTree($scorm);
    $flat_tree = $this
      ->opignoScormPlayerFlattenTree($tree);

    // Get the start SCO.
    $start_sco = $this
      ->opignoScormPlayerStartSco($flat_tree);

    /* @todo Replace with custom event subscriber implementation. */

    // Get implemented CMI paths.
    $paths = opigno_scorm_add_cmi_paths($scorm_version);

    // Get CMI data for each SCO.
    $data = opigno_scorm_add_cmi_data($scorm, $flat_tree, $scorm_version);
    $sco_identifiers = [];
    $scos_suspend_data = [];
    foreach ($flat_tree as $sco) {
      if ($sco->scorm_type == 'sco') {
        $sco_identifiers[$sco->identifier] = $sco->id;
        $scos_suspend_data[$sco->id] = opigno_scorm_scorm_cmi_get($account
          ->id(), $scorm->id, 'cmi.suspend_data.' . $sco->id, '');
      }
    }
    $last_user_sco = opigno_scorm_scorm_cmi_get($account
      ->id(), $scorm->id, 'user.sco', '');
    if ($last_user_sco != '') {
      foreach ($flat_tree as $sco) {
        if ($last_user_sco == $sco->id && !empty($sco->launch)) {
          $start_sco = $sco;
        }
      }
    }

    // Add base path for player link.
    global $base_path;
    $start_sco->base_path = $base_path;
    return [
      '#theme' => 'opigno_scorm__player',
      '#scorm_id' => $scorm->id,
      '#tree' => count($flat_tree) == 2 ? NULL : $tree,
      '#start_sco' => $start_sco,
      '#attached' => [
        'library' => [
          'opigno_scorm/opigno-scorm-player',
        ],
        'drupalSettings' => [
          'opignoScormUIPlayer' => [
            'cmiPaths' => $paths,
            'cmiData' => $data,
            'scoIdentifiers' => $sco_identifiers,
            'cmiSuspendItems' => $scos_suspend_data,
          ],
          'scormVersion' => $scorm_version,
        ],
      ],
      '#cache' => [
        'max-age' => 0,
      ],
    ];
  }

  /**
   * Traverse the SCORM package data and construct a SCO tree.
   *
   * @param object $scorm
   *   Scorm object.
   * @param int $parent_identifier
   *   Parent identifier.
   *
   * @return array
   *   SCO tree.
   */
  private function opignoScormPlayerScormTree($scorm, $parent_identifier = 0) {
    $conenction = $this->database;
    $tree = [];
    $result = $conenction
      ->select('opigno_scorm_package_scos', 'sco')
      ->fields('sco', [
      'id',
    ])
      ->condition('sco.scorm_id', $scorm->id)
      ->condition('sco.parent_identifier', $parent_identifier)
      ->execute();
    while ($sco_id = $result
      ->fetchField()) {
      $sco = $this->scorm_service
        ->scormLoadSco($sco_id);
      $children = $this
        ->opignoScormPlayerScormTree($scorm, $sco->identifier);
      $sco->children = $children;
      $tree[] = $sco;
    }
    return $tree;
  }

  /**
   * Helper function to flatten the SCORM tree.
   *
   * @param array $tree
   *   Tree.
   *
   * @return array
   *   SCORM tree.
   */
  private function opignoScormPlayerFlattenTree(array $tree) {
    $items = [];
    if (!empty($tree)) {
      foreach ($tree as $sco) {
        $items[] = $sco;
        if (!empty($sco->children)) {
          $items = array_merge($items, $this
            ->opignoScormPlayerFlattenTree($sco->children));
        }
      }
    }
    return $items;
  }

  /**
   * Determine the start SCO for the SCORM package.
   *
   * @todo Get last viewed SCO.
   *
   * @param array $flat_tree
   *   Flat tree.
   *
   * @return object
   *   Start SCO.
   */
  private function opignoScormPlayerStartSco(array $flat_tree) {
    foreach ($flat_tree as $sco) {
      if (!empty($sco->launch)) {
        return $sco;
      }
    }

    // Failsafe. Just get the first element.
    return array_shift($flat_tree);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
OpignoScormPlayer::$database	protected	property
OpignoScormPlayer::$scorm_service	protected	property
OpignoScormPlayer::opignoScormPlayerFlattenTree	private	function	Helper function to flatten the SCORM tree.
OpignoScormPlayer::opignoScormPlayerScormTree	private	function	Traverse the SCORM package data and construct a SCO tree.
OpignoScormPlayer::opignoScormPlayerStartSco	private	function	Determine the start SCO for the SCORM package.
OpignoScormPlayer::toRendarableArray	public	function	Build rendarable array for scorm package output.
OpignoScormPlayer::__construct	public	function	OpignoScormPlayer constructor.