API

Relay’s API is available in a searchable format on docs.relay.so/api. Additionally, all builds include a relay.stub.php file, which outlines that build’s classes and their APIs.

Stubs

Fetching a specific stub without downloading a build can be done as well:

wget "https://builds.r2.relay.so/dev/relay.stub.php"
curl "https://builds.r2.relay.so/v0.5.1/relay.stub.php" > relay.stub.php

Groups

Similar to PHPUnit, we’ve included @group tags in the stubs to provide some metadata.

  • local indicates a method that does not communicate with Redis
  • remote indicates a method that may communicate with Redis
  • redis (implies remote) indicates a method that represents a Redis command
  • enhanced indicates a method that is a Redis command that may be handled in-memory