Download the PHP package elementworks/pusher-helper without Composer

On this page you can find all versions of the php package elementworks/pusher-helper. 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 pusher-helper

Pusher Helper plugin for Craft CMS 3.x

Support functionality for Pusher

Requirements

This plugin requires Craft CMS 3.0.0-beta.23 or later.

Installation

To install the plugin, follow these instructions.

  1. Open your terminal and go to your Craft project:

    cd /path/to/project

  2. Then tell Composer to load the plugin:

    composer require elementworks/pusher-helper
  3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Pusher Helper.

Pusher Helper Overview

This plugin provides boilerplate backend support for Pusher to CraftCMS, including:

There is no front-end code provided by this plugin. You will need to write your own front-end implementation to suit your own requirements.

Configuring Pusher Helper

Copy the config.php file in the src directory of the plugin into the config directory of your project, rename it pusher-helper.php and add the settings you need for your project. You are strongly advised to use environment variables for the Pusher settings.

Add the following environment variables to your .env file in all environments:

PUSHER_CLUSTER defaults to eu if not otherwise specified. The other Pusher API parameters are required for the plugin to work.

The globalChannel config setting is the name of the global presence channel as described here: https://support.pusher.com/hc/en-us/articles/360019620253-How-can-I-implement-large-presence-channels-on-Channels- and must start with private-.

The userFields config setting determines what fields on a user object will be included in the presence messages sent out on the global presence channel. These can include any valid fields defined on users in your project. They can be used to populate a who's online list, so think about what information you might want to include on there, remembering it is best to keep this as brief as possible to limit the number and size of messages sent.

Pusher imposes a 10kb limit on messages, so the messages sent on the global presence channel will be chunked if they are above this.

Using Pusher Helper

Install and configure the plugin as described above.

You are responsible for providing the following to make this work:

Pusher Helper Roadmap

Some things to do, and ideas for potential features:

Brought to you by Element Works Ltd

All versions of pusher-helper with dependencies

PHP Build Version
Package Version
Requires craftcms/cms Version ^3.0.0
pusher/pusher-php-server Version ^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 elementworks/pusher-helper contains the following files

Loading the files please wait ....