added phpstan on level 0

.travis.yml

@@ -23,10 +23,15 @@ matrix:
     - php: 5.6
     - php: 7.0
     - php: 7.1
+      env: PHPSTAN=1
     - php: 7.2
+      env: PHPSTAN=1
     - php: 7.3
+      env: PHPSTAN=1
     - php: 7.3
-      env: deps=high
+      env:
+        - deps=high
+        - PHPSTAN=1
     - php: nightly
   fast_finish: true
   allow_failures:
@@ -58,6 +63,13 @@ before_script:
 script:
   # run test suite directories in parallel using GNU parallel
   - ls -d tests/Composer/Test/* | grep -v TestCase.php | parallel --gnu --keep-order 'echo "Running {} tests"; ./vendor/bin/phpunit -c tests/complete.phpunit.xml --colors=always {} || (echo -e "\e[41mFAILED\e[0m {}" && exit 1);'
+  # Run PHPStan
+  - if [[ $PHPSTAN == "1" ]]; then
+      yes | pecl install imagick &&
+      (yes | pecl install rar || true) &&
+      composer require --dev phpstan/phpstan-shim:^0.11 --ignore-platform-reqs &&
+      vendor/bin/phpstan.phar analyse src --configuration=phpstan/config.neon --autoload-file=phpstan/autoload.php;
+    fi
 
 before_deploy:
   - php -d phar.readonly=0 bin/compile

phpstan/autoload.php

@@ -0,0 +1,13 @@
+<?php
+
+require_once __DIR__ . '/../vendor/autoload.php';
+
+if (!extension_loaded('apcu')) {
+    require_once __DIR__ . '/stubs/apcu.php';
+}
+
+if (!extension_loaded('rar')) {
+    require_once __DIR__ . '/stubs/rar.php';
+}
+
+require_once __DIR__ . '/../src/bootstrap.php';

phpstan/config.neon

@@ -0,0 +1,24 @@
+parameters:
+    level: 0
+    excludes_analyse:
+        - ../../../../src/Composer/Package/LinkConstraint/EmptyConstraint.php
+        - ../../../../src/Composer/Package/LinkConstraint/LinkConstraintInterface.php
+        - ../../../../src/Composer/Package/LinkConstraint/MultiConstraint.php
+        - ../../../../src/Composer/Package/LinkConstraint/SpecificConstraint.php
+        - ../../../../src/Composer/Package/LinkConstraint/VersionConstraint.php
+        - ../../../../src/Composer/Util/SpdxLicense.php
+        - ../../../../src/Composer/XdebugHandler.php
+    ignoreErrors:
+        # unused parameters
+        - '~^Constructor of class Composer\\Repository\\VcsRepository has an unused parameter \$dispatcher\.$~'
+        - '~^Constructor of class Composer\\Repository\\PearRepository has an unused parameter \$dispatcher\.$~'
+
+        # ion cube cannot be installed on travis and stubs not found
+        - '~^Function ioncube_loader_\w+ not found\.$~'
+
+        # variables from global scope
+        - '~^Undefined variable: \$vendorDir$~'
+        - '~^Undefined variable: \$baseDir$~'
+
+        # always checked whether the class exists
+        - '~^Instantiated class Symfony\\Component\\Console\\Terminal not found\.$~'

phpstan/stubs/apcu.php

@@ -0,0 +1,321 @@
+<?php
+
+/**
+ * Stubs for APCu 5.0.0
+ *
+ * @source https://github.com/JetBrains/phpstorm-stubs/blob/master/apcu/apcu.php
+ */
+
+/**
+ * @link https://php.net/manual/en/apcu.constants.php
+ */
+define('APC_LIST_ACTIVE', 1);
+/**
+ * @link https://php.net/manual/en/apcu.constants.php
+ */
+define('APC_LIST_DELETED', 2);
+/**
+ * @link https://php.net/manual/en/apcu.constants.php
+ */
+define('APC_ITER_TYPE', 1);
+/**
+ * @link https://php.net/manual/en/apcu.constants.php
+ */
+define('APC_ITER_KEY', 2);
+/**
+ * @link https://php.net/manual/en/apcu.constants.php
+ */
+define('APC_ITER_FILENAME', 4);
+/**
+ * @link https://php.net/manual/en/apcu.constants.php
+ */
+define('APC_ITER_DEVICE', 8);
+/**
+ * @link https://php.net/manual/en/apcu.constants.php
+ */
+define('APC_ITER_INODE', 16);
+/**
+ * @link https://php.net/manual/en/apcu.constants.php
+ */
+define('APC_ITER_VALUE', 32);
+/**
+ * @link https://php.net/manual/en/apcu.constants.php
+ */
+define('APC_ITER_MD5', 64);
+/**
+ * @link https://php.net/manual/en/apcu.constants.php
+ */
+define('APC_ITER_NUM_HITS', 128);
+/**
+ * @link https://php.net/manual/en/apcu.constants.php
+ */
+define('APC_ITER_MTIME', 256);
+/**
+ * @link https://php.net/manual/en/apcu.constants.php
+ */
+define('APC_ITER_CTIME', 512);
+/**
+ * @link https://php.net/manual/en/apcu.constants.php
+ */
+define('APC_ITER_DTIME', 1024);
+/**
+ * @link https://php.net/manual/en/apcu.constants.php
+ */
+define('APC_ITER_ATIME', 2048);
+/**
+ * @link https://php.net/manual/en/apcu.constants.php
+ */
+define('APC_ITER_REFCOUNT', 4096);
+/**
+ * @link https://php.net/manual/en/apcu.constants.php
+ */
+define('APC_ITER_MEM_SIZE', 8192);
+/**
+ * @link https://php.net/manual/en/apcu.constants.php
+ */
+define('APC_ITER_TTL', 16384);
+/**
+ * @link https://php.net/manual/en/apcu.constants.php
+ */
+define('APC_ITER_NONE', 0);
+/**
+ * @link https://php.net/manual/en/apcu.constants.php
+ */
+define('APC_ITER_ALL', -1);
+
+
+/**
+ * Clears the APCu cache
+ * @link https://php.net/manual/en/function.apcu-clear-cache.php
+ *
+ * @return bool Returns TRUE always.
+ */
+function apcu_clear_cache(){}
+
+/**
+ * Retrieves APCu Shared Memory Allocation information
+ * @link https://php.net/manual/en/function.apcu-sma-info.php
+ * @param bool $limited When set to FALSE (default) apcu_sma_info() will
+ * return a detailed information about each segment.
+ *
+ * @return array|bool Array of Shared Memory Allocation data; FALSE on failure.
+ */
+function apcu_sma_info($limited = false){}
+
+/**
+ * Cache a variable in the data store
+ * @link https://php.net/manual/en/function.apcu-store.php
+ * @param string|array $key String: Store the variable using this name. Keys are cache-unique,
+ * so storing a second value with the same key will overwrite the original value.
+ * Array: Names in key, variables in value.
+ * @param mixed $var [optional] The variable to store
+ * @param int $ttl [optional]  Time To Live; store var in the cache for ttl seconds. After the ttl has passed,
+ * the stored variable will be expunged from the cache (on the next request). If no ttl is supplied
+ * (or if the ttl is 0), the value will persist until it is removed from the cache manually,
+ * or otherwise fails to exist in the cache (clear, restart, etc.).
+ * @return bool|array Returns TRUE on success or FALSE on failure | array with error keys.
+ */
+function apcu_store($key, $var, $ttl = 0){}
+
+/**
+ * Fetch a stored variable from the cache
+ * @link https://php.net/manual/en/function.apcu-fetch.php
+ * @param string|string[] $key The key used to store the value (with apcu_store()).
+ * If an array is passed then each element is fetched and returned.
+ * @param bool $success Set to TRUE in success and FALSE in failure.
+ * @return mixed The stored variable or array of variables on success; FALSE on failure.
+ */
+function apcu_fetch($key, &$success = null){}
+
+/**
+ * Removes a stored variable from the cache
+ * @link https://php.net/manual/en/function.apcu-delete.php
+ * @param string|string[]|APCUIterator $key The key used to store the value (with apcu_store()).
+ * @return bool|string[] Returns TRUE on success or FALSE on failure. For array of keys returns list of failed keys.
+ */
+function apcu_delete($key){}
+
+/**
+ * Caches a variable in the data store, only if it's not already stored
+ * @link https://php.net/manual/en/function.apcu-add.php
+ * @param string|array $key Store the variable using this name. Keys are cache-unique,
+ * so attempting to use apcu_add() to store data with a key that already exists will not
+ * overwrite the existing data, and will instead return FALSE. (This is the only difference
+ * between apcu_add() and apcu_store().)
+ * Array: Names in key, variables in value.
+ * @param mixed $var The variable to store
+ * @param int $ttl Time To Live; store var in the cache for ttl seconds. After the ttl has passed,
+ * the stored variable will be expunged from the cache (on the next request). If no ttl is supplied
+ * (or if the ttl is 0), the value will persist until it is removed from the cache manually,
+ * or otherwise fails to exist in the cache (clear, restart, etc.).
+ * @return bool|array Returns TRUE if something has effectively been added into the cache, FALSE otherwise.
+ * Second syntax returns array with error keys.
+ */
+function apcu_add($key, $var, $ttl = 0){}
+
+/**
+ * Checks if APCu key exists
+ * @link https://php.net/manual/en/function.apcu-exists.php
+ * @param string|string[] $keys A string, or an array of strings, that contain keys.
+ * @return bool|string[] Returns TRUE if the key exists, otherwise FALSE
+ * Or if an array was passed to keys, then an array is returned that
+ * contains all existing keys, or an empty array if none exist.
+ */
+function apcu_exists($keys){}
+
+/**
+ * Increase a stored number
+ * @link https://php.net/manual/en/function.apcu-inc.php
+ * @param string $key The key of the value being increased.
+ * @param int $step The step, or value to increase.
+ * @param bool $success Optionally pass the success or fail boolean value to this referenced variable.
+ * @return int|bool Returns the current value of key's value on success, or FALSE on failure.
+ */
+function apcu_inc($key, $step = 1, &$success = null){}
+
+/**
+ * Decrease a stored number
+ * @link https://php.net/manual/en/function.apcu-dec.php
+ * @param string $key The key of the value being decreased.
+ * @param int $step The step, or value to decrease.
+ * @param bool $success Optionally pass the success or fail boolean value to this referenced variable.
+ * @return int|bool Returns the current value of key's value on success, or FALSE on failure.
+ */
+function apcu_dec($key, $step = 1, &$success = null){}
+
+/**
+ * Updates an old value with a new value
+ *
+ * apcu_cas() updates an already existing integer value if the old parameter matches the currently stored value
+ * with the value of the new parameter.
+ *
+ * @link https://php.net/manual/en/function.apcu-cas.php
+ * @param string $key The key of the value being updated.
+ * @param int $old The old value (the value currently stored).
+ * @param int $new The new value to update to.
+ * @return bool Returns TRUE on success or FALSE on failure.
+ */
+function apcu_cas($key, $old, $new){}
+
+/**
+ * Atomically fetch or generate a cache entry
+ *
+ * <p>Atomically attempts to find key in the cache, if it cannot be found generator is called,
+ * passing key as the only argument. The return value of the call is then cached with the optionally
+ * specified ttl, and returned.
+ * </p>
+ *
+ * <p>Note: When control enters <i>apcu_entry()</i> the lock for the cache is acquired exclusively, it is released when
+ * control leaves apcu_entry(): In effect, this turns the body of generator into a critical section,
+ * disallowing two processes from executing the same code paths concurrently.
+ * In addition, it prohibits the concurrent execution of any other APCu functions,
+ * since they will acquire the same lock.
+ * </p>
+ *
+ * @link https://php.net/manual/en/function.apcu-entry.php
+ *
+ * @param string $key Identity of cache entry
+ * @param callable $generator A callable that accepts key as the only argument and returns the value to cache.
+ * <p>Warning
+ * The only APCu function that can be called safely by generator is apcu_entry().</p>
+ * @param int $ttl [optional] Time To Live; store var in the cache for ttl seconds.
+ * After the ttl has passed, the stored variable will be expunged from the cache (on the next request).
+ * If no ttl is supplied (or if the ttl is 0), the value will persist until it is removed from the cache manually,
+ * or otherwise fails to exist in the cache (clear, restart, etc.).
+ * @return mixed Returns the cached value
+ * @since APCu 5.1.0
+ */
+function apcu_entry($key, callable $generator, $ttl = 0){}
+
+/**
+ * Retrieves cached information from APCu's data store
+ *
+ * @link https://php.net/manual/en/function.apcu-cache-info.php
+ *
+ * @param bool $limited If limited is TRUE, the return value will exclude the individual list of cache entries.
+ * This is useful when trying to optimize calls for statistics gathering.
+ * @return array|bool Array of cached data (and meta-data) or FALSE on failure
+ */
+function apcu_cache_info($limited = false){}
+
+/**
+ * The APCUIterator class
+ *
+ * The APCUIterator class makes it easier to iterate over large APCu caches.
+ * This is helpful as it allows iterating over large caches in steps, while grabbing a defined number
+ * of entries per lock instance, so it frees the cache locks for other activities rather than hold up
+ * the entire cache to grab 100 (the default) entries. Also, using regular expression matching is more
+ * efficient as it's been moved to the C level.
+ *
+ * @link https://php.net/manual/en/class.apcuiterator.php
+ * @since APCu 5.0.0
+ */
+class APCUIterator implements Iterator
+{
+    /**
+     * Constructs an APCUIterator iterator object
+     * @link https://php.net/manual/en/apcuiterator.construct.php
+     * @param string|string[]|null $search A PCRE regular expression that matches against APCu key names,
+     * either as a string for a single regular expression, or as an array of regular expressions.
+     * Or, optionally pass in NULL to skip the search.
+     * @param int $format The desired format, as configured with one ore more of the APC_ITER_* constants.
+     * @param int $chunk_size The chunk size. Must be a value greater than 0. The default value is 100.
+     * @param int $list The type to list. Either pass in APC_LIST_ACTIVE  or APC_LIST_DELETED.
+     */
+    public function __construct($search = null, $format = APC_ITER_ALL, $chunk_size = 100, $list = APC_LIST_ACTIVE){}
+
+    /**
+     * Rewinds back the iterator to the first element
+     * @link https://php.net/manual/en/apcuiterator.rewind.php
+     */
+    public function rewind(){}
+
+    /**
+     * Checks if the current iterator position is valid
+     * @link https://php.net/manual/en/apcuiterator.valid.php
+     * @return bool Returns TRUE if the current iterator position is valid, otherwise FALSE.
+     */
+    public function valid(){}
+
+    /**
+     * Gets the current item from the APCUIterator stack
+     * @link https://php.net/manual/en/apcuiterator.current.php
+     * @return mixed Returns the current item on success, or FALSE if no more items or exist, or on failure.
+     */
+    public function current(){}
+
+    /**
+     * Gets the current iterator key
+     * @link https://php.net/manual/en/apcuiterator.key.php
+     * @return string|int|bool Returns the key on success, or FALSE upon failure.
+     */
+    public function key(){}
+
+    /**
+     * Moves the iterator pointer to the next element
+     * @link https://php.net/manual/en/apcuiterator.next.php
+     * @return bool Returns TRUE on success or FALSE on failure.
+     */
+    public function next(){}
+
+    /**
+     * Gets the total number of cache hits
+     * @link https://php.net/manual/en/apcuiterator.gettotalhits.php
+     * @return int|bool The number of hits on success, or FALSE on failure.
+     */
+    public function getTotalHits(){}
+
+    /**
+     * Gets the total cache size
+     * @link https://php.net/manual/en/apcuiterator.gettotalsize.php
+     * @return int|bool The total cache size.
+     */
+    public function getTotalSize(){}
+
+    /**
+     * Get the total count
+     * @link https://php.net/manual/en/apcuiterator.gettotalcount.php
+     * @return int|bool The total count.
+     */
+    public function getTotalCount(){}
+}