jolicode/slack-php-api

The jolicode/slack-php-api is a PHP client for the Slack Web API. It is automatically generated using JanePHP from the official Slack API specifications.

Key features include:

• A full object-oriented interface for all Slack Web API endpoints, requests, and responses.
• High fidelity to the official Slack API specs due to its automated generation process.

The SDK is primarily composed of code generated from the official Slack OpenAPI specification. It consists of four main types of classes:

• Endpoints: Represent the requests made to API methods.
• Models: Represent the data exchanged with the API.
• Normalizers: Transform JSON from the API into PHP models.
• Runtime: Internal classes required for the Jane library to function.

End-users should use ClientFactory to manage these components automatically.

Many Slack API endpoints use cursor-based pagination. Instead of manually managing cursors, the client provides virtual methods prefixed with iterate. These methods allow you to use a standard foreach loop to traverse all pages of results automatically, hiding the complexity of cursor management.

$userNames = [];

/** @var JoliCode\Slack\Api\Model\ObjsUser $user */
foreach ($client->iterateUsersList() as $user) {
    $userNames[] = $user->getName();
}

If you need manual control over pagination, you can use the standard API methods by passing a cursor in the options array. You can retrieve the next cursor from the response metadata using getResponseMetadata()->getNextCursor().

$userNames = [];
$cursor = '';

do {
    $response = $client->usersList([
        'limit' => 200,
        'cursor' => $cursor,
    ]);

    /** @var JoliCode\Slack\Api\Model\ObjsUser $user */
    foreach ($response->getUsers() as $user) {
        $userNames[] = $user->getName();
    }

    $cursor = $response->getResponseMetadata() ? $response->getResponseMetadata()->getNextCursor() : '';
} while (!empty($cursor));

If you have updated the specification and need to rebuild the SDK, follow these steps:

1. Clear existing code: Remove all content from the generated directory to ensure a clean state:

   rm -Rf generated/*

2. Run Jane: Use the Jane OpenAPI generator with the project's configuration file to regenerate the models and endpoints:

   vendor/bin/jane-openapi generate --config-file=.jane-openapi.php

To interact with the Slack Web API, use the JoliCode\Slack\ClientFactory::create() method with your Slack Bot Token. The resulting client provides a full object-oriented interface for all Slack endpoints. Methods return response objects that allow you to access data via typed getter methods (e.g., getUser()).

// $client contains all the methods to interact with the API
$client = JoliCode\Slack\ClientFactory::create($yourSlackToken);

$user = $client->usersInfo(['user' => 'U123AZER'])->getUser();

To start using the SDK, use the ClientFactory::create() method and pass your Slack token. This returns a Client instance which provides access to all Slack API methods. The SDK is object-oriented: every endpoint, response, and model is represented by a specific PHP class with full typehinting and PHPDoc support.

<?php

use JoliCode//Slack//Api//Client;
use JoliCode//Slack//ClientFactory;

/** @var Client $client */
$client = ClientFactory::create($yourSlackToken);

The Slack PHP API is built on PSR-7 and PSR-18 interfaces. Before installing the SDK, ensure your project has a PSR-7 message factory and a PSR-18 HTTP client implementation.

If you do not have these installed, you can install default implementations using Symfony and Nyholm:

composer require symfony/http-client nyholm/psr7

Once the dependencies are ready, install the Slack client via Composer:

composer require jolicode/slack-php-api

Because the official Slack OpenAPI specification may be incomplete or incorrect, this SDK uses a patched version. To download the latest official specification, sort the keys, and apply the project's custom patches to create resources/slack-openapi-patched.json, run the spec:update command using the client generator.

This command performs these steps:

1. Downloads the official Slack OpenAPI spec to resources/slack-openapi.json.
2. Sorts JSON keys and saves to resources/slack-openapi-sorted.json.
3. Applies patches and saves the final version to resources/slack-openapi-patched.json.

./bin/slack-api-client-generator spec:update