Merge pull request #8 from devianl2/revert-7-main

Revert "Improve SCORM disk storage handler"

Author: devianl2

README.md

@@ -32,42 +32,8 @@ php artisan vendor:publish --provider="Peopleaps\Scorm\ScormServiceProvider"
 ```
 
 ## Step 3:
-Run config cache for update cached configuration
-```sh
-php artisan config:cache
-```
-
-## Step 4:
 Migrate file to database
 ```sh
 php artisan migrate
 ```
 
-## Step 5 (Optional):
-update SCORM config under config/scorm
-- update scorm table names.
-- update SCORM disk and configure disk @see config/filesystems.php
-```
-    'disk'  =>  'scorm-local',
-    'disk'  =>  'scorm-s3',
-
- // @see config/filesystems.php
-     'disks' => [
-         .....
-         'scorm-local' => [
-            'driver'     => 'local',
-            'root'       =>  env('SCORM_ROOT_DIR'), // set root dir
-            'visibility' => 'public',
-        ],
-
-        's3-scorm' => [
-            'driver' => 's3',
-            'root'   => env('SCORM_ROOT_DIR'), // set root dir
-            'key'    => env('AWS_ACCESS_KEY_ID'),
-            'secret' => env('AWS_SECRET_ACCESS_KEY'),
-            'region' => env('AWS_DEFAULT_REGION'),
-            'bucket' => env('AWS_SCORM_BUCKET'),
-        ],
-        .....
-     ]
-```

config/scorm.php

@@ -3,25 +3,11 @@
 return [
 
     'table_names' =>  [
-        'user_table'   =>  'users', // user table name on main LMS app.
+        'user_table'   =>  'users',
         'scorm_table'   =>  'scorm',
         'scorm_sco_table'   =>  'scorm_sco',
         'scorm_sco_tracking_table'   =>  'scorm_sco_tracking',
     ],
-    /**
-     * Scorm directory. You may create a custom path in file system
-     * Define Scorm disk under @see config/filesystems.php
-     * 'disk'  =>  'local',
-     * 'disk'  =>  's3-scorm',
-     * ex.
-     * 's3-scorm' => [
-     * 'driver' => 's3',
-     * 'root'   => env('SCORM_ROOT_DIR'),  // define root dir
-     * 'key'    => env('AWS_ACCESS_KEY_ID'),
-     * 'secret' => env('AWS_SECRET_ACCESS_KEY'),
-     * 'region' => env('AWS_DEFAULT_REGION'),
-     * 'bucket' => env('AWS_SCORM_BUCKET'),
-     * ],
-     */
+    // Scorm directory. You may create a custom path in file system
     'disk'  =>  'local',
 ];

database/migrations/create_scorm_tables.php.stub

@@ -97,7 +97,19 @@ class CreateScormTables extends Migration
      */
     public function down()
     {
-        $tableNames = config('scorm.table_names');
+        $tableNames = config('scorm_sco_tracking_table');
+
+        if (empty($tableNames)) {
+            throw new \Exception('Error: Table not found.');
+        }
+
+        $tableNames = config('scorm_sco_table');
+
+        if (empty($tableNames)) {
+            throw new \Exception('Error: Table not found.');
+        }
+
+        $tableNames = config('scorm_table');
 
         if (empty($tableNames)) {
             throw new \Exception('Error: Table not found.');

src/Entity/Scorm.php

@@ -3,16 +3,18 @@
 
 namespace Peopleaps\Scorm\Entity;
 
+
+use Doctrine\Common\Collections\ArrayCollection;
+
 class Scorm
 {
     const SCORM_12 = 'scorm_12';
     const SCORM_2004 = 'scorm_2004';
 
     public $uuid;
     public $id;
-    public $title;
     public $version;
-    public $entryUrl;
+    public $hashName;
     public $ratio = 56.25;
     public $scos;
     public $scoSerializer;
@@ -68,33 +70,17 @@ public function setVersion($version)
     /**
      * @return string
      */
-    public function getTitle()
-    {
-        return $this->title;
-    }
-
-    /**
-     * @param string $title
-     */
-    public function setTitle($title)
-    {
-        $this->title = $title;
-    }
-
-    /**
-     * @return string
-     */
-    public function getEntryUrl()
+    public function getHashName()
     {
-        return $this->entryUrl;
+        return $this->hashName;
     }
 
     /**
-     * @param string $title
+     * @param string $hashName
      */
-    public function setEntryUrl($entryUrl)
+    public function setHashName($hashName)
     {
-        $this->entryUrl = $entryUrl;
+        $this->hashName = $hashName;
     }
 
     /**
@@ -145,8 +131,7 @@ public function serialize(Scorm $scorm)
         return [
             'id' => $scorm->getUuid(),
             'version' => $scorm->getVersion(),
-            'title' => $scorm->getTitle(),
-            'entryUrl' => $scorm->getEntryUrl(),
+            'hashName' => $scorm->getHashName(),
             'ratio' => $scorm->getRatio(),
             'scos' => $this->serializeScos($scorm),
         ];

src/Library/ScormLib.php

@@ -7,7 +7,7 @@
 use DOMDocument;
 use Peopleaps\Scorm\Entity\Sco;
 use Peopleaps\Scorm\Exception\InvalidScormArchiveException;
-use Illuminate\Support\Str;
+use Ramsey\Uuid\Uuid;
 
 class ScormLib
 {
@@ -28,20 +28,16 @@ public function parseOrganizationsNode(DOMDocument $dom)
             $organizations = $organizationsList->item(0);
             $organization = $organizations->firstChild;
 
-            if (
-                !is_null($organizations->attributes)
-                && !is_null($organizations->attributes->getNamedItem('default'))
-            ) {
+            if (!is_null($organizations->attributes)
+                && !is_null($organizations->attributes->getNamedItem('default'))) {
                 $defaultOrganization = $organizations->attributes->getNamedItem('default')->nodeValue;
             } else {
                 $defaultOrganization = null;
             }
             // No default organization is defined
             if (is_null($defaultOrganization)) {
-                while (
-                    !is_null($organization)
-                    && 'organization' !== $organization->nodeName
-                ) {
+                while (!is_null($organization)
+                    && 'organization' !== $organization->nodeName) {
                     $organization = $organization->nextSibling;
                 }
 
@@ -52,12 +48,10 @@ public function parseOrganizationsNode(DOMDocument $dom)
             // A default organization is defined
             // Look for it
             else {
-                while (
-                    !is_null($organization)
+                while (!is_null($organization)
                     && ('organization' !== $organization->nodeName
                         || is_null($organization->attributes->getNamedItem('identifier'))
-                        || $organization->attributes->getNamedItem('identifier')->nodeValue !== $defaultOrganization)
-                ) {
+                        || $organization->attributes->getNamedItem('identifier')->nodeValue !== $defaultOrganization)) {
                     $organization = $organization->nextSibling;
                 }
 
@@ -88,7 +82,7 @@ private function parseItemNodes(\DOMNode $source, \DOMNodeList $resources, Sco $
             if ('item' === $item->nodeName) {
                 $sco = new Sco();
                 $scos[] = $sco;
-                $sco->setUuid(Str::uuid());
+                $sco->setUuid(Uuid::uuid4());
                 $sco->setScoParent($parentSco);
                 $this->findAttrParams($sco, $item, $resources);
                 $this->findNodeParams($sco, $item->firstChild);
@@ -125,7 +119,7 @@ private function parseResourceNodes(\DOMNodeList $resources)
                         throw new InvalidScormArchiveException('sco_resource_without_href_message');
                     }
                     $sco = new Sco();
-                    $sco->setUuid(Str::uuid());
+                    $sco->setUuid(Uuid::uuid4());
                     $sco->setBlock(false);
                     $sco->setVisible(true);
                     $sco->setIdentifier($identifier->nodeValue);
@@ -201,12 +195,10 @@ private function findNodeParams(Sco $sco, \DOMNode $item)
                 case 'adlcp:timeLimitAction':
                     $action = strtolower($item->nodeValue);
 
-                    if (
-                        'exit,message' === $action
+                    if ('exit,message' === $action
                         || 'exit,no message' === $action
                         || 'continue,message' === $action
-                        || 'continue,no message' === $action
-                    ) {
+                        || 'continue,no message' === $action) {
                         $sco->setTimeLimitAction($action);
                     }
                     break;