Dapr PHP SDK

PHP SDK packages for developing Dapr applications

Dapr offers an SDK to help with the development of PHP applications. Using it, you can create PHP clients, servers, and virtual actors with Dapr.

Setting up

Prerequisites

Optional Prerequisites

Initialize your project

In a directory where you want to create your service, run composer init and answer the questions. Install dapr/php-sdk and any other dependencies you may wish to use.

Configure your service

Create a config.php, copying the contents below:

  1. <?php
  3. use Dapr\Actors\Generators\ProxyFactory;
  4. use Dapr\Middleware\Defaults\{Response\ApplicationJson,Tracing};
  5. use Psr\Log\LogLevel;
  6. use function DI\{env,get};
  8. return [
  9.     // set the log level
  10.     'dapr.log.level'               => LogLevel::WARNING,
  12.     // Generate a new proxy on each request - recommended for development
  13.     'dapr.actors.proxy.generation' => ProxyFactory::GENERATED,
  15.     // put any subscriptions here
  16.     'dapr.subscriptions'           => [],
  18.     // if this service will be hosting any actors, add them here
  19.     'dapr.actors'                  => [],
  21.     // if this service will be hosting any actors, configure how long until dapr should consider an actor idle
  22.     'dapr.actors.idle_timeout'     => null,
  24.     // if this service will be hosting any actors, configure how often dapr will check for idle actors 
  25.     'dapr.actors.scan_interval'    => null,
  27.     // if this service will be hosting any actors, configure how long dapr will wait for an actor to finish during drains
  28.     'dapr.actors.drain_timeout'    => null,
  30.     // if this service will be hosting any actors, configure if dapr should wait for an actor to finish
  31.     'dapr.actors.drain_enabled'    => null,
  33.     // you shouldn't have to change this, but the setting is here if you need to
  34.     'dapr.port'                    => env('DAPR_HTTP_PORT', '3500'),
  36.     // add any custom serialization routines here
  37.     'dapr.serializers.custom'      => [],
  39.     // add any custom deserialization routines here
  40.     'dapr.deserializers.custom'    => [],
  42.     // the following has no effect, as it is the default middlewares and processed in order specified
  43.     'dapr.http.middleware.request'  => [get(Tracing::class)],
  44.     'dapr.http.middleware.response' => [get(ApplicationJson::class), get(Tracing::class)],
  45. ];

Create your service

Create index.php and put the following contents:

  1. <?php
  3. require_once __DIR__.'/vendor/autoload.php';
  5. use Dapr\App;
  7. $app = App::create(configure: fn(\DI\ContainerBuilder $builder) => $builder->addDefinitions(__DIR__ . '/config.php'));
  8. $app->get('/hello/{name}', function(string $name) {
  9.     return ['hello' => $name];
  10. });
  11. $app->start();

Try it out

Initialize dapr with dapr init and then start the project with dapr run -a dev -p 3000 -- php -S 0.0.0.0:3000.

You can now open a web browser and point it to http://localhost:3000/hello/world replacing world with your name, a pet’s name, or whatever you want.

Congratulations, you’ve created your first Dapr service! I’m excited to see what you’ll do with it!

More Information

Last modified January 1, 0001