Download the PHP package slack-php/slack-socket-mode without Composer
On this page you can find all versions of the php package slack-php/slack-socket-mode. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download slack-php/slack-socket-mode
More information about slack-php/slack-socket-mode
Files in slack-php/slack-socket-mode
Package slack-socket-mode
Short Description Provides a a slack-php Socket Mode implementation
License MIT
Informations about the package slack-socket-mode
Slack PHP – Socket Mode
This package provides a slack-php AppServer
implementation that allows an application written for the
Slack App Framework for PHP to be run in Socket Mode. Socket Mode uses the websocket protocol to communicate
with Slack, and allows you to run an app (even locally) without having to expose it via a public HTTP endpoint. This can
be very useful for testing Slack apps in a way that does not violate most work-related firewall restrictions.
This package should be used for testing only, and is not designed for production use.
This Socket Mode implementation uses the
amphp/websocket-client
package from Amp, an awesome collection of PHP packages that make async and event loop style programming in PHP possible. Check it out sometime.
Installation
- Requires PHP 7.4+
- Use Composer to install:
composer require slack-php/slack-socket-mode
Usage
When using Socket Mode, there is no web server serving your app. When you run an app configured for Socket Mode, it
establishes a connection to Slack as a websocket client. It maintains that connection to listen for Slack events until
it is explicitly terminated (e.g., via CTRL+C
), Socket Mode is disabled in your app configuration, or an unrecoverable
error occurs. This is a different way of running PHP than many aren't used to, so please pay close attention.
When running an app in Slack Mode, you need an "App Token" instead of the typical "Signing Secret". The App Token is specially purposed for making the web socket connection. You can read more about Socket Mode in the Slack documentation to learn how to get an App Token.
Example
This small app responds to the /cool
slash command.
Assumptions:
- You have required the Composer autoloader to enable autoloading of the framework files.
- You have set
SLACK_APP_TOKEN
in the environment (e.g.,putenv("SLACK_APP_TOKEN=foo");
)
Switching Servers
The relationship between app and server can also be flipped, which might be helpful if you bootstrap script toggles between the Socket and HTTP server.