|
|
Maxious
|
1 |
protobuf-php(5) -- Proto files |
|
|
|
2 |
================================ |
|
|
|
3 |
|
|
|
|
4 |
## SYNOPSIS |
|
|
|
5 |
|
|
|
|
6 |
Protobuf for PHP supports a few custom options for proto files. |
|
|
|
7 |
|
|
|
|
8 |
|
|
|
|
9 |
## DESCRIPTION |
|
|
|
10 |
|
|
|
|
11 |
Proto files processed with Protobuf for PHP can use a number of custom options |
|
|
|
12 |
that affect the generated source code. |
|
|
|
13 |
|
|
|
|
14 |
* `php.suffix` <string>: |
|
|
|
15 |
Sets a custom suffix for the generated PHP files. By default ".php" is used. |
|
|
|
16 |
|
|
|
|
17 |
* `php.namespace` <string>: |
|
|
|
18 |
Defines the namespace to use for the generated PHP classes. |
|
|
|
19 |
|
|
|
|
20 |
* `php.package` <string>: |
|
|
|
21 |
An alias for `php.namespace` |
|
|
|
22 |
|
|
|
|
23 |
* `php.multifile` <boolean>: |
|
|
|
24 |
By default a single PHP file is generated for each Proto file processed, |
|
|
|
25 |
including in it all the messages, enums and extensions defined in the proto |
|
|
|
26 |
definition. If this option is set to `true` then each message and enum is |
|
|
|
27 |
generated in a separate file, following PEAR's conventions, and if extensions |
|
|
|
28 |
are pressent in the proto definition a file named after the proto file with the |
|
|
|
29 |
suffix "-extensions" will contain them. |
|
|
|
30 |
|
|
|
|
31 |
* `php.generic_services` <boolean>: |
|
|
|
32 |
By default no service interfaces will be generated. If this option is set |
|
|
|
33 |
to true then Interfaces will be created for each `service` definition found, |
|
|
|
34 |
including a method named after each `rpc` entry. |
|
|
|
35 |
|
|
|
|
36 |
|
|
|
|
37 |
|
|
|
|
38 |
## EXAMPLES ## |
|
|
|
39 |
|
|
|
|
40 |
option (php.suffix) = ".pb.php" |
|
|
|
41 |
option (php.namespace) = "MyOrg.Protos" |
|
|
|
42 |
option (php.multifile) = true |
|
|
|
43 |
option (php.generic_services) = true |
|
|
|
44 |
|
|
|
|
45 |
|
|
|
|
46 |
## BUGS ## |
|
|
|
47 |
|
|
|
|
48 |
Please report bugs using GitHub's issue tracker at http://github.com/drslump/protobuf-php/issues |
|
|
|
49 |
|
|
|
|
50 |
|
|
|
|
51 |
## COPYRIGHT ## |
|
|
|
52 |
|
|
|
|
53 |
Protobuf for PHP is Copyright (C) 2011 Ivan -DrSlump- Montes <http://pollinimini.net> |
|
|
|
54 |
|
|
|
|
55 |
|
|
|
|
56 |
## SEE ALSO |
|
|
|
57 |
|
|
|
|
58 |
protoc-gen-php(1), protobuf-php(3), |
|
|
|
59 |
<http://github.com/drslump/protobuf-php> |
|
|
|
60 |
|