Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nexylan/slack-bundle

Symfony bundle integration of the nexylan/slack library.
https://github.com/nexylan/slack-bundle

slack symfony symfony-bundle

Last synced: 6 days ago
JSON representation

Symfony bundle integration of the nexylan/slack library.

Host: GitHub
URL: https://github.com/nexylan/slack-bundle
Owner: nexylan
License: mit
Created: 2016-03-01T16:05:16.000Z (almost 9 years ago)
Default Branch: master
Last Pushed: 2022-11-26T13:13:15.000Z (about 2 years ago)
Last Synced: 2024-12-29T00:28:11.257Z (13 days ago)
Topics: slack, symfony, symfony-bundle
Language: PHP
Homepage: https://github.com/nexylan/slack
Size: 68.4 KB
Stars: 109
Watchers: 6
Forks: 21
Open Issues: 10
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # NexySlackBundle

Symfony bundle integration of the [nexylan/slack](https://github.com/nexylan/slack) library (old popular `maknz/slack`).

[![Latest Stable Version](https://poser.pugx.org/nexylan/slack-bundle/v/stable)](https://packagist.org/packages/nexylan/slack-bundle)

[![Latest Unstable Version](https://poser.pugx.org/nexylan/slack-bundle/v/unstable)](https://packagist.org/packages/nexylan/slack-bundle)

[![License](https://poser.pugx.org/nexylan/slack-bundle/license)](https://packagist.org/packages/nexylan/slack-bundle)

[![Dependency Status](https://www.versioneye.com/php/nexylan:slack-bundle/badge.svg)](https://www.versioneye.com/php/nexylan:slack-bundle)

[![Reference Status](https://www.versioneye.com/php/nexylan:slack-bundle/reference_badge.svg)](https://www.versioneye.com/php/nexylan:slack-bundle/references)

[![Total Downloads](https://poser.pugx.org/nexylan/slack-bundle/downloads)](https://packagist.org/packages/nexylan/slack-bundle)

[![Monthly Downloads](https://poser.pugx.org/nexylan/slack-bundle/d/monthly)](https://packagist.org/packages/nexylan/slack-bundle)

[![Daily Downloads](https://poser.pugx.org/nexylan/slack-bundle/d/daily)](https://packagist.org/packages/nexylan/slack-bundle)

[![Build Status](https://travis-ci.org/nexylan/NexySlackBundle.svg?branch=master)](https://travis-ci.org/nexylan/NexySlackBundle)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nexylan/NexySlackBundle/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/nexylan/NexySlackBundle/?branch=master)

[![Code Climate](https://codeclimate.com/github/nexylan/NexySlackBundle/badges/gpa.svg)](https://codeclimate.com/github/nexylan/NexySlackBundle)

[![Coverage Status](https://coveralls.io/repos/nexylan/NexySlackBundle/badge.svg?branch=master)](https://coveralls.io/r/nexylan/NexySlackBundle?branch=master)

[![SensioLabsInsight](https://insight.sensiolabs.com/projects/15e2cfed-cfb8-4856-ac0d-92768fc0c324/mini.png)](https://insight.sensiolabs.com/projects/8a6b5dd0-e974-478c-92ee-43125cb7bae3)

## Documentation

All the installation and usage instructions are located in this README.

Check it for specific version:

* [__1.x__](https://github.com/nexylan/NexySlackBundle/tree/1.x) with support for Symfony `>=2.7`

* [__2.x__](https://github.com/nexylan/NexySlackBundle/tree/master) with support for Symfony `>=3.4`

## Prerequisites

This version of the project requires:

* PHP 7.1+

* Symfony 3.4+

## Installation

First of all, you need to require this library through composer:

``` bash

$ composer require nexylan/slack-bundle php-http/guzzle6-adapter

```

Why `php-http/guzzle6-adapter`? We are decoupled from any HTTP messaging client thanks to [HTTPlug](http://httplug.io/).

Then, enable the bundle on the `AppKernel` class:

``` php

// app/AppKernel.php

public function registerBundles()

{

    $bundles = array(

        // ...

        new Http\HttplugBundle\HttplugBundle(),

        new Nexy\SlackBundle\NexySlackBundle(),

    );

    // ...

    return $bundles

}

```

## Configuration

If it is not already done, you have to configure httplug-bundle first.

Check the [official documentation](http://docs.php-http.org/en/latest/integrations/symfony-bundle.html) for this.

Configure the bundle to your needs (example with default values):

```yaml

nexy_slack:

    # If you want to use an another httplug client service.

    http:

        client: httplug.client

    # The Slack API Incoming WebHooks URL.

    endpoint:             ~ # Required

    channel:              null

    username:             null

    icon:                 null

    link_names:           false

    unfurl_links:         false

    unfurl_media:         true

    allow_markdown:       true

    markdown_in_attachments: []

```

Excepted `endpoint`, all the other configuration keys are related to the Slack client default settings.

All those settings are described on the [nexylan/slack documentation](https://github.com/nexylan/slack#settings).

## Usage

The Slack client instance can be retrieved from the `nexy_slack.client` service.

Here is an example:

```php

get('nexy_slack.client');

        $message = $slack->createMessage();

        $message

            ->to('#test')

            ->from('John Doe')

            ->withIcon(':ghost:')

            ->setText('This is an amazing message!')

        ;

        $message->attach((new Attachment())

             ->setFallback('Some fallback text')

             ->setText('The attachment text')

         );

        $slack->sendMessage($message);

    }

}

```

All the how to manipulate the Slack client is on the [nexylan/slack documentation](https://github.com/nexylan/slack#sending-messages).