Download the PHP package inphinit/proxy without Composer

On this page you can find all versions of the php package inphinit/proxy. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of inphinit/proxy

Informations about the package proxy

About Inphinit Proxy

Until version 1.x, this project primarily served as a proxy solution for the html2canvas library. Version 2.0 marked a significant expansion, introducing extensive configuration and adaptation options that enable its use for a wide variety of needs and objectives.

Although developed as part of the Inphinit framework, the project operates completely independently. This means you can readily use it with any PHP framework or in a stand-alone application. While the project is modular, consider adopting the Inphinit framework itself for your new projects. For more details: https://inphinit.github.io

Proxies for other scripting languages

You do not use PHP, but need html2canvas working with proxy, see other proxies:

Requirements

  1. PHP 8 (https://www.php.net/supported-versions.php)
    • Minimal PHP 5.4 (backward compatibility is maintained for users with upgrade limitations)
  2. cURL PHP extension to use CurlDriver
  3. allow_url_fopen must be set to 1 on php.ini to use StreamDriver

Installing

You can install via composer:

Then add this to your script or controller:

If you are not using web frameworks, you can download the release from https://github.com/inphinit/inphinit-php-proxy/releases, then extract the contents and move it to the web server and rename the folder, like this (optional):

Configure html2canvas

If you are using a web framework, simply point to the address of the route you configured to use the proxy, for example:

If you have manually downloaded it to use on your server, you can use the proxy.php script, a example:

Setup proxy

Method Description
setMaxDownloadSize(int $value): void Set the maximum allowed download size
getMaxDownloadSize(): int Get the maximum allowed download size
setMaxRedirs(int $value): void Set the maximum number of HTTP redirects
getMaxRedirs(): int Get the maximum number of HTTP redirects
setReferer(string $value): void Set the Referer request header
getReferer(): string Get the Referer request header
setTimeout(int $value): void Set connection timeout
getTimeout(): int Get connection timeout
setUserAgent(string $value): void Set the User-Agent request header
getUserAgent(): string Get the User-Agent request header
setDrivers(array $drivers): void Set drivers used to download the resource
setOptions(string $key, mixed $value): void Set generic options
getOptions([string $key]): mixed Get generic options
setAllowedUrls(array $urls): void Set allowed URLs
addAllowedType(string $type, bool $binary): void Add Content-Type to the allowed list
removeAllowedType(string $type): void Remove Content-Type from the allowed list
isAllowedType(string $type[, string &$errorMessage]) Check if Content-Type is allowed
setTemporary(string $path): void Sets temporary handle path, eg.: /mnt/storage/, php://temp, php://memory
getTemporary(): resource Get temporary stream
download(string $url[, bool $ignoreDownloadError]): void Perform download
setResponseCacheTime(int $seconds): void Enable or disable cache for Proxy::respose() or Proxy::jsonp()
response(): void Dump response to output
jsonp(string $callback): void Output JSONP callback with URL or data URI content
getContents([int $length[, int $offset]]): string If last download was successful, contents will be returned
getContentType(): string If last download was successful, Content-Type will be returned
getHttpStatus(): int If last download was successful, HTTP status will be returned
getErrorCode(): int If last download was failed, error code will be returned
getErrorMessage(): string If last download was failed, error message will be returned
reset(): void Reset last download

Generic options

Generic options are primarily used for driver configurations. Since each driver may require different types of settings, the most flexible approach is to allow these options to store any value. This is particularly useful when developing a new driver. Existing options include:

Usage Description
setOptions('curl', array $value) Options for CurlDriver. See: https://www.php.net/manual/en/curl.constants.php
setOptions('stream', array $value) Options for StreamDriver. See: https://www.php.net/manual/en/context.php

Setup cURL driver use generic options with 'curl' in first param, eg.: $proxy->setOptions('curl', [ ... ]);, a sample for change SSL version:

A example for disable SSL verify (for local tests):

For more constants options for use with $proxy->setOptions('curl', [ ... ]), see: https://www.php.net/manual/en/curl.constants.php

For setup Stream driver use generic options with 'stream' in first param, eg.: $proxy->setOptions('stream', [ ... ]), a sample for set HTTP protocol version:

An example SSL configuration:

Content-Type allowed

When executing the download() method a Content-Type validation will be performed, by default the following Content-Types are allowed:

Content-Type Proxy::jsonp()
image/apng base64
image/png base64
image/avif base64
image/webp base64
image/gif base64
image/jpeg base64
image/svg+xml URL-encoded
image/svg-xml URL-encoded

You can define another allowed Content-Type, example:

Second parameter of the method specifies whether the Proxy::jsonp() should use URL encoding or Base64 encoding in the data URI scheme.

To remove an allowed Content-Type use the Proxy::removeAllowedType() method, example:

How to use

To return the download response directly to the browser, use the Proxy::response() method:

If you want to use the JSONP format, replace the Proxy::response method with Proxy::jsonp. In this example, the callback will return and receive the content in DATA URI format:

If you need to handle content, you can use the Proxy::getContents, Proxy::getContentType, Proxy::getHttpStatus methods:

In the examples so far, CurlDriver takes priority, and uses StreamDriver as a fallback, but you can change this, in a hypothetical example, if you only want to use StreamDriver:

You can also limit the URLs that the proxy can access:

Writing your own driver

The following methods are required to write an Inphinit\Proxy compatible driver

Method Description
__construct(Proxy $proxy) It will receive the Proxy instance
available(): bool It will inform if the server has support
exec(string $url, int &$httpStatus, string &$contentType, int &$errorCode, string &$errorMessage): void It will execute the driver and fill in the references

Optionally you can use InterfaceDriver to avoid errors when writing:

Once created you can use it like this:

Common issues and solutions

When adding an image that belongs to another domain in <canvas> and after that try to export the canvas for a new image, a security error occurs (actually occurs is a security lock), which can return the error:

SecurityError: DOM Exception 18

Error: An attempt was made to break through the security policy of the user agent.

If using Google Maps (or google maps static) you can get this error in console:

Google Maps API error: MissingKeyMapError

You need get a API Key in: https://developers.google.com/maps/documentation/javascript/get-api-key

If you get this error:

Access to Image at 'file:///...' from origin 'null' has been blocked by CORS policy: Invalid response. Origin 'null' is therefore not allowed access.

Means that you are not using an HTTP server, html2canvas does not work over the file:/// protocol, use Apache, Nginx or IIS with PHP for work.

Debuging with Web Console from DevTools

If you have any issue is recommend to analyze the log with the Web Console tab and requests with Network tab from your browser, see documentations:

An alternative is to debug issues by accessing the link directly:

http://[DOMAIN]/[PATH]/proxy?url=http%3A%2F%2Fmaps.googleapis.com%2Fmaps%2Fapi%2Fstaticmap%3Fcenter%3D40.714728%2C-73.998672%26zoom%3D12%26size%3D800x600%26maptype%3Droadmap%26sensor%3Dfalse%261&callback=html2canvas_0

Replace [DOMAIN] by your domain (eg. 127.0.0.1) and replace [PATH] by your project folder (eg.: project-1/test), something like:

http://localhost/project-1/test/proxy?url=http%3A%2F%2Fmaps.googleapis.com%2Fmaps%2Fapi%2Fstaticmap%3Fcenter%3D40.714728%2C-73.998672%26zoom%3D12%26size%3D800x600%26maptype%3Droadmap%26sensor%3Dfalse%261&callback=html2canvas_0

All versions of proxy with dependencies

PHP Build Version
Package Version
Requires php Version >=5.4.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package inphinit/proxy contains the following files

Loading the files please wait ....