Merge pull request #18 from atelierdisko/master

Retrieve list of license identifiers and names

src/SpdxLicenses.php

@@ -25,8 +25,8 @@ class SpdxLicenses
      * The array is indexed by license identifiers, which contain
      * a numerically indexed array with license details.
      *
-     *  [ license identifier =>
-     *      [ 0 => full name (string), 1 => osi certified (bool), 2 => deprecated (bool) ]
+     *  [ lowercased license identifier =>
+     *      [ 0 => identifier (string), 1 => full name (string), 2 => osi certified (bool), 3 => deprecated (bool) ]
      *    , ...
      *  ]
      *
@@ -45,8 +45,8 @@ class SpdxLicenses
      * The array is indexed by license exception identifiers, which contain
      * a numerically indexed array with license exception details.
      *
-     *  [ exception identifier =>
-     *      [ 0 => full name (string) ]
+     *  [ lowercased exception identifier =>
+     *      [ 0 => exception identifier (string), 1 => full name (string) ]
      *    , ...
      *  ]
      *
@@ -95,6 +95,16 @@ public function getLicenseByIdentifier($identifier)
         );
     }
 
+    /**
+     * Returns all licenses information, keyed by the lowercased license identifier.
+     *
+     * @return array[] Each item is [ 0 => identifier (string), 1 => full name (string), 2 => osi certified (bool), 3 => deprecated (bool) ]
+     */
+    public function getLicenses()
+    {
+        return $this->licenses;
+    }
+
     /**
      * Returns license exception metadata by license exception identifier.
      *

tests/SpdxLicensesTest.php

@@ -142,6 +142,18 @@ public function testGetLicenseByIdentifier()
         $this->assertNull($licenseNull);
     }
 
+    public function testGetLicenses()
+    {
+        $results = $this->licenses->getLicenses();
+
+        $this->assertArrayHasKey('cc-by-sa-4.0', $results);
+        $this->assertArrayHasKey(0, $results['cc-by-sa-4.0']);
+        $this->assertEquals('CC-BY-SA-4.0', $results['cc-by-sa-4.0'][0]);
+        $this->assertEquals('Creative Commons Attribution Share Alike 4.0', $results['cc-by-sa-4.0'][1]);
+        $this->assertEquals(false, $results['cc-by-sa-4.0'][2]);
+        $this->assertEquals(false, $results['cc-by-sa-4.0'][3]);
+    }
+
     public function testGetExceptionByIdentifier()
     {
         $licenseNull = $this->licenses->getExceptionByIdentifier('Font-exception-2.0-Errorl');