Symfony JoliNotif Notifier

https://github.com/symfony/joli-notif-notifier
Admin
Provides a JoliNotif integration bridge for the Symfony Notifier Component to enable desktop...
Tokens:2,245
Snippets:16
Trust Score:9.5
License:MIT
Update:10 months ago
Show doc for...
Tokens:
Raw
### JoliNotif DSN Example

Source: https://github.com/symfony/joli-notif-notifier/blob/7.3/README.md

This snippet shows an example of a Data Source Name (DSN) for configuring the JoliNotif notifier. It specifies the transport mechanism and potentially authentication details.

```dotenv
JOLINOTIF_DSN=jolinotif://default
```

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

### Complete JoliNotif Integration Example in PHP

Source: https://context7.com/symfony/joli-notif-notifier/llms.txt

This comprehensive PHP example shows a service that uses the JoliNotif transport to send various desktop notifications, including build success, failure, and deployment alerts. It demonstrates customization of icons, sounds, and error handling.

```php
<?php

namespace App\Service;

use Symfony\Component\Notifier\Bridge\JoliNotif\JoliNotifOptions;
use Symfony\Component\Notifier\Bridge\JoliNotif\JoliNotifTransport;
use Symfony\Component\Notifier\Message\DesktopMessage;
use Symfony\Component\Notifier\Exception\TransportException;

class BuildNotificationService
{
    public function __construct(private JoliNotifTransport $transport)
    {
    }

    public function notifyBuildSuccess(string $buildId, string $branch): void
    {
        $options = (new JoliNotifOptions())
            ->setIconPath(__DIR__ . '/../../public/icons/success.png')
            ->setExtraOption('sound', 'Hero');

        $message = new DesktopMessage(
            subject: "Build Successful",
            content: "Build #{$buildId} on {$branch} completed successfully"
        );
        $message->setOptions($options);

        try {
            $this->transport->send($message);
        } catch (TransportException $e) {
            error_log("Failed to send build notification: " . $e->getMessage());
        }
    }

    public function notifyBuildFailure(string $buildId, string $error): void
    {
        $options = (new JoliNotifOptions())
            ->setIconPath(__DIR__ . '/../../public/icons/error.png')
            ->setExtraOption('sound', 'Basso')
            ->setExtraOption('timeout', 30);

        $message = new DesktopMessage(
            subject: "Build Failed",
            content: "Build #{$buildId} failed: {$error}"
        );
        $message->setOptions($options);

        $this->transport->send($message);
    }

    public function notifyDeployment(string $environment, array $changes): void
    {
        $changeList = implode(', ', array_slice($changes, 0, 3));
        if (count($changes) > 3) {
            $changeList .= sprintf(' and %d more', count($changes) - 3);
        }

        $message = new DesktopMessage(
            subject: "Deployment to {$environment}",
            content: "Changes: {$changeList}"
        );

        $options = (new JoliNotifOptions())
            ->setIconPath(__DIR__ . '/../../public/icons/deploy.png');
        $message->setOptions($options);

        $this->transport->send($message);
    }
}

```

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

### Configure JoliNotif Transport with Environment Variables (DSN)

Source: https://context7.com/symfony/joli-notif-notifier/llms.txt

Provides an example of how to configure the JoliNotif transport in a Symfony application using environment variables. The JOLINOTIF_DSN variable is used to specify the connection details for the notification service.

```bash
# .env file
JOLINOTIF_DSN=jolinotif://default

```

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

### Configure JoliNotifOptions for Desktop Notifications

Source: https://context7.com/symfony/joli-notif-notifier/llms.txt

Shows how to configure desktop notification options using the JoliNotifOptions class. This includes setting icon paths, platform-specific extra options like sound and timeout, and attaching these options to a DesktopMessage.

```php
<?php

use Symfony\Component\Notifier\Bridge\JoliNotif\JoliNotifOptions;
use Symfony\Component\Notifier\Message\DesktopMessage;

// Create options with constructor
$options = new JoliNotifOptions(
    iconPath: '/path/to/icon.png',
    extraOptions: ['sound' => 'default', 'timeout' => 5]
);

// Or build options fluently
$options = (new JoliNotifOptions())
    ->setIconPath('/usr/share/icons/notification.png')
    ->setExtraOption('sound', 'Glass')
    ->setExtraOption('timeout', 10);

// Retrieve option values
$iconPath = $options->getIconPath(); // Returns: /usr/share/icons/notification.png
$sound = $options->getExtraOption('sound'); // Returns: Glass
$allExtraOptions = $options->getExtraOptions(); // Returns: ['sound' => 'Glass', 'timeout' => 10]

// Convert to array format
$optionsArray = $options->toArray();
// Returns: ['icon_path' => '/usr/share/icons/notification.png', 'extra_options' => [...]]

// Attach options to a message
$message = new DesktopMessage('Update Available', 'Version 2.0 is ready to install');
$message->setOptions($options);

```

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

### Create JoliNotif Transport using Factory

Source: https://context7.com/symfony/joli-notif-notifier/llms.txt

Demonstrates how to create a JoliNotif transport instance using the JoliNotifTransportFactory. This factory follows Symfony's transport factory pattern for the Notifier component, allowing transport creation from DSN strings.

```php
<?php

use Symfony\Component\Notifier\Bridge\JoliNotif\JoliNotifTransportFactory;
use Symfony\Component\Notifier\Transport\Dsn;

// Create the factory
$factory = new JoliNotifTransportFactory();

// Create transport from DSN
$dsn = new Dsn('jolinotif://default');
$transport = $factory->create($dsn);

// The transport is now ready to send desktop notifications
echo $transport; // Output: jolinotif://localhost

```

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

### Send Desktop Notifications with JoliNotifTransport

Source: https://context7.com/symfony/joli-notif-notifier/llms.txt

Illustrates how to use the JoliNotifTransport to send desktop notifications. It supports basic messages and advanced configuration using JoliNotifOptions, including custom icons, sounds, and timeouts.

```php
<?php

use Joli\JoliNotif\DefaultNotifier as JoliNotifier;
use Symfony\Component\Notifier\Bridge\JoliNotif\JoliNotifTransport;
use Symfony\Component\Notifier\Bridge\JoliNotif\JoliNotifOptions;
use Symfony\Component\Notifier\Message\DesktopMessage;

// Create transport
$transport = new JoliNotifTransport(new JoliNotifier());

// Create a simple desktop message
$message = new DesktopMessage('Task Complete', 'Your export has finished successfully');

// Send the notification
try {
    $sentMessage = $transport->send($message);
    echo "Notification sent successfully\n";
} catch (\Exception $e) {
    echo "Failed to send notification: " . $e->getMessage() . "\n";
}

// Create message with options
$options = (new JoliNotifOptions())
    ->setIconPath('/usr/share/icons/success.png')
    ->setExtraOption('sound', 'default');

$messageWithOptions = new DesktopMessage('Build Status', 'Build #42 completed');
$messageWithOptions->setOptions($options);

// Send notification with custom icon and sound
$transport->send($messageWithOptions);

```

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

### Send Desktop Notification with Symfony Notifier

Source: https://context7.com/symfony/joli-notif-notifier/llms.txt

A PHP class demonstrating how to send a desktop notification using Symfony's Notifier component. It injects `NotifierInterface` and sends a high-importance alert to the desktop channel.

```php
<?php

use Symfony\Component\Notifier\NotifierInterface;
use Symfony\Component\Notifier\Notification\Notification;
use Symfony\Component\Notifier\Recipient\Recipient;

class NotificationService
{
    public function __construct(private NotifierInterface $notifier)
    {
    }

    public function sendDesktopNotification(): void
    {
        $notification = (new Notification('Server Alert', ['desktop']))
            ->content('CPU usage exceeded 90%')
            ->importance(Notification::IMPORTANCE_HIGH);

        // Send to desktop channel
        $this->notifier->send($notification, new Recipient('user@example.com'));
    }
}

```

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

### Configure JoliNotif Transport in Symfony

Source: https://context7.com/symfony/joli-notif-notifier/llms.txt

This snippet shows how to configure the JoliNotif transport in Symfony's `notifier.yaml` configuration file. It relies on an environment variable `JOLINOTIF_DSN` for the transport's Data Source Name.

```yaml
framework:
    notifier:
        texter_transports:
            jolinotif: '%env(JOLINOTIF_DSN)%'

```
Tokens:
Raw