README

Allows your composer projects to easily install arbitrary platform dependent packages (such as binaries) from remote URLs to custom folder locations (i.e. outside of the vendor folder).

To use, simply require steveorevo/platform-installer in your project and fillout the "extras" section with a platform-install definition. This can contain a list of platforms to be matched by string. The string (case-insensitive) will be checked if it matches your system's os platform (apart of the php_uname() function call return value). To match all platforms, simply use the string 'all'. You can specify a microprocessor architecture by appending an underscore and numeric i.e. 'darwin_64' to only match Macintosh systems with 64-bit architecture or 'win_32' for Windows 32-bit systems only.

Other values could be 'win' for all Windows based systems, 'linux', 'raspberrypi', 'cygwin', 'sunos', 'armv71', etc. Following the platform string should be an array of objects containing URLs to zip or tar archives to be downloaded and directories to uncompress the contents to (relative to the composer.json file). If the path does not already exist, it will be created. An example composer.json might look like:

{
  "require": {
    "steveorevo/platform-installer": "1.*"
  },
  "extra": {
    "platform-installer": {
      "darwin_64": [
        { 
          "url": "http://domain/folder/mac-package.zip", 
          "dir": "platform/mac" 
        }
      ],
      "win_32": [
        { 
          "url": "http://domain/folder/win-package.zip", 
          "dir": "platform/win32" 
        }
      ],
      "linux": [
        { 
          "url": "http://domain/folder/linux-package.zip", 
          "dir": "platform/linux" 
        }
      ]
    }
  }
}

If a target directory (dir) is not included, it will be placed withn the vendor/steveorevo/platform folder root. Existing folders will not be updated; to update a given platform installer you must remove it. It should be noted that URLs are cached (use composer clear-cache to force redownload). In most cases, this shouldn't matter as version updates dictate a new unique URL (i.e. gitlab.com, etc.).