https://github.com/slack-php/slack-php-socket-mode

A Socket Mode implementation for the slack-php framework
https://github.com/slack-php/slack-php-socket-mode

Last synced: about 1 month ago
JSON representation

A Socket Mode implementation for the slack-php framework

• Host: GitHub
• URL: https://github.com/slack-php/slack-php-socket-mode
• Owner: slack-php
• License: mit
• Created: 2021-06-20T17:12:12.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-11-12T00:22:49.000Z (about 2 years ago)
• Last Synced: 2024-04-25T06:20:25.184Z (8 months ago)
• Language: PHP
• Size: 28.3 KB
• Stars: 9
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Slack PHP – Socket Mode

This package provides a slack-php `AppServer` implementation that allows an application written for the

[Slack App Framework for PHP][1] to be run in [Socket Mode][2]. 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`][3] package from [Amp][4], 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][2] 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");`)

```php

command('cool', function (Context $ctx) {

        $ctx->ack(':thumbsup: That is so cool!');

    })

    ->withLogger(new StderrLogger(LogLevel::DEBUG))

    ->run(new SocketServer());

```

### 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.

```php

command('cool', function (Context $ctx) {

        $ctx->ack(':thumbsup: That is so cool!');

    });

if (getenv('SOCKET_MODE')) {

    $server = SocketServer::new()->withLogger(new StderrLogger(LogLevel::DEBUG));

} else {

    $server = HttpServer::new()->withLogger(new StderrLogger(LogLevel::NOTICE));

}

$server->withApp($app)->start();

```

[1]: https://github.com/slack-php/slack-php-app-framework

[2]: https://api.slack.com/apis/connections/socket

[3]: https://amphp.org/websocket-client/

[4]: https://amphp.org/