tree: 8d3a24bdb5f839ec0ae87ceb528303727b7ae0b6
  1. BUILD.bazel
  2. defs.bzl
  3. php_grpc_compile.bzl
  4. php_proto_compile.bzl
  5. README.md
  6. repositories.bzl
php/README.md

PHP rules

Rules for generating PHP protobuf and gRPC .php files and libraries using standard Protocol Buffers and gRPC

RuleDescription
php_proto_compileGenerates PHP protobuf .php artifacts
php_grpc_compileGenerates PHP protobuf+gRPC .php artifacts

php_proto_compile

Generates PHP protobuf .php artifacts

WORKSPACE

load("@rules_proto_grpc//php:repositories.bzl", rules_proto_grpc_php_repos = "php_repos")

rules_proto_grpc_php_repos()

BUILD.bazel

load("@rules_proto_grpc//php:defs.bzl", "php_proto_compile")

php_proto_compile(
    name = "person_php_proto",
    protos = ["@rules_proto_grpc//example/proto:person_proto"],
)

php_proto_compile(
    name = "place_php_proto",
    protos = ["@rules_proto_grpc//example/proto:place_proto"],
)

php_proto_compile(
    name = "thing_php_proto",
    protos = ["@rules_proto_grpc//example/proto:thing_proto"],
)

Attributes

NameTypeMandatoryDefaultDescription
protoslist<ProtoInfo>true[]List of labels that provide a ProtoInfo (such as rules_proto proto_library)
optionsdict<string, list(string)>false[]Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins
verboseintfalse0The verbosity level. Supported values and results are 1: show command, 2: show command and sandbox after running protoc, 3: show command and sandbox before and after running protoc, 4. show env, command, expected outputs and sandbox before and after running protoc
prefix_pathstringfalse``Path to prefix to the generated files in the output directory
extra_protoc_argslist<string>false[]A list of extra args to pass directly to protoc, not as plugin options

Plugins

  • @rules_proto_grpc//php:php_plugin

php_grpc_compile

Generates PHP protobuf+gRPC .php artifacts

WORKSPACE

load("@rules_proto_grpc//php:repositories.bzl", rules_proto_grpc_php_repos = "php_repos")

rules_proto_grpc_php_repos()

load("@com_github_grpc_grpc//bazel:grpc_deps.bzl", "grpc_deps")

grpc_deps()

BUILD.bazel

load("@rules_proto_grpc//php:defs.bzl", "php_grpc_compile")

php_grpc_compile(
    name = "thing_php_grpc",
    protos = ["@rules_proto_grpc//example/proto:thing_proto"],
)

php_grpc_compile(
    name = "greeter_php_grpc",
    protos = ["@rules_proto_grpc//example/proto:greeter_grpc"],
)

Attributes

NameTypeMandatoryDefaultDescription
protoslist<ProtoInfo>true[]List of labels that provide a ProtoInfo (such as rules_proto proto_library)
optionsdict<string, list(string)>false[]Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins
verboseintfalse0The verbosity level. Supported values and results are 1: show command, 2: show command and sandbox after running protoc, 3: show command and sandbox before and after running protoc, 4. show env, command, expected outputs and sandbox before and after running protoc
prefix_pathstringfalse``Path to prefix to the generated files in the output directory
extra_protoc_argslist<string>false[]A list of extra args to pass directly to protoc, not as plugin options

Plugins

  • @rules_proto_grpc//php:php_plugin
  • @rules_proto_grpc//php:grpc_php_plugin