dunglas/digital-ocean-bundle

DigitalOcean API v2 client for Symfony and API Platform

Fund package maintenance!
dunglas

Installs: 12

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

Type:symfony-bundle

v1.0.0 2021-08-31 15:22 UTC

This package is auto-updated.

Last update: 2021-08-31 15:41:31 UTC


README

DunglasDigitalOceanBundle allows using the DigitalOcean API from your Symfony and API Platform projects. It registers the DigitalOcean PHP API Client as a Symfony service.

If you aren't yet a DigitalOcean user, use this affiliate link to get $100 in free credit!

If you want to deploy your Symfony apps to DigitalOcean, checkout this tutorial.

Example

// src/Controller/DigitalOceanController.php
namespace App\Controller;

use DigitalOceanV2\Client;
use DigitalOceanV2\ResultPager;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;

class ProductController
{
    #[Route("/droplets")]
    public function listDroplets(Client $doClient): Response
    {
        // get the first 100 droplets as an array
        $droplets = $doClient->droplet()->getAll();
        
        // or create a new result pager
        $pager = new ResultPager($doClient);

        // and get all droplets as an array
        $droplets = $pager->fetchAll($doClient->droplet(), 'getAll'); 

        // ...
    }
}

Of course, you can also inject the client service into your commands, messenger handlers and any other service.

More examples.

Installation

Make sure Composer is installed globally, as explained in the installation chapter of the Composer documentation.

Applications that use Symfony Flex

Open a command console, enter your project directory and execute:

$ composer require dunglas/digital-ocean-bundle symfony/http-client nyholm/psr7 guzzlehttp/promises

The previous command installs the bundle, Symfony HttpClient and the dependencies it needs to "provide" psr/http-client-implementation and psr/http-factory-implementation.

Alternatively, you can use any other implementation of these interfaces such as Guzzle.

Applications that don't use Symfony Flex

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

$ composer require dunglas/digital-ocean-bundle symfony/http-client nyholm/psr7 guzzlehttp/promises

Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the config/bundles.php file of your project:

// config/bundles.php

return [
    // ...
    \Dunglas\DigitalOceanBundle\DunglasDigitalOceanBundle::class => ['all' => true],
];

Configuration

dunglas_digital_ocean:
    connections:
        primary: # can be any name
            token: <your-access-token>
        secondary:
            token: <your-access-token>
    default_connection: primary # If not set, the first in the list will be used

This configuration automatically registers the following autowiring aliases:

DigitalOceanV2\Client $primaryClient
DigitalOceanV2\Client $secondaryClient

If you have only one client, you can use this shortcut:

dunglas_digital_ocean: <your-access-token>

Use the DigitalOceanV2\Client type to inject the default DigitalOcean client.

Credits

This bundle is brought to you by Kévin Dunglas. It is sponsored by Les-Tilleuls.coop.