PHP¶

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

Rules¶
Rule	Description
php_proto_compile	Generates PHP protobuf `.php` files
php_grpc_compile	Generates PHP protobuf and gRPC `.php` files

php_proto_compile¶

Generates PHP protobuf .php files

Example¶

Full example project can be found here

`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¶

Attributes for php_proto_compile¶
Name	Type	Mandatory	Default	Description
`protos`	`label_list`	true		List of labels that provide the `ProtoInfo` provider (such as `proto_library` from `rules_proto`)
`options`	`string_list_dict`	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
`verbose`	`int`	false	`0`	The 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_path`	`string`	false	`""`	Path to prefix to the generated files in the output directory
`extra_protoc_args`	`string_list`	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 and gRPC .php files

Example¶

Full example project can be found here

`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¶

Attributes for php_grpc_compile¶
Name	Type	Mandatory	Default	Description
`protos`	`label_list`	true		List of labels that provide the `ProtoInfo` provider (such as `proto_library` from `rules_proto`)
`options`	`string_list_dict`	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
`verbose`	`int`	false	`0`	The 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_path`	`string`	false	`""`	Path to prefix to the generated files in the output directory
`extra_protoc_args`	`string_list`	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