Merge 556c22d into bff03c0

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+github: mlocati
+custom: "https://paypal.me/mlocati"

.travis.yml

@@ -2,16 +2,13 @@ sudo: true
 
 language: php
 
+branches:
+  only:
+  - master
+
 env:
   - COMPOSER_DISABLE_XDEBUG_WARN=1
 
-php:
-  - 5.3
-  - 5.4
-  - 5.5
-  - 5.6
-  - 7.0
-  - hhvm
 
 before_script:
   - sudo apt-get -qq update
@@ -24,6 +21,35 @@ script:
   - mkdir -p build/logs
   - ./vendor/bin/phpunit --coverage-clover build/logs/clover.xml
 
+matrix:
+  fast_finish: true
+  allow_failures:
+  - name: Test with PHP Nightly
+  include:
+  - name: Test with PHP 5.3
+    dist: precise
+    php: '5.3'
+  - name: Test with PHP 5.4
+    dist: trusty
+    php: '5.4'
+  - name: Test with PHP 5.5
+    dist: trusty
+    php: '5.5'
+  - name: Test with PHP 5.6
+    php: '5.6'
+  - name: Test with PHP 7.0
+    php: '7.0'
+  - name: Test with PHP 7.1
+    php: '7.1'
+  - name: Test with PHP 7.2
+    php: '7.2'
+  - name: Test with PHP 7.3
+    php: '7.3'
+  - name: Test with PHP 7.4
+    php: '7.4'
+  - name: Test with PHP Nightly
+    php: nightly
+
 cache:
   directories:
     - vendor

README.md

@@ -115,3 +115,9 @@ $toc->resolve($map);
 // Now the TOC of the main CHM file contains references to the entries in the other two CHM files 
 printTree($toc, 0);
 ```
+
+
+
+## Do you want to really say thank you?
+
+You can offer me a [monthly coffee](https://github.com/sponsors/mlocati) or a [one-time coffee](https://paypal.me/mlocati) :wink:

composer.json

@@ -27,5 +27,15 @@
     },
     "require": {
         "php": ">=5.3.3"
-    }
+    },
+    "funding": [
+        {
+            "type": "github",
+            "url": "https://github.com/sponsors/mlocati"
+        },
+        {
+            "type": "other",
+            "url": "https://www.paypal.me/mlocati"
+        }
+    ]
 }

src/CHM.php

@@ -16,58 +16,58 @@ class CHM
     /**
      * The reader that provides the data.
      *
-     * @var Reader
+     * @var \CHMLib\Reader\Reader
      */
     protected $reader;
 
     /**
      * The CHM initial header.
      *
-     * @var Header\ITSF
+     * @var \CHMLib\Header\ITSF
      */
     protected $itsf;
 
     /**
      * The directory listing header.
      *
-     * @var Header\ITSP
+     * @var \CHMLib\Header\ITSP
      */
     protected $itsp;
 
     /**
      * The entries found in this CHM.
      *
-     * @var Entry[]
+     * @var \CHMLib\Entry[]
      */
     protected $entries;
 
     /**
      * The data sections.
      *
-     * @var Section\Section[]
+     * @var \CHMLib\Section\Section[]
      */
     protected $sections;
 
     /**
      * The TOC.
      *
-     * @var TOCIndex\Tree|null|false
+     * @var \CHMLib\TOCIndex\Tree|null|false
      */
     protected $toc;
 
     /**
      * The index.
      *
-     * @var TOCIndex\Tree|null|false
+     * @var \CHMLib\TOCIndex\Tree|null|false
      */
     protected $index;
 
     /**
      * Initializes the instance.
      *
-     * @param Reader $reader The reader that provides the data.
+     * @param \CHMLib\Reader\Reader $reader The reader that provides the data.
      *
-     * @throws Exception Throws an Exception in case of errors.
+     * @throws \Exception Throws an Exception in case of errors.
      */
     public function __construct(Reader $reader)
     {
@@ -128,7 +128,7 @@ public static function fromFile($filename)
     /**
      * Get the reader that provides the data.
      *
-     * @return Reader
+     * @return \CHMLib\Reader\Reader
      */
     public function getReader()
     {
@@ -138,7 +138,7 @@ public function getReader()
     /**
      * Get the CHM initial header.
      *
-     * @return Header\ITSF
+     * @return \CHMLib\Header\ITSF
      */
     public function getITSF()
     {
@@ -148,7 +148,7 @@ public function getITSF()
     /**
      * Get the directory listing header.
      *
-     * @return Header\ITSP
+     * @return \CHMLib\Header\ITSP
      */
     public function getITSP()
     {
@@ -160,7 +160,7 @@ public function getITSP()
      *
      * @param string $path The full path (case sensitive) of the entry to look for.
      *
-     * @return Entry|null
+     * @return \CHMLib\Entry|null
      */
     public function getEntryByPath($path)
     {
@@ -192,7 +192,7 @@ public function getEntries($type = null)
      *
      * @param int $i
      *
-     * @return Section\Section|null
+     * @return \CHMLib\Section\Section|null
      */
     public function getSectionByIndex($i)
     {
@@ -202,9 +202,9 @@ public function getSectionByIndex($i)
     /**
      * Retrieve the list of the entries contained in this CHM.
      *
-     * @throws Exception Throws an Exception in case of errors.
+     * @throws \Exception Throws an Exception in case of errors.
      *
-     * @return Entry[]
+     * @return \CHMLib\Entry[]
      */
     protected function retrieveEntryList()
     {
@@ -221,7 +221,7 @@ protected function retrieveEntryList()
                     throw $x;
                 }
                 $this->reader->setPosition($offset);
-                $pmgi = new Header\PMGI($this->reader);
+                new Header\PMGI($this->reader);
                 $pmgl = null;
             }
             if ($pmgl !== null) {
@@ -242,7 +242,7 @@ protected function retrieveEntryList()
     /**
      * Retrieve the list of the data sections contained in this CHM.
      *
-     * @throws Exception Throws an Exception in case of errors.
+     * @throws \Exception Throws an Exception in case of errors.
      */
     protected function retrieveSectionList()
     {
@@ -285,7 +285,7 @@ protected function retrieveSectionList()
     /**
      * Get the TOC of this CHM file (if available).
      *
-     * @return SpecialEntry\TOC|null
+     * @return \CHMLib\TOCIndex\Tree|null
      */
     public function getTOC()
     {
@@ -306,7 +306,7 @@ public function getTOC()
     /**
      * Get the index of this CHM file (if available).
      *
-     * @return TOCIndex\Tree|null
+     * @return \CHMLib\TOCIndex\Tree|null
      */
     public function getIndex()
     {

src/Entry.php

@@ -67,7 +67,7 @@ public static function setContentCacheEnabled($enabled)
     /**
      * The parent CHM file.
      *
-     * @var CHM
+     * @var \CHMLib\CHM
      */
     protected $chm;
 
@@ -116,7 +116,7 @@ public static function setContentCacheEnabled($enabled)
     /**
      * Initializes the instance.
      *
-     * @param CHM $chm The parent CHM file.
+     * @param \CHMLib\CHM $chm The parent CHM file.
      */
     public function __construct(CHM $chm)
     {
@@ -145,7 +145,7 @@ public function __construct(CHM $chm)
     /**
      * Get the parent CHM file.
      *
-     * @return CHM
+     * @return \CHMLib\CHM
      */
     public function getCHM()
     {
@@ -245,7 +245,7 @@ public function getType()
     /**
      * Get the contents of this entry.
      *
-     * @throws Exception Throws an Exception in case of errors.
+     * @throws \Exception Throws an Exception in case of errors.
      *
      * @return string
      */

src/Header/ITSF.php

@@ -22,7 +22,7 @@ class ITSF extends VersionedHeader
     /**
      * The language of the OS at the time of compilation.
      *
-     * @var Language
+     * @var \CHMLib\Windows\Language
      */
     protected $originalOSLanguage;
 
@@ -80,8 +80,8 @@ class ITSF extends VersionedHeader
      *
      * @param Reader $reader The reader that provides the data.
      *
-     * @throws UnexpectedHeaderException Throws an UnexpectedHeaderException if the header signature is not valid.
-     * @throws Exception Throws an Exception in case of errors.
+     * @throws \CHMLib\Exception\UnexpectedHeaderException Throws an UnexpectedHeaderException if the header signature is not valid.
+     * @throws \Exception Throws an Exception in case of errors.
      */
     public function __construct(Reader $reader)
     {
@@ -121,7 +121,7 @@ public function getTimestamp()
     /**
      * Get the language of the OS at the time of compilation.
      *
-     * @return Language
+     * @return \CHMLib\Windows\Language
      */
     public function getOriginalOSLanguage()
     {

src/Header/ITSP.php

@@ -66,7 +66,7 @@ class ITSP extends VersionedHeader
     /**
      * The language of the program that generated the CHM file.
      *
-     * @var Language
+     * @var \CHMLib\Windows\Language
      */
     protected $generatorLanguage;
 
@@ -82,8 +82,8 @@ class ITSP extends VersionedHeader
      *
      * @param Reader $reader The reader that provides the data.
      *
-     * @throws UnexpectedHeaderException Throws an UnexpectedHeaderException if the header signature is not valid.
-     * @throws Exception Throws an Exception in case of errors.
+     * @throws \CHMLib\Exception\UnexpectedHeaderException Throws an UnexpectedHeaderException if the header signature is not valid.
+     * @throws \Exception Throws an Exception in case of errors.
      */
     public function __construct(Reader $reader)
     {
@@ -186,7 +186,7 @@ public function getNumberOfDirectoryChunks()
     /**
      * Get the language of the program that generated the CHM file.
      *
-     * @return Language
+     * @return \CHMLib\Windows\Language
      */
     public function getGeneratorLanguage()
     {

src/Header/LZXC.php

@@ -42,10 +42,10 @@ class LZXC extends Header
     /**
      * Initializes the instance.
      *
-     * @param Reader $reader The reader that provides the data.
+     * @param \CHMLib\Reader\Reader $reader The reader that provides the data.
      *
-     * @throws UnexpectedHeaderException Throws an UnexpectedHeaderException if the header signature is not valid.
-     * @throws Exception Throws an Exception in case of errors.
+     * @throws \CHMLib\Exception\UnexpectedHeaderException Throws an UnexpectedHeaderException if the header signature is not valid.
+     * @throws \Exception Throws an Exception in case of errors.
      */
     public function __construct(Reader $reader)
     {

src/Header/PMGI.php

@@ -23,8 +23,8 @@ class PMGI extends Header
      *
      * @param Reader $reader The reader that provides the data.
      *
-     * @throws UnexpectedHeaderException Throws an UnexpectedHeaderException if the header signature is not valid.
-     * @throws Exception Throws an Exception in case of errors.
+     * @throws \CHMLib\Exception\UnexpectedHeaderException Throws an UnexpectedHeaderException if the header signature is not valid.
+     * @throws \Exception Throws an Exception in case of errors.
      */
     public function __construct(Reader $reader)
     {

src/Header/PMGL.php

@@ -35,10 +35,10 @@ class PMGL extends Header
     /**
      * Initializes the instance.
      *
-     * @param Reader $reader The reader that provides the data.
+     * @param \CHMLib\Reader\Reader $reader The reader that provides the data.
      *
-     * @throws UnexpectedHeaderException Throws an UnexpectedHeaderException if the header signature is not valid.
-     * @throws Exception Throws an Exception in case of errors.
+     * @throws \CHMLib\Exception\UnexpectedHeaderException Throws an UnexpectedHeaderException if the header signature is not valid.
+     * @throws \Exception Throws an Exception in case of errors.
      */
     public function __construct(Reader $reader)
     {

src/Header/VersionedHeader.php

@@ -26,7 +26,7 @@ abstract class VersionedHeader extends Header
     /**
      * Initializes the instance.
      *
-     * @param Reader $reader The reader that provides the data.
+     * @param \CHMLib\Reader\Reader $reader The reader that provides the data.
      *
      * @throws \Exception Throws an Exception in case of errors.
      */