Skip to content

php-skir/runtime

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Laravel Skir Runtime

Framework-agnostic PHP runtime support for Skir serialization and descriptors.

This package is intentionally small. Laravel-specific routing and client behavior live in separate packages.

Installation

composer require php-skir/runtime

What it provides

  • DenseJson for encoding and decoding Skir dense JSON values.
  • Cbor helpers for optional CBOR bodies and SkirRPC envelopes.
  • Type, Field, and Variant descriptors for generated DTO metadata.
  • EnumValue for Skir enum constants and wrapper variants.
  • MethodDescriptor for generated SkirRPC method metadata.
  • Package-local SkirRuntimeException exceptions for invalid Skir values.

Dense JSON

use Skir\Runtime\DenseJson;
use Skir\Runtime\Field;
use Skir\Runtime\Type;

$user = Type::struct([
    Field::value('id', 0, Type::int32()),
    Field::value('name', 1, Type::string()),
]);

$json = DenseJson::toJson($user, [
    'id' => 1,
    'name' => 'Jane',
]);

$data = DenseJson::fromJson($user, $json);

Struct values are encoded as field-number indexed arrays. Removed fields and sparse field numbers are preserved so generated DTOs can stay compatible with existing Skir schemas.

CBOR

CBOR support is optional and requires spomky-labs/cbor-php in the consuming app:

composer require spomky-labs/cbor-php

The runtime helper keeps CBOR wrapping shared between server and client packages:

use Skir\Runtime\Cbor;

$body = Cbor::encodeEnvelope($methodDescriptor, $request);
$payload = Cbor::decodeEnvelope($body);

Current scope

This runtime does not register routes, discover procedures, or make HTTP calls. Those concerns belong in the php-skir/server and php-skir/client packages.

About

PHP runtime support for Skir serialization and descriptors

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors

Languages