Download the PHP package randomhost/steamsignature without Composer

On this page you can find all versions of the php package randomhost/steamsignature. 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?

Informations about the package steamsignature

Build Status

randomhost/steamsignature

1. Purpose

This package reads the Steam Web-API and community XML data of Valve's Steam platform and displays the current online status of players as PNG image, designed to be used in forum and blog signatures.

The included link target method detects whether the player is currently playing on a multiplayer server and returns either the URL to the player's steam profile or the URL for joining the game using the visitor's locally installed Steam client if this is supported by the game.

2. Example

3. Requirements

Note: The only officially supported way to install this package is via Composer. However, it is theoretically possible to install PHP 8 and Composer on a local computer, run the installation there and then upload the vendor folder created by Composer to the server, in case shell access is not available.

4. Installation

Important: This package uses the Composer dependency manager for PHP to check system requirements and to install package dependencies. Please make sure it is installed before trying to use this package.

The following example assumes that your web server is running under the user account www-data, that composer is installed into the system $PATH, and that you have a working sudo setup to run shell commands as a different user.

In this case, you simply have to run this command within the same directory which contains this README.md on your server:

5. Usage

A basic approach at using this package could look like this:

The example above should be mostly self-explanatory.

The API class must be initialized with a personalized API key. You can obtain your API key from the Steam developer website.

The API class is a very limited implementation of the Steam Web-API and is not supposed to be used directly, except for one method:

  1. API::resolveVanityUrl($vanityUrl)
    Resolves the given vanity URL into a 64-Bit Steam ID, ready to be passed to the Signature class constructor.

The Signature class provides two public methods:

  1. Signature::render()
    Outputs the signature image directly to the web browser.

    Note: This method must be the only code which sends output to the web browser. If you receive Cannot modify header information errors, please ensure that your application does not generate any output before Signature::render() is called. Additionally, no output may be generated after calling this method as it would break the image.

  2. Signature::getLinkTarget()
    Returns a link to the Steam user's profile page or a join link to join the game the user is currently playing if the game supports joining through Steam.

An example implementation of this script can be found in the src/www/ folder.

6. License

See LICENSE.txt for full license details.


All versions of steamsignature with dependencies

PHP Build Version
Package Version
Requires php Version ~8.0
randomhost/image Version ~3.0-beta
ext-mbstring Version *
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 randomhost/steamsignature contains the following files

Loading the files please wait ....