Slack PHP API

https://github.com/jolicode/slack-php-api
Admin
An up-to-date PHP SDK for the Slack API, automatically generated from official Slack API...
Tokens:3,492
Snippets:47
Trust Score:10
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install Slack PHP API client

Source: https://github.com/jolicode/slack-php-api/blob/main/README.md

Install the Slack PHP API library via Composer.

```bash
composer require jolicode/slack-php-api
```

--------------------------------

### Install PSR-7 and PSR-18 dependencies

Source: https://github.com/jolicode/slack-php-api/blob/main/README.md

Install default implementations for PSR-7 and PSR-18 if your project does not already have them.

```bash
composer require symfony/http-client nyholm/psr7
```

--------------------------------

### Manual pagination handling

Source: https://github.com/jolicode/slack-php-api/blob/main/docs/2-usage.md

This example demonstrates the manual implementation of cursor-based pagination, which is equivalent to the iterate method shown previously.

```php
$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));
```

--------------------------------

### Initialize client and fetch user info

Source: https://github.com/jolicode/slack-php-api/blob/main/README.md

Create a client instance using your Slack token and perform an API call to retrieve user information.

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

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

--------------------------------

### Configure window.$docsify object

Source: https://github.com/jolicode/slack-php-api/blob/main/docs/index.html

Sets up the documentation site metadata, theme color, and URL aliases for the slack-php-api project.

```javascript
window.$docsify = { name: 'slack-php-api', repo: 'jolicode/slack-php-api', relativePath: true, loadSidebar: 'navigation.md', homepage: 'index.md', themeColor: '#ecb22e', auto2top: true, alias: { '/docs/(.*)': '/$1.md', // supports regexp '/changelog': 'https://raw.githubusercontent.com/jolicode/slack-php-api/main/CHANGELOG.md', }, }
```

--------------------------------

### Run the test suite

Source: https://github.com/jolicode/slack-php-api/blob/main/CONTRIBUTING.md

Execute the project's test suite using the make command.

```shell
make test
```

--------------------------------

### Create a Slack API Client

Source: https://github.com/jolicode/slack-php-api/blob/main/docs/2-usage.md

Use the ClientFactory to instantiate a configured Client instance with your Slack token.

```php
<?php

use JoliCode\Slack\Api\Client;
use JoliCode\Slack\ClientFactory;

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

--------------------------------

### Regenerate the SDK

Source: https://github.com/jolicode/slack-php-api/blob/main/docs/4-updating-sdk.md

Uses Jane OpenAPI to regenerate the SDK based on the updated configuration file.

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

--------------------------------

### Run PHP CS fixer

Source: https://github.com/jolicode/slack-php-api/blob/main/CONTRIBUTING.md

Ensure code compliance with project standards by running the PHP CS fixer tool.

```shell
make cs
```

--------------------------------

### Configure Slack OAuth token for tests

Source: https://github.com/jolicode/slack-php-api/blob/main/CONTRIBUTING.md

Set the required SLACK_TOKEN in the phpunit.xml configuration file to enable full test execution.

```xml
<server name="SLACK_TOKEN" value="edit_me" />
```

--------------------------------

### Add upstream remote

Source: https://github.com/jolicode/slack-php-api/blob/main/CONTRIBUTING.md

Track the original repository by adding it as an upstream remote.

```shell
git remote add upstream https://github.com/jolicode/slack-php-api.git
```

--------------------------------

### Call a Slack API method

Source: https://github.com/jolicode/slack-php-api/blob/main/docs/2-usage.md

Execute an API method using the client and retrieve the corresponding model object.

```php
<?php
//...

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

dump($user);
```

--------------------------------

### Publish updated changes

Source: https://github.com/jolicode/slack-php-api/blob/main/CONTRIBUTING.md

Force push your rebased changes to your fork to update the pull request.

```shell
git push -f origin <your-branch>
```

--------------------------------

### Generate a new patch file

Source: https://github.com/jolicode/slack-php-api/blob/main/docs/4-updating-sdk.md

Creates a new cumulative patch file in the resources directory based on manual edits made to the patched specification.

```bash
./bin/slack-api-client-generator spec:generate-patch
```

--------------------------------

### Update and patch the API specification

Source: https://github.com/jolicode/slack-php-api/blob/main/docs/4-updating-sdk.md

Downloads the official Slack OpenAPI specification, sorts the JSON keys, and applies custom patches to generate a corrected specification file.

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

--------------------------------

### Iterate over paginated results

Source: https://github.com/jolicode/slack-php-api/blob/main/docs/2-usage.md

Use the virtual iterate methods to automatically handle cursor-based pagination when fetching lists.

```php
$userNames = [];

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

--------------------------------

### Remove existing generated SDK files

Source: https://github.com/jolicode/slack-php-api/blob/main/docs/4-updating-sdk.md

Clears the contents of the generated directory before regenerating the SDK to ensure no stale files remain.

```bash
rm -Rf generated/*
```

--------------------------------

### Update fork with upstream changes

Source: https://github.com/jolicode/slack-php-api/blob/main/CONTRIBUTING.md

Commands to pull the latest changes from the upstream repository and rebase your local branch.

```shell
git checkout main
git pull --rebase origin main
git pull --rebase upstream main
git checkout <your-branch>
git rebase main
```

--------------------------------

### Accessing unmapped API response data

Source: https://github.com/jolicode/slack-php-api/blob/main/docs/3-troubleshoots.md

Demonstrates how to access API response fields that are not explicitly mapped in the DTO by using ArrayObject syntax.

```php
$results = $client->searchMessages([
    'query' => 'test'
]);

var_dump($results->getOk()); // ok property is mapped
var_dump($results['messages']); // messages property is not mapped but still readable
```
Tokens:
Raw