PHP SDK forCloudEvents

Status

Installation

composer require cloudevents/sdk-php

Create a CloudEvent

useCloudEvents\V1\CloudEvent;useCloudEvents\V1\CloudEventImmutable;// Immutable CloudEvent$immutableEvent =newCloudEventImmutable('1n6bFxDMHZFChlI4TVI9tdzphB9','/examples/php-sdk','com.example.type',    ['example' =>'first-event'],'application/json');// Mutable CloudEvent$mutableEvent =newCloudEvent('1n6bFxDMHZFChlI4TVI9tdzphB9','/examples/php-sdk','com.example.type',    ['example' =>'first-event'],'application/json');// Create immutable from mutable or via versa$event = CloudEventImmutable::createFromInterface($mutableEvent);$event = CloudEvent::createFromInterface($immutableEvent);

Serialize/Deserialize a CloudEvent

useCloudEvents\Serializers\JsonDeserializer;useCloudEvents\Serializers\JsonSerializer;// JSON serialization$payload = JsonSerializer::create()->serializeStructured($event);$payload = JsonSerializer::create()->serializeBatch($events);// JSON deserialization$event = JsonDeserializer::create()->deserializeStructured($payload);$events = JsonDeserializer::create()->deserializeBatch($payload);

Marshal/Unmarshal a CloudEvent

useCloudEvents\Http\Marshaller;useCloudEvents\Http\Unmarshaller;// Marshal HTTP request$request = Marshaller::createJsonMarshaller()->marshalStructuredRequest($event);$request = Marshaller::createJsonMarshaller()->marshalBinaryRequest($event);$request = Marshaller::createJsonMarshaller()->marshalBatchRequest($events);// Marshal HTTP response$request = Marshaller::createJsonMarshaller()->marshalStructuredResponse($event);$request = Marshaller::createJsonMarshaller()->marshalBinaryResponse($event);$request = Marshaller::createJsonMarshaller()->marshalBatchResponse($events);// Unmarshal HTTP message$events = Unmarshaller::createJsonUnmarshaller()->unmarshal($message);

Testing

$ composer run -lscripts:  lint          Show all current linting errors according to PSR12  lint-fix      Show and fix all current linting errors according to PSR12  sa            Run the static analyzer  tests         Run all tests locally  tests-build   Build containers to test against supported PHP versions  tests-docker  Run tests within supported PHP version containers

Community

Additional SDK Resources